@botpress/client 2.5.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -8592,6 +8592,27 @@ interface ChargeWorkspaceUnpaidInvoicesResponse$1 {
8592
8592
  }[];
8593
8593
  }
8594
8594
 
8595
+ interface SaveWorkspaceCancellationReasonsRequestHeaders$1 {
8596
+ }
8597
+ interface SaveWorkspaceCancellationReasonsRequestQuery$1 {
8598
+ }
8599
+ interface SaveWorkspaceCancellationReasonsRequestParams$1 {
8600
+ id: string;
8601
+ }
8602
+ interface SaveWorkspaceCancellationReasonsRequestBody$1 {
8603
+ /**
8604
+ * Reasons for canceling the subscription
8605
+ */
8606
+ reasons: ("too_expensive" | "not_using_enough" | "missing_feature" | "switched_tool" | "technical_issues" | "support_expectations" | "temporary_need")[];
8607
+ /**
8608
+ * Additional comment on the cancellation
8609
+ */
8610
+ comment?: string;
8611
+ }
8612
+ type SaveWorkspaceCancellationReasonsInput$1 = SaveWorkspaceCancellationReasonsRequestBody$1 & SaveWorkspaceCancellationReasonsRequestHeaders$1 & SaveWorkspaceCancellationReasonsRequestQuery$1 & SaveWorkspaceCancellationReasonsRequestParams$1;
8613
+ interface SaveWorkspaceCancellationReasonsResponse$1 {
8614
+ }
8615
+
8595
8616
  interface CreateWorkspaceRequestHeaders$1 {
8596
8617
  }
8597
8618
  interface CreateWorkspaceRequestQuery$1 {
@@ -15432,6 +15453,7 @@ declare class Client$9 {
15432
15453
  readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput$1) => Promise<ListWorkspaceInvoicesResponse$1>;
15433
15454
  readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput$1) => Promise<GetUpcomingInvoiceResponse$1>;
15434
15455
  readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput$1) => Promise<ChargeWorkspaceUnpaidInvoicesResponse$1>;
15456
+ readonly saveWorkspaceCancellationReasons: (input: SaveWorkspaceCancellationReasonsInput$1) => Promise<SaveWorkspaceCancellationReasonsResponse$1>;
15435
15457
  readonly createWorkspace: (input: CreateWorkspaceInput$1) => Promise<CreateWorkspaceResponse$1>;
15436
15458
  readonly getPublicWorkspace: (input: GetPublicWorkspaceInput$1) => Promise<GetPublicWorkspaceResponse$3>;
15437
15459
  readonly getWorkspace: (input: GetWorkspaceInput$1) => Promise<GetWorkspaceResponse$1>;
@@ -16636,7 +16658,7 @@ interface CreateCreditGrantRequestParams {
16636
16658
  }
16637
16659
  interface CreateCreditGrantRequestBody {
16638
16660
  /**
16639
- * Nanodollar value of the credit grant, must be at least $5 and a whole dollar amount
16661
+ * Nanodollar value of the credit grant, must be at least $5 and a whole number of cents
16640
16662
  */
16641
16663
  amount: number;
16642
16664
  feature: "ai_spend";
@@ -16663,6 +16685,54 @@ interface CreateCreditGrantResponse {
16663
16685
  createdAt: string;
16664
16686
  }
16665
16687
 
16688
+ interface ListCreditGrantsRequestHeaders {
16689
+ }
16690
+ interface ListCreditGrantsRequestQuery {
16691
+ nextToken?: string;
16692
+ pageSize?: number;
16693
+ }
16694
+ interface ListCreditGrantsRequestParams {
16695
+ }
16696
+ interface ListCreditGrantsRequestBody {
16697
+ }
16698
+ type ListCreditGrantsInput = ListCreditGrantsRequestBody & ListCreditGrantsRequestHeaders & ListCreditGrantsRequestQuery & ListCreditGrantsRequestParams;
16699
+ interface ListCreditGrantsResponse {
16700
+ creditGrants: {
16701
+ id: string;
16702
+ workspace_id: string;
16703
+ invoice_id: string | null;
16704
+ /**
16705
+ * Nanodollar value of the credit grant
16706
+ */
16707
+ amount: number;
16708
+ feature: "incoming_messages_events" | "integration_spend" | "table_rows" | "bot_count" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions" | "indexed_file_count" | "conversation_sessions" | "ai_spend";
16709
+ /**
16710
+ * Start of the period (inclusive)
16711
+ */
16712
+ period_start: string;
16713
+ /**
16714
+ * End of the period (exclusive)
16715
+ */
16716
+ period_end: string;
16717
+ updatedAt: string;
16718
+ createdAt: string;
16719
+ /**
16720
+ * Nanodollar value left on the credit grant, not including usage of the current period (consumed at period end)
16721
+ */
16722
+ remaining_amount: number;
16723
+ /**
16724
+ * Nanodollar value of the credit grant used so far in the current monthly usage period
16725
+ */
16726
+ current_period_usage: number;
16727
+ }[];
16728
+ meta: {
16729
+ /**
16730
+ * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
16731
+ */
16732
+ nextToken?: string;
16733
+ };
16734
+ }
16735
+
16666
16736
  interface ListInvoicesRequestHeaders {
16667
16737
  }
16668
16738
  interface ListInvoicesRequestQuery {
@@ -16895,6 +16965,7 @@ declare class Client$7 {
16895
16965
  readonly createTrial: (input: CreateTrialInput) => Promise<CreateTrialResponse>;
16896
16966
  readonly removeTrial: (input: RemoveTrialInput) => Promise<RemoveTrialResponse>;
16897
16967
  readonly createCreditGrant: (input: CreateCreditGrantInput) => Promise<CreateCreditGrantResponse>;
16968
+ readonly listCreditGrants: (input: ListCreditGrantsInput) => Promise<ListCreditGrantsResponse>;
16898
16969
  readonly listInvoices: (input: ListInvoicesInput) => Promise<ListInvoicesResponse>;
16899
16970
  readonly payInvoice: (input: PayInvoiceInput) => Promise<PayInvoiceResponse>;
16900
16971
  readonly getPaymentMethod: (input: GetPaymentMethodInput) => Promise<GetPaymentMethodResponse>;
@@ -28211,6 +28282,27 @@ interface ChargeWorkspaceUnpaidInvoicesResponse {
28211
28282
  }[];
28212
28283
  }
28213
28284
 
28285
+ interface SaveWorkspaceCancellationReasonsRequestHeaders {
28286
+ }
28287
+ interface SaveWorkspaceCancellationReasonsRequestQuery {
28288
+ }
28289
+ interface SaveWorkspaceCancellationReasonsRequestParams {
28290
+ id: string;
28291
+ }
28292
+ interface SaveWorkspaceCancellationReasonsRequestBody {
28293
+ /**
28294
+ * Reasons for canceling the subscription
28295
+ */
28296
+ reasons: ("too_expensive" | "not_using_enough" | "missing_feature" | "switched_tool" | "technical_issues" | "support_expectations" | "temporary_need")[];
28297
+ /**
28298
+ * Additional comment on the cancellation
28299
+ */
28300
+ comment?: string;
28301
+ }
28302
+ type SaveWorkspaceCancellationReasonsInput = SaveWorkspaceCancellationReasonsRequestBody & SaveWorkspaceCancellationReasonsRequestHeaders & SaveWorkspaceCancellationReasonsRequestQuery & SaveWorkspaceCancellationReasonsRequestParams;
28303
+ interface SaveWorkspaceCancellationReasonsResponse {
28304
+ }
28305
+
28214
28306
  interface CreateWorkspaceRequestHeaders {
28215
28307
  }
28216
28308
  interface CreateWorkspaceRequestQuery {
@@ -39840,6 +39932,7 @@ declare class Client$1 {
39840
39932
  readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
39841
39933
  readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
39842
39934
  readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
39935
+ readonly saveWorkspaceCancellationReasons: (input: SaveWorkspaceCancellationReasonsInput) => Promise<SaveWorkspaceCancellationReasonsResponse>;
39843
39936
  readonly createWorkspace: (input: CreateWorkspaceInput) => Promise<CreateWorkspaceResponse>;
39844
39937
  readonly getPublicWorkspace: (input: GetPublicWorkspaceInput) => Promise<GetPublicWorkspaceResponse$1>;
39845
39938
  readonly getWorkspace: (input: GetWorkspaceInput) => Promise<GetWorkspaceResponse>;