rebilly-js-sdk 62.220.2 → 62.221.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 +1 -1
- package/dist/rebilly-js-sdk.d.cts +108 -54
- package/dist/rebilly-js-sdk.d.mts +108 -54
- package/dist/rebilly-js-sdk.d.ts +108 -54
- package/dist/rebilly-js-sdk.es.mjs +69 -72
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
- package/src/resources/files-resource.js +5 -8
package/CHANGELOG.md
CHANGED
|
@@ -6390,10 +6390,6 @@ export interface coreComponents {
|
|
|
6390
6390
|
/** Type of link. */
|
|
6391
6391
|
rel?: "self" | "file";
|
|
6392
6392
|
}[];
|
|
6393
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
6394
|
-
_embedded?: {
|
|
6395
|
-
file?: { [key: string]: any };
|
|
6396
|
-
};
|
|
6397
6393
|
};
|
|
6398
6394
|
Conflict: { [key: string]: any } & {
|
|
6399
6395
|
/** HTTP status code. */
|
|
@@ -17686,6 +17682,7 @@ export interface coreComponents {
|
|
|
17686
17682
|
| "pick-gateway-account"
|
|
17687
17683
|
| "remove-reminder"
|
|
17688
17684
|
| "request-kyc"
|
|
17685
|
+
| "request-physical-address"
|
|
17689
17686
|
| "reset-reminder"
|
|
17690
17687
|
| "schedule-invoice-retry"
|
|
17691
17688
|
| "schedule-payment"
|
|
@@ -17956,6 +17953,31 @@ export interface coreComponents {
|
|
|
17956
17953
|
/** Currency three letter code to display on the bypass link, if optional. */
|
|
17957
17954
|
bypassCurrencyToDisplay?: string;
|
|
17958
17955
|
};
|
|
17956
|
+
/**
|
|
17957
|
+
* Displays a Rebilly-hosted page where the customer can provide a street address and postal code before the payment is sent to the gateway.
|
|
17958
|
+
* The page is displayed only if the customer's primary address is a PO Box.
|
|
17959
|
+
* The submitted values are stored in the `referenceData` field of the transaction using the `physicalAddress` and `physicalAddressPostalCode` keys.
|
|
17960
|
+
* After the customer provides an address, the page is not displayed on their later payments.
|
|
17961
|
+
* If the customer skips this step, the page is displayed again on their next payment.
|
|
17962
|
+
*/
|
|
17963
|
+
RuleActionRequestPhysicalAddress: coreComponents["schemas"]["RuleAction"] & {
|
|
17964
|
+
/**
|
|
17965
|
+
* Text that is displayed above the form.
|
|
17966
|
+
* HTML is permitted.
|
|
17967
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
17968
|
+
*/
|
|
17969
|
+
instructionsText?: string | null;
|
|
17970
|
+
/**
|
|
17971
|
+
* Text of the button that the customer can press to submit the address.
|
|
17972
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
17973
|
+
*/
|
|
17974
|
+
buttonText?: string | null;
|
|
17975
|
+
/**
|
|
17976
|
+
* Text of the link that the customer can select to skip the address step and continue the payment without providing an address.
|
|
17977
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
17978
|
+
*/
|
|
17979
|
+
skipLinkText?: string | null;
|
|
17980
|
+
};
|
|
17959
17981
|
/** Schedule an invoice retry. */
|
|
17960
17982
|
RuleActionScheduleInvoiceRetry: coreComponents["schemas"]["RuleAction"] & {
|
|
17961
17983
|
/** Describes the retry instruction. */
|
|
@@ -28638,14 +28660,6 @@ export interface coreComponents {
|
|
|
28638
28660
|
collectionQuery: string;
|
|
28639
28661
|
/** ID of the resource. */
|
|
28640
28662
|
resourceId: string;
|
|
28641
|
-
/**
|
|
28642
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
28643
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
28644
|
-
*
|
|
28645
|
-
* For more information, see
|
|
28646
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
28647
|
-
*/
|
|
28648
|
-
collectionExpand: string;
|
|
28649
28663
|
/**
|
|
28650
28664
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
28651
28665
|
* The ID value is always returned.
|
|
@@ -28663,6 +28677,14 @@ export interface coreComponents {
|
|
|
28663
28677
|
| "plans"
|
|
28664
28678
|
| "gateway-accounts"
|
|
28665
28679
|
| "deposit-requests";
|
|
28680
|
+
/**
|
|
28681
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
28682
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
28683
|
+
*
|
|
28684
|
+
* For more information, see
|
|
28685
|
+
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
28686
|
+
*/
|
|
28687
|
+
collectionExpand: string;
|
|
28666
28688
|
/** Type of resource. */
|
|
28667
28689
|
externalIdentifierResource:
|
|
28668
28690
|
| "customers"
|
|
@@ -31284,14 +31306,6 @@ export interface operations {
|
|
|
31284
31306
|
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
31285
31307
|
/** Use this field to perform a partial search of text fields. */
|
|
31286
31308
|
q?: coreComponents["parameters"]["collectionQuery"];
|
|
31287
|
-
/**
|
|
31288
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
31289
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
31290
|
-
*
|
|
31291
|
-
* For more information, see
|
|
31292
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
31293
|
-
*/
|
|
31294
|
-
expand?: coreComponents["parameters"]["collectionExpand"];
|
|
31295
31309
|
/**
|
|
31296
31310
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
31297
31311
|
* The ID value is always returned.
|
|
@@ -46329,10 +46343,6 @@ export interface storefrontComponents {
|
|
|
46329
46343
|
/** Type of link. */
|
|
46330
46344
|
rel?: "self" | "file";
|
|
46331
46345
|
}[];
|
|
46332
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
46333
|
-
_embedded?: {
|
|
46334
|
-
file?: { [key: string]: any };
|
|
46335
|
-
};
|
|
46336
46346
|
};
|
|
46337
46347
|
Conflict: { [key: string]: any } & {
|
|
46338
46348
|
/** HTTP status code. */
|
|
@@ -57625,6 +57635,7 @@ export interface storefrontComponents {
|
|
|
57625
57635
|
| "pick-gateway-account"
|
|
57626
57636
|
| "remove-reminder"
|
|
57627
57637
|
| "request-kyc"
|
|
57638
|
+
| "request-physical-address"
|
|
57628
57639
|
| "reset-reminder"
|
|
57629
57640
|
| "schedule-invoice-retry"
|
|
57630
57641
|
| "schedule-payment"
|
|
@@ -57895,6 +57906,31 @@ export interface storefrontComponents {
|
|
|
57895
57906
|
/** Currency three letter code to display on the bypass link, if optional. */
|
|
57896
57907
|
bypassCurrencyToDisplay?: string;
|
|
57897
57908
|
};
|
|
57909
|
+
/**
|
|
57910
|
+
* Displays a Rebilly-hosted page where the customer can provide a street address and postal code before the payment is sent to the gateway.
|
|
57911
|
+
* The page is displayed only if the customer's primary address is a PO Box.
|
|
57912
|
+
* The submitted values are stored in the `referenceData` field of the transaction using the `physicalAddress` and `physicalAddressPostalCode` keys.
|
|
57913
|
+
* After the customer provides an address, the page is not displayed on their later payments.
|
|
57914
|
+
* If the customer skips this step, the page is displayed again on their next payment.
|
|
57915
|
+
*/
|
|
57916
|
+
RuleActionRequestPhysicalAddress: storefrontComponents["schemas"]["RuleAction"] & {
|
|
57917
|
+
/**
|
|
57918
|
+
* Text that is displayed above the form.
|
|
57919
|
+
* HTML is permitted.
|
|
57920
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
57921
|
+
*/
|
|
57922
|
+
instructionsText?: string | null;
|
|
57923
|
+
/**
|
|
57924
|
+
* Text of the button that the customer can press to submit the address.
|
|
57925
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
57926
|
+
*/
|
|
57927
|
+
buttonText?: string | null;
|
|
57928
|
+
/**
|
|
57929
|
+
* Text of the link that the customer can select to skip the address step and continue the payment without providing an address.
|
|
57930
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
57931
|
+
*/
|
|
57932
|
+
skipLinkText?: string | null;
|
|
57933
|
+
};
|
|
57898
57934
|
/** Schedule an invoice retry. */
|
|
57899
57935
|
RuleActionScheduleInvoiceRetry: storefrontComponents["schemas"]["RuleAction"] & {
|
|
57900
57936
|
/** Describes the retry instruction. */
|
|
@@ -68577,14 +68613,6 @@ export interface storefrontComponents {
|
|
|
68577
68613
|
collectionQuery: string;
|
|
68578
68614
|
/** ID of the resource. */
|
|
68579
68615
|
resourceId: string;
|
|
68580
|
-
/**
|
|
68581
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
68582
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
68583
|
-
*
|
|
68584
|
-
* For more information, see
|
|
68585
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
68586
|
-
*/
|
|
68587
|
-
collectionExpand: string;
|
|
68588
68616
|
/**
|
|
68589
68617
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
68590
68618
|
* The ID value is always returned.
|
|
@@ -68602,6 +68630,14 @@ export interface storefrontComponents {
|
|
|
68602
68630
|
| "plans"
|
|
68603
68631
|
| "gateway-accounts"
|
|
68604
68632
|
| "deposit-requests";
|
|
68633
|
+
/**
|
|
68634
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
68635
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
68636
|
+
*
|
|
68637
|
+
* For more information, see
|
|
68638
|
+
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
68639
|
+
*/
|
|
68640
|
+
collectionExpand: string;
|
|
68605
68641
|
/** Type of resource. */
|
|
68606
68642
|
externalIdentifierResource:
|
|
68607
68643
|
| "customers"
|
|
@@ -73588,10 +73624,6 @@ export interface reportsComponents {
|
|
|
73588
73624
|
/** Type of link. */
|
|
73589
73625
|
rel?: "self" | "file";
|
|
73590
73626
|
}[];
|
|
73591
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
73592
|
-
_embedded?: {
|
|
73593
|
-
file?: { [key: string]: any };
|
|
73594
|
-
};
|
|
73595
73627
|
};
|
|
73596
73628
|
Conflict: { [key: string]: any } & {
|
|
73597
73629
|
/** HTTP status code. */
|
|
@@ -84884,6 +84916,7 @@ export interface reportsComponents {
|
|
|
84884
84916
|
| "pick-gateway-account"
|
|
84885
84917
|
| "remove-reminder"
|
|
84886
84918
|
| "request-kyc"
|
|
84919
|
+
| "request-physical-address"
|
|
84887
84920
|
| "reset-reminder"
|
|
84888
84921
|
| "schedule-invoice-retry"
|
|
84889
84922
|
| "schedule-payment"
|
|
@@ -85154,6 +85187,31 @@ export interface reportsComponents {
|
|
|
85154
85187
|
/** Currency three letter code to display on the bypass link, if optional. */
|
|
85155
85188
|
bypassCurrencyToDisplay?: string;
|
|
85156
85189
|
};
|
|
85190
|
+
/**
|
|
85191
|
+
* Displays a Rebilly-hosted page where the customer can provide a street address and postal code before the payment is sent to the gateway.
|
|
85192
|
+
* The page is displayed only if the customer's primary address is a PO Box.
|
|
85193
|
+
* The submitted values are stored in the `referenceData` field of the transaction using the `physicalAddress` and `physicalAddressPostalCode` keys.
|
|
85194
|
+
* After the customer provides an address, the page is not displayed on their later payments.
|
|
85195
|
+
* If the customer skips this step, the page is displayed again on their next payment.
|
|
85196
|
+
*/
|
|
85197
|
+
RuleActionRequestPhysicalAddress: reportsComponents["schemas"]["RuleAction"] & {
|
|
85198
|
+
/**
|
|
85199
|
+
* Text that is displayed above the form.
|
|
85200
|
+
* HTML is permitted.
|
|
85201
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
85202
|
+
*/
|
|
85203
|
+
instructionsText?: string | null;
|
|
85204
|
+
/**
|
|
85205
|
+
* Text of the button that the customer can press to submit the address.
|
|
85206
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
85207
|
+
*/
|
|
85208
|
+
buttonText?: string | null;
|
|
85209
|
+
/**
|
|
85210
|
+
* Text of the link that the customer can select to skip the address step and continue the payment without providing an address.
|
|
85211
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
85212
|
+
*/
|
|
85213
|
+
skipLinkText?: string | null;
|
|
85214
|
+
};
|
|
85157
85215
|
/** Schedule an invoice retry. */
|
|
85158
85216
|
RuleActionScheduleInvoiceRetry: reportsComponents["schemas"]["RuleAction"] & {
|
|
85159
85217
|
/** Describes the retry instruction. */
|
|
@@ -95836,14 +95894,6 @@ export interface reportsComponents {
|
|
|
95836
95894
|
collectionQuery: string;
|
|
95837
95895
|
/** ID of the resource. */
|
|
95838
95896
|
resourceId: string;
|
|
95839
|
-
/**
|
|
95840
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
95841
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
95842
|
-
*
|
|
95843
|
-
* For more information, see
|
|
95844
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
95845
|
-
*/
|
|
95846
|
-
collectionExpand: string;
|
|
95847
95897
|
/**
|
|
95848
95898
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
95849
95899
|
* The ID value is always returned.
|
|
@@ -95861,6 +95911,14 @@ export interface reportsComponents {
|
|
|
95861
95911
|
| "plans"
|
|
95862
95912
|
| "gateway-accounts"
|
|
95863
95913
|
| "deposit-requests";
|
|
95914
|
+
/**
|
|
95915
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
95916
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
95917
|
+
*
|
|
95918
|
+
* For more information, see
|
|
95919
|
+
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
95920
|
+
*/
|
|
95921
|
+
collectionExpand: string;
|
|
95864
95922
|
/** Type of resource. */
|
|
95865
95923
|
externalIdentifierResource:
|
|
95866
95924
|
| "customers"
|
|
@@ -102805,19 +102863,17 @@ declare module "resources/files-resource" {
|
|
|
102805
102863
|
export default function FilesResource({ apiHandler }: {
|
|
102806
102864
|
apiHandler: any;
|
|
102807
102865
|
}): {
|
|
102808
|
-
getAllAttachments({ limit, offset, filter, q,
|
|
102809
|
-
attach({ id, data
|
|
102866
|
+
getAllAttachments({ limit, offset, filter, q, fields, sort, }?: rebilly.GetAttachmentCollectionRequest): rebilly.GetAttachmentCollectionResponsePromise;
|
|
102867
|
+
attach({ id, data }: {
|
|
102810
102868
|
id?: string;
|
|
102811
102869
|
data: any;
|
|
102812
|
-
expand?: any;
|
|
102813
102870
|
}): rebilly.PostAttachmentResponsePromise;
|
|
102814
102871
|
getAttachment({ id }: {
|
|
102815
102872
|
id: any;
|
|
102816
102873
|
}): rebilly.GetAttachmentResponsePromise;
|
|
102817
|
-
updateAttachment({ id, data
|
|
102874
|
+
updateAttachment({ id, data }: {
|
|
102818
102875
|
id: any;
|
|
102819
102876
|
data: any;
|
|
102820
|
-
expand?: any;
|
|
102821
102877
|
}): rebilly.PutAttachmentResponsePromise;
|
|
102822
102878
|
detach({ id }: {
|
|
102823
102879
|
id: any;
|
|
@@ -104696,19 +104752,17 @@ declare module "resources/api-instance" {
|
|
|
104696
104752
|
}): any;
|
|
104697
104753
|
};
|
|
104698
104754
|
files: {
|
|
104699
|
-
getAllAttachments({ limit, offset, filter, q,
|
|
104700
|
-
attach({ id, data
|
|
104755
|
+
getAllAttachments({ limit, offset, filter, q, fields, sort, }?: rebilly.GetAttachmentCollectionRequest): rebilly.GetAttachmentCollectionResponsePromise;
|
|
104756
|
+
attach({ id, data }: {
|
|
104701
104757
|
id?: string;
|
|
104702
104758
|
data: any;
|
|
104703
|
-
expand?: any;
|
|
104704
104759
|
}): rebilly.PostAttachmentResponsePromise;
|
|
104705
104760
|
getAttachment({ id }: {
|
|
104706
104761
|
id: any;
|
|
104707
104762
|
}): rebilly.GetAttachmentResponsePromise;
|
|
104708
|
-
updateAttachment({ id, data
|
|
104763
|
+
updateAttachment({ id, data }: {
|
|
104709
104764
|
id: any;
|
|
104710
104765
|
data: any;
|
|
104711
|
-
expand?: any;
|
|
104712
104766
|
}): rebilly.PutAttachmentResponsePromise;
|
|
104713
104767
|
detach({ id }: {
|
|
104714
104768
|
id: any;
|
|
@@ -6390,10 +6390,6 @@ export interface coreComponents {
|
|
|
6390
6390
|
/** Type of link. */
|
|
6391
6391
|
rel?: "self" | "file";
|
|
6392
6392
|
}[];
|
|
6393
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
6394
|
-
_embedded?: {
|
|
6395
|
-
file?: { [key: string]: any };
|
|
6396
|
-
};
|
|
6397
6393
|
};
|
|
6398
6394
|
Conflict: { [key: string]: any } & {
|
|
6399
6395
|
/** HTTP status code. */
|
|
@@ -17686,6 +17682,7 @@ export interface coreComponents {
|
|
|
17686
17682
|
| "pick-gateway-account"
|
|
17687
17683
|
| "remove-reminder"
|
|
17688
17684
|
| "request-kyc"
|
|
17685
|
+
| "request-physical-address"
|
|
17689
17686
|
| "reset-reminder"
|
|
17690
17687
|
| "schedule-invoice-retry"
|
|
17691
17688
|
| "schedule-payment"
|
|
@@ -17956,6 +17953,31 @@ export interface coreComponents {
|
|
|
17956
17953
|
/** Currency three letter code to display on the bypass link, if optional. */
|
|
17957
17954
|
bypassCurrencyToDisplay?: string;
|
|
17958
17955
|
};
|
|
17956
|
+
/**
|
|
17957
|
+
* Displays a Rebilly-hosted page where the customer can provide a street address and postal code before the payment is sent to the gateway.
|
|
17958
|
+
* The page is displayed only if the customer's primary address is a PO Box.
|
|
17959
|
+
* The submitted values are stored in the `referenceData` field of the transaction using the `physicalAddress` and `physicalAddressPostalCode` keys.
|
|
17960
|
+
* After the customer provides an address, the page is not displayed on their later payments.
|
|
17961
|
+
* If the customer skips this step, the page is displayed again on their next payment.
|
|
17962
|
+
*/
|
|
17963
|
+
RuleActionRequestPhysicalAddress: coreComponents["schemas"]["RuleAction"] & {
|
|
17964
|
+
/**
|
|
17965
|
+
* Text that is displayed above the form.
|
|
17966
|
+
* HTML is permitted.
|
|
17967
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
17968
|
+
*/
|
|
17969
|
+
instructionsText?: string | null;
|
|
17970
|
+
/**
|
|
17971
|
+
* Text of the button that the customer can press to submit the address.
|
|
17972
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
17973
|
+
*/
|
|
17974
|
+
buttonText?: string | null;
|
|
17975
|
+
/**
|
|
17976
|
+
* Text of the link that the customer can select to skip the address step and continue the payment without providing an address.
|
|
17977
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
17978
|
+
*/
|
|
17979
|
+
skipLinkText?: string | null;
|
|
17980
|
+
};
|
|
17959
17981
|
/** Schedule an invoice retry. */
|
|
17960
17982
|
RuleActionScheduleInvoiceRetry: coreComponents["schemas"]["RuleAction"] & {
|
|
17961
17983
|
/** Describes the retry instruction. */
|
|
@@ -28638,14 +28660,6 @@ export interface coreComponents {
|
|
|
28638
28660
|
collectionQuery: string;
|
|
28639
28661
|
/** ID of the resource. */
|
|
28640
28662
|
resourceId: string;
|
|
28641
|
-
/**
|
|
28642
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
28643
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
28644
|
-
*
|
|
28645
|
-
* For more information, see
|
|
28646
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
28647
|
-
*/
|
|
28648
|
-
collectionExpand: string;
|
|
28649
28663
|
/**
|
|
28650
28664
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
28651
28665
|
* The ID value is always returned.
|
|
@@ -28663,6 +28677,14 @@ export interface coreComponents {
|
|
|
28663
28677
|
| "plans"
|
|
28664
28678
|
| "gateway-accounts"
|
|
28665
28679
|
| "deposit-requests";
|
|
28680
|
+
/**
|
|
28681
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
28682
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
28683
|
+
*
|
|
28684
|
+
* For more information, see
|
|
28685
|
+
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
28686
|
+
*/
|
|
28687
|
+
collectionExpand: string;
|
|
28666
28688
|
/** Type of resource. */
|
|
28667
28689
|
externalIdentifierResource:
|
|
28668
28690
|
| "customers"
|
|
@@ -31284,14 +31306,6 @@ export interface operations {
|
|
|
31284
31306
|
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
31285
31307
|
/** Use this field to perform a partial search of text fields. */
|
|
31286
31308
|
q?: coreComponents["parameters"]["collectionQuery"];
|
|
31287
|
-
/**
|
|
31288
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
31289
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
31290
|
-
*
|
|
31291
|
-
* For more information, see
|
|
31292
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
31293
|
-
*/
|
|
31294
|
-
expand?: coreComponents["parameters"]["collectionExpand"];
|
|
31295
31309
|
/**
|
|
31296
31310
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
31297
31311
|
* The ID value is always returned.
|
|
@@ -46329,10 +46343,6 @@ export interface storefrontComponents {
|
|
|
46329
46343
|
/** Type of link. */
|
|
46330
46344
|
rel?: "self" | "file";
|
|
46331
46345
|
}[];
|
|
46332
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
46333
|
-
_embedded?: {
|
|
46334
|
-
file?: { [key: string]: any };
|
|
46335
|
-
};
|
|
46336
46346
|
};
|
|
46337
46347
|
Conflict: { [key: string]: any } & {
|
|
46338
46348
|
/** HTTP status code. */
|
|
@@ -57625,6 +57635,7 @@ export interface storefrontComponents {
|
|
|
57625
57635
|
| "pick-gateway-account"
|
|
57626
57636
|
| "remove-reminder"
|
|
57627
57637
|
| "request-kyc"
|
|
57638
|
+
| "request-physical-address"
|
|
57628
57639
|
| "reset-reminder"
|
|
57629
57640
|
| "schedule-invoice-retry"
|
|
57630
57641
|
| "schedule-payment"
|
|
@@ -57895,6 +57906,31 @@ export interface storefrontComponents {
|
|
|
57895
57906
|
/** Currency three letter code to display on the bypass link, if optional. */
|
|
57896
57907
|
bypassCurrencyToDisplay?: string;
|
|
57897
57908
|
};
|
|
57909
|
+
/**
|
|
57910
|
+
* Displays a Rebilly-hosted page where the customer can provide a street address and postal code before the payment is sent to the gateway.
|
|
57911
|
+
* The page is displayed only if the customer's primary address is a PO Box.
|
|
57912
|
+
* The submitted values are stored in the `referenceData` field of the transaction using the `physicalAddress` and `physicalAddressPostalCode` keys.
|
|
57913
|
+
* After the customer provides an address, the page is not displayed on their later payments.
|
|
57914
|
+
* If the customer skips this step, the page is displayed again on their next payment.
|
|
57915
|
+
*/
|
|
57916
|
+
RuleActionRequestPhysicalAddress: storefrontComponents["schemas"]["RuleAction"] & {
|
|
57917
|
+
/**
|
|
57918
|
+
* Text that is displayed above the form.
|
|
57919
|
+
* HTML is permitted.
|
|
57920
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
57921
|
+
*/
|
|
57922
|
+
instructionsText?: string | null;
|
|
57923
|
+
/**
|
|
57924
|
+
* Text of the button that the customer can press to submit the address.
|
|
57925
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
57926
|
+
*/
|
|
57927
|
+
buttonText?: string | null;
|
|
57928
|
+
/**
|
|
57929
|
+
* Text of the link that the customer can select to skip the address step and continue the payment without providing an address.
|
|
57930
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
57931
|
+
*/
|
|
57932
|
+
skipLinkText?: string | null;
|
|
57933
|
+
};
|
|
57898
57934
|
/** Schedule an invoice retry. */
|
|
57899
57935
|
RuleActionScheduleInvoiceRetry: storefrontComponents["schemas"]["RuleAction"] & {
|
|
57900
57936
|
/** Describes the retry instruction. */
|
|
@@ -68577,14 +68613,6 @@ export interface storefrontComponents {
|
|
|
68577
68613
|
collectionQuery: string;
|
|
68578
68614
|
/** ID of the resource. */
|
|
68579
68615
|
resourceId: string;
|
|
68580
|
-
/**
|
|
68581
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
68582
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
68583
|
-
*
|
|
68584
|
-
* For more information, see
|
|
68585
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
68586
|
-
*/
|
|
68587
|
-
collectionExpand: string;
|
|
68588
68616
|
/**
|
|
68589
68617
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
68590
68618
|
* The ID value is always returned.
|
|
@@ -68602,6 +68630,14 @@ export interface storefrontComponents {
|
|
|
68602
68630
|
| "plans"
|
|
68603
68631
|
| "gateway-accounts"
|
|
68604
68632
|
| "deposit-requests";
|
|
68633
|
+
/**
|
|
68634
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
68635
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
68636
|
+
*
|
|
68637
|
+
* For more information, see
|
|
68638
|
+
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
68639
|
+
*/
|
|
68640
|
+
collectionExpand: string;
|
|
68605
68641
|
/** Type of resource. */
|
|
68606
68642
|
externalIdentifierResource:
|
|
68607
68643
|
| "customers"
|
|
@@ -73588,10 +73624,6 @@ export interface reportsComponents {
|
|
|
73588
73624
|
/** Type of link. */
|
|
73589
73625
|
rel?: "self" | "file";
|
|
73590
73626
|
}[];
|
|
73591
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
73592
|
-
_embedded?: {
|
|
73593
|
-
file?: { [key: string]: any };
|
|
73594
|
-
};
|
|
73595
73627
|
};
|
|
73596
73628
|
Conflict: { [key: string]: any } & {
|
|
73597
73629
|
/** HTTP status code. */
|
|
@@ -84884,6 +84916,7 @@ export interface reportsComponents {
|
|
|
84884
84916
|
| "pick-gateway-account"
|
|
84885
84917
|
| "remove-reminder"
|
|
84886
84918
|
| "request-kyc"
|
|
84919
|
+
| "request-physical-address"
|
|
84887
84920
|
| "reset-reminder"
|
|
84888
84921
|
| "schedule-invoice-retry"
|
|
84889
84922
|
| "schedule-payment"
|
|
@@ -85154,6 +85187,31 @@ export interface reportsComponents {
|
|
|
85154
85187
|
/** Currency three letter code to display on the bypass link, if optional. */
|
|
85155
85188
|
bypassCurrencyToDisplay?: string;
|
|
85156
85189
|
};
|
|
85190
|
+
/**
|
|
85191
|
+
* Displays a Rebilly-hosted page where the customer can provide a street address and postal code before the payment is sent to the gateway.
|
|
85192
|
+
* The page is displayed only if the customer's primary address is a PO Box.
|
|
85193
|
+
* The submitted values are stored in the `referenceData` field of the transaction using the `physicalAddress` and `physicalAddressPostalCode` keys.
|
|
85194
|
+
* After the customer provides an address, the page is not displayed on their later payments.
|
|
85195
|
+
* If the customer skips this step, the page is displayed again on their next payment.
|
|
85196
|
+
*/
|
|
85197
|
+
RuleActionRequestPhysicalAddress: reportsComponents["schemas"]["RuleAction"] & {
|
|
85198
|
+
/**
|
|
85199
|
+
* Text that is displayed above the form.
|
|
85200
|
+
* HTML is permitted.
|
|
85201
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
85202
|
+
*/
|
|
85203
|
+
instructionsText?: string | null;
|
|
85204
|
+
/**
|
|
85205
|
+
* Text of the button that the customer can press to submit the address.
|
|
85206
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
85207
|
+
*/
|
|
85208
|
+
buttonText?: string | null;
|
|
85209
|
+
/**
|
|
85210
|
+
* Text of the link that the customer can select to skip the address step and continue the payment without providing an address.
|
|
85211
|
+
* If this value is omitted or null, the default text is displayed in the customer's language.
|
|
85212
|
+
*/
|
|
85213
|
+
skipLinkText?: string | null;
|
|
85214
|
+
};
|
|
85157
85215
|
/** Schedule an invoice retry. */
|
|
85158
85216
|
RuleActionScheduleInvoiceRetry: reportsComponents["schemas"]["RuleAction"] & {
|
|
85159
85217
|
/** Describes the retry instruction. */
|
|
@@ -95836,14 +95894,6 @@ export interface reportsComponents {
|
|
|
95836
95894
|
collectionQuery: string;
|
|
95837
95895
|
/** ID of the resource. */
|
|
95838
95896
|
resourceId: string;
|
|
95839
|
-
/**
|
|
95840
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
95841
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
95842
|
-
*
|
|
95843
|
-
* For more information, see
|
|
95844
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
95845
|
-
*/
|
|
95846
|
-
collectionExpand: string;
|
|
95847
95897
|
/**
|
|
95848
95898
|
* Limits the returned fields to the specified list, each field separated by a comma.
|
|
95849
95899
|
* The ID value is always returned.
|
|
@@ -95861,6 +95911,14 @@ export interface reportsComponents {
|
|
|
95861
95911
|
| "plans"
|
|
95862
95912
|
| "gateway-accounts"
|
|
95863
95913
|
| "deposit-requests";
|
|
95914
|
+
/**
|
|
95915
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
95916
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
95917
|
+
*
|
|
95918
|
+
* For more information, see
|
|
95919
|
+
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
95920
|
+
*/
|
|
95921
|
+
collectionExpand: string;
|
|
95864
95922
|
/** Type of resource. */
|
|
95865
95923
|
externalIdentifierResource:
|
|
95866
95924
|
| "customers"
|
|
@@ -102805,19 +102863,17 @@ declare module "resources/files-resource" {
|
|
|
102805
102863
|
export default function FilesResource({ apiHandler }: {
|
|
102806
102864
|
apiHandler: any;
|
|
102807
102865
|
}): {
|
|
102808
|
-
getAllAttachments({ limit, offset, filter, q,
|
|
102809
|
-
attach({ id, data
|
|
102866
|
+
getAllAttachments({ limit, offset, filter, q, fields, sort, }?: rebilly.GetAttachmentCollectionRequest): rebilly.GetAttachmentCollectionResponsePromise;
|
|
102867
|
+
attach({ id, data }: {
|
|
102810
102868
|
id?: string;
|
|
102811
102869
|
data: any;
|
|
102812
|
-
expand?: any;
|
|
102813
102870
|
}): rebilly.PostAttachmentResponsePromise;
|
|
102814
102871
|
getAttachment({ id }: {
|
|
102815
102872
|
id: any;
|
|
102816
102873
|
}): rebilly.GetAttachmentResponsePromise;
|
|
102817
|
-
updateAttachment({ id, data
|
|
102874
|
+
updateAttachment({ id, data }: {
|
|
102818
102875
|
id: any;
|
|
102819
102876
|
data: any;
|
|
102820
|
-
expand?: any;
|
|
102821
102877
|
}): rebilly.PutAttachmentResponsePromise;
|
|
102822
102878
|
detach({ id }: {
|
|
102823
102879
|
id: any;
|
|
@@ -104696,19 +104752,17 @@ declare module "resources/api-instance" {
|
|
|
104696
104752
|
}): any;
|
|
104697
104753
|
};
|
|
104698
104754
|
files: {
|
|
104699
|
-
getAllAttachments({ limit, offset, filter, q,
|
|
104700
|
-
attach({ id, data
|
|
104755
|
+
getAllAttachments({ limit, offset, filter, q, fields, sort, }?: rebilly.GetAttachmentCollectionRequest): rebilly.GetAttachmentCollectionResponsePromise;
|
|
104756
|
+
attach({ id, data }: {
|
|
104701
104757
|
id?: string;
|
|
104702
104758
|
data: any;
|
|
104703
|
-
expand?: any;
|
|
104704
104759
|
}): rebilly.PostAttachmentResponsePromise;
|
|
104705
104760
|
getAttachment({ id }: {
|
|
104706
104761
|
id: any;
|
|
104707
104762
|
}): rebilly.GetAttachmentResponsePromise;
|
|
104708
|
-
updateAttachment({ id, data
|
|
104763
|
+
updateAttachment({ id, data }: {
|
|
104709
104764
|
id: any;
|
|
104710
104765
|
data: any;
|
|
104711
|
-
expand?: any;
|
|
104712
104766
|
}): rebilly.PutAttachmentResponsePromise;
|
|
104713
104767
|
detach({ id }: {
|
|
104714
104768
|
id: any;
|