Skip to content

Latest commit

 

History

History

github

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 

README.md

Github

(github)

Available Operations

checkAccess

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.checkAccess({
    org: "<value>",
    repo: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.CheckAccessResponse>

Errors

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

configureCodeSamples

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.configureCodeSamples({
    org: "<value>",
    repo: "<value>",
    targetName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.ConfigureCodeSamplesResponse>

Errors

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

configureMintlifyRepo

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.configureMintlifyRepo({
    input: "<value>",
    org: "<value>",
    overlays: [
      "<value>",
    ],
    repo: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.ConfigureMintlifyRepoResponse>

Errors

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

configureTarget

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.configureTarget({
    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.ConfigureTargetResponse>

Errors

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

fetchPublishingPRs

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.fetchPublishingPRs({
    generateGenLockId: "<value>",
    org: "<value>",
    repo: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.FetchPublishingPRsResponse>

Errors

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

githubCheckPublishingSecrets

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.githubCheckPublishingSecrets({
    generateGenLockId: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GithubCheckPublishingSecretsResponse>

Errors

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

githubStorePublishingSecrets

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.githubStorePublishingSecrets({
    generateGenLockId: "<value>",
    secrets: {
      "key": "<value>",
    },
  });

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

run();

Parameters

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

Response

Promise<operations.GithubStorePublishingSecretsResponse>

Errors

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

triggerAction

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.triggerAction({
    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.TriggerActionResponse>

Errors

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