@botpress/client 0.33.1 → 0.34.0

package/dist/index.d.ts

@@ -150,6 +150,7 @@ interface ListConversationsRequestQuery {
     };
     participantIds?: string[];
     integrationName?: string;
+    channel?: string;
 }
 interface ListConversationsRequestParams {
 }
@@ -2882,6 +2883,10 @@ interface ListPublicIntegrationsResponse {
             handle: string | null;
             name: string;
         };
+        meta: {
+            installs: number;
+            views: number;
+        };
     }[];
     meta: {
         /**
@@ -2994,7 +2999,7 @@ interface GetPublicIntegrationByIdResponse {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -3021,7 +3026,7 @@ interface GetPublicIntegrationByIdResponse {
                 /**
                  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
                  */
-                schema?: {
+                schema: {
                     [k: string]: any;
                 };
             };
@@ -3254,6 +3259,10 @@ interface GetPublicIntegrationByIdResponse {
             handle: string | null;
             name: string;
         };
+        meta: {
+            installs: number;
+            views: number;
+        };
     };
 }
 
@@ -3361,7 +3370,7 @@ interface GetPublicIntegrationResponse {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -3388,7 +3397,7 @@ interface GetPublicIntegrationResponse {
                 /**
                  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
                  */
-                schema?: {
+                schema: {
                     [k: string]: any;
                 };
             };
@@ -3621,6 +3630,10 @@ interface GetPublicIntegrationResponse {
             handle: string | null;
             name: string;
         };
+        meta: {
+            installs: number;
+            views: number;
+        };
     };
 }
 
@@ -5263,35 +5276,6 @@ type DeployBotVersionInput = DeployBotVersionRequestBody & DeployBotVersionReque
 interface DeployBotVersionResponse {
 }
 
-interface SetWorkspacePaymentMethodRequestHeaders {
-}
-interface SetWorkspacePaymentMethodRequestQuery {
-}
-interface SetWorkspacePaymentMethodRequestParams {
-    id: string;
-}
-interface SetWorkspacePaymentMethodRequestBody {
-    /**
-     * ID of the Stripe PaymentMethod to attach to the workspace.
-     */
-    stripePaymentMethodId: string;
-}
-type SetWorkspacePaymentMethodInput = SetWorkspacePaymentMethodRequestBody & SetWorkspacePaymentMethodRequestHeaders & SetWorkspacePaymentMethodRequestQuery & SetWorkspacePaymentMethodRequestParams;
-interface SetWorkspacePaymentMethodResponse {
-    stripePaymentMethodId: string;
-    paymentMethod: {
-        type: string;
-        lastDigits: string;
-    } | null;
-    status: "succeeded" | "processing" | "canceled" | "requires_confirmation" | "requires_action" | "requires_payment_method";
-    /**
-     * If the payment needs to be confirmed, this will contain a URL to redirect the user to so they can complete the verification process to confirm it.
-     */
-    nextAction?: {
-        redirectToUrl: string;
-    };
-}
-
 interface ListWorkspaceInvoicesRequestHeaders {
 }
 interface ListWorkspaceInvoicesRequestQuery {
@@ -6337,7 +6321,7 @@ interface CreateIntegrationResponse {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -6364,7 +6348,7 @@ interface CreateIntegrationResponse {
                 /**
                  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
                  */
-                schema?: {
+                schema: {
                     [k: string]: any;
                 };
             };
@@ -6991,7 +6975,7 @@ interface UpdateIntegrationResponse {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -7018,7 +7002,7 @@ interface UpdateIntegrationResponse {
                 /**
                  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
                  */
-                schema?: {
+                schema: {
                     [k: string]: any;
                 };
             };
@@ -7416,7 +7400,7 @@ interface GetIntegrationResponse {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -7443,7 +7427,7 @@ interface GetIntegrationResponse {
                 /**
                  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
                  */
-                schema?: {
+                schema: {
                     [k: string]: any;
                 };
             };
@@ -7800,7 +7784,7 @@ interface GetIntegrationByNameResponse {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -7827,7 +7811,7 @@ interface GetIntegrationByNameResponse {
                 /**
                  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
                  */
-                schema?: {
+                schema: {
                     [k: string]: any;
                 };
             };
@@ -11498,7 +11482,7 @@ interface Integration {
         /**
          * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
          */
-        schema?: {
+        schema: {
             [k: string]: any;
         };
     };
@@ -11525,7 +11509,7 @@ interface Integration {
             /**
              * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
              */
-            schema?: {
+            schema: {
                 [k: string]: any;
             };
         };
@@ -12150,6 +12134,73 @@ interface State {
         [k: string]: any;
     };
 }
+/**
+ * Workflow definition
+ */
+interface Workflow {
+    /**
+     * Id of the [Workflow](#schema_workflow)
+     */
+    id: string;
+    /**
+     * Name of the workflow
+     */
+    name: string;
+    /**
+     * Status of the [Workflow](#schema_workflow)
+     */
+    status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
+    /**
+     * Input provided to the [Workflow](#schema_workflow)
+     */
+    input: {
+        [k: string]: any;
+    };
+    /**
+     * Data returned by the [Workflow](#schema_workflow) output
+     */
+    output: {
+        [k: string]: any;
+    };
+    /**
+     * Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)
+     */
+    parentWorkflowId?: string;
+    /**
+     * Conversation id related to this [Workflow](#schema_workflow)
+     */
+    conversationId?: string;
+    /**
+     * User id related to this [Workflow](#schema_workflow)
+     */
+    userId?: string;
+    /**
+     * Creation date of the [Workflow](#schema_workflow) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Updating date of the [Workflow](#schema_workflow) in ISO 8601 format
+     */
+    updatedAt: string;
+    /**
+     * The date when the [Workflow](#schema_workflow) completed in ISO 8601 format
+     */
+    completedAt?: string;
+    /**
+     * If the [Workflow](#schema_workflow) fails this is the reason behind it
+     */
+    failureReason?: string;
+    /**
+     * The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format
+     */
+    timeoutAt: string;
+    /**
+     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Workflow](#schema_workflow). Individual keys can be unset by posting an empty value to them.
+     */
+    tags: {
+        [k: string]: string;
+    };
+}
 interface Table {
     /**
      * Unique identifier for the table
@@ -12511,7 +12562,6 @@ declare class Client$1 {
     readonly getBotVersion: (input: GetBotVersionInput) => Promise<GetBotVersionResponse>;
     readonly createBotVersion: (input: CreateBotVersionInput) => Promise<CreateBotVersionResponse>;
     readonly deployBotVersion: (input: DeployBotVersionInput) => Promise<DeployBotVersionResponse>;
-    readonly setWorkspacePaymentMethod: (input: SetWorkspacePaymentMethodInput) => Promise<SetWorkspacePaymentMethodResponse>;
     readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
     readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
     readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
@@ -13004,6 +13054,10 @@ declare class Lister {
             handle: string | null;
             name: string;
         };
+        meta: {
+            installs: number;
+            views: number;
+        };
     }>;
     readonly bots: (props: ListInputs['listBots']) => AsyncCollection<{
         id: string;
@@ -13109,4 +13163,4 @@ declare class Client extends Client$1 implements IClient {
     readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
 }
 
-export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workspace, type WorkspaceMember, errorFrom, isApiError };
+export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workflow, type Workspace, type WorkspaceMember, errorFrom, isApiError };