README.md

Reports

Overview

REST APIs for managing reports (lint reports, change reports, etc)

Available Operations

• GetChangesReportSignedUrl - Get the signed access url for the change reports for a particular document.
• GetLintingReportSignedUrl - Get the signed access url for the linting reports for a particular document.
• UploadReport - Upload a report.

GetChangesReportSignedUrl

Get the signed access url for the change reports for a particular document.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GetChangesReportSignedUrlRequest req = new GetChangesReportSignedUrlRequest() {
    DocumentChecksum = "<value>",
};

var res = await sdk.Reports.GetChangesReportSignedUrlAsync(req);

// handle response

Parameters

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

Response

GetChangesReportSignedUrlResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetLintingReportSignedUrl

Get the signed access url for the linting reports for a particular document.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GetLintingReportSignedUrlRequest req = new GetLintingReportSignedUrlRequest() {
    DocumentChecksum = "<value>",
};

var res = await sdk.Reports.GetLintingReportSignedUrlAsync(req);

// handle response

Parameters

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

Response

GetLintingReportSignedUrlResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*

UploadReport

Upload a report.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

UploadReportRequestBody req = new UploadReportRequestBody() {
    Data = new Report() {},
    File = new SpeakeasySDK.Models.Operations.File() {
        Content = System.IO.File.ReadAllBytes("example.file"),
        FileName = "example.file",
    },
};

var res = await sdk.Reports.UploadReportAsync(req);

// handle response

Parameters

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

Response

UploadReportResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*