rebilly-js-sdk 62.204.5 → 62.206.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 +2 -4
- package/dist/rebilly-js-sdk.d.cts +268 -0
- package/dist/rebilly-js-sdk.d.mts +268 -0
- package/dist/rebilly-js-sdk.d.ts +268 -0
- package/dist/rebilly-js-sdk.es.mjs +46 -31
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
- package/src/resources/storefront/order-changes-resource.js +20 -0
- package/src/resources/storefront/storefront-api-instance.js +2 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
## 62.
|
|
1
|
+
## 62.206.0 (2026-10-07)
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
- **fe:** make the published @rebilly/framepay types self-contained ([#28257](https://github.com/Rebilly/rebilly/pull/28257))
|
|
3
|
+
This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.
|
|
@@ -2141,6 +2141,14 @@ declare namespace rebilly {
|
|
|
2141
2141
|
type StorefrontPostSubscriptionItemsChangeResponse = operations['StorefrontPostSubscriptionItemsChange']['responses']['201']['content']['application/json']
|
|
2142
2142
|
type StorefrontPostSubscriptionItemsChangeResponsePromise = Promise<{fields: StorefrontPostSubscriptionItemsChangeResponse}>
|
|
2143
2143
|
|
|
2144
|
+
type StorefrontGetOrderChangeCollectionRequest = operations['StorefrontGetOrderChangeCollection']['parameters']["query"] & (operations['StorefrontGetOrderChangeCollection']['parameters'] extends {path: {}} ? operations['StorefrontGetOrderChangeCollection']['parameters']["path"] : {})
|
|
2145
|
+
|
|
2146
|
+
type StorefrontGetOrderChangeCollectionResponse = operations['StorefrontGetOrderChangeCollection']['responses']['200']['content']['application/json'][0]
|
|
2147
|
+
type StorefrontGetOrderChangeCollectionResponsePromise = Promise<{ items: {fields: StorefrontGetOrderChangeCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
2148
|
+
|
|
2149
|
+
type StorefrontDeleteOrderChangeResponse = operations['StorefrontDeleteOrderChange']['responses']['204']
|
|
2150
|
+
type StorefrontDeleteOrderChangeResponsePromise = Promise<{fields: StorefrontDeleteOrderChangeResponse}>
|
|
2151
|
+
|
|
2144
2152
|
type StorefrontPostSubscriptionReactivationRequest = operations['StorefrontPostSubscriptionReactivation']['requestBody']['content']['application/json']
|
|
2145
2153
|
type StorefrontCreateSubscriptionReactivationRequest = { id?: string, data: StorefrontPostSubscriptionReactivationRequest, expand?: string }
|
|
2146
2154
|
type StorefrontPostSubscriptionReactivationResponse = operations['StorefrontPostSubscriptionReactivation']['responses']['201']['content']['application/json']
|
|
@@ -26945,6 +26953,59 @@ export interface coreComponents {
|
|
|
26945
26953
|
invoice?: { [key: string]: any };
|
|
26946
26954
|
};
|
|
26947
26955
|
};
|
|
26956
|
+
/**
|
|
26957
|
+
* Change to the items of a recurring order of the customer.
|
|
26958
|
+
* A change with `applyAt` set to `nextRenewal` records the new items and applies them at the next renewal.
|
|
26959
|
+
* The current items remain until the next renewal, when the new items are applied and billed on the renewal invoice.
|
|
26960
|
+
*/
|
|
26961
|
+
StorefrontOrderChange: {
|
|
26962
|
+
/** ID of the order change. */
|
|
26963
|
+
id: string;
|
|
26964
|
+
/** ID of the order. */
|
|
26965
|
+
orderId: string;
|
|
26966
|
+
/** Status of the order change. */
|
|
26967
|
+
status: "pending" | "applied" | "canceled" | "superseded";
|
|
26968
|
+
/**
|
|
26969
|
+
* Time when the new items are applied.
|
|
26970
|
+
*
|
|
26971
|
+
* - `now`: The items change immediately.
|
|
26972
|
+
* - `nextRenewal`: The current items stay until the next renewal.
|
|
26973
|
+
* The new items are billed on the next renewal invoice.
|
|
26974
|
+
* To cancel a pending change, use the `DELETE /storefront/order-changes/{id}` operation.
|
|
26975
|
+
*/
|
|
26976
|
+
applyAt: "now" | "nextRenewal";
|
|
26977
|
+
/**
|
|
26978
|
+
* Date and time when the change is applied.
|
|
26979
|
+
* If `applyAt` is set to `nextRenewal`, this value equals the renewal time of the order.
|
|
26980
|
+
*/
|
|
26981
|
+
effectiveTime: string;
|
|
26982
|
+
/**
|
|
26983
|
+
* Date and time when the items of a pending change are billed.
|
|
26984
|
+
* After this time, the change is locked and cannot be modified until the renewal.
|
|
26985
|
+
*/
|
|
26986
|
+
lockedTime?: string | null;
|
|
26987
|
+
/** Date and time when the items of the order are replaced. */
|
|
26988
|
+
appliedTime?: string | null;
|
|
26989
|
+
/**
|
|
26990
|
+
* ID of the quote that is used to create the change.
|
|
26991
|
+
* This value is `null` if the change is not created from a quote.
|
|
26992
|
+
*/
|
|
26993
|
+
quoteId?: string | null;
|
|
26994
|
+
/** New items for the order. */
|
|
26995
|
+
items: {
|
|
26996
|
+
/** Plan details. */
|
|
26997
|
+
plan:
|
|
26998
|
+
| coreComponents["schemas"]["OriginalPlan"]
|
|
26999
|
+
| coreComponents["schemas"]["FlexiblePlan"];
|
|
27000
|
+
/** Number of units of the product on the given plan. */
|
|
27001
|
+
quantity?: number;
|
|
27002
|
+
usageLimits?: coreComponents["schemas"]["UsageLimits"] | null;
|
|
27003
|
+
/** Specifies if this item is excluded from monthly recurring revenue calculations. */
|
|
27004
|
+
excludeFromMrr?: boolean | null;
|
|
27005
|
+
}[];
|
|
27006
|
+
createdTime: coreComponents["schemas"]["CreatedTime"];
|
|
27007
|
+
updatedTime: coreComponents["schemas"]["UpdatedTime"];
|
|
27008
|
+
};
|
|
26948
27009
|
/** Reactivate customer subscription. */
|
|
26949
27010
|
PostSubscriptionReactivation: {
|
|
26950
27011
|
/** ID of the order associated with the reactivation quote. */
|
|
@@ -45274,6 +45335,27 @@ export interface storefrontPaths {
|
|
|
45274
45335
|
};
|
|
45275
45336
|
};
|
|
45276
45337
|
};
|
|
45338
|
+
"/order-changes": {
|
|
45339
|
+
/**
|
|
45340
|
+
* Retrieves a list of changes to the items of the orders of the customer.
|
|
45341
|
+
* To find the pending change of an order, use `filter=orderId:{orderId};status:pending`.
|
|
45342
|
+
*/
|
|
45343
|
+
get: operations["StorefrontGetOrderChangeCollection"];
|
|
45344
|
+
};
|
|
45345
|
+
"/order-changes/{id}": {
|
|
45346
|
+
/**
|
|
45347
|
+
* Cancels a pending change to the items of an order of the customer.
|
|
45348
|
+
* The current items of the order stay as they are.
|
|
45349
|
+
* A change cannot be canceled after it is locked by an issued invoice, applied, canceled, or superseded.
|
|
45350
|
+
*/
|
|
45351
|
+
delete: operations["StorefrontDeleteOrderChange"];
|
|
45352
|
+
parameters: {
|
|
45353
|
+
path: {
|
|
45354
|
+
/** ID of the resource. */
|
|
45355
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
45356
|
+
};
|
|
45357
|
+
};
|
|
45358
|
+
};
|
|
45277
45359
|
"/subscription-reactivations": {
|
|
45278
45360
|
/**
|
|
45279
45361
|
* Creates a quote for requested reactivation.
|
|
@@ -66615,6 +66697,59 @@ export interface storefrontComponents {
|
|
|
66615
66697
|
invoice?: { [key: string]: any };
|
|
66616
66698
|
};
|
|
66617
66699
|
};
|
|
66700
|
+
/**
|
|
66701
|
+
* Change to the items of a recurring order of the customer.
|
|
66702
|
+
* A change with `applyAt` set to `nextRenewal` records the new items and applies them at the next renewal.
|
|
66703
|
+
* The current items remain until the next renewal, when the new items are applied and billed on the renewal invoice.
|
|
66704
|
+
*/
|
|
66705
|
+
StorefrontOrderChange: {
|
|
66706
|
+
/** ID of the order change. */
|
|
66707
|
+
id: string;
|
|
66708
|
+
/** ID of the order. */
|
|
66709
|
+
orderId: string;
|
|
66710
|
+
/** Status of the order change. */
|
|
66711
|
+
status: "pending" | "applied" | "canceled" | "superseded";
|
|
66712
|
+
/**
|
|
66713
|
+
* Time when the new items are applied.
|
|
66714
|
+
*
|
|
66715
|
+
* - `now`: The items change immediately.
|
|
66716
|
+
* - `nextRenewal`: The current items stay until the next renewal.
|
|
66717
|
+
* The new items are billed on the next renewal invoice.
|
|
66718
|
+
* To cancel a pending change, use the `DELETE /storefront/order-changes/{id}` operation.
|
|
66719
|
+
*/
|
|
66720
|
+
applyAt: "now" | "nextRenewal";
|
|
66721
|
+
/**
|
|
66722
|
+
* Date and time when the change is applied.
|
|
66723
|
+
* If `applyAt` is set to `nextRenewal`, this value equals the renewal time of the order.
|
|
66724
|
+
*/
|
|
66725
|
+
effectiveTime: string;
|
|
66726
|
+
/**
|
|
66727
|
+
* Date and time when the items of a pending change are billed.
|
|
66728
|
+
* After this time, the change is locked and cannot be modified until the renewal.
|
|
66729
|
+
*/
|
|
66730
|
+
lockedTime?: string | null;
|
|
66731
|
+
/** Date and time when the items of the order are replaced. */
|
|
66732
|
+
appliedTime?: string | null;
|
|
66733
|
+
/**
|
|
66734
|
+
* ID of the quote that is used to create the change.
|
|
66735
|
+
* This value is `null` if the change is not created from a quote.
|
|
66736
|
+
*/
|
|
66737
|
+
quoteId?: string | null;
|
|
66738
|
+
/** New items for the order. */
|
|
66739
|
+
items: {
|
|
66740
|
+
/** Plan details. */
|
|
66741
|
+
plan:
|
|
66742
|
+
| storefrontComponents["schemas"]["OriginalPlan"]
|
|
66743
|
+
| storefrontComponents["schemas"]["FlexiblePlan"];
|
|
66744
|
+
/** Number of units of the product on the given plan. */
|
|
66745
|
+
quantity?: number;
|
|
66746
|
+
usageLimits?: storefrontComponents["schemas"]["UsageLimits"] | null;
|
|
66747
|
+
/** Specifies if this item is excluded from monthly recurring revenue calculations. */
|
|
66748
|
+
excludeFromMrr?: boolean | null;
|
|
66749
|
+
}[];
|
|
66750
|
+
createdTime: storefrontComponents["schemas"]["CreatedTime"];
|
|
66751
|
+
updatedTime: storefrontComponents["schemas"]["UpdatedTime"];
|
|
66752
|
+
};
|
|
66618
66753
|
/** Reactivate customer subscription. */
|
|
66619
66754
|
PostSubscriptionReactivation: {
|
|
66620
66755
|
/** ID of the order associated with the reactivation quote. */
|
|
@@ -71279,6 +71414,65 @@ export interface operations {
|
|
|
71279
71414
|
};
|
|
71280
71415
|
};
|
|
71281
71416
|
};
|
|
71417
|
+
/**
|
|
71418
|
+
* Retrieves a list of changes to the items of the orders of the customer.
|
|
71419
|
+
* To find the pending change of an order, use `filter=orderId:{orderId};status:pending`.
|
|
71420
|
+
*/
|
|
71421
|
+
StorefrontGetOrderChangeCollection: {
|
|
71422
|
+
parameters: {
|
|
71423
|
+
query: {
|
|
71424
|
+
/**
|
|
71425
|
+
* Limit the number of collection items to be returned.
|
|
71426
|
+
* Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
|
|
71427
|
+
*/
|
|
71428
|
+
limit?: storefrontComponents["parameters"]["collectionLimit"];
|
|
71429
|
+
/** Specifies the starting point within the collection of items to be returned. */
|
|
71430
|
+
offset?: storefrontComponents["parameters"]["collectionOffset"];
|
|
71431
|
+
/**
|
|
71432
|
+
* Criteria for filtering collection items.
|
|
71433
|
+
* This field requires a special format.
|
|
71434
|
+
* Use `,` to specify multiple allowed values.
|
|
71435
|
+
* Use `;` to specify multiple fields.
|
|
71436
|
+
*
|
|
71437
|
+
* For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).
|
|
71438
|
+
*/
|
|
71439
|
+
filter?: storefrontComponents["parameters"]["collectionFilter"];
|
|
71440
|
+
};
|
|
71441
|
+
};
|
|
71442
|
+
responses: {
|
|
71443
|
+
/** List of order changes retrieved. */
|
|
71444
|
+
200: {
|
|
71445
|
+
headers: {};
|
|
71446
|
+
content: {
|
|
71447
|
+
"application/json": storefrontComponents["schemas"]["StorefrontOrderChange"][];
|
|
71448
|
+
};
|
|
71449
|
+
};
|
|
71450
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
71451
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
71452
|
+
};
|
|
71453
|
+
};
|
|
71454
|
+
/**
|
|
71455
|
+
* Cancels a pending change to the items of an order of the customer.
|
|
71456
|
+
* The current items of the order stay as they are.
|
|
71457
|
+
* A change cannot be canceled after it is locked by an issued invoice, applied, canceled, or superseded.
|
|
71458
|
+
*/
|
|
71459
|
+
StorefrontDeleteOrderChange: {
|
|
71460
|
+
parameters: {
|
|
71461
|
+
path: {
|
|
71462
|
+
/** ID of the resource. */
|
|
71463
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
71464
|
+
};
|
|
71465
|
+
};
|
|
71466
|
+
responses: {
|
|
71467
|
+
/** Order change canceled. */
|
|
71468
|
+
204: never;
|
|
71469
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
71470
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
71471
|
+
404: storefrontComponents["responses"]["NotFound"];
|
|
71472
|
+
409: storefrontComponents["responses"]["Conflict"];
|
|
71473
|
+
429: storefrontComponents["responses"]["TooManyRequests"];
|
|
71474
|
+
};
|
|
71475
|
+
};
|
|
71282
71476
|
/**
|
|
71283
71477
|
* Creates a quote for requested reactivation.
|
|
71284
71478
|
* The quote invoice includes items from outstanding unpaid and past-due invoices for the related order.
|
|
@@ -93531,6 +93725,59 @@ export interface reportsComponents {
|
|
|
93531
93725
|
invoice?: { [key: string]: any };
|
|
93532
93726
|
};
|
|
93533
93727
|
};
|
|
93728
|
+
/**
|
|
93729
|
+
* Change to the items of a recurring order of the customer.
|
|
93730
|
+
* A change with `applyAt` set to `nextRenewal` records the new items and applies them at the next renewal.
|
|
93731
|
+
* The current items remain until the next renewal, when the new items are applied and billed on the renewal invoice.
|
|
93732
|
+
*/
|
|
93733
|
+
StorefrontOrderChange: {
|
|
93734
|
+
/** ID of the order change. */
|
|
93735
|
+
id: string;
|
|
93736
|
+
/** ID of the order. */
|
|
93737
|
+
orderId: string;
|
|
93738
|
+
/** Status of the order change. */
|
|
93739
|
+
status: "pending" | "applied" | "canceled" | "superseded";
|
|
93740
|
+
/**
|
|
93741
|
+
* Time when the new items are applied.
|
|
93742
|
+
*
|
|
93743
|
+
* - `now`: The items change immediately.
|
|
93744
|
+
* - `nextRenewal`: The current items stay until the next renewal.
|
|
93745
|
+
* The new items are billed on the next renewal invoice.
|
|
93746
|
+
* To cancel a pending change, use the `DELETE /storefront/order-changes/{id}` operation.
|
|
93747
|
+
*/
|
|
93748
|
+
applyAt: "now" | "nextRenewal";
|
|
93749
|
+
/**
|
|
93750
|
+
* Date and time when the change is applied.
|
|
93751
|
+
* If `applyAt` is set to `nextRenewal`, this value equals the renewal time of the order.
|
|
93752
|
+
*/
|
|
93753
|
+
effectiveTime: string;
|
|
93754
|
+
/**
|
|
93755
|
+
* Date and time when the items of a pending change are billed.
|
|
93756
|
+
* After this time, the change is locked and cannot be modified until the renewal.
|
|
93757
|
+
*/
|
|
93758
|
+
lockedTime?: string | null;
|
|
93759
|
+
/** Date and time when the items of the order are replaced. */
|
|
93760
|
+
appliedTime?: string | null;
|
|
93761
|
+
/**
|
|
93762
|
+
* ID of the quote that is used to create the change.
|
|
93763
|
+
* This value is `null` if the change is not created from a quote.
|
|
93764
|
+
*/
|
|
93765
|
+
quoteId?: string | null;
|
|
93766
|
+
/** New items for the order. */
|
|
93767
|
+
items: {
|
|
93768
|
+
/** Plan details. */
|
|
93769
|
+
plan:
|
|
93770
|
+
| reportsComponents["schemas"]["OriginalPlan"]
|
|
93771
|
+
| reportsComponents["schemas"]["FlexiblePlan"];
|
|
93772
|
+
/** Number of units of the product on the given plan. */
|
|
93773
|
+
quantity?: number;
|
|
93774
|
+
usageLimits?: reportsComponents["schemas"]["UsageLimits"] | null;
|
|
93775
|
+
/** Specifies if this item is excluded from monthly recurring revenue calculations. */
|
|
93776
|
+
excludeFromMrr?: boolean | null;
|
|
93777
|
+
}[];
|
|
93778
|
+
createdTime: reportsComponents["schemas"]["CreatedTime"];
|
|
93779
|
+
updatedTime: reportsComponents["schemas"]["UpdatedTime"];
|
|
93780
|
+
};
|
|
93534
93781
|
/** Reactivate customer subscription. */
|
|
93535
93782
|
PostSubscriptionReactivation: {
|
|
93536
93783
|
/** ID of the order associated with the reactivation quote. */
|
|
@@ -100786,6 +101033,11 @@ declare module "rebilly-js-sdk" {
|
|
|
100786
101033
|
export type StorefrontCreateSubscriptionItemsChangeRequest = rebilly.StorefrontCreateSubscriptionItemsChangeRequest;
|
|
100787
101034
|
export type StorefrontPostSubscriptionItemsChangeResponse = rebilly.StorefrontPostSubscriptionItemsChangeResponse;
|
|
100788
101035
|
export type StorefrontPostSubscriptionItemsChangeResponsePromise = rebilly.StorefrontPostSubscriptionItemsChangeResponsePromise;
|
|
101036
|
+
export type StorefrontGetOrderChangeCollectionRequest = rebilly.StorefrontGetOrderChangeCollectionRequest;
|
|
101037
|
+
export type StorefrontGetOrderChangeCollectionResponse = rebilly.StorefrontGetOrderChangeCollectionResponse;
|
|
101038
|
+
export type StorefrontGetOrderChangeCollectionResponsePromise = rebilly.StorefrontGetOrderChangeCollectionResponsePromise;
|
|
101039
|
+
export type StorefrontDeleteOrderChangeResponse = rebilly.StorefrontDeleteOrderChangeResponse;
|
|
101040
|
+
export type StorefrontDeleteOrderChangeResponsePromise = rebilly.StorefrontDeleteOrderChangeResponsePromise;
|
|
100789
101041
|
export type StorefrontPostSubscriptionReactivationRequest = rebilly.StorefrontPostSubscriptionReactivationRequest;
|
|
100790
101042
|
export type StorefrontCreateSubscriptionReactivationRequest = rebilly.StorefrontCreateSubscriptionReactivationRequest;
|
|
100791
101043
|
export type StorefrontPostSubscriptionReactivationResponse = rebilly.StorefrontPostSubscriptionReactivationResponse;
|
|
@@ -105671,6 +105923,16 @@ declare module "resources/storefront/kyc-requests-resource" {
|
|
|
105671
105923
|
}): rebilly.StorefrontGetKycRequestResponsePromise;
|
|
105672
105924
|
};
|
|
105673
105925
|
}
|
|
105926
|
+
declare module "resources/storefront/order-changes-resource" {
|
|
105927
|
+
export default function OrderChangesResource({ apiHandler }: {
|
|
105928
|
+
apiHandler: any;
|
|
105929
|
+
}): {
|
|
105930
|
+
getAll({ limit, offset, filter }?: rebilly.StorefrontGetOrderChangeCollectionRequest): rebilly.StorefrontGetOrderChangeCollectionResponsePromise;
|
|
105931
|
+
delete({ id }: {
|
|
105932
|
+
id: any;
|
|
105933
|
+
}): any;
|
|
105934
|
+
};
|
|
105935
|
+
}
|
|
105674
105936
|
declare module "resources/storefront/orders-resource" {
|
|
105675
105937
|
export default function OrdersResource({ apiHandler }: {
|
|
105676
105938
|
apiHandler: any;
|
|
@@ -105998,6 +106260,12 @@ declare module "resources/storefront/storefront-api-instance" {
|
|
|
105998
106260
|
expand?: any;
|
|
105999
106261
|
}): rebilly.StorefrontGetKycRequestResponsePromise;
|
|
106000
106262
|
};
|
|
106263
|
+
orderChanges: {
|
|
106264
|
+
getAll({ limit, offset, filter }?: rebilly.StorefrontGetOrderChangeCollectionRequest): rebilly.StorefrontGetOrderChangeCollectionResponsePromise;
|
|
106265
|
+
delete({ id }: {
|
|
106266
|
+
id: any;
|
|
106267
|
+
}): any;
|
|
106268
|
+
};
|
|
106001
106269
|
orders: {
|
|
106002
106270
|
getUpcomingInvoice({ id, expand }: {
|
|
106003
106271
|
id: any;
|
|
@@ -2141,6 +2141,14 @@ declare namespace rebilly {
|
|
|
2141
2141
|
type StorefrontPostSubscriptionItemsChangeResponse = operations['StorefrontPostSubscriptionItemsChange']['responses']['201']['content']['application/json']
|
|
2142
2142
|
type StorefrontPostSubscriptionItemsChangeResponsePromise = Promise<{fields: StorefrontPostSubscriptionItemsChangeResponse}>
|
|
2143
2143
|
|
|
2144
|
+
type StorefrontGetOrderChangeCollectionRequest = operations['StorefrontGetOrderChangeCollection']['parameters']["query"] & (operations['StorefrontGetOrderChangeCollection']['parameters'] extends {path: {}} ? operations['StorefrontGetOrderChangeCollection']['parameters']["path"] : {})
|
|
2145
|
+
|
|
2146
|
+
type StorefrontGetOrderChangeCollectionResponse = operations['StorefrontGetOrderChangeCollection']['responses']['200']['content']['application/json'][0]
|
|
2147
|
+
type StorefrontGetOrderChangeCollectionResponsePromise = Promise<{ items: {fields: StorefrontGetOrderChangeCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
2148
|
+
|
|
2149
|
+
type StorefrontDeleteOrderChangeResponse = operations['StorefrontDeleteOrderChange']['responses']['204']
|
|
2150
|
+
type StorefrontDeleteOrderChangeResponsePromise = Promise<{fields: StorefrontDeleteOrderChangeResponse}>
|
|
2151
|
+
|
|
2144
2152
|
type StorefrontPostSubscriptionReactivationRequest = operations['StorefrontPostSubscriptionReactivation']['requestBody']['content']['application/json']
|
|
2145
2153
|
type StorefrontCreateSubscriptionReactivationRequest = { id?: string, data: StorefrontPostSubscriptionReactivationRequest, expand?: string }
|
|
2146
2154
|
type StorefrontPostSubscriptionReactivationResponse = operations['StorefrontPostSubscriptionReactivation']['responses']['201']['content']['application/json']
|
|
@@ -26945,6 +26953,59 @@ export interface coreComponents {
|
|
|
26945
26953
|
invoice?: { [key: string]: any };
|
|
26946
26954
|
};
|
|
26947
26955
|
};
|
|
26956
|
+
/**
|
|
26957
|
+
* Change to the items of a recurring order of the customer.
|
|
26958
|
+
* A change with `applyAt` set to `nextRenewal` records the new items and applies them at the next renewal.
|
|
26959
|
+
* The current items remain until the next renewal, when the new items are applied and billed on the renewal invoice.
|
|
26960
|
+
*/
|
|
26961
|
+
StorefrontOrderChange: {
|
|
26962
|
+
/** ID of the order change. */
|
|
26963
|
+
id: string;
|
|
26964
|
+
/** ID of the order. */
|
|
26965
|
+
orderId: string;
|
|
26966
|
+
/** Status of the order change. */
|
|
26967
|
+
status: "pending" | "applied" | "canceled" | "superseded";
|
|
26968
|
+
/**
|
|
26969
|
+
* Time when the new items are applied.
|
|
26970
|
+
*
|
|
26971
|
+
* - `now`: The items change immediately.
|
|
26972
|
+
* - `nextRenewal`: The current items stay until the next renewal.
|
|
26973
|
+
* The new items are billed on the next renewal invoice.
|
|
26974
|
+
* To cancel a pending change, use the `DELETE /storefront/order-changes/{id}` operation.
|
|
26975
|
+
*/
|
|
26976
|
+
applyAt: "now" | "nextRenewal";
|
|
26977
|
+
/**
|
|
26978
|
+
* Date and time when the change is applied.
|
|
26979
|
+
* If `applyAt` is set to `nextRenewal`, this value equals the renewal time of the order.
|
|
26980
|
+
*/
|
|
26981
|
+
effectiveTime: string;
|
|
26982
|
+
/**
|
|
26983
|
+
* Date and time when the items of a pending change are billed.
|
|
26984
|
+
* After this time, the change is locked and cannot be modified until the renewal.
|
|
26985
|
+
*/
|
|
26986
|
+
lockedTime?: string | null;
|
|
26987
|
+
/** Date and time when the items of the order are replaced. */
|
|
26988
|
+
appliedTime?: string | null;
|
|
26989
|
+
/**
|
|
26990
|
+
* ID of the quote that is used to create the change.
|
|
26991
|
+
* This value is `null` if the change is not created from a quote.
|
|
26992
|
+
*/
|
|
26993
|
+
quoteId?: string | null;
|
|
26994
|
+
/** New items for the order. */
|
|
26995
|
+
items: {
|
|
26996
|
+
/** Plan details. */
|
|
26997
|
+
plan:
|
|
26998
|
+
| coreComponents["schemas"]["OriginalPlan"]
|
|
26999
|
+
| coreComponents["schemas"]["FlexiblePlan"];
|
|
27000
|
+
/** Number of units of the product on the given plan. */
|
|
27001
|
+
quantity?: number;
|
|
27002
|
+
usageLimits?: coreComponents["schemas"]["UsageLimits"] | null;
|
|
27003
|
+
/** Specifies if this item is excluded from monthly recurring revenue calculations. */
|
|
27004
|
+
excludeFromMrr?: boolean | null;
|
|
27005
|
+
}[];
|
|
27006
|
+
createdTime: coreComponents["schemas"]["CreatedTime"];
|
|
27007
|
+
updatedTime: coreComponents["schemas"]["UpdatedTime"];
|
|
27008
|
+
};
|
|
26948
27009
|
/** Reactivate customer subscription. */
|
|
26949
27010
|
PostSubscriptionReactivation: {
|
|
26950
27011
|
/** ID of the order associated with the reactivation quote. */
|
|
@@ -45274,6 +45335,27 @@ export interface storefrontPaths {
|
|
|
45274
45335
|
};
|
|
45275
45336
|
};
|
|
45276
45337
|
};
|
|
45338
|
+
"/order-changes": {
|
|
45339
|
+
/**
|
|
45340
|
+
* Retrieves a list of changes to the items of the orders of the customer.
|
|
45341
|
+
* To find the pending change of an order, use `filter=orderId:{orderId};status:pending`.
|
|
45342
|
+
*/
|
|
45343
|
+
get: operations["StorefrontGetOrderChangeCollection"];
|
|
45344
|
+
};
|
|
45345
|
+
"/order-changes/{id}": {
|
|
45346
|
+
/**
|
|
45347
|
+
* Cancels a pending change to the items of an order of the customer.
|
|
45348
|
+
* The current items of the order stay as they are.
|
|
45349
|
+
* A change cannot be canceled after it is locked by an issued invoice, applied, canceled, or superseded.
|
|
45350
|
+
*/
|
|
45351
|
+
delete: operations["StorefrontDeleteOrderChange"];
|
|
45352
|
+
parameters: {
|
|
45353
|
+
path: {
|
|
45354
|
+
/** ID of the resource. */
|
|
45355
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
45356
|
+
};
|
|
45357
|
+
};
|
|
45358
|
+
};
|
|
45277
45359
|
"/subscription-reactivations": {
|
|
45278
45360
|
/**
|
|
45279
45361
|
* Creates a quote for requested reactivation.
|
|
@@ -66615,6 +66697,59 @@ export interface storefrontComponents {
|
|
|
66615
66697
|
invoice?: { [key: string]: any };
|
|
66616
66698
|
};
|
|
66617
66699
|
};
|
|
66700
|
+
/**
|
|
66701
|
+
* Change to the items of a recurring order of the customer.
|
|
66702
|
+
* A change with `applyAt` set to `nextRenewal` records the new items and applies them at the next renewal.
|
|
66703
|
+
* The current items remain until the next renewal, when the new items are applied and billed on the renewal invoice.
|
|
66704
|
+
*/
|
|
66705
|
+
StorefrontOrderChange: {
|
|
66706
|
+
/** ID of the order change. */
|
|
66707
|
+
id: string;
|
|
66708
|
+
/** ID of the order. */
|
|
66709
|
+
orderId: string;
|
|
66710
|
+
/** Status of the order change. */
|
|
66711
|
+
status: "pending" | "applied" | "canceled" | "superseded";
|
|
66712
|
+
/**
|
|
66713
|
+
* Time when the new items are applied.
|
|
66714
|
+
*
|
|
66715
|
+
* - `now`: The items change immediately.
|
|
66716
|
+
* - `nextRenewal`: The current items stay until the next renewal.
|
|
66717
|
+
* The new items are billed on the next renewal invoice.
|
|
66718
|
+
* To cancel a pending change, use the `DELETE /storefront/order-changes/{id}` operation.
|
|
66719
|
+
*/
|
|
66720
|
+
applyAt: "now" | "nextRenewal";
|
|
66721
|
+
/**
|
|
66722
|
+
* Date and time when the change is applied.
|
|
66723
|
+
* If `applyAt` is set to `nextRenewal`, this value equals the renewal time of the order.
|
|
66724
|
+
*/
|
|
66725
|
+
effectiveTime: string;
|
|
66726
|
+
/**
|
|
66727
|
+
* Date and time when the items of a pending change are billed.
|
|
66728
|
+
* After this time, the change is locked and cannot be modified until the renewal.
|
|
66729
|
+
*/
|
|
66730
|
+
lockedTime?: string | null;
|
|
66731
|
+
/** Date and time when the items of the order are replaced. */
|
|
66732
|
+
appliedTime?: string | null;
|
|
66733
|
+
/**
|
|
66734
|
+
* ID of the quote that is used to create the change.
|
|
66735
|
+
* This value is `null` if the change is not created from a quote.
|
|
66736
|
+
*/
|
|
66737
|
+
quoteId?: string | null;
|
|
66738
|
+
/** New items for the order. */
|
|
66739
|
+
items: {
|
|
66740
|
+
/** Plan details. */
|
|
66741
|
+
plan:
|
|
66742
|
+
| storefrontComponents["schemas"]["OriginalPlan"]
|
|
66743
|
+
| storefrontComponents["schemas"]["FlexiblePlan"];
|
|
66744
|
+
/** Number of units of the product on the given plan. */
|
|
66745
|
+
quantity?: number;
|
|
66746
|
+
usageLimits?: storefrontComponents["schemas"]["UsageLimits"] | null;
|
|
66747
|
+
/** Specifies if this item is excluded from monthly recurring revenue calculations. */
|
|
66748
|
+
excludeFromMrr?: boolean | null;
|
|
66749
|
+
}[];
|
|
66750
|
+
createdTime: storefrontComponents["schemas"]["CreatedTime"];
|
|
66751
|
+
updatedTime: storefrontComponents["schemas"]["UpdatedTime"];
|
|
66752
|
+
};
|
|
66618
66753
|
/** Reactivate customer subscription. */
|
|
66619
66754
|
PostSubscriptionReactivation: {
|
|
66620
66755
|
/** ID of the order associated with the reactivation quote. */
|
|
@@ -71279,6 +71414,65 @@ export interface operations {
|
|
|
71279
71414
|
};
|
|
71280
71415
|
};
|
|
71281
71416
|
};
|
|
71417
|
+
/**
|
|
71418
|
+
* Retrieves a list of changes to the items of the orders of the customer.
|
|
71419
|
+
* To find the pending change of an order, use `filter=orderId:{orderId};status:pending`.
|
|
71420
|
+
*/
|
|
71421
|
+
StorefrontGetOrderChangeCollection: {
|
|
71422
|
+
parameters: {
|
|
71423
|
+
query: {
|
|
71424
|
+
/**
|
|
71425
|
+
* Limit the number of collection items to be returned.
|
|
71426
|
+
* Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
|
|
71427
|
+
*/
|
|
71428
|
+
limit?: storefrontComponents["parameters"]["collectionLimit"];
|
|
71429
|
+
/** Specifies the starting point within the collection of items to be returned. */
|
|
71430
|
+
offset?: storefrontComponents["parameters"]["collectionOffset"];
|
|
71431
|
+
/**
|
|
71432
|
+
* Criteria for filtering collection items.
|
|
71433
|
+
* This field requires a special format.
|
|
71434
|
+
* Use `,` to specify multiple allowed values.
|
|
71435
|
+
* Use `;` to specify multiple fields.
|
|
71436
|
+
*
|
|
71437
|
+
* For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).
|
|
71438
|
+
*/
|
|
71439
|
+
filter?: storefrontComponents["parameters"]["collectionFilter"];
|
|
71440
|
+
};
|
|
71441
|
+
};
|
|
71442
|
+
responses: {
|
|
71443
|
+
/** List of order changes retrieved. */
|
|
71444
|
+
200: {
|
|
71445
|
+
headers: {};
|
|
71446
|
+
content: {
|
|
71447
|
+
"application/json": storefrontComponents["schemas"]["StorefrontOrderChange"][];
|
|
71448
|
+
};
|
|
71449
|
+
};
|
|
71450
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
71451
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
71452
|
+
};
|
|
71453
|
+
};
|
|
71454
|
+
/**
|
|
71455
|
+
* Cancels a pending change to the items of an order of the customer.
|
|
71456
|
+
* The current items of the order stay as they are.
|
|
71457
|
+
* A change cannot be canceled after it is locked by an issued invoice, applied, canceled, or superseded.
|
|
71458
|
+
*/
|
|
71459
|
+
StorefrontDeleteOrderChange: {
|
|
71460
|
+
parameters: {
|
|
71461
|
+
path: {
|
|
71462
|
+
/** ID of the resource. */
|
|
71463
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
71464
|
+
};
|
|
71465
|
+
};
|
|
71466
|
+
responses: {
|
|
71467
|
+
/** Order change canceled. */
|
|
71468
|
+
204: never;
|
|
71469
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
71470
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
71471
|
+
404: storefrontComponents["responses"]["NotFound"];
|
|
71472
|
+
409: storefrontComponents["responses"]["Conflict"];
|
|
71473
|
+
429: storefrontComponents["responses"]["TooManyRequests"];
|
|
71474
|
+
};
|
|
71475
|
+
};
|
|
71282
71476
|
/**
|
|
71283
71477
|
* Creates a quote for requested reactivation.
|
|
71284
71478
|
* The quote invoice includes items from outstanding unpaid and past-due invoices for the related order.
|
|
@@ -93531,6 +93725,59 @@ export interface reportsComponents {
|
|
|
93531
93725
|
invoice?: { [key: string]: any };
|
|
93532
93726
|
};
|
|
93533
93727
|
};
|
|
93728
|
+
/**
|
|
93729
|
+
* Change to the items of a recurring order of the customer.
|
|
93730
|
+
* A change with `applyAt` set to `nextRenewal` records the new items and applies them at the next renewal.
|
|
93731
|
+
* The current items remain until the next renewal, when the new items are applied and billed on the renewal invoice.
|
|
93732
|
+
*/
|
|
93733
|
+
StorefrontOrderChange: {
|
|
93734
|
+
/** ID of the order change. */
|
|
93735
|
+
id: string;
|
|
93736
|
+
/** ID of the order. */
|
|
93737
|
+
orderId: string;
|
|
93738
|
+
/** Status of the order change. */
|
|
93739
|
+
status: "pending" | "applied" | "canceled" | "superseded";
|
|
93740
|
+
/**
|
|
93741
|
+
* Time when the new items are applied.
|
|
93742
|
+
*
|
|
93743
|
+
* - `now`: The items change immediately.
|
|
93744
|
+
* - `nextRenewal`: The current items stay until the next renewal.
|
|
93745
|
+
* The new items are billed on the next renewal invoice.
|
|
93746
|
+
* To cancel a pending change, use the `DELETE /storefront/order-changes/{id}` operation.
|
|
93747
|
+
*/
|
|
93748
|
+
applyAt: "now" | "nextRenewal";
|
|
93749
|
+
/**
|
|
93750
|
+
* Date and time when the change is applied.
|
|
93751
|
+
* If `applyAt` is set to `nextRenewal`, this value equals the renewal time of the order.
|
|
93752
|
+
*/
|
|
93753
|
+
effectiveTime: string;
|
|
93754
|
+
/**
|
|
93755
|
+
* Date and time when the items of a pending change are billed.
|
|
93756
|
+
* After this time, the change is locked and cannot be modified until the renewal.
|
|
93757
|
+
*/
|
|
93758
|
+
lockedTime?: string | null;
|
|
93759
|
+
/** Date and time when the items of the order are replaced. */
|
|
93760
|
+
appliedTime?: string | null;
|
|
93761
|
+
/**
|
|
93762
|
+
* ID of the quote that is used to create the change.
|
|
93763
|
+
* This value is `null` if the change is not created from a quote.
|
|
93764
|
+
*/
|
|
93765
|
+
quoteId?: string | null;
|
|
93766
|
+
/** New items for the order. */
|
|
93767
|
+
items: {
|
|
93768
|
+
/** Plan details. */
|
|
93769
|
+
plan:
|
|
93770
|
+
| reportsComponents["schemas"]["OriginalPlan"]
|
|
93771
|
+
| reportsComponents["schemas"]["FlexiblePlan"];
|
|
93772
|
+
/** Number of units of the product on the given plan. */
|
|
93773
|
+
quantity?: number;
|
|
93774
|
+
usageLimits?: reportsComponents["schemas"]["UsageLimits"] | null;
|
|
93775
|
+
/** Specifies if this item is excluded from monthly recurring revenue calculations. */
|
|
93776
|
+
excludeFromMrr?: boolean | null;
|
|
93777
|
+
}[];
|
|
93778
|
+
createdTime: reportsComponents["schemas"]["CreatedTime"];
|
|
93779
|
+
updatedTime: reportsComponents["schemas"]["UpdatedTime"];
|
|
93780
|
+
};
|
|
93534
93781
|
/** Reactivate customer subscription. */
|
|
93535
93782
|
PostSubscriptionReactivation: {
|
|
93536
93783
|
/** ID of the order associated with the reactivation quote. */
|
|
@@ -100786,6 +101033,11 @@ declare module "rebilly-js-sdk" {
|
|
|
100786
101033
|
export type StorefrontCreateSubscriptionItemsChangeRequest = rebilly.StorefrontCreateSubscriptionItemsChangeRequest;
|
|
100787
101034
|
export type StorefrontPostSubscriptionItemsChangeResponse = rebilly.StorefrontPostSubscriptionItemsChangeResponse;
|
|
100788
101035
|
export type StorefrontPostSubscriptionItemsChangeResponsePromise = rebilly.StorefrontPostSubscriptionItemsChangeResponsePromise;
|
|
101036
|
+
export type StorefrontGetOrderChangeCollectionRequest = rebilly.StorefrontGetOrderChangeCollectionRequest;
|
|
101037
|
+
export type StorefrontGetOrderChangeCollectionResponse = rebilly.StorefrontGetOrderChangeCollectionResponse;
|
|
101038
|
+
export type StorefrontGetOrderChangeCollectionResponsePromise = rebilly.StorefrontGetOrderChangeCollectionResponsePromise;
|
|
101039
|
+
export type StorefrontDeleteOrderChangeResponse = rebilly.StorefrontDeleteOrderChangeResponse;
|
|
101040
|
+
export type StorefrontDeleteOrderChangeResponsePromise = rebilly.StorefrontDeleteOrderChangeResponsePromise;
|
|
100789
101041
|
export type StorefrontPostSubscriptionReactivationRequest = rebilly.StorefrontPostSubscriptionReactivationRequest;
|
|
100790
101042
|
export type StorefrontCreateSubscriptionReactivationRequest = rebilly.StorefrontCreateSubscriptionReactivationRequest;
|
|
100791
101043
|
export type StorefrontPostSubscriptionReactivationResponse = rebilly.StorefrontPostSubscriptionReactivationResponse;
|
|
@@ -105671,6 +105923,16 @@ declare module "resources/storefront/kyc-requests-resource" {
|
|
|
105671
105923
|
}): rebilly.StorefrontGetKycRequestResponsePromise;
|
|
105672
105924
|
};
|
|
105673
105925
|
}
|
|
105926
|
+
declare module "resources/storefront/order-changes-resource" {
|
|
105927
|
+
export default function OrderChangesResource({ apiHandler }: {
|
|
105928
|
+
apiHandler: any;
|
|
105929
|
+
}): {
|
|
105930
|
+
getAll({ limit, offset, filter }?: rebilly.StorefrontGetOrderChangeCollectionRequest): rebilly.StorefrontGetOrderChangeCollectionResponsePromise;
|
|
105931
|
+
delete({ id }: {
|
|
105932
|
+
id: any;
|
|
105933
|
+
}): any;
|
|
105934
|
+
};
|
|
105935
|
+
}
|
|
105674
105936
|
declare module "resources/storefront/orders-resource" {
|
|
105675
105937
|
export default function OrdersResource({ apiHandler }: {
|
|
105676
105938
|
apiHandler: any;
|
|
@@ -105998,6 +106260,12 @@ declare module "resources/storefront/storefront-api-instance" {
|
|
|
105998
106260
|
expand?: any;
|
|
105999
106261
|
}): rebilly.StorefrontGetKycRequestResponsePromise;
|
|
106000
106262
|
};
|
|
106263
|
+
orderChanges: {
|
|
106264
|
+
getAll({ limit, offset, filter }?: rebilly.StorefrontGetOrderChangeCollectionRequest): rebilly.StorefrontGetOrderChangeCollectionResponsePromise;
|
|
106265
|
+
delete({ id }: {
|
|
106266
|
+
id: any;
|
|
106267
|
+
}): any;
|
|
106268
|
+
};
|
|
106001
106269
|
orders: {
|
|
106002
106270
|
getUpcomingInvoice({ id, expand }: {
|
|
106003
106271
|
id: any;
|