Schema3Other
Overview
Available Operations
- createIntentApiV1SandboxGithubOauthIntentsPost - Create Intent
- connectApiV1SandboxGithubOauthConnectionsPost - Connect
- getConnectionApiV1SandboxGithubOauthConnectionsGet - Get Connection
- disconnectApiV1SandboxGithubOauthConnectionsDelete - Disconnect
- listRepositoriesApiV1SandboxGithubRepositoriesGet - List Repositories
- refreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost - Refresh Repositories
- resolveReferenceApiV1SandboxGithubRepositoriesResolvePost - Resolve Reference
- readCloneApiV1SandboxSessionsSessionIdGithubReadClonePost - Read Clone
- manifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet - Manifest
- putRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut - Put Repository
- dismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete - Dismiss Repository
- listEnvironmentsApiV1SandboxEnvironmentsGet - List Environments
- createEnvironmentApiV1SandboxEnvironmentsPost - Create Environment
- getEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet - Get Environment
- updateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut - Update Environment
- deleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete - Delete Environment
- runEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost - Run Environment Setup
- pushApiV1SandboxSessionsSessionIdGithubPushPost - Push
- createOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost - Create Or Update
createIntentApiV1SandboxGithubOauthIntentsPost
Create Intent
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.createIntentApiV1SandboxGithubOauthIntentsPost({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherCreateIntentApiV1SandboxGithubOauthIntentsPost } from "@meetkai/mka1/funcs/schema3OtherCreateIntentApiV1SandboxGithubOauthIntentsPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherCreateIntentApiV1SandboxGithubOauthIntentsPost(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherCreateIntentApiV1SandboxGithubOauthIntentsPost 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.
useSchema3OtherCreateIntentApiV1SandboxGithubOauthIntentsPostMutation
} from "@meetkai/mka1/react-query/schema3OtherCreateIntentApiV1SandboxGithubOauthIntentsPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.CreateIntentApiV1SandboxGithubOauthIntentsPostRequest | ✔️ | 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<components.AuthorizeIntent>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
connectApiV1SandboxGithubOauthConnectionsPost
Connect
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.connectApiV1SandboxGithubOauthConnectionsPost({
connectRequest: {
code: "<value>",
state: "Wyoming",
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherConnectApiV1SandboxGithubOauthConnectionsPost } from "@meetkai/mka1/funcs/schema3OtherConnectApiV1SandboxGithubOauthConnectionsPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherConnectApiV1SandboxGithubOauthConnectionsPost(sdk, {
connectRequest: {
code: "<value>",
state: "Wyoming",
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherConnectApiV1SandboxGithubOauthConnectionsPost 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.
useSchema3OtherConnectApiV1SandboxGithubOauthConnectionsPostMutation
} from "@meetkai/mka1/react-query/schema3OtherConnectApiV1SandboxGithubOauthConnectionsPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ConnectApiV1SandboxGithubOauthConnectionsPostRequest | ✔️ | 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<components.Connection>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
getConnectionApiV1SandboxGithubOauthConnectionsGet
Get Connection
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.getConnectionApiV1SandboxGithubOauthConnectionsGet({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet } from "@meetkai/mka1/funcs/schema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet 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.
useSchema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet,
useSchema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGetSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchSchema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateSchema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet,
invalidateAllSchema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet,
} from "@meetkai/mka1/react-query/schema3OtherGetConnectionApiV1SandboxGithubOauthConnectionsGet.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetConnectionApiV1SandboxGithubOauthConnectionsGetRequest | ✔️ | 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<components.ConnectionEnvelope>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
disconnectApiV1SandboxGithubOauthConnectionsDelete
Disconnect
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
await sdk.schema3Other.disconnectApiV1SandboxGithubOauthConnectionsDelete({});
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherDisconnectApiV1SandboxGithubOauthConnectionsDelete } from "@meetkai/mka1/funcs/schema3OtherDisconnectApiV1SandboxGithubOauthConnectionsDelete.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherDisconnectApiV1SandboxGithubOauthConnectionsDelete(sdk, {});
if (res.ok) {
const { value: result } = res;
} else {
console.log("schema3OtherDisconnectApiV1SandboxGithubOauthConnectionsDelete 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.
useSchema3OtherDisconnectApiV1SandboxGithubOauthConnectionsDeleteMutation
} from "@meetkai/mka1/react-query/schema3OtherDisconnectApiV1SandboxGithubOauthConnectionsDelete.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.DisconnectApiV1SandboxGithubOauthConnectionsDeleteRequest | ✔️ | 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.APIError | 4XX, 5XX | */* |
listRepositoriesApiV1SandboxGithubRepositoriesGet
List Repositories
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.listRepositoriesApiV1SandboxGithubRepositoriesGet({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet } from "@meetkai/mka1/funcs/schema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet 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.
useSchema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet,
useSchema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGetSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchSchema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateSchema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet,
invalidateAllSchema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet,
} from "@meetkai/mka1/react-query/schema3OtherListRepositoriesApiV1SandboxGithubRepositoriesGet.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListRepositoriesApiV1SandboxGithubRepositoriesGetRequest | ✔️ | 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<components.RepositoryList>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
refreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost
Refresh Repositories
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.refreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherRefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost } from "@meetkai/mka1/funcs/schema3OtherRefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherRefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherRefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost 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.
useSchema3OtherRefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPostMutation
} from "@meetkai/mka1/react-query/schema3OtherRefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.RefreshRepositoriesApiV1SandboxGithubRepositoriesRefreshPostRequest | ✔️ | 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<components.RepositoryList>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
resolveReferenceApiV1SandboxGithubRepositoriesResolvePost
Resolve Reference
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.resolveReferenceApiV1SandboxGithubRepositoriesResolvePost({
resolveReferenceRequest: {
repositoryId: 716014,
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherResolveReferenceApiV1SandboxGithubRepositoriesResolvePost } from "@meetkai/mka1/funcs/schema3OtherResolveReferenceApiV1SandboxGithubRepositoriesResolvePost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherResolveReferenceApiV1SandboxGithubRepositoriesResolvePost(sdk, {
resolveReferenceRequest: {
repositoryId: 716014,
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherResolveReferenceApiV1SandboxGithubRepositoriesResolvePost 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.
useSchema3OtherResolveReferenceApiV1SandboxGithubRepositoriesResolvePostMutation
} from "@meetkai/mka1/react-query/schema3OtherResolveReferenceApiV1SandboxGithubRepositoriesResolvePost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ResolveReferenceApiV1SandboxGithubRepositoriesResolvePostRequest | ✔️ | 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<components.ResolvedReference>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
readCloneApiV1SandboxSessionsSessionIdGithubReadClonePost
Read Clone
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.readCloneApiV1SandboxSessionsSessionIdGithubReadClonePost({
sessionId: "<id>",
gitHubReadCloneRequest: {
assignmentGeneration: 416733,
repositoryId: 297335,
owner: "<value>",
repository: "<value>",
baseSha: "<value>",
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePost } from "@meetkai/mka1/funcs/schema3OtherReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePost(sdk, {
sessionId: "<id>",
gitHubReadCloneRequest: {
assignmentGeneration: 416733,
repositoryId: 297335,
owner: "<value>",
repository: "<value>",
baseSha: "<value>",
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePost 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.
useSchema3OtherReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePostMutation
} from "@meetkai/mka1/react-query/schema3OtherReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ReadCloneApiV1SandboxSessionsSessionIdGithubReadClonePostRequest | ✔️ | 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<components.GitHubReadCloneResult>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
manifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet
Manifest
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.manifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet({
sessionId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet } from "@meetkai/mka1/funcs/schema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet(sdk, {
sessionId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet 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.
useSchema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet,
useSchema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGetSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchSchema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateSchema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet,
invalidateAllSchema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet,
} from "@meetkai/mka1/react-query/schema3OtherManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGet.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ManifestApiV1SandboxSessionsSessionIdGithubRepositoriesGetRequest | ✔️ | 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<components.SessionRepositoryManifest>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
putRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut
Put Repository
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.putRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut({
sessionId: "<id>",
repositoryId: 299392,
putSessionRepositoryRequest: {
assignmentGeneration: 155720,
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import {
schema3OtherPutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut,
} from "@meetkai/mka1/funcs/schema3OtherPutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherPutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut(sdk, {
sessionId: "<id>",
repositoryId: 299392,
putSessionRepositoryRequest: {
assignmentGeneration: 155720,
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherPutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut 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.
useSchema3OtherPutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPutMutation
} from "@meetkai/mka1/react-query/schema3OtherPutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPut.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.PutRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdPutRequest | ✔️ | 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<components.SessionRepositoryModel>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
dismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete
Dismiss Repository
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
await sdk.schema3Other.dismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete({
sessionId: "<id>",
repositoryId: 324689,
dismissSessionRepositoryRequest: {
assignmentGeneration: 294447,
},
});
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import {
schema3OtherDismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete,
} from "@meetkai/mka1/funcs/schema3OtherDismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherDismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete(sdk, {
sessionId: "<id>",
repositoryId: 324689,
dismissSessionRepositoryRequest: {
assignmentGeneration: 294447,
},
});
if (res.ok) {
const { value: result } = res;
} else {
console.log("schema3OtherDismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete 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.
useSchema3OtherDismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDeleteMutation
} from "@meetkai/mka1/react-query/schema3OtherDismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDelete.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.DismissRepositoryApiV1SandboxSessionsSessionIdGithubRepositoriesRepositoryIdDeleteRequest | ✔️ | 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.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
listEnvironmentsApiV1SandboxEnvironmentsGet
List Environments
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.listEnvironmentsApiV1SandboxEnvironmentsGet({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet } from "@meetkai/mka1/funcs/schema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet 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.
useSchema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet,
useSchema3OtherListEnvironmentsApiV1SandboxEnvironmentsGetSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchSchema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateSchema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet,
invalidateAllSchema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet,
} from "@meetkai/mka1/react-query/schema3OtherListEnvironmentsApiV1SandboxEnvironmentsGet.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListEnvironmentsApiV1SandboxEnvironmentsGetRequest | ✔️ | 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<components.EnvironmentList>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
createEnvironmentApiV1SandboxEnvironmentsPost
Create Environment
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.createEnvironmentApiV1SandboxEnvironmentsPost({
saveEnvironmentRequest: {
name: "<value>",
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherCreateEnvironmentApiV1SandboxEnvironmentsPost } from "@meetkai/mka1/funcs/schema3OtherCreateEnvironmentApiV1SandboxEnvironmentsPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherCreateEnvironmentApiV1SandboxEnvironmentsPost(sdk, {
saveEnvironmentRequest: {
name: "<value>",
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherCreateEnvironmentApiV1SandboxEnvironmentsPost 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.
useSchema3OtherCreateEnvironmentApiV1SandboxEnvironmentsPostMutation
} from "@meetkai/mka1/react-query/schema3OtherCreateEnvironmentApiV1SandboxEnvironmentsPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.CreateEnvironmentApiV1SandboxEnvironmentsPostRequest | ✔️ | 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<components.EnvironmentModel>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
getEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet
Get Environment
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.getEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet({
environmentId: 870075,
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet } from "@meetkai/mka1/funcs/schema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet(sdk, {
environmentId: 870075,
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet 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.
useSchema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet,
useSchema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGetSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchSchema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateSchema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet,
invalidateAllSchema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet,
} from "@meetkai/mka1/react-query/schema3OtherGetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGet.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetEnvironmentApiV1SandboxEnvironmentsEnvironmentIdGetRequest | ✔️ | 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<components.EnvironmentModel>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
updateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut
Update Environment
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.updateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut({
environmentId: 594591,
saveEnvironmentRequest: {
name: "<value>",
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherUpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut } from "@meetkai/mka1/funcs/schema3OtherUpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherUpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut(sdk, {
environmentId: 594591,
saveEnvironmentRequest: {
name: "<value>",
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherUpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut 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.
useSchema3OtherUpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPutMutation
} from "@meetkai/mka1/react-query/schema3OtherUpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPut.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.UpdateEnvironmentApiV1SandboxEnvironmentsEnvironmentIdPutRequest | ✔️ | 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<components.EnvironmentModel>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
deleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete
Delete Environment
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
await sdk.schema3Other.deleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete({
environmentId: 458423,
});
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherDeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete } from "@meetkai/mka1/funcs/schema3OtherDeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherDeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete(sdk, {
environmentId: 458423,
});
if (res.ok) {
const { value: result } = res;
} else {
console.log("schema3OtherDeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete 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.
useSchema3OtherDeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDeleteMutation
} from "@meetkai/mka1/react-query/schema3OtherDeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDelete.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.DeleteEnvironmentApiV1SandboxEnvironmentsEnvironmentIdDeleteRequest | ✔️ | 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.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
runEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost
Run Environment Setup
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.runEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost({
sessionId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherRunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost } from "@meetkai/mka1/funcs/schema3OtherRunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherRunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost(sdk, {
sessionId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherRunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost 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.
useSchema3OtherRunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPostMutation
} from "@meetkai/mka1/react-query/schema3OtherRunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.RunEnvironmentSetupApiV1SandboxSessionsSessionIdEnvironmentSetupPostRequest | ✔️ | 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<components.EnvironmentSetupRunModel>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
pushApiV1SandboxSessionsSessionIdGithubPushPost
Push
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.pushApiV1SandboxSessionsSessionIdGithubPushPost({
sessionId: "<id>",
gitHubPushRequest: {
assignmentGeneration: 210842,
branch: "<value>",
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherPushApiV1SandboxSessionsSessionIdGithubPushPost } from "@meetkai/mka1/funcs/schema3OtherPushApiV1SandboxSessionsSessionIdGithubPushPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherPushApiV1SandboxSessionsSessionIdGithubPushPost(sdk, {
sessionId: "<id>",
gitHubPushRequest: {
assignmentGeneration: 210842,
branch: "<value>",
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherPushApiV1SandboxSessionsSessionIdGithubPushPost 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.
useSchema3OtherPushApiV1SandboxSessionsSessionIdGithubPushPostMutation
} from "@meetkai/mka1/react-query/schema3OtherPushApiV1SandboxSessionsSessionIdGithubPushPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.PushApiV1SandboxSessionsSessionIdGithubPushPostRequest | ✔️ | 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<components.GitHubPushResult>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
createOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost
Create Or Update
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.schema3Other.createOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost({
sessionId: "<id>",
gitHubPullRequestRequest: {
branch: "<value>",
title: "<value>",
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { schema3OtherCreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost } from "@meetkai/mka1/funcs/schema3OtherCreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await schema3OtherCreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost(sdk, {
sessionId: "<id>",
gitHubPullRequestRequest: {
branch: "<value>",
title: "<value>",
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("schema3OtherCreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost 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.
useSchema3OtherCreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPostMutation
} from "@meetkai/mka1/react-query/schema3OtherCreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPost.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.CreateOrUpdateApiV1SandboxSessionsSessionIdGithubPullRequestPostRequest | ✔️ | 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<components.GitHubPullRequestResult>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |