@botpress/client 2.0.0 → 2.2.0

package/dist/index.d.ts

@@ -2549,6 +2549,29 @@ interface GetIntegrationIdentifierAvailabilityResponse$1 {
     status: "available" | "shareable" | "unavailable";
 }
 
+interface GetIntegrationInstanceIdentifiersRequestHeaders$1 {
+}
+interface GetIntegrationInstanceIdentifiersRequestQuery$1 {
+}
+interface GetIntegrationInstanceIdentifiersRequestParams$1 {
+}
+interface GetIntegrationInstanceIdentifiersRequestBody$1 {
+}
+type GetIntegrationInstanceIdentifiersInput$1 = GetIntegrationInstanceIdentifiersRequestBody$1 & GetIntegrationInstanceIdentifiersRequestHeaders$1 & GetIntegrationInstanceIdentifiersRequestQuery$1 & GetIntegrationInstanceIdentifiersRequestParams$1;
+interface GetIntegrationInstanceIdentifiersResponse$1 {
+    /**
+     * Identifiers held by the integration instance, keyed by identifier value
+     */
+    identifiers: {
+        [k: string]: {
+            /**
+             * Creation date of the identifier in ISO 8601 format
+             */
+            createdAt: string;
+        };
+    };
+}
+
 interface ConfigureIntegrationRequestHeaders$1 {
 }
 interface ConfigureIntegrationRequestQuery$1 {
@@ -2557,9 +2580,15 @@ interface ConfigureIntegrationRequestParams$1 {
 }
 interface ConfigureIntegrationRequestBody$1 {
     /**
-     * Unique identifier of the integration that was installed on the bot
+     * Unique identifier of the integration that was installed on the bot.
      */
     identifier?: string | null;
+    /**
+     * Identifiers of the integration. Keyed by identifier value: an empty object adds the identifier, `null` removes it, and values not provided are left unchanged. Mutually exclusive with `identifier`.
+     */
+    identifiers?: {
+        [k: string]: {} | null;
+    };
     /**
      * Recurring schedule on which `register()` will be called on the integration
      */
@@ -2571,6 +2600,17 @@ interface ConfigureIntegrationRequestBody$1 {
 }
 type ConfigureIntegrationInput$1 = ConfigureIntegrationRequestBody$1 & ConfigureIntegrationRequestHeaders$1 & ConfigureIntegrationRequestQuery$1 & ConfigureIntegrationRequestParams$1;
 interface ConfigureIntegrationResponse$1 {
+    /**
+     * Identifiers held by the integration instance, keyed by identifier value
+     */
+    identifiers?: {
+        [k: string]: {
+            /**
+             * Creation date of the identifier in ISO 8601 format
+             */
+            createdAt: string;
+        };
+    };
 }
 
 interface CreateWorkflowRequestHeaders$1 {
@@ -3258,6 +3298,7 @@ declare class Client$b {
     readonly callAction: (input: CallActionInput$1) => Promise<CallActionResponse$1>;
     readonly unlinkIntegrationIdentifier: (input: UnlinkIntegrationIdentifierInput$1) => Promise<UnlinkIntegrationIdentifierResponse$1>;
     readonly getIntegrationIdentifierAvailability: (input: GetIntegrationIdentifierAvailabilityInput$1) => Promise<GetIntegrationIdentifierAvailabilityResponse$1>;
+    readonly getIntegrationInstanceIdentifiers: (input: GetIntegrationInstanceIdentifiersInput$1) => Promise<GetIntegrationInstanceIdentifiersResponse$1>;
     readonly configureIntegration: (input: ConfigureIntegrationInput$1) => Promise<ConfigureIntegrationResponse$1>;
     readonly createWorkflow: (input: CreateWorkflowInput$1) => Promise<CreateWorkflowResponse$1>;
     readonly getWorkflow: (input: GetWorkflowInput$1) => Promise<GetWorkflowResponse$1>;
@@ -3315,8 +3356,8 @@ declare class Client$a extends Client$b {
             };
         }>;
         participants: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -8936,7 +8977,7 @@ interface GetAuditRecordsResponse$1 {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "SET_WORKSPACE_QUOTA_BLOCK_INTERNAL" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED" | "SET_WORKSPACE_FEATURE_GATE" | "DELETE_WORKSPACE_FEATURE_GATE";
     }[];
     meta: {
         /**
@@ -15464,9 +15505,9 @@ declare class Client$8 extends Client$9 {
     constructor(clientProps: ClientProps$8);
     get list(): {
         publicIntegrations: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
             limit?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
@@ -15530,8 +15571,8 @@ declare class Client$8 extends Client$9 {
             type: "studio" | "adk" | "desk";
         }>;
         botIssues: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
         }) => AsyncCollection<{
             id: string;
             code: string;
@@ -15570,9 +15611,9 @@ declare class Client$8 extends Client$9 {
             displayName?: string;
         }>;
         integrations: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
             limit?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
@@ -15613,8 +15654,8 @@ declare class Client$8 extends Client$9 {
             };
         }>;
         interfaces: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -15643,8 +15684,8 @@ declare class Client$8 extends Client$9 {
             createdAt: string;
         }>;
         usageActivity: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
             type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
             timestampFrom?: string | undefined;
             timestampUntil?: string | undefined;
@@ -15657,8 +15698,8 @@ declare class Client$8 extends Client$9 {
             };
         }>;
         usageActivityDaily: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
             type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
             dateFrom?: string | undefined;
             dateUntil?: string | undefined;
@@ -16366,7 +16407,11 @@ interface GetAutoRechargeSettingsResponse {
     settings: {
         [k: string]: {
             enabled: boolean;
-            threshold?: number;
+            targetType?: "addon" | "credit_grant";
+            threshold?: number | null;
+            addonId?: string;
+            chunkSize?: number | null;
+            maxAmount?: number | null;
             disabledReason?: string;
         };
     };
@@ -16382,7 +16427,11 @@ interface SetAutoRechargeSettingsRequestBody {
     settings: {
         [k: string]: {
             enabled: boolean;
-            threshold?: number;
+            targetType?: "addon" | "credit_grant";
+            threshold?: number | null;
+            addonId?: string;
+            chunkSize?: number | null;
+            maxAmount?: number | null;
         };
     };
 }
@@ -16391,7 +16440,11 @@ interface SetAutoRechargeSettingsResponse {
     settings: {
         [k: string]: {
             enabled: boolean;
-            threshold?: number;
+            targetType?: "addon" | "credit_grant";
+            threshold?: number | null;
+            addonId?: string;
+            chunkSize?: number | null;
+            maxAmount?: number | null;
             disabledReason?: string;
         };
     };
@@ -16455,7 +16508,7 @@ interface CreateCreditGrantRequestParams {
 }
 interface CreateCreditGrantRequestBody {
     /**
-     * Nanodollar value of the credit grant (e.g. 10_000_000_000 = $10.00 USD)
+     * Nanodollar value of the credit grant, must be a multiple of $5 (e.g. 10_000_000_000 = $10.00 USD)
      */
     amount: number;
     feature: "ai_spend";
@@ -17987,8 +18040,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
             indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
             limit?: number | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -22216,6 +22269,29 @@ interface GetIntegrationIdentifierAvailabilityResponse {
     status: "available" | "shareable" | "unavailable";
 }
 
+interface GetIntegrationInstanceIdentifiersRequestHeaders {
+}
+interface GetIntegrationInstanceIdentifiersRequestQuery {
+}
+interface GetIntegrationInstanceIdentifiersRequestParams {
+}
+interface GetIntegrationInstanceIdentifiersRequestBody {
+}
+type GetIntegrationInstanceIdentifiersInput = GetIntegrationInstanceIdentifiersRequestBody & GetIntegrationInstanceIdentifiersRequestHeaders & GetIntegrationInstanceIdentifiersRequestQuery & GetIntegrationInstanceIdentifiersRequestParams;
+interface GetIntegrationInstanceIdentifiersResponse {
+    /**
+     * Identifiers held by the integration instance, keyed by identifier value
+     */
+    identifiers: {
+        [k: string]: {
+            /**
+             * Creation date of the identifier in ISO 8601 format
+             */
+            createdAt: string;
+        };
+    };
+}
+
 interface ConfigureIntegrationRequestHeaders {
 }
 interface ConfigureIntegrationRequestQuery {
@@ -22224,9 +22300,15 @@ interface ConfigureIntegrationRequestParams {
 }
 interface ConfigureIntegrationRequestBody {
     /**
-     * Unique identifier of the integration that was installed on the bot
+     * Unique identifier of the integration that was installed on the bot.
      */
     identifier?: string | null;
+    /**
+     * Identifiers of the integration. Keyed by identifier value: an empty object adds the identifier, `null` removes it, and values not provided are left unchanged. Mutually exclusive with `identifier`.
+     */
+    identifiers?: {
+        [k: string]: {} | null;
+    };
     /**
      * Recurring schedule on which `register()` will be called on the integration
      */
@@ -22238,6 +22320,17 @@ interface ConfigureIntegrationRequestBody {
 }
 type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
 interface ConfigureIntegrationResponse {
+    /**
+     * Identifiers held by the integration instance, keyed by identifier value
+     */
+    identifiers?: {
+        [k: string]: {
+            /**
+             * Creation date of the identifier in ISO 8601 format
+             */
+            createdAt: string;
+        };
+    };
 }
 
 interface CreateWorkflowRequestHeaders {
@@ -28370,7 +28463,7 @@ interface GetAuditRecordsResponse {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "SET_WORKSPACE_QUOTA_BLOCK_INTERNAL" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED" | "SET_WORKSPACE_FEATURE_GATE" | "DELETE_WORKSPACE_FEATURE_GATE";
     }[];
     meta: {
         /**
@@ -39545,6 +39638,7 @@ declare class Client$1 {
     readonly callAction: (input: CallActionInput) => Promise<CallActionResponse>;
     readonly unlinkIntegrationIdentifier: (input: UnlinkIntegrationIdentifierInput) => Promise<UnlinkIntegrationIdentifierResponse>;
     readonly getIntegrationIdentifierAvailability: (input: GetIntegrationIdentifierAvailabilityInput) => Promise<GetIntegrationIdentifierAvailabilityResponse>;
+    readonly getIntegrationInstanceIdentifiers: (input: GetIntegrationInstanceIdentifiersInput) => Promise<GetIntegrationInstanceIdentifiersResponse>;
     readonly configureIntegration: (input: ConfigureIntegrationInput) => Promise<ConfigureIntegrationResponse>;
     readonly createWorkflow: (input: CreateWorkflowInput) => Promise<CreateWorkflowResponse>;
     readonly getWorkflow: (input: GetWorkflowInput) => Promise<GetWorkflowResponse>;
@@ -39748,8 +39842,8 @@ declare class Client extends Client$1 implements IClient {
             };
         }>;
         participants: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -39839,9 +39933,9 @@ declare class Client extends Client$1 implements IClient {
             };
         }>;
         publicIntegrations: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
             limit?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
@@ -39905,8 +39999,8 @@ declare class Client extends Client$1 implements IClient {
             type: "studio" | "adk" | "desk";
         }>;
         botIssues: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
         }) => AsyncCollection<{
             id: string;
             code: string;
@@ -39937,9 +40031,9 @@ declare class Client extends Client$1 implements IClient {
             pageSize?: number | undefined;
         }) => AsyncCollection<UpdateWorkspaceMemberResponse$1>;
         integrations: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
             limit?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
@@ -39980,8 +40074,8 @@ declare class Client extends Client$1 implements IClient {
             };
         }>;
         interfaces: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -39996,8 +40090,8 @@ declare class Client extends Client$1 implements IClient {
             public: boolean;
         }>;
         publicInterfaces: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -40012,8 +40106,8 @@ declare class Client extends Client$1 implements IClient {
             public: boolean;
         }>;
         plugins: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -40029,8 +40123,8 @@ declare class Client extends Client$1 implements IClient {
             lifecycleStatus: "published" | "deprecated";
         }>;
         publicPlugins: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
+            name?: string | undefined;
             version?: string | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -40095,8 +40189,8 @@ declare class Client extends Client$1 implements IClient {
             indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
             limit?: number | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -40129,8 +40223,8 @@ declare class Client extends Client$1 implements IClient {
             };
         }>;
         usageActivity: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
             type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
             timestampFrom?: string | undefined;
             timestampUntil?: string | undefined;
@@ -40143,8 +40237,8 @@ declare class Client extends Client$1 implements IClient {
             };
         }>;
         usageActivityDaily: (props: {
-            pageSize?: number | undefined;
             id: string;
+            pageSize?: number | undefined;
             type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
             dateFrom?: string | undefined;
             dateUntil?: string | undefined;
@@ -40160,8 +40254,8 @@ declare class Client extends Client$1 implements IClient {
             };
         }>;
         workflows: (props: {
-            name?: string | undefined;
             pageSize?: number | undefined;
+            name?: string | undefined;
             tags?: {
                 [x: string]: string;
             } | undefined;