Skip to content

README.md

Latest commit

 

History

History
1125 lines (835 loc) · 71.5 KB

README.md

File metadata and controls

1125 lines (835 loc) · 71.5 KB

Github

Overview

REST APIs for managing the github integration

Available Operations

checkAccess

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.github.checkAccess({
    org: "<value>",
    repo: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubCheckAccess } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubCheckAccess.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubCheckAccess(speakeasy, {
    org: "<value>",
    repo: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("githubCheckAccess failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Query hooks for fetching data.
  useGithubCheckAccess,
  useGithubCheckAccessSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchGithubCheckAccess,
  
  // Utilities to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateGithubCheckAccess,
  invalidateAllGithubCheckAccess,
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubCheckAccess.js";

Parameters

Parameter Type Required Description
request operations.CheckGithubAccessRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

checkPublishingPRs

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.github.checkPublishingPRs({
    generateGenLockId: "<id>",
    org: "<value>",
    repo: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubCheckPublishingPRs } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubCheckPublishingPRs.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubCheckPublishingPRs(speakeasy, {
    generateGenLockId: "<id>",
    org: "<value>",
    repo: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("githubCheckPublishingPRs failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Query hooks for fetching data.
  useGithubCheckPublishingPRs,
  useGithubCheckPublishingPRsSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchGithubCheckPublishingPRs,
  
  // Utilities to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateGithubCheckPublishingPRs,
  invalidateAllGithubCheckPublishingPRs,
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubCheckPublishingPRs.js";

Parameters

Parameter Type Required Description
request operations.GithubCheckPublishingPRsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<shared.GithubPublishingPRResponse>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

checkPublishingSecrets

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.github.checkPublishingSecrets({
    generateGenLockId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubCheckPublishingSecrets } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubCheckPublishingSecrets.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubCheckPublishingSecrets(speakeasy, {
    generateGenLockId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("githubCheckPublishingSecrets failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Query hooks for fetching data.
  useGithubCheckPublishingSecrets,
  useGithubCheckPublishingSecretsSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchGithubCheckPublishingSecrets,
  
  // Utilities to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateGithubCheckPublishingSecrets,
  invalidateAllGithubCheckPublishingSecrets,
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubCheckPublishingSecrets.js";

Parameters

Parameter Type Required Description
request operations.GithubCheckPublishingSecretsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<shared.GithubMissingPublishingSecretsResponse>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

configureCodeSamples

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.github.configureCodeSamples({
    org: "<value>",
    repo: "<value>",
    targetName: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubConfigureCodeSamples } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubConfigureCodeSamples.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubConfigureCodeSamples(speakeasy, {
    org: "<value>",
    repo: "<value>",
    targetName: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("githubConfigureCodeSamples failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useGithubConfigureCodeSamplesMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubConfigureCodeSamples.js";

Parameters

Parameter Type Required Description
request shared.GithubConfigureCodeSamplesRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<shared.GithubConfigureCodeSamplesResponse>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

configureMintlifyRepo

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.github.configureMintlifyRepo({
    input: "<value>",
    org: "<value>",
    overlays: [
      "<value 1>",
    ],
    repo: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubConfigureMintlifyRepo } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubConfigureMintlifyRepo.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubConfigureMintlifyRepo(speakeasy, {
    input: "<value>",
    org: "<value>",
    overlays: [
      "<value 1>",
    ],
    repo: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("githubConfigureMintlifyRepo failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useGithubConfigureMintlifyRepoMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubConfigureMintlifyRepo.js";

Parameters

Parameter Type Required Description
request shared.GithubConfigureMintlifyRepoRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

configureTarget

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.github.configureTarget({
    org: "<value>",
    repoName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubConfigureTarget } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubConfigureTarget.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubConfigureTarget(speakeasy, {
    org: "<value>",
    repoName: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("githubConfigureTarget failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useGithubConfigureTargetMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubConfigureTarget.js";

Parameters

Parameter Type Required Description
request shared.GithubConfigureTargetRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

getAction

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.github.getAction({
    org: "<value>",
    repo: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubGetAction } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubGetAction.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubGetAction(speakeasy, {
    org: "<value>",
    repo: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("githubGetAction failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Query hooks for fetching data.
  useGithubGetAction,
  useGithubGetActionSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchGithubGetAction,
  
  // Utilities to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateGithubGetAction,
  invalidateAllGithubGetAction,
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubGetAction.js";

Parameters

Parameter Type Required Description
request operations.GetGitHubActionRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<shared.GithubGetActionResponse>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

getSetup

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.github.getSetup({
    org: "<value>",
    repo: "<value>",
    generateGenLockId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubGetSetup } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubGetSetup.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubGetSetup(speakeasy, {
    org: "<value>",
    repo: "<value>",
    generateGenLockId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("githubGetSetup failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Query hooks for fetching data.
  useGithubGetSetup,
  useGithubGetSetupSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchGithubGetSetup,
  
  // Utilities to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateGithubGetSetup,
  invalidateAllGithubGetSetup,
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubGetSetup.js";

Parameters

Parameter Type Required Description
request operations.GetGithubSetupStateRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<shared.GithubSetupStateResponse>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

linkGithub

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.github.linkGithub({});


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubLinkGithub } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubLinkGithub.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubLinkGithub(speakeasy, {});
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("githubLinkGithub failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useGithubLinkGithubMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubLinkGithub.js";

Parameters

Parameter Type Required Description
request operations.LinkGithubAccessRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

storePublishingSecrets

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.github.storePublishingSecrets({
    generateGenLockId: "<id>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubStorePublishingSecrets } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubStorePublishingSecrets.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubStorePublishingSecrets(speakeasy, {
    generateGenLockId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("githubStorePublishingSecrets failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useGithubStorePublishingSecretsMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubStorePublishingSecrets.js";

Parameters

Parameter Type Required Description
request shared.GithubStorePublishingSecretsRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*

triggerAction

Example Usage

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

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.github.triggerAction({
    genLockId: "<id>",
    org: "<value>",
    repoName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { githubTriggerAction } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/githubTriggerAction.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await githubTriggerAction(speakeasy, {
    genLockId: "<id>",
    org: "<value>",
    repoName: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("githubTriggerAction failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useGithubTriggerActionMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/githubTriggerAction.js";

Parameters

Parameter Type Required Description
request shared.GithubTriggerActionRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ErrorT 4XX application/json
errors.SDKError 5XX */*