@tembo-io/sdk 0.10.0 → 0.11.0

package/dist/cjs/resources/integrations/integrations.d.ts

@@ -0,0 +1,777 @@
+import { APIResource } from '../../resource';
+import { APIPromise } from '../../api-promise';
+import type { RequestOptions } from '../../internal/request-options';
+import * as ProvidersAPI from './providers';
+import { Providers, type ProviderListResponse, type ProviderDiscoverSnykOrganizationsResponse, type ProviderListParams, type ProviderDiscoverSnykOrganizationsParams } from './providers';
+import * as TriggersAPI from './triggers';
+import { Triggers, type TriggerListResponse, type TriggerRetrieveResponse, type TriggerListFilterOptionsResponse, type TriggerListParams, type TriggerRetrieveParams, type TriggerListFilterOptionsParams } from './triggers';
+export declare class Integrations extends APIResource {
+    providers: ProvidersAPI.Providers;
+    triggers: TriggersAPI.Triggers;
+    /**
+     * List integrations visible to the current organization or authenticated admin.
+     *
+     * @param {IntegrationListParams} [query] - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationListResponse>} List integrations
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.list({
+     *   limit: 50,
+     *   includeTotal: false,
+     * });
+     * ```
+     */
+    list(query?: IntegrationListParams | null | undefined, options?: RequestOptions): APIPromise<IntegrationListResponse>;
+    /**
+     * Create an integration that does not require an OAuth callback.
+     *
+     * @param {IntegrationCreateParams} body - The request body to send.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationCreateResponse>} Create an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.create({
+     *   environment: 'x',
+     *   roleArn: 'x',
+     *   type: 'aws',
+     * });
+     * ```
+     */
+    create(body: IntegrationCreateParams, options?: RequestOptions): APIPromise<IntegrationCreateResponse>;
+    /**
+     * Retrieve an integration and its configuration.
+     *
+     * @param {string} integrationID
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationRetrieveResponse>} Retrieve an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.retrieve('7c9e6679-7425-40de-944b-e07fc1f90ae7');
+     * ```
+     */
+    retrieve(integrationID: string, options?: RequestOptions): APIPromise<IntegrationRetrieveResponse>;
+    /**
+     * Update provider settings or an editable configuration.
+     *
+     * @param {string} integrationID
+     * @param {IntegrationUpdateParams} body - The request body to send.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationUpdateResponse>} Update an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.update('7c9e6679-7425-40de-944b-e07fc1f90ae7', {
+     *   settings: {},
+     * });
+     * ```
+     */
+    update(integrationID: string, body: IntegrationUpdateParams, options?: RequestOptions): APIPromise<IntegrationUpdateResponse>;
+    /**
+     * Uninstall an integration from its provider when supported, then delete it from Tembo.
+     *
+     * @param {string} integrationID
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationDeleteResponse>} Delete an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.delete('7c9e6679-7425-40de-944b-e07fc1f90ae7');
+     * ```
+     */
+    delete(integrationID: string, options?: RequestOptions): APIPromise<IntegrationDeleteResponse>;
+    /**
+     * Return the provider authorization URL for an integration.
+     *
+     * @param {string} integrationID
+     * @param {IntegrationAuthorizeParams} [params] - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationAuthorizeResponse>} Authorize an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.authorize('7c9e6679-7425-40de-944b-e07fc1f90ae7');
+     * ```
+     */
+    authorize(integrationID: string, params?: IntegrationAuthorizeParams | null | undefined, options?: RequestOptions): APIPromise<IntegrationAuthorizeResponse>;
+    /**
+     * Test the saved provider connection.
+     *
+     * @param {string} integrationID
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationTestResponse>} Test an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.test('7c9e6679-7425-40de-944b-e07fc1f90ae7');
+     * ```
+     */
+    test(integrationID: string, options?: RequestOptions): APIPromise<IntegrationTestResponse>;
+    /**
+     * Queue or immediately perform an integration sync.
+     *
+     * @param {string} integrationID
+     * @param {IntegrationSyncParams} body - The request body to send.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationSyncResponse>} Sync an integration
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.sync('7c9e6679-7425-40de-944b-e07fc1f90ae7', {
+     *   mode: 'queued',
+     * });
+     * ```
+     */
+    sync(integrationID: string, body: IntegrationSyncParams, options?: RequestOptions): APIPromise<IntegrationSyncResponse>;
+    /**
+     * Queue integration and pull-request sync jobs for integrations with enabled repositories.
+     *
+     * @param {IntegrationSyncAllParams} body - The request body to send.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationSyncAllResponse>} Sync eligible integrations
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.syncAll({});
+     * ```
+     */
+    syncAll(body: IntegrationSyncAllParams, options?: RequestOptions): APIPromise<IntegrationSyncAllResponse>;
+    /**
+     * Count active sync jobs for integrations with enabled repositories.
+     *
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationRetrieveSyncStatusResponse>} Retrieve eligible integration sync status
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.retrieveSyncStatus();
+     * ```
+     */
+    retrieveSyncStatus(options?: RequestOptions): APIPromise<IntegrationRetrieveSyncStatusResponse>;
+    /**
+     * Retrieve the GitHub installation rate-limit state.
+     *
+     * @param {string} integrationID
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationRetrieveRateLimitResponse>} Retrieve an integration rate limit
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.retrieveRateLimit('7c9e6679-7425-40de-944b-e07fc1f90ae7');
+     * ```
+     */
+    retrieveRateLimit(integrationID: string, options?: RequestOptions): APIPromise<IntegrationRetrieveRateLimitResponse>;
+    /**
+     * List environments visible to a Sentry integration.
+     *
+     * @param {string} integrationID
+     * @param {IntegrationListSentryEnvironmentsParams} [query] - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationListSentryEnvironmentsResponse>} List Sentry environments
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.listSentryEnvironments('7c9e6679-7425-40de-944b-e07fc1f90ae7', {
+     *   limit: 50,
+     * });
+     * ```
+     */
+    listSentryEnvironments(integrationID: string, query?: IntegrationListSentryEnvironmentsParams | null | undefined, options?: RequestOptions): APIPromise<IntegrationListSentryEnvironmentsResponse>;
+    /**
+     * List channels visible to a Slack integration.
+     *
+     * @param {string} integrationID
+     * @param {IntegrationListSlackChannelsParams} [query] - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<IntegrationListSlackChannelsResponse>} List Slack channels
+     *
+     * @example
+     * ```ts
+     * const integration = await client.integrations.listSlackChannels('7c9e6679-7425-40de-944b-e07fc1f90ae7', {
+     *   limit: 50,
+     * });
+     * ```
+     */
+    listSlackChannels(integrationID: string, query?: IntegrationListSlackChannelsParams | null | undefined, options?: RequestOptions): APIPromise<IntegrationListSlackChannelsResponse>;
+}
+export interface IntegrationListParams {
+    /**
+     * @format uuid
+     */
+    cursor?: string;
+    /**
+     * @default 50
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    enabled?: boolean;
+    hasEnabledRepositories?: boolean;
+    /**
+     * @minItems 1
+     * @maxItems 100
+     */
+    ids?: Array<string>;
+    /**
+     * @minLength 1
+     * @maxLength 200
+     */
+    search?: string;
+    /**
+     * @minItems 1
+     * @maxItems 18
+     */
+    type?: Array<string>;
+    /**
+     * @format date-time
+     */
+    createdAfter?: string;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    excludeOrganizationName?: string;
+    /**
+     * @default false
+     */
+    includeTotal?: boolean;
+}
+export interface IntegrationListResponse {
+    items: Array<IntegrationListResponse.Item>;
+    /**
+     * @format uuid
+     */
+    nextCursor: string | null;
+    /**
+     * @minimum 0
+     */
+    totalCount?: number;
+}
+export declare namespace IntegrationListResponse {
+    interface Item {
+        /**
+         * @format date-time
+         */
+        createdAt: string;
+        displayName: string;
+        /**
+         * @format date-time
+         */
+        enabledAt: string | null;
+        id: string;
+        /**
+         * @format date-time
+         */
+        lastSyncedAt: string | null;
+        /**
+         * @minimum 0
+         */
+        repositoryCount: number;
+        /**
+         * @minimum 0
+         */
+        sourceCount: number;
+        /**
+         * @minLength 1
+         * @maxLength 100
+         */
+        type: string;
+        /**
+         * @format date-time
+         */
+        updatedAt: string;
+    }
+}
+export type IntegrationCreateParams = IntegrationCreateParams.Variant0 | IntegrationCreateParams.Variant1 | IntegrationCreateParams.Variant2 | IntegrationCreateParams.Variant3 | IntegrationCreateParams.Variant4 | IntegrationCreateParams.Variant5 | IntegrationCreateParams.Variant6;
+export declare namespace IntegrationCreateParams {
+    interface Variant0 {
+        /**
+         * @minLength 1
+         * @maxLength 200
+         */
+        environment: string;
+        /**
+         * @minLength 1
+         * @maxLength 2048
+         */
+        roleArn: string;
+        type: 'aws';
+    }
+    interface Variant1 {
+        /**
+         * @pattern ^[a-z][a-z0-9-]{4,28}[a-z0-9]$
+         */
+        projectId: string;
+        /**
+         * @minLength 1
+         * @maxLength 1000000
+         */
+        serviceAccountJson: string;
+        type: 'bigquery';
+    }
+    interface Variant2 {
+        /**
+         * @minLength 1
+         * @maxLength 65536
+         */
+        accessToken: string;
+        type: 'gitlab';
+    }
+    interface Variant3 {
+        /**
+         * @minLength 1
+         * @maxLength 2048
+         */
+        gateway: string;
+        /**
+         * @minLength 1
+         * @maxLength 200
+         */
+        instanceName: string;
+        /**
+         * @minLength 1
+         * @maxLength 65536
+         */
+        password: string;
+        protocol: 'fortinet' | 'anyconnect' | 'gp' | 'nc';
+        type: 'openconnect';
+        /**
+         * @minLength 1
+         * @maxLength 4096
+         */
+        username: string;
+    }
+    interface Variant4 {
+        /**
+         * @minLength 1
+         * @maxLength 16384
+         */
+        connectionString: string;
+        /**
+         * @minLength 1
+         * @maxLength 200
+         */
+        instanceName: string;
+        type: 'postgres';
+        /**
+         * @maxLength 1000000
+         */
+        caCertificate?: string;
+    }
+    interface Variant5 {
+        /**
+         * @minLength 1
+         * @maxLength 16384
+         */
+        clientId: string;
+        /**
+         * @minLength 1
+         * @maxLength 65536
+         */
+        clientSecret: string;
+        /**
+         * @format uuid
+         */
+        organizationId: string;
+        type: 'snyk';
+        /**
+         * @minLength 1
+         * @maxLength 500
+         */
+        organizationName?: string;
+    }
+    interface Variant6 {
+        /**
+         * @minLength 1
+         * @maxLength 200
+         */
+        instanceName: string;
+        /**
+         * @minLength 1
+         * @maxLength 16384
+         */
+        oauthClientId: string;
+        /**
+         * @minLength 1
+         * @maxLength 65536
+         */
+        oauthClientSecret: string;
+        /**
+         * @minItems 1
+         * @maxItems 100
+         */
+        tags: Array<string>;
+        type: 'tailscale';
+        /**
+         * @default -
+         * @minLength 1
+         * @maxLength 500
+         */
+        tailnet?: string;
+    }
+}
+export interface IntegrationCreateResponse {
+    integration: IntegrationCreateResponse.Integration;
+    /**
+     * @format uuid
+     */
+    sessionSourceId: string | null;
+}
+export declare namespace IntegrationCreateResponse {
+    interface Integration {
+        /**
+         * @format date-time
+         */
+        createdAt: string;
+        displayName: string;
+        /**
+         * @format date-time
+         */
+        enabledAt: string | null;
+        id: string;
+        /**
+         * @format date-time
+         */
+        lastSyncedAt: string | null;
+        /**
+         * @minimum 0
+         */
+        repositoryCount: number;
+        /**
+         * @minimum 0
+         */
+        sourceCount: number;
+        /**
+         * @minLength 1
+         * @maxLength 100
+         */
+        type: string;
+        /**
+         * @format date-time
+         */
+        updatedAt: string;
+    }
+}
+export interface IntegrationRetrieveResponse {
+    /**
+     * @format date-time
+     */
+    createdAt: string;
+    displayName: string;
+    /**
+     * @format date-time
+     */
+    enabledAt: string | null;
+    id: string;
+    /**
+     * @format date-time
+     */
+    lastSyncedAt: string | null;
+    /**
+     * @minimum 0
+     */
+    repositoryCount: number;
+    /**
+     * @minimum 0
+     */
+    sourceCount: number;
+    /**
+     * @minLength 1
+     * @maxLength 100
+     */
+    type: string;
+    /**
+     * @format date-time
+     */
+    updatedAt: string;
+}
+export type IntegrationUpdateParams = IntegrationUpdateParams.Settings | IntegrationUpdateParams.Aws | IntegrationUpdateParams.Postgres | IntegrationUpdateParams.AtlassianServiceAccount;
+export declare namespace IntegrationUpdateParams {
+    interface Settings {
+        settings: Settings.Settings;
+    }
+    namespace Settings {
+        interface Settings {
+            /**
+             * @format uuid
+             */
+            defaultRepositoryId?: string | null;
+            /**
+             * @maxItems 1000
+             */
+            disallowedSlackChannelIds?: Array<string>;
+            instantSolve?: boolean;
+            /**
+             * @maxItems 1000
+             */
+            sentryEnvironments?: Array<string>;
+        }
+    }
+    interface Aws {
+        aws: Aws.Aws;
+    }
+    namespace Aws {
+        interface Aws {
+            /**
+             * @minLength 1
+             * @maxLength 200
+             */
+            environment: string;
+            /**
+             * @minLength 1
+             * @maxLength 2048
+             */
+            roleArn: string;
+        }
+    }
+    interface Postgres {
+        postgres: Postgres.Postgres;
+    }
+    namespace Postgres {
+        interface Postgres {
+            /**
+             * @minLength 1
+             * @maxLength 16384
+             */
+            connectionString: string;
+            /**
+             * @minLength 1
+             * @maxLength 200
+             */
+            instanceName: string;
+            /**
+             * @maxLength 1000000
+             */
+            caCertificate?: string;
+        }
+    }
+    interface AtlassianServiceAccount {
+        atlassianServiceAccount: AtlassianServiceAccount.AtlassianServiceAccount | null;
+    }
+    namespace AtlassianServiceAccount {
+        interface AtlassianServiceAccount {
+            /**
+             * @minLength 1
+             * @maxLength 4096
+             */
+            clientId: string;
+            /**
+             * @minLength 1
+             * @maxLength 65536
+             */
+            clientSecret: string;
+        }
+    }
+}
+export interface IntegrationUpdateResponse {
+    /**
+     * @format date-time
+     */
+    createdAt: string;
+    displayName: string;
+    /**
+     * @format date-time
+     */
+    enabledAt: string | null;
+    id: string;
+    /**
+     * @format date-time
+     */
+    lastSyncedAt: string | null;
+    /**
+     * @minimum 0
+     */
+    repositoryCount: number;
+    /**
+     * @minimum 0
+     */
+    sourceCount: number;
+    /**
+     * @minLength 1
+     * @maxLength 100
+     */
+    type: string;
+    /**
+     * @format date-time
+     */
+    updatedAt: string;
+}
+export interface IntegrationDeleteResponse {
+    /**
+     * @format uuid
+     */
+    id: string;
+    deleted: true;
+}
+export interface IntegrationAuthorizeParams {
+    /**
+     * @format uri
+     * @maxLength 8192
+     */
+    returnUrl?: string;
+    capability?: 'confluenceTriggers';
+}
+export interface IntegrationAuthorizeResponse {
+    /**
+     * @format uri
+     */
+    authorizationUrl: string;
+}
+export interface IntegrationTestResponse {
+    healthy: boolean;
+    message: string;
+}
+export interface IntegrationSyncParams {
+    /**
+     * @default queued
+     */
+    mode?: 'immediate' | 'queued';
+}
+export interface IntegrationSyncResponse {
+    /**
+     * @format uuid
+     */
+    integrationId: string;
+    jobId: string | null;
+    mode: 'immediate' | 'queued';
+}
+export type IntegrationSyncAllParams = Record<string, unknown>;
+export interface IntegrationSyncAllResponse {
+    /**
+     * @minimum 0
+     * @maximum 9007199254740991
+     */
+    eligibleIntegrationCount: number;
+    /**
+     * @minimum 0
+     * @maximum 9007199254740991
+     */
+    integrationSyncJobCount: number;
+    /**
+     * @minimum 0
+     * @maximum 9007199254740991
+     */
+    pullRequestSyncJobCount: number;
+}
+export interface IntegrationRetrieveSyncStatusResponse {
+    /**
+     * @minimum 0
+     * @maximum 9007199254740991
+     */
+    activeJobCount: number;
+    /**
+     * @minimum 0
+     * @maximum 9007199254740991
+     */
+    eligibleIntegrationCount: number;
+}
+export interface IntegrationRetrieveRateLimitResponse {
+    core: IntegrationRetrieveRateLimitResponse.Core;
+    graphql: IntegrationRetrieveRateLimitResponse.Graphql;
+    search: IntegrationRetrieveRateLimitResponse.Search;
+}
+export declare namespace IntegrationRetrieveRateLimitResponse {
+    interface Core {
+        limit: number;
+        remaining: number;
+        /**
+         * @format date-time
+         */
+        resetAt: string;
+        used: number;
+    }
+    interface Graphql {
+        limit: number;
+        remaining: number;
+        /**
+         * @format date-time
+         */
+        resetAt: string;
+        used: number;
+    }
+    interface Search {
+        limit: number;
+        remaining: number;
+        /**
+         * @format date-time
+         */
+        resetAt: string;
+        used: number;
+    }
+}
+export interface IntegrationListSentryEnvironmentsParams {
+    /**
+     * @maxLength 10
+     * @pattern ^\d+$
+     */
+    cursor?: string;
+    /**
+     * @default 50
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+}
+export interface IntegrationListSentryEnvironmentsResponse {
+    /**
+     * @maxItems 100
+     */
+    items: Array<string>;
+    /**
+     * @maxLength 10
+     * @pattern ^\d+$
+     */
+    nextCursor: string | null;
+}
+export interface IntegrationListSlackChannelsParams {
+    /**
+     * @maxLength 10
+     * @pattern ^\d+$
+     */
+    cursor?: string;
+    /**
+     * @default 50
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * @minLength 1
+     * @maxLength 200
+     */
+    search?: string;
+}
+export interface IntegrationListSlackChannelsResponse {
+    /**
+     * @maxItems 100
+     */
+    items: Array<IntegrationListSlackChannelsResponse.Item>;
+    /**
+     * @maxLength 10
+     * @pattern ^\d+$
+     */
+    nextCursor: string | null;
+}
+export declare namespace IntegrationListSlackChannelsResponse {
+    interface Item {
+        /**
+         * @minLength 1
+         * @maxLength 255
+         */
+        id: string;
+        /**
+         * @minLength 1
+         * @maxLength 255
+         */
+        name: string;
+    }
+}
+export declare namespace Integrations {
+    export { type IntegrationListResponse as IntegrationListResponse, type IntegrationCreateResponse as IntegrationCreateResponse, type IntegrationRetrieveResponse as IntegrationRetrieveResponse, type IntegrationUpdateResponse as IntegrationUpdateResponse, type IntegrationDeleteResponse as IntegrationDeleteResponse, type IntegrationAuthorizeResponse as IntegrationAuthorizeResponse, type IntegrationTestResponse as IntegrationTestResponse, type IntegrationSyncResponse as IntegrationSyncResponse, type IntegrationSyncAllResponse as IntegrationSyncAllResponse, type IntegrationRetrieveSyncStatusResponse as IntegrationRetrieveSyncStatusResponse, type IntegrationRetrieveRateLimitResponse as IntegrationRetrieveRateLimitResponse, type IntegrationListSentryEnvironmentsResponse as IntegrationListSentryEnvironmentsResponse, type IntegrationListSlackChannelsResponse as IntegrationListSlackChannelsResponse, type IntegrationListParams as IntegrationListParams, type IntegrationCreateParams as IntegrationCreateParams, type IntegrationUpdateParams as IntegrationUpdateParams, type IntegrationAuthorizeParams as IntegrationAuthorizeParams, type IntegrationSyncParams as IntegrationSyncParams, type IntegrationSyncAllParams as IntegrationSyncAllParams, type IntegrationListSentryEnvironmentsParams as IntegrationListSentryEnvironmentsParams, type IntegrationListSlackChannelsParams as IntegrationListSlackChannelsParams, };
+    export { Providers as Providers, type ProviderListResponse as ProviderListResponse, type ProviderDiscoverSnykOrganizationsResponse as ProviderDiscoverSnykOrganizationsResponse, type ProviderListParams as ProviderListParams, type ProviderDiscoverSnykOrganizationsParams as ProviderDiscoverSnykOrganizationsParams, };
+    export { Triggers as Triggers, type TriggerListResponse as TriggerListResponse, type TriggerRetrieveResponse as TriggerRetrieveResponse, type TriggerListFilterOptionsResponse as TriggerListFilterOptionsResponse, type TriggerListParams as TriggerListParams, type TriggerRetrieveParams as TriggerRetrieveParams, type TriggerListFilterOptionsParams as TriggerListFilterOptionsParams, };
+}
+//# sourceMappingURL=integrations.d.ts.map