diff --git a/generated-sources/api/src/apis/ConnectionApi.ts b/generated-sources/api/src/apis/ConnectionApi.ts index 91c1e809..5d97a2f2 100644 --- a/generated-sources/api/src/apis/ConnectionApi.ts +++ b/generated-sources/api/src/apis/ConnectionApi.ts @@ -115,7 +115,7 @@ export interface ConnectionApiInterface { deleteConnection(requestParameters: DeleteConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** - * 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] @@ -126,7 +126,7 @@ export interface ConnectionApiInterface { generateConnectionRaw(requestParameters: GenerateConnectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** - * 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; @@ -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} @@ -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> { @@ -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 { diff --git a/generated-sources/api/src/apis/InstallationApi.ts b/generated-sources/api/src/apis/InstallationApi.ts index 182b9b8e..639f22fd 100644 --- a/generated-sources/api/src/apis/InstallationApi.ts +++ b/generated-sources/api/src/apis/InstallationApi.ts @@ -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. @@ -103,7 +103,7 @@ export interface InstallationApiInterface { createInstallationRaw(requestParameters: CreateInstallationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** - * 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; @@ -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> { @@ -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 { diff --git a/generated-sources/api/src/apis/IntegrationApi.ts b/generated-sources/api/src/apis/IntegrationApi.ts index e437e5bd..f00f682e 100644 --- a/generated-sources/api/src/apis/IntegrationApi.ts +++ b/generated-sources/api/src/apis/IntegrationApi.ts @@ -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 @@ -79,7 +79,7 @@ export interface IntegrationApiInterface { batchUpsertIntegrationsRaw(requestParameters: BatchUpsertIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** - * 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>; @@ -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>> { @@ -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> { diff --git a/generated-sources/api/src/apis/OAuthApi.ts b/generated-sources/api/src/apis/OAuthApi.ts index 0ef6d814..7f9794bf 100644 --- a/generated-sources/api/src/apis/OAuthApi.ts +++ b/generated-sources/api/src/apis/OAuthApi.ts @@ -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. @@ -55,13 +55,13 @@ export interface OAuthApiInterface { oauthConnectRaw(requestParameters: OauthConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** - * 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; /** - * 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. @@ -72,7 +72,7 @@ export interface OAuthApiInterface { oauthUpdateRaw(requestParameters: OauthUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** - * 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; @@ -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> { @@ -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 { @@ -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> { @@ -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 { diff --git a/generated-sources/api/src/apis/RevisionApi.ts b/generated-sources/api/src/apis/RevisionApi.ts index 884ddc3f..7735b22f 100644 --- a/generated-sources/api/src/apis/RevisionApi.ts +++ b/generated-sources/api/src/apis/RevisionApi.ts @@ -53,7 +53,7 @@ export interface GetHydratedRevisionRequest { */ export interface RevisionApiInterface { /** - * We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. + * We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. * @summary Create a new revision. * @param {string} projectIdOrName The Ampersand project ID or project name. * @param {string} integrationId The integration ID. @@ -66,7 +66,7 @@ export interface RevisionApiInterface { createRevisionRaw(requestParameters: CreateRevisionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** - * We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. + * We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. * Create a new revision. */ createRevision(requestParameters: CreateRevisionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; @@ -98,7 +98,7 @@ export interface RevisionApiInterface { export class RevisionApi extends runtime.BaseAPI implements RevisionApiInterface { /** - * We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. + * We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. * Create a new revision. */ async createRevisionRaw(requestParameters: CreateRevisionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { @@ -148,7 +148,7 @@ export class RevisionApi extends runtime.BaseAPI implements RevisionApiInterface } /** - * We recommend using the [CLI\'s deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. + * We recommend using the [CLI\'s deploy command](https://docs.ampersand.ai/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. * Create a new revision. */ async createRevision(requestParameters: CreateRevisionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { diff --git a/generated-sources/api/src/models/OauthConnectRequest.ts b/generated-sources/api/src/models/OauthConnectRequest.ts index 3296880a..c645f84a 100644 --- a/generated-sources/api/src/models/OauthConnectRequest.ts +++ b/generated-sources/api/src/models/OauthConnectRequest.ts @@ -75,7 +75,7 @@ export interface OauthConnectRequest { */ providerMetadata?: { [key: string]: ProviderMetadataInfo; }; /** - * ID of the provider app, returned from the [Create Provider App endpoint](https://docs.withampersand.com/reference/provider-apps/create-provider-app). If omitted, the default provider app that was set up on the Ampersand Dashboard is assumed. + * ID of the provider app, returned from the [Create Provider App endpoint](https://docs.ampersand.ai/reference/provider-app/create-a-new-provider-app). If omitted, the default provider app that was set up on the Ampersand Dashboard is assumed. * @type {string} * @memberof OauthConnectRequest */