instill-sdk 0.4.0 → 0.4.1-rc.0

package/dist/core/index.d.ts

@@ -5,5 +5,6 @@ export * from "./organization";
 export * from "./subscription";
 export * from "./token";
 export * from "./user";
+export * from "./integration";
 export * from "./utils";
 //# sourceMappingURL=index.d.ts.map

package/dist/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC"}

package/dist/core/integration/IntegrationClient.d.ts

@@ -0,0 +1,77 @@
+import { APIResource } from "../../main/resource";
+import { AddIntegrationRequest, DeleteIntegrationConnectionRequest, GetConnectionPipelinesRequest, GetConnectionPipelinesResponse, GetIntegrationConnectionRequest, GetIntegrationConnectionsRequest, GetIntegrationConnectionsResponse, GetIntegrationRequest, GetIntegrationsRequest, GetIntegrationsResponse, Integration, IntegrationConnection, TestIntegrationConnectionRequest, UpdateIntegrationConnectionRequest } from "./type";
+export declare class IntegrationClient extends APIResource {
+    /**
+     * Returns a paginated list of the available integrations.
+     */
+    getIntegrations(props: GetIntegrationsRequest & {
+        enablePagination: true;
+    }): Promise<GetIntegrationsResponse>;
+    getIntegrations(props: GetIntegrationsRequest & {
+        enablePagination: false;
+    }): Promise<Integration[]>;
+    getIntegrations(props: GetIntegrationsRequest & {
+        enablePagination: undefined;
+    }): Promise<Integration[]>;
+    getIntegrations(props: GetIntegrationsRequest & {
+        enablePagination?: boolean;
+    }): Promise<GetIntegrationsResponse | Integration[]>;
+    /**
+     * Returns a paginated list of the connected integrations.
+     */
+    getIntegrationConnections(props: GetIntegrationConnectionsRequest & {
+        enablePagination: true;
+    }): Promise<GetIntegrationConnectionsResponse>;
+    getIntegrationConnections(props: GetIntegrationConnectionsRequest & {
+        enablePagination: false;
+    }): Promise<IntegrationConnection[]>;
+    getIntegrationConnections(props: GetIntegrationConnectionsRequest & {
+        enablePagination: undefined;
+    }): Promise<IntegrationConnection[]>;
+    getIntegrationConnections(props: GetIntegrationConnectionsRequest & {
+        enablePagination?: boolean;
+    }): Promise<GetIntegrationConnectionsResponse | IntegrationConnection[]>;
+    /**
+     * Returns a paginated list of the connection pipelines.
+     */
+    getConnectionPipelines(props: GetConnectionPipelinesRequest & {
+        enablePagination: true;
+    }): Promise<GetConnectionPipelinesResponse>;
+    getConnectionPipelines(props: GetConnectionPipelinesRequest & {
+        enablePagination: false;
+    }): Promise<string[]>;
+    getConnectionPipelines(props: GetConnectionPipelinesRequest & {
+        enablePagination: undefined;
+    }): Promise<string[]>;
+    getConnectionPipelines(props: GetConnectionPipelinesRequest & {
+        enablePagination?: boolean;
+    }): Promise<GetConnectionPipelinesResponse | string[]>;
+    /**
+     * Gets a specific integration connection
+     */
+    getIntegration(props: GetIntegrationRequest): Promise<Integration>;
+    /**
+     * Gets a specific integration
+     */
+    getIntegrationConnection(props: GetIntegrationConnectionRequest): Promise<IntegrationConnection>;
+    /**
+     * Adds an integration connection
+     */
+    addIntegration({ id, integrationId, namespaceId, setup, method, }: AddIntegrationRequest): Promise<IntegrationConnection>;
+    /**
+     * Updates an integration connection
+     */
+    updateIntegrationConnection(props: UpdateIntegrationConnectionRequest): Promise<IntegrationConnection>;
+    /**
+     * Deletes an integration connection
+     */
+    deleteIntegrationConnection({ namespaceId, connectionId, }: DeleteIntegrationConnectionRequest): Promise<{
+        namespaceId: string;
+        connectionId: string;
+    }>;
+    /**
+     * Tests an integration connection
+     */
+    testIntegrationConnection(props: TestIntegrationConnectionRequest): Promise<string>;
+}
+//# sourceMappingURL=IntegrationClient.d.ts.map

package/dist/core/integration/IntegrationClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntegrationClient.d.ts","sourceRoot":"","sources":["../../../src/core/integration/IntegrationClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EACL,qBAAqB,EAErB,kCAAkC,EAClC,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAE/B,gCAAgC,EAChC,iCAAiC,EACjC,qBAAqB,EAErB,sBAAsB,EACtB,uBAAuB,EACvB,WAAW,EACX,qBAAqB,EACrB,gCAAgC,EAEhC,kCAAkC,EAEnC,MAAM,QAAQ,CAAC;AAEhB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACG,eAAe,CACnB,KAAK,EAAE,sBAAsB,GAAG;QAAE,gBAAgB,EAAE,IAAI,CAAA;KAAE,GACzD,OAAO,CAAC,uBAAuB,CAAC;IAC7B,eAAe,CACnB,KAAK,EAAE,sBAAsB,GAAG;QAAE,gBAAgB,EAAE,KAAK,CAAA;KAAE,GAC1D,OAAO,CAAC,WAAW,EAAE,CAAC;IACnB,eAAe,CACnB,KAAK,EAAE,sBAAsB,GAAG;QAAE,gBAAgB,EAAE,SAAS,CAAA;KAAE,GAC9D,OAAO,CAAC,WAAW,EAAE,CAAC;IACnB,eAAe,CACnB,KAAK,EAAE,sBAAsB,GAAG;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,OAAO,CAAC,uBAAuB,GAAG,WAAW,EAAE,CAAC;IAyCnD;;OAEG;IACG,yBAAyB,CAC7B,KAAK,EAAE,gCAAgC,GAAG;QAAE,gBAAgB,EAAE,IAAI,CAAA;KAAE,GACnE,OAAO,CAAC,iCAAiC,CAAC;IACvC,yBAAyB,CAC7B,KAAK,EAAE,gCAAgC,GAAG;QAAE,gBAAgB,EAAE,KAAK,CAAA;KAAE,GACpE,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAC7B,yBAAyB,CAC7B,KAAK,EAAE,gCAAgC,GAAG;QAAE,gBAAgB,EAAE,SAAS,CAAA;KAAE,GACxE,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAC7B,yBAAyB,CAC7B,KAAK,EAAE,gCAAgC,GAAG;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,GACvE,OAAO,CAAC,iCAAiC,GAAG,qBAAqB,EAAE,CAAC;IA4CvE;;OAEG;IACG,sBAAsB,CAC1B,KAAK,EAAE,6BAA6B,GAAG;QAAE,gBAAgB,EAAE,IAAI,CAAA;KAAE,GAChE,OAAO,CAAC,8BAA8B,CAAC;IACpC,sBAAsB,CAC1B,KAAK,EAAE,6BAA6B,GAAG;QAAE,gBAAgB,EAAE,KAAK,CAAA;KAAE,GACjE,OAAO,CAAC,MAAM,EAAE,CAAC;IACd,sBAAsB,CAC1B,KAAK,EAAE,6BAA6B,GAAG;QAAE,gBAAgB,EAAE,SAAS,CAAA;KAAE,GACrE,OAAO,CAAC,MAAM,EAAE,CAAC;IACd,sBAAsB,CAC1B,KAAK,EAAE,6BAA6B,GAAG;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,GACpE,OAAO,CAAC,8BAA8B,GAAG,MAAM,EAAE,CAAC;IAmDrD;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,qBAAqB;IAiBjD;;OAEG;IACG,wBAAwB,CAAC,KAAK,EAAE,+BAA+B;IAkBrE;;OAEG;IACG,cAAc,CAAC,EACnB,EAAE,EACF,aAAa,EACb,WAAW,EACX,KAAK,EACL,MAAM,GACP,EAAE,qBAAqB;IAoBxB;;OAEG;IACG,2BAA2B,CAAC,KAAK,EAAE,kCAAkC;IAgB3E;;OAEG;IACG,2BAA2B,CAAC,EAChC,WAAW,EACX,YAAY,GACb,EAAE,kCAAkC;;;;IAYrC;;OAEG;IACG,yBAAyB,CAAC,KAAK,EAAE,gCAAgC;CAWxE"}

package/dist/core/integration/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./IntegrationClient";
+export * from "./type";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/integration/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/integration/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,QAAQ,CAAC"}

package/dist/core/integration/type.d.ts

@@ -0,0 +1,107 @@
+import { InstillJSONSchema, Nullable } from "../../types";
+import { ResourceView } from "../../vdp";
+export type IntegrationMethod = "METHOD_DICTIONARY" | "METHOD_OAUTH";
+export type Integration = {
+    id: string;
+    title: string;
+    description: string;
+    vendor: string;
+    icon: string;
+    featured: boolean;
+    schemas: {
+        method: IntegrationMethod;
+        schema: InstillJSONSchema;
+    }[];
+    view: ResourceView;
+};
+export type IntegrationConnection = {
+    uid: string;
+    id: string;
+    namespaceId: string;
+    integrationId: string;
+    integrationTitle: string;
+    pipelineIds: string[];
+    method: IntegrationMethod;
+    setup: Record<string, unknown>;
+    view: ResourceView;
+    createTime: string;
+    updateTime: string;
+};
+export type GetIntegrationsRequest = {
+    pageToken?: string;
+    pageSize: number;
+    filter: Nullable<string>;
+};
+export type GetIntegrationsResponse = {
+    integrations: Integration[];
+    nextPageToken: Nullable<string>;
+    totalSize: number;
+};
+export type GetIntegrationRequest = {
+    view?: ResourceView;
+    integrationId: string;
+};
+export type GetIntegrationResponse = {
+    integration: Integration;
+};
+export type GetIntegrationConnectionRequest = {
+    view?: ResourceView;
+    namespaceId: string;
+    connectionId: string;
+};
+export type GetIntegrationConnectionResponse = {
+    connection: IntegrationConnection;
+};
+export type AddIntegrationRequest = {
+    namespaceId: string;
+    id: string;
+    integrationId: string;
+    setup: Record<string, unknown>;
+    method: IntegrationMethod;
+};
+export type AddIntegrationResponse = {
+    connection: IntegrationConnection;
+};
+export type GetIntegrationConnectionsRequest = {
+    namespaceId: string;
+    pageToken?: string;
+    pageSize: number;
+    filter: Nullable<string>;
+};
+export type GetIntegrationConnectionsResponse = {
+    connections: IntegrationConnection[];
+    nextPageToken: Nullable<string>;
+    totalSize: number;
+};
+export type UpdateIntegrationConnectionRequest = {
+    namespaceId: string;
+    connectionId: string;
+    payload: {
+        setup: Record<string, unknown>;
+    };
+};
+export type UpdateIntegrationConnectionResponse = {
+    connection: IntegrationConnection;
+};
+export type GetConnectionPipelinesRequest = {
+    namespaceId: string;
+    connectionId: string;
+    pageToken?: string;
+    pageSize: number;
+    filter: Nullable<string>;
+};
+export type GetConnectionPipelinesResponse = {
+    pipelineIds: string[];
+    nextPageToken: Nullable<string>;
+    totalSize: number;
+};
+export type DeleteIntegrationConnectionRequest = {
+    namespaceId: string;
+    connectionId: string;
+};
+export type TestIntegrationConnectionRequest = {
+    namespaceId: string;
+    connectionId: string;
+};
+export type TestIntegrationConnectionResponse = unknown;
+//# sourceMappingURL=type.d.ts.map

package/dist/core/integration/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/core/integration/type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG,cAAc,CAAC;AAErE,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE;QACP,MAAM,EAAE,iBAAiB,CAAC;QAC1B,MAAM,EAAE,iBAAiB,CAAC;KAC3B,EAAE,CAAC;IACJ,IAAI,EAAE,YAAY,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,iBAAiB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACrC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG,OAAO,CAAC"}