Skip to content

README.md

Latest commit

 

History

History
239 lines (182 loc) · 15 KB

README.md

File metadata and controls

239 lines (182 loc) · 15 KB

Reports

Overview

Available Operations

  • List - List configured reports
  • Create - Add a report
  • Get - Get a report
  • Put - Update a report

List

List all configured reports that can be generated.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

ListReportsRequest req = new ListReportsRequest() {};

ListReportsResponse? res = await sdk.Reports.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter Type Required Description
request ListReportsRequest ✔️ The request object to use for the request.

Response

ListReportsResponse

Errors

Error Type Status Code Content Type
Gr4vy.Models.Errors.Error400 400 application/json
Gr4vy.Models.Errors.Error401 401 application/json
Gr4vy.Models.Errors.Error403 403 application/json
Gr4vy.Models.Errors.Error404 404 application/json
Gr4vy.Models.Errors.Error405 405 application/json
Gr4vy.Models.Errors.Error409 409 application/json
Gr4vy.Models.Errors.HTTPValidationError 422 application/json
Gr4vy.Models.Errors.Error425 425 application/json
Gr4vy.Models.Errors.Error429 429 application/json
Gr4vy.Models.Errors.Error500 500 application/json
Gr4vy.Models.Errors.Error502 502 application/json
Gr4vy.Models.Errors.Error504 504 application/json
Gr4vy.Models.Errors.APIException 4XX, 5XX */*

Create

Create a new report.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.Reports.CreateAsync(reportCreate: new ReportCreate() {
    Name = "Monthly Transaction Report",
    Schedule = "<value>",
    ScheduleEnabled = true,
    ScheduleTimezone = "UTC",
    Spec = Spec.CreateDetailedSettlement(
        new DetailedSettlementReportSpec() {
            Params = new Dictionary<string, object>() {
                { "filters", new Dictionary<string, object>() {
                    { "ingested_at", new Dictionary<string, object>() {
                        { "end", "day_end" },
                        { "start", "day_start" },
                    } },
                } },
            },
        }
    ),
});

// handle response

Parameters

Parameter Type Required Description Example
ReportCreate ReportCreate ✔️ N/A
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

Report

Errors

Error Type Status Code Content Type
Gr4vy.Models.Errors.Error400 400 application/json
Gr4vy.Models.Errors.Error401 401 application/json
Gr4vy.Models.Errors.Error403 403 application/json
Gr4vy.Models.Errors.Error404 404 application/json
Gr4vy.Models.Errors.Error405 405 application/json
Gr4vy.Models.Errors.Error409 409 application/json
Gr4vy.Models.Errors.HTTPValidationError 422 application/json
Gr4vy.Models.Errors.Error425 425 application/json
Gr4vy.Models.Errors.Error429 429 application/json
Gr4vy.Models.Errors.Error500 500 application/json
Gr4vy.Models.Errors.Error502 502 application/json
Gr4vy.Models.Errors.Error504 504 application/json
Gr4vy.Models.Errors.APIException 4XX, 5XX */*

Get

Fetches a report by its ID.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.Reports.GetAsync(reportId: "4d4c7123-b794-4fad-b1b9-5ab2606e6bbe");

// handle response

Parameters

Parameter Type Required Description Example
ReportId string ✔️ The ID of the report to retrieve details for. 4d4c7123-b794-4fad-b1b9-5ab2606e6bbe
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

Report

Errors

Error Type Status Code Content Type
Gr4vy.Models.Errors.Error400 400 application/json
Gr4vy.Models.Errors.Error401 401 application/json
Gr4vy.Models.Errors.Error403 403 application/json
Gr4vy.Models.Errors.Error404 404 application/json
Gr4vy.Models.Errors.Error405 405 application/json
Gr4vy.Models.Errors.Error409 409 application/json
Gr4vy.Models.Errors.HTTPValidationError 422 application/json
Gr4vy.Models.Errors.Error425 425 application/json
Gr4vy.Models.Errors.Error429 429 application/json
Gr4vy.Models.Errors.Error500 500 application/json
Gr4vy.Models.Errors.Error502 502 application/json
Gr4vy.Models.Errors.Error504 504 application/json
Gr4vy.Models.Errors.APIException 4XX, 5XX */*

Put

Updates the configuration of a report.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.Reports.PutAsync(
    reportId: "4d4c7123-b794-4fad-b1b9-5ab2606e6bbe",
    reportUpdate: new ReportUpdate() {}
);

// handle response

Parameters

Parameter Type Required Description Example
ReportId string ✔️ The ID of the report to edit. 4d4c7123-b794-4fad-b1b9-5ab2606e6bbe
ReportUpdate ReportUpdate ✔️ N/A
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

Report

Errors

Error Type Status Code Content Type
Gr4vy.Models.Errors.Error400 400 application/json
Gr4vy.Models.Errors.Error401 401 application/json
Gr4vy.Models.Errors.Error403 403 application/json
Gr4vy.Models.Errors.Error404 404 application/json
Gr4vy.Models.Errors.Error405 405 application/json
Gr4vy.Models.Errors.Error409 409 application/json
Gr4vy.Models.Errors.HTTPValidationError 422 application/json
Gr4vy.Models.Errors.Error425 425 application/json
Gr4vy.Models.Errors.Error429 429 application/json
Gr4vy.Models.Errors.Error500 500 application/json
Gr4vy.Models.Errors.Error502 502 application/json
Gr4vy.Models.Errors.Error504 504 application/json
Gr4vy.Models.Errors.APIException 4XX, 5XX */*