rebilly-js-sdk 62.211.0 → 62.212.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/CHANGELOG.md CHANGED
@@ -1,3 +1,3 @@
1
- ## 62.211.0 (2026-10-09)
1
+ ## 62.212.0 (2026-10-09)
2
2
 
3
3
  This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.
@@ -1883,6 +1883,11 @@ declare namespace rebilly {
1883
1883
  type PostWebhookResponse = operations['PostWebhook']['responses']['201']['content']['application/json']
1884
1884
  type PostWebhookResponsePromise = Promise<{fields: PostWebhookResponse}>
1885
1885
 
1886
+ type GetWebhookEventCollectionRequest = operations['GetWebhookEventCollection']['parameters']["query"] & (operations['GetWebhookEventCollection']['parameters'] extends {path: {}} ? operations['GetWebhookEventCollection']['parameters']["path"] : {})
1887
+
1888
+ type GetWebhookEventCollectionResponse = operations['GetWebhookEventCollection']['responses']['200']['content']['application/json'][0]
1889
+ type GetWebhookEventCollectionResponsePromise = Promise<{ items: {fields: GetWebhookEventCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
1890
+
1886
1891
  type GetWebhookRequest = { id: string }
1887
1892
 
1888
1893
  type GetWebhookResponse = operations['GetWebhook']['responses']['200']['content']['application/json']
@@ -3066,7 +3071,12 @@ export interface corePaths {
3066
3071
  };
3067
3072
  };
3068
3073
  "/invoices": {
3069
- /** Retrieves a list of invoices. */
3074
+ /**
3075
+ * Retrieves a list of invoices.
3076
+ * Each invoice in the list includes up to 10 of the most recent transactions in `transactions`.
3077
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
3078
+ * Search results can lag briefly behind a write.
3079
+ */
3070
3080
  get: operations["GetInvoiceCollection"];
3071
3081
  /** Creates an invoice. */
3072
3082
  post: operations["PostInvoice"];
@@ -5776,6 +5786,13 @@ export interface corePaths {
5776
5786
  /** Creates a webhook. */
5777
5787
  post: operations["PostWebhook"];
5778
5788
  };
5789
+ "/webhook-events": {
5790
+ /**
5791
+ * Retrieves the event types that your organization can use in the events filter of a webhook.
5792
+ * If your organization uses the Replay add-on, the list also contains Replay event types.
5793
+ */
5794
+ get: operations["GetWebhookEventCollection"];
5795
+ };
5779
5796
  "/webhooks/{id}": {
5780
5797
  /** Retrieves a webhook with a specified ID. */
5781
5798
  get: operations["GetWebhook"];
@@ -9574,7 +9591,11 @@ export interface coreComponents {
9574
9591
  /** Specifies if the order is a new order. */
9575
9592
  isNewOrder?: boolean;
9576
9593
  customerId: coreComponents["schemas"]["CustomerId"];
9577
- /** Invoice transactions array. */
9594
+ /**
9595
+ * Up to 10 of the most recent transactions for the invoice.
9596
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
9597
+ * Search results can lag briefly behind a write.
9598
+ */
9578
9599
  transactions?: coreComponents["schemas"]["Transaction"][];
9579
9600
  /**
9580
9601
  * Invoice payment retry instruction.
@@ -23396,7 +23417,8 @@ export interface coreComponents {
23396
23417
  * Event types that trigger the webhook.
23397
23418
  * If empty, all event types trigger the webhook.
23398
23419
  */
23399
- eventsFilter?: coreComponents["schemas"]["GlobalEventType"][];
23420
+ eventsFilter?: (Partial<coreComponents["schemas"]["GlobalEventType"]> &
23421
+ Partial<string>)[];
23400
23422
  status?: "active" | "inactive";
23401
23423
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
23402
23424
  /** URL that receives requests when a specified event occurs. */
@@ -23703,7 +23725,8 @@ export interface coreComponents {
23703
23725
  /** ID of the main entity related to the event type. */
23704
23726
  entityId?: string;
23705
23727
  organizationId?: coreComponents["schemas"]["OrganizationId"];
23706
- eventType?: coreComponents["schemas"]["GlobalEventType"];
23728
+ eventType?: Partial<coreComponents["schemas"]["GlobalEventType"]> &
23729
+ Partial<string>;
23707
23730
  /** Source that triggered the webhook. */
23708
23731
  source?: "webhooks" | "rules";
23709
23732
  /** Number of attempts to send the webhook. */
@@ -23769,6 +23792,15 @@ export interface coreComponents {
23769
23792
  allowedIps?: coreComponents["schemas"]["AllowedIps"];
23770
23793
  _links?: coreComponents["schemas"]["SelfLink"];
23771
23794
  };
23795
+ WebhookEvent: {
23796
+ /** Event type that a webhook can subscribe to. */
23797
+ eventType: string;
23798
+ /**
23799
+ * Product in which the event occurs.
23800
+ * Use this value to distinguish between Replay events and non-Replay events.
23801
+ */
23802
+ product: "core" | "replay";
23803
+ };
23772
23804
  CustomerInformation: {
23773
23805
  /** Currency code in ISO 4217 format. */
23774
23806
  currency?: string;
@@ -28330,7 +28362,10 @@ export interface coreComponents {
28330
28362
  transactionId?: string | null;
28331
28363
  /** ID of the payout request that received the merged amount. */
28332
28364
  mergedIntoPayoutRequestId?: string;
28333
- /** ID of the related Replay transfer. */
28365
+ /**
28366
+ * ID of the transfer that reserves the payout funds.
28367
+ * This value is `null` if no transfer exists.
28368
+ */
28334
28369
  replayTransferId?: string | null;
28335
28370
  /** Specifies whether the allocation is created automatically. */
28336
28371
  isAutoAllocation?: boolean;
@@ -33287,7 +33322,12 @@ export interface operations {
33287
33322
  403: coreComponents["responses"]["Forbidden"];
33288
33323
  };
33289
33324
  };
33290
- /** Retrieves a list of invoices. */
33325
+ /**
33326
+ * Retrieves a list of invoices.
33327
+ * Each invoice in the list includes up to 10 of the most recent transactions in `transactions`.
33328
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
33329
+ * Search results can lag briefly behind a write.
33330
+ */
33291
33331
  GetInvoiceCollection: {
33292
33332
  parameters: {
33293
33333
  query: {
@@ -44438,6 +44478,45 @@ export interface operations {
44438
44478
  };
44439
44479
  requestBody: coreComponents["requestBodies"]["GlobalWebhook"];
44440
44480
  };
44481
+ /**
44482
+ * Retrieves the event types that your organization can use in the events filter of a webhook.
44483
+ * If your organization uses the Replay add-on, the list also contains Replay event types.
44484
+ */
44485
+ GetWebhookEventCollection: {
44486
+ parameters: {
44487
+ query: {
44488
+ /**
44489
+ * Limit the number of collection items to be returned.
44490
+ * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
44491
+ */
44492
+ limit?: coreComponents["parameters"]["collectionLimit"];
44493
+ /** Specifies the starting point within the collection of items to be returned. */
44494
+ offset?: coreComponents["parameters"]["collectionOffset"];
44495
+ /**
44496
+ * Criteria for filtering collection items.
44497
+ * This field requires a special format.
44498
+ * Use `,` to specify multiple allowed values.
44499
+ * Use `;` to specify multiple fields.
44500
+ *
44501
+ * For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).
44502
+ */
44503
+ filter?: coreComponents["parameters"]["collectionFilter"];
44504
+ /** Use this field to perform a partial search of text fields. */
44505
+ q?: coreComponents["parameters"]["collectionQuery"];
44506
+ };
44507
+ };
44508
+ responses: {
44509
+ /** Webhook event types retrieved. */
44510
+ 200: {
44511
+ headers: {};
44512
+ content: {
44513
+ "application/json": coreComponents["schemas"]["WebhookEvent"][];
44514
+ };
44515
+ };
44516
+ 401: coreComponents["responses"]["Unauthorized"];
44517
+ 403: coreComponents["responses"]["Forbidden"];
44518
+ };
44519
+ };
44441
44520
  /** Retrieves a webhook with a specified ID. */
44442
44521
  GetWebhook: {
44443
44522
  parameters: {
@@ -49361,7 +49440,11 @@ export interface storefrontComponents {
49361
49440
  /** Specifies if the order is a new order. */
49362
49441
  isNewOrder?: boolean;
49363
49442
  customerId: storefrontComponents["schemas"]["CustomerId"];
49364
- /** Invoice transactions array. */
49443
+ /**
49444
+ * Up to 10 of the most recent transactions for the invoice.
49445
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
49446
+ * Search results can lag briefly behind a write.
49447
+ */
49365
49448
  transactions?: storefrontComponents["schemas"]["Transaction"][];
49366
49449
  /**
49367
49450
  * Invoice payment retry instruction.
@@ -63183,7 +63266,8 @@ export interface storefrontComponents {
63183
63266
  * Event types that trigger the webhook.
63184
63267
  * If empty, all event types trigger the webhook.
63185
63268
  */
63186
- eventsFilter?: storefrontComponents["schemas"]["GlobalEventType"][];
63269
+ eventsFilter?: (Partial<storefrontComponents["schemas"]["GlobalEventType"]> &
63270
+ Partial<string>)[];
63187
63271
  status?: "active" | "inactive";
63188
63272
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
63189
63273
  /** URL that receives requests when a specified event occurs. */
@@ -63490,7 +63574,8 @@ export interface storefrontComponents {
63490
63574
  /** ID of the main entity related to the event type. */
63491
63575
  entityId?: string;
63492
63576
  organizationId?: storefrontComponents["schemas"]["OrganizationId"];
63493
- eventType?: storefrontComponents["schemas"]["GlobalEventType"];
63577
+ eventType?: Partial<storefrontComponents["schemas"]["GlobalEventType"]> &
63578
+ Partial<string>;
63494
63579
  /** Source that triggered the webhook. */
63495
63580
  source?: "webhooks" | "rules";
63496
63581
  /** Number of attempts to send the webhook. */
@@ -63556,6 +63641,15 @@ export interface storefrontComponents {
63556
63641
  allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
63557
63642
  _links?: storefrontComponents["schemas"]["SelfLink"];
63558
63643
  };
63644
+ WebhookEvent: {
63645
+ /** Event type that a webhook can subscribe to. */
63646
+ eventType: string;
63647
+ /**
63648
+ * Product in which the event occurs.
63649
+ * Use this value to distinguish between Replay events and non-Replay events.
63650
+ */
63651
+ product: "core" | "replay";
63652
+ };
63559
63653
  CustomerInformation: {
63560
63654
  /** Currency code in ISO 4217 format. */
63561
63655
  currency?: string;
@@ -68117,7 +68211,10 @@ export interface storefrontComponents {
68117
68211
  transactionId?: string | null;
68118
68212
  /** ID of the payout request that received the merged amount. */
68119
68213
  mergedIntoPayoutRequestId?: string;
68120
- /** ID of the related Replay transfer. */
68214
+ /**
68215
+ * ID of the transfer that reserves the payout funds.
68216
+ * This value is `null` if no transfer exists.
68217
+ */
68121
68218
  replayTransferId?: string | null;
68122
68219
  /** Specifies whether the allocation is created automatically. */
68123
68220
  isAutoAllocation?: boolean;
@@ -76504,7 +76601,11 @@ export interface reportsComponents {
76504
76601
  /** Specifies if the order is a new order. */
76505
76602
  isNewOrder?: boolean;
76506
76603
  customerId: reportsComponents["schemas"]["CustomerId"];
76507
- /** Invoice transactions array. */
76604
+ /**
76605
+ * Up to 10 of the most recent transactions for the invoice.
76606
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
76607
+ * Search results can lag briefly behind a write.
76608
+ */
76508
76609
  transactions?: reportsComponents["schemas"]["Transaction"][];
76509
76610
  /**
76510
76611
  * Invoice payment retry instruction.
@@ -90326,7 +90427,8 @@ export interface reportsComponents {
90326
90427
  * Event types that trigger the webhook.
90327
90428
  * If empty, all event types trigger the webhook.
90328
90429
  */
90329
- eventsFilter?: reportsComponents["schemas"]["GlobalEventType"][];
90430
+ eventsFilter?: (Partial<reportsComponents["schemas"]["GlobalEventType"]> &
90431
+ Partial<string>)[];
90330
90432
  status?: "active" | "inactive";
90331
90433
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
90332
90434
  /** URL that receives requests when a specified event occurs. */
@@ -90633,7 +90735,8 @@ export interface reportsComponents {
90633
90735
  /** ID of the main entity related to the event type. */
90634
90736
  entityId?: string;
90635
90737
  organizationId?: reportsComponents["schemas"]["OrganizationId"];
90636
- eventType?: reportsComponents["schemas"]["GlobalEventType"];
90738
+ eventType?: Partial<reportsComponents["schemas"]["GlobalEventType"]> &
90739
+ Partial<string>;
90637
90740
  /** Source that triggered the webhook. */
90638
90741
  source?: "webhooks" | "rules";
90639
90742
  /** Number of attempts to send the webhook. */
@@ -90699,6 +90802,15 @@ export interface reportsComponents {
90699
90802
  allowedIps?: reportsComponents["schemas"]["AllowedIps"];
90700
90803
  _links?: reportsComponents["schemas"]["SelfLink"];
90701
90804
  };
90805
+ WebhookEvent: {
90806
+ /** Event type that a webhook can subscribe to. */
90807
+ eventType: string;
90808
+ /**
90809
+ * Product in which the event occurs.
90810
+ * Use this value to distinguish between Replay events and non-Replay events.
90811
+ */
90812
+ product: "core" | "replay";
90813
+ };
90702
90814
  CustomerInformation: {
90703
90815
  /** Currency code in ISO 4217 format. */
90704
90816
  currency?: string;
@@ -95260,7 +95372,10 @@ export interface reportsComponents {
95260
95372
  transactionId?: string | null;
95261
95373
  /** ID of the payout request that received the merged amount. */
95262
95374
  mergedIntoPayoutRequestId?: string;
95263
- /** ID of the related Replay transfer. */
95375
+ /**
95376
+ * ID of the transfer that reserves the payout funds.
95377
+ * This value is `null` if no transfer exists.
95378
+ */
95264
95379
  replayTransferId?: string | null;
95265
95380
  /** Specifies whether the allocation is created automatically. */
95266
95381
  isAutoAllocation?: boolean;
@@ -101088,6 +101203,9 @@ declare module "rebilly-js-sdk" {
101088
101203
  export type CreateWebhookRequest = rebilly.CreateWebhookRequest;
101089
101204
  export type PostWebhookResponse = rebilly.PostWebhookResponse;
101090
101205
  export type PostWebhookResponsePromise = rebilly.PostWebhookResponsePromise;
101206
+ export type GetWebhookEventCollectionRequest = rebilly.GetWebhookEventCollectionRequest;
101207
+ export type GetWebhookEventCollectionResponse = rebilly.GetWebhookEventCollectionResponse;
101208
+ export type GetWebhookEventCollectionResponsePromise = rebilly.GetWebhookEventCollectionResponsePromise;
101091
101209
  export type GetWebhookRequest = rebilly.GetWebhookRequest;
101092
101210
  export type GetWebhookResponse = rebilly.GetWebhookResponse;
101093
101211
  export type GetWebhookResponsePromise = rebilly.GetWebhookResponsePromise;
@@ -103676,6 +103794,13 @@ declare module "resources/users-resource" {
103676
103794
  }): rebilly.PutUserResponsePromise;
103677
103795
  };
103678
103796
  }
103797
+ declare module "resources/webhook-events-resource" {
103798
+ export default function WebhookEventsResource({ apiHandler }: {
103799
+ apiHandler: any;
103800
+ }): {
103801
+ getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
103802
+ };
103803
+ }
103679
103804
  declare module "resources/webhooks-resource" {
103680
103805
  export default function WebhooksResource({ apiHandler }: {
103681
103806
  apiHandler: any;
@@ -105333,6 +105458,9 @@ declare module "resources/api-instance" {
105333
105458
  data: any;
105334
105459
  }): rebilly.PutUserResponsePromise;
105335
105460
  };
105461
+ webhookEvents: {
105462
+ getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
105463
+ };
105336
105464
  webhooks: {
105337
105465
  getAll({ limit, offset, filter }?: rebilly.GetWebhookCollectionRequest): rebilly.GetWebhookCollectionResponsePromise;
105338
105466
  create({ id, data }: rebilly.CreateWebhookRequest): rebilly.PostWebhookResponsePromise;
@@ -1883,6 +1883,11 @@ declare namespace rebilly {
1883
1883
  type PostWebhookResponse = operations['PostWebhook']['responses']['201']['content']['application/json']
1884
1884
  type PostWebhookResponsePromise = Promise<{fields: PostWebhookResponse}>
1885
1885
 
1886
+ type GetWebhookEventCollectionRequest = operations['GetWebhookEventCollection']['parameters']["query"] & (operations['GetWebhookEventCollection']['parameters'] extends {path: {}} ? operations['GetWebhookEventCollection']['parameters']["path"] : {})
1887
+
1888
+ type GetWebhookEventCollectionResponse = operations['GetWebhookEventCollection']['responses']['200']['content']['application/json'][0]
1889
+ type GetWebhookEventCollectionResponsePromise = Promise<{ items: {fields: GetWebhookEventCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
1890
+
1886
1891
  type GetWebhookRequest = { id: string }
1887
1892
 
1888
1893
  type GetWebhookResponse = operations['GetWebhook']['responses']['200']['content']['application/json']
@@ -3066,7 +3071,12 @@ export interface corePaths {
3066
3071
  };
3067
3072
  };
3068
3073
  "/invoices": {
3069
- /** Retrieves a list of invoices. */
3074
+ /**
3075
+ * Retrieves a list of invoices.
3076
+ * Each invoice in the list includes up to 10 of the most recent transactions in `transactions`.
3077
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
3078
+ * Search results can lag briefly behind a write.
3079
+ */
3070
3080
  get: operations["GetInvoiceCollection"];
3071
3081
  /** Creates an invoice. */
3072
3082
  post: operations["PostInvoice"];
@@ -5776,6 +5786,13 @@ export interface corePaths {
5776
5786
  /** Creates a webhook. */
5777
5787
  post: operations["PostWebhook"];
5778
5788
  };
5789
+ "/webhook-events": {
5790
+ /**
5791
+ * Retrieves the event types that your organization can use in the events filter of a webhook.
5792
+ * If your organization uses the Replay add-on, the list also contains Replay event types.
5793
+ */
5794
+ get: operations["GetWebhookEventCollection"];
5795
+ };
5779
5796
  "/webhooks/{id}": {
5780
5797
  /** Retrieves a webhook with a specified ID. */
5781
5798
  get: operations["GetWebhook"];
@@ -9574,7 +9591,11 @@ export interface coreComponents {
9574
9591
  /** Specifies if the order is a new order. */
9575
9592
  isNewOrder?: boolean;
9576
9593
  customerId: coreComponents["schemas"]["CustomerId"];
9577
- /** Invoice transactions array. */
9594
+ /**
9595
+ * Up to 10 of the most recent transactions for the invoice.
9596
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
9597
+ * Search results can lag briefly behind a write.
9598
+ */
9578
9599
  transactions?: coreComponents["schemas"]["Transaction"][];
9579
9600
  /**
9580
9601
  * Invoice payment retry instruction.
@@ -23396,7 +23417,8 @@ export interface coreComponents {
23396
23417
  * Event types that trigger the webhook.
23397
23418
  * If empty, all event types trigger the webhook.
23398
23419
  */
23399
- eventsFilter?: coreComponents["schemas"]["GlobalEventType"][];
23420
+ eventsFilter?: (Partial<coreComponents["schemas"]["GlobalEventType"]> &
23421
+ Partial<string>)[];
23400
23422
  status?: "active" | "inactive";
23401
23423
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
23402
23424
  /** URL that receives requests when a specified event occurs. */
@@ -23703,7 +23725,8 @@ export interface coreComponents {
23703
23725
  /** ID of the main entity related to the event type. */
23704
23726
  entityId?: string;
23705
23727
  organizationId?: coreComponents["schemas"]["OrganizationId"];
23706
- eventType?: coreComponents["schemas"]["GlobalEventType"];
23728
+ eventType?: Partial<coreComponents["schemas"]["GlobalEventType"]> &
23729
+ Partial<string>;
23707
23730
  /** Source that triggered the webhook. */
23708
23731
  source?: "webhooks" | "rules";
23709
23732
  /** Number of attempts to send the webhook. */
@@ -23769,6 +23792,15 @@ export interface coreComponents {
23769
23792
  allowedIps?: coreComponents["schemas"]["AllowedIps"];
23770
23793
  _links?: coreComponents["schemas"]["SelfLink"];
23771
23794
  };
23795
+ WebhookEvent: {
23796
+ /** Event type that a webhook can subscribe to. */
23797
+ eventType: string;
23798
+ /**
23799
+ * Product in which the event occurs.
23800
+ * Use this value to distinguish between Replay events and non-Replay events.
23801
+ */
23802
+ product: "core" | "replay";
23803
+ };
23772
23804
  CustomerInformation: {
23773
23805
  /** Currency code in ISO 4217 format. */
23774
23806
  currency?: string;
@@ -28330,7 +28362,10 @@ export interface coreComponents {
28330
28362
  transactionId?: string | null;
28331
28363
  /** ID of the payout request that received the merged amount. */
28332
28364
  mergedIntoPayoutRequestId?: string;
28333
- /** ID of the related Replay transfer. */
28365
+ /**
28366
+ * ID of the transfer that reserves the payout funds.
28367
+ * This value is `null` if no transfer exists.
28368
+ */
28334
28369
  replayTransferId?: string | null;
28335
28370
  /** Specifies whether the allocation is created automatically. */
28336
28371
  isAutoAllocation?: boolean;
@@ -33287,7 +33322,12 @@ export interface operations {
33287
33322
  403: coreComponents["responses"]["Forbidden"];
33288
33323
  };
33289
33324
  };
33290
- /** Retrieves a list of invoices. */
33325
+ /**
33326
+ * Retrieves a list of invoices.
33327
+ * Each invoice in the list includes up to 10 of the most recent transactions in `transactions`.
33328
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
33329
+ * Search results can lag briefly behind a write.
33330
+ */
33291
33331
  GetInvoiceCollection: {
33292
33332
  parameters: {
33293
33333
  query: {
@@ -44438,6 +44478,45 @@ export interface operations {
44438
44478
  };
44439
44479
  requestBody: coreComponents["requestBodies"]["GlobalWebhook"];
44440
44480
  };
44481
+ /**
44482
+ * Retrieves the event types that your organization can use in the events filter of a webhook.
44483
+ * If your organization uses the Replay add-on, the list also contains Replay event types.
44484
+ */
44485
+ GetWebhookEventCollection: {
44486
+ parameters: {
44487
+ query: {
44488
+ /**
44489
+ * Limit the number of collection items to be returned.
44490
+ * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
44491
+ */
44492
+ limit?: coreComponents["parameters"]["collectionLimit"];
44493
+ /** Specifies the starting point within the collection of items to be returned. */
44494
+ offset?: coreComponents["parameters"]["collectionOffset"];
44495
+ /**
44496
+ * Criteria for filtering collection items.
44497
+ * This field requires a special format.
44498
+ * Use `,` to specify multiple allowed values.
44499
+ * Use `;` to specify multiple fields.
44500
+ *
44501
+ * For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).
44502
+ */
44503
+ filter?: coreComponents["parameters"]["collectionFilter"];
44504
+ /** Use this field to perform a partial search of text fields. */
44505
+ q?: coreComponents["parameters"]["collectionQuery"];
44506
+ };
44507
+ };
44508
+ responses: {
44509
+ /** Webhook event types retrieved. */
44510
+ 200: {
44511
+ headers: {};
44512
+ content: {
44513
+ "application/json": coreComponents["schemas"]["WebhookEvent"][];
44514
+ };
44515
+ };
44516
+ 401: coreComponents["responses"]["Unauthorized"];
44517
+ 403: coreComponents["responses"]["Forbidden"];
44518
+ };
44519
+ };
44441
44520
  /** Retrieves a webhook with a specified ID. */
44442
44521
  GetWebhook: {
44443
44522
  parameters: {
@@ -49361,7 +49440,11 @@ export interface storefrontComponents {
49361
49440
  /** Specifies if the order is a new order. */
49362
49441
  isNewOrder?: boolean;
49363
49442
  customerId: storefrontComponents["schemas"]["CustomerId"];
49364
- /** Invoice transactions array. */
49443
+ /**
49444
+ * Up to 10 of the most recent transactions for the invoice.
49445
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
49446
+ * Search results can lag briefly behind a write.
49447
+ */
49365
49448
  transactions?: storefrontComponents["schemas"]["Transaction"][];
49366
49449
  /**
49367
49450
  * Invoice payment retry instruction.
@@ -63183,7 +63266,8 @@ export interface storefrontComponents {
63183
63266
  * Event types that trigger the webhook.
63184
63267
  * If empty, all event types trigger the webhook.
63185
63268
  */
63186
- eventsFilter?: storefrontComponents["schemas"]["GlobalEventType"][];
63269
+ eventsFilter?: (Partial<storefrontComponents["schemas"]["GlobalEventType"]> &
63270
+ Partial<string>)[];
63187
63271
  status?: "active" | "inactive";
63188
63272
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
63189
63273
  /** URL that receives requests when a specified event occurs. */
@@ -63490,7 +63574,8 @@ export interface storefrontComponents {
63490
63574
  /** ID of the main entity related to the event type. */
63491
63575
  entityId?: string;
63492
63576
  organizationId?: storefrontComponents["schemas"]["OrganizationId"];
63493
- eventType?: storefrontComponents["schemas"]["GlobalEventType"];
63577
+ eventType?: Partial<storefrontComponents["schemas"]["GlobalEventType"]> &
63578
+ Partial<string>;
63494
63579
  /** Source that triggered the webhook. */
63495
63580
  source?: "webhooks" | "rules";
63496
63581
  /** Number of attempts to send the webhook. */
@@ -63556,6 +63641,15 @@ export interface storefrontComponents {
63556
63641
  allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
63557
63642
  _links?: storefrontComponents["schemas"]["SelfLink"];
63558
63643
  };
63644
+ WebhookEvent: {
63645
+ /** Event type that a webhook can subscribe to. */
63646
+ eventType: string;
63647
+ /**
63648
+ * Product in which the event occurs.
63649
+ * Use this value to distinguish between Replay events and non-Replay events.
63650
+ */
63651
+ product: "core" | "replay";
63652
+ };
63559
63653
  CustomerInformation: {
63560
63654
  /** Currency code in ISO 4217 format. */
63561
63655
  currency?: string;
@@ -68117,7 +68211,10 @@ export interface storefrontComponents {
68117
68211
  transactionId?: string | null;
68118
68212
  /** ID of the payout request that received the merged amount. */
68119
68213
  mergedIntoPayoutRequestId?: string;
68120
- /** ID of the related Replay transfer. */
68214
+ /**
68215
+ * ID of the transfer that reserves the payout funds.
68216
+ * This value is `null` if no transfer exists.
68217
+ */
68121
68218
  replayTransferId?: string | null;
68122
68219
  /** Specifies whether the allocation is created automatically. */
68123
68220
  isAutoAllocation?: boolean;
@@ -76504,7 +76601,11 @@ export interface reportsComponents {
76504
76601
  /** Specifies if the order is a new order. */
76505
76602
  isNewOrder?: boolean;
76506
76603
  customerId: reportsComponents["schemas"]["CustomerId"];
76507
- /** Invoice transactions array. */
76604
+ /**
76605
+ * Up to 10 of the most recent transactions for the invoice.
76606
+ * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
76607
+ * Search results can lag briefly behind a write.
76608
+ */
76508
76609
  transactions?: reportsComponents["schemas"]["Transaction"][];
76509
76610
  /**
76510
76611
  * Invoice payment retry instruction.
@@ -90326,7 +90427,8 @@ export interface reportsComponents {
90326
90427
  * Event types that trigger the webhook.
90327
90428
  * If empty, all event types trigger the webhook.
90328
90429
  */
90329
- eventsFilter?: reportsComponents["schemas"]["GlobalEventType"][];
90430
+ eventsFilter?: (Partial<reportsComponents["schemas"]["GlobalEventType"]> &
90431
+ Partial<string>)[];
90330
90432
  status?: "active" | "inactive";
90331
90433
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
90332
90434
  /** URL that receives requests when a specified event occurs. */
@@ -90633,7 +90735,8 @@ export interface reportsComponents {
90633
90735
  /** ID of the main entity related to the event type. */
90634
90736
  entityId?: string;
90635
90737
  organizationId?: reportsComponents["schemas"]["OrganizationId"];
90636
- eventType?: reportsComponents["schemas"]["GlobalEventType"];
90738
+ eventType?: Partial<reportsComponents["schemas"]["GlobalEventType"]> &
90739
+ Partial<string>;
90637
90740
  /** Source that triggered the webhook. */
90638
90741
  source?: "webhooks" | "rules";
90639
90742
  /** Number of attempts to send the webhook. */
@@ -90699,6 +90802,15 @@ export interface reportsComponents {
90699
90802
  allowedIps?: reportsComponents["schemas"]["AllowedIps"];
90700
90803
  _links?: reportsComponents["schemas"]["SelfLink"];
90701
90804
  };
90805
+ WebhookEvent: {
90806
+ /** Event type that a webhook can subscribe to. */
90807
+ eventType: string;
90808
+ /**
90809
+ * Product in which the event occurs.
90810
+ * Use this value to distinguish between Replay events and non-Replay events.
90811
+ */
90812
+ product: "core" | "replay";
90813
+ };
90702
90814
  CustomerInformation: {
90703
90815
  /** Currency code in ISO 4217 format. */
90704
90816
  currency?: string;
@@ -95260,7 +95372,10 @@ export interface reportsComponents {
95260
95372
  transactionId?: string | null;
95261
95373
  /** ID of the payout request that received the merged amount. */
95262
95374
  mergedIntoPayoutRequestId?: string;
95263
- /** ID of the related Replay transfer. */
95375
+ /**
95376
+ * ID of the transfer that reserves the payout funds.
95377
+ * This value is `null` if no transfer exists.
95378
+ */
95264
95379
  replayTransferId?: string | null;
95265
95380
  /** Specifies whether the allocation is created automatically. */
95266
95381
  isAutoAllocation?: boolean;
@@ -101088,6 +101203,9 @@ declare module "rebilly-js-sdk" {
101088
101203
  export type CreateWebhookRequest = rebilly.CreateWebhookRequest;
101089
101204
  export type PostWebhookResponse = rebilly.PostWebhookResponse;
101090
101205
  export type PostWebhookResponsePromise = rebilly.PostWebhookResponsePromise;
101206
+ export type GetWebhookEventCollectionRequest = rebilly.GetWebhookEventCollectionRequest;
101207
+ export type GetWebhookEventCollectionResponse = rebilly.GetWebhookEventCollectionResponse;
101208
+ export type GetWebhookEventCollectionResponsePromise = rebilly.GetWebhookEventCollectionResponsePromise;
101091
101209
  export type GetWebhookRequest = rebilly.GetWebhookRequest;
101092
101210
  export type GetWebhookResponse = rebilly.GetWebhookResponse;
101093
101211
  export type GetWebhookResponsePromise = rebilly.GetWebhookResponsePromise;
@@ -103676,6 +103794,13 @@ declare module "resources/users-resource" {
103676
103794
  }): rebilly.PutUserResponsePromise;
103677
103795
  };
103678
103796
  }
103797
+ declare module "resources/webhook-events-resource" {
103798
+ export default function WebhookEventsResource({ apiHandler }: {
103799
+ apiHandler: any;
103800
+ }): {
103801
+ getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
103802
+ };
103803
+ }
103679
103804
  declare module "resources/webhooks-resource" {
103680
103805
  export default function WebhooksResource({ apiHandler }: {
103681
103806
  apiHandler: any;
@@ -105333,6 +105458,9 @@ declare module "resources/api-instance" {
105333
105458
  data: any;
105334
105459
  }): rebilly.PutUserResponsePromise;
105335
105460
  };
105461
+ webhookEvents: {
105462
+ getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
105463
+ };
105336
105464
  webhooks: {
105337
105465
  getAll({ limit, offset, filter }?: rebilly.GetWebhookCollectionRequest): rebilly.GetWebhookCollectionResponsePromise;
105338
105466
  create({ id, data }: rebilly.CreateWebhookRequest): rebilly.PostWebhookResponsePromise;