Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions generated-sources/api/src/apis/ConnectionApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export interface ConnectionApiInterface {
deleteConnection(requestParameters: DeleteConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;

/**
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/get-url-for-oauth-flow) instead, unless you already have the refresh token and are importing it into Ampersand.
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead, unless you already have the refresh token and are importing it into Ampersand.
* @summary Generate a new connection
* @param {string} projectIdOrName The Ampersand project ID or project name.
* @param {GenerateConnectionRequest} [generateConnectionParams]
Expand All @@ -126,7 +126,7 @@ export interface ConnectionApiInterface {
generateConnectionRaw(requestParameters: GenerateConnectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Connection>>;

/**
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/get-url-for-oauth-flow) instead, unless you already have the refresh token and are importing it into Ampersand.
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead, unless you already have the refresh token and are importing it into Ampersand.
* Generate a new connection
*/
generateConnection(requestParameters: GenerateConnectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Connection>;
Expand Down Expand Up @@ -172,7 +172,7 @@ export interface ConnectionApiInterface {
* Rotate credentials or update metadata (such as the provider workspace reference) for an existing connection.
* @summary Update a connection.
* @param {string} projectIdOrName The Ampersand project ID or project name.
* @param {string} connectionId The ID of the connection to update. You can find this via the [list connections endpoint](https://docs.withampersand.com/reference/connection/list-connections).
* @param {string} connectionId The ID of the connection to update. You can find this via the [list connections endpoint](https://docs.ampersand.ai/reference/connection/list-connections).
* @param {UpdateConnectionRequest} updateConnectionRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
Expand Down Expand Up @@ -286,7 +286,7 @@ export class ConnectionApi extends runtime.BaseAPI implements ConnectionApiInter
}

/**
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/get-url-for-oauth-flow) instead, unless you already have the refresh token and are importing it into Ampersand.
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead, unless you already have the refresh token and are importing it into Ampersand.
* Generate a new connection
*/
async generateConnectionRaw(requestParameters: GenerateConnectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Connection>> {
Expand Down Expand Up @@ -324,7 +324,7 @@ export class ConnectionApi extends runtime.BaseAPI implements ConnectionApiInter
}

/**
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/get-url-for-oauth-flow) instead, unless you already have the refresh token and are importing it into Ampersand.
* All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead, unless you already have the refresh token and are importing it into Ampersand.
* Generate a new connection
*/
async generateConnection(requestParameters: GenerateConnectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Connection> {
Expand Down
8 changes: 4 additions & 4 deletions generated-sources/api/src/apis/InstallationApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export interface UpdateInstallationOperationRequest {
*/
export interface InstallationApiInterface {
/**
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* @summary Create a new installation
* @param {string} projectIdOrName The Ampersand project ID or project name.
* @param {string} integrationId The integration ID.
Expand All @@ -103,7 +103,7 @@ export interface InstallationApiInterface {
createInstallationRaw(requestParameters: CreateInstallationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Installation>>;

/**
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* Create a new installation
*/
createInstallation(requestParameters: CreateInstallationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Installation>;
Expand Down Expand Up @@ -226,7 +226,7 @@ export interface InstallationApiInterface {
export class InstallationApi extends runtime.BaseAPI implements InstallationApiInterface {

/**
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* Create a new installation
*/
async createInstallationRaw(requestParameters: CreateInstallationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Installation>> {
Expand Down Expand Up @@ -276,7 +276,7 @@ export class InstallationApi extends runtime.BaseAPI implements InstallationApiI
}

/**
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group\'s default. To create a connection, use the [OAuth Connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) or the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* Create a new installation
*/
async createInstallation(requestParameters: CreateInstallationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Installation> {
Expand Down
8 changes: 4 additions & 4 deletions generated-sources/api/src/apis/IntegrationApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export interface ListIntegrationsRequest {
*/
export interface IntegrationApiInterface {
/**
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly.
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly.
* @summary Batch upsert a group of integrations
* @param {string} projectIdOrName The Ampersand project ID or project name.
* @param {BatchUpsertIntegrationsRequest} batchUpsertIntegrationsRequest
Expand All @@ -79,7 +79,7 @@ export interface IntegrationApiInterface {
batchUpsertIntegrationsRaw(requestParameters: BatchUpsertIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Integration>>>;

/**
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly.
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly.
* Batch upsert a group of integrations
*/
batchUpsertIntegrations(requestParameters: BatchUpsertIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Integration>>;
Expand Down Expand Up @@ -156,7 +156,7 @@ export interface IntegrationApiInterface {
export class IntegrationApi extends runtime.BaseAPI implements IntegrationApiInterface {

/**
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly.
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly.
* Batch upsert a group of integrations
*/
async batchUpsertIntegrationsRaw(requestParameters: BatchUpsertIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Integration>>> {
Expand Down Expand Up @@ -202,7 +202,7 @@ export class IntegrationApi extends runtime.BaseAPI implements IntegrationApiInt
}

/**
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly.
* This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly.
* Batch upsert a group of integrations
*/
async batchUpsertIntegrations(requestParameters: BatchUpsertIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Integration>> {
Expand Down
16 changes: 8 additions & 8 deletions generated-sources/api/src/apis/OAuthApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export interface OauthUpdateRequest {
*/
export interface OAuthApiInterface {
/**
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* @summary Generate OAuth authorization URL
* @param {OauthConnectRequest} connectOAuthParams
* @param {*} [options] Override http request option.
Expand All @@ -55,13 +55,13 @@ export interface OAuthApiInterface {
oauthConnectRaw(requestParameters: OauthConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;

/**
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* Generate OAuth authorization URL
*/
oauthConnect(requestParameters: OauthConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;

/**
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) instead.
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead.
* @summary Generate OAuth authorization URL for existing connection
* @param {string} projectIdOrName Ampersand project ID or name.
* @param {string} connectionId The ID of the connection to update.
Expand All @@ -72,7 +72,7 @@ export interface OAuthApiInterface {
oauthUpdateRaw(requestParameters: OauthUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;

/**
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) instead.
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead.
* Generate OAuth authorization URL for existing connection
*/
oauthUpdate(requestParameters: OauthUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
Expand All @@ -85,7 +85,7 @@ export interface OAuthApiInterface {
export class OAuthApi extends runtime.BaseAPI implements OAuthApiInterface {

/**
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* Generate OAuth authorization URL
*/
async oauthConnectRaw(requestParameters: OauthConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
Expand Down Expand Up @@ -127,7 +127,7 @@ export class OAuthApi extends runtime.BaseAPI implements OAuthApiInterface {
}

/**
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components).
* Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.ampersand.ai/embeddable-ui-components).
* Generate OAuth authorization URL
*/
async oauthConnect(requestParameters: OauthConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
Expand All @@ -136,7 +136,7 @@ export class OAuthApi extends runtime.BaseAPI implements OAuthApiInterface {
}

/**
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) instead.
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead.
* Generate OAuth authorization URL for existing connection
*/
async oauthUpdateRaw(requestParameters: OauthUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
Expand Down Expand Up @@ -179,7 +179,7 @@ export class OAuthApi extends runtime.BaseAPI implements OAuthApiInterface {
}

/**
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url) instead.
* Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection\'s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url) instead.
* Generate OAuth authorization URL for existing connection
*/
async oauthUpdate(requestParameters: OauthUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
Expand Down
Loading
Loading