github

Github

(github)

Available Operations

• githubCheckAccess
• githubConfigureTarget
• githubTriggerAction

githubCheckAccess

Example Usage

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

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

  const res = await sdk.github.githubCheckAccess({
    org: "<value>",
    repo: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GithubCheckAccessResponse>

Errors

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

githubConfigureTarget

Example Usage

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

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

  const res = await sdk.github.githubConfigureTarget({
    org: "<value>",
    repoName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GithubConfigureTargetResponse>

Errors

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

githubTriggerAction

Example Usage

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

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

  const res = await sdk.github.githubTriggerAction({
    genLockId: "<value>",
    org: "<value>",
    repoName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GithubTriggerActionResponse>

Errors

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