Reports

(reports)

Overview

REST APIs for managing reports

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

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

async function run() {
  const sdk = new Speakeasy({
    security: {
      apiKey: "<YOUR_API_KEY_HERE>",
    },
    workspaceID: "<value>",
  });

  const res = await sdk.reports.getChangesReportSignedUrl({
    documentChecksum: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetChangesReportSignedUrlRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.GetChangesReportSignedUrlResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

getLintingReportSignedUrl

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

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

async function run() {
  const sdk = new Speakeasy({
    security: {
      apiKey: "<YOUR_API_KEY_HERE>",
    },
    workspaceID: "<value>",
  });

  const res = await sdk.reports.getLintingReportSignedUrl({
    documentChecksum: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetLintingReportSignedUrlRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.GetLintingReportSignedUrlResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

uploadReport

Upload a report.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { TypeT } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";

async function run() {
  const sdk = new Speakeasy({
    security: {
      apiKey: "<YOUR_API_KEY_HERE>",
    },
    workspaceID: "<value>",
  });

  const res = await sdk.reports.uploadReport({
    data: {},
    file: {
      content: new TextEncoder().encode("0xA329C0ad85"),
      fileName: "sausages.m3a",
    },
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.UploadReportRequestBody	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.UploadReportResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/