rebilly-js-sdk 48.0.0 → 48.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/rebilly-js-sdk.d.ts +1349 -719
- package/dist/rebilly-js-sdk.es.js +49 -10
- package/dist/rebilly-js-sdk.umd.js +5 -5
- package/package.json +1 -1
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -191,10 +191,10 @@ declare module rebilly {
|
|
|
191
191
|
type GetCustomerTimelineCustomEventTypeResponse = operations['GetCustomerTimelineCustomEventType']['responses']['200']['content']['application/json']
|
|
192
192
|
type GetCustomerTimelineCustomEventTypeResponsePromise = Promise<{fields: GetCustomerTimelineCustomEventTypeResponse}>
|
|
193
193
|
|
|
194
|
-
type
|
|
194
|
+
type GetCustomerAmlHitRequest = { id : String }
|
|
195
195
|
|
|
196
|
-
type
|
|
197
|
-
type
|
|
196
|
+
type GetCustomerAmlHitResponse = operations['GetCustomerAmlHit']['responses']['200']['content']['application/json']
|
|
197
|
+
type GetCustomerAmlHitResponsePromise = Promise<{fields: GetCustomerAmlHitResponse}>
|
|
198
198
|
|
|
199
199
|
type GetCustomerLeadSourceRequest = { id : String }
|
|
200
200
|
|
|
@@ -944,19 +944,45 @@ declare module rebilly {
|
|
|
944
944
|
type PatchCustomerEddScoreResponse = operations['PatchCustomerEddScore']['responses']['200']['content']['application/json']
|
|
945
945
|
type PatchCustomerEddScoreResponsePromise = Promise<{fields: PatchCustomerEddScoreResponse}>
|
|
946
946
|
|
|
947
|
-
type
|
|
947
|
+
type GetCustomerEddTimelineCollectionRequest = operations['GetCustomerEddTimelineCollection']['parameters']["query"] & (operations['GetCustomerEddTimelineCollection']['parameters'] extends {path: {}} ? operations['GetCustomerEddTimelineCollection']['parameters']["path"] : {}) & { id : String }
|
|
948
948
|
|
|
949
|
-
type
|
|
950
|
-
type
|
|
951
|
-
type
|
|
952
|
-
type
|
|
953
|
-
type
|
|
954
|
-
type
|
|
949
|
+
type GetCustomerEddTimelineCollectionResponse = operations['GetCustomerEddTimelineCollection']['responses']['200']['content']['application/json'][0]
|
|
950
|
+
type GetCustomerEddTimelineCollectionResponsePromise = Promise<{ items: {fields: GetCustomerEddTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
951
|
+
type PostCustomerEddTimelineRequest = operations['PostCustomerEddTimeline']['requestBody']['content']['application/json']
|
|
952
|
+
type CreateCustomerEddTimelineRequest = { id: String, data: PostCustomerEddTimelineRequest, expand?: String }
|
|
953
|
+
type PostCustomerEddTimelineResponse = operations['PostCustomerEddTimeline']['responses']['201']['content']['application/json']
|
|
954
|
+
type PostCustomerEddTimelineResponsePromise = Promise<{fields: PostCustomerEddTimelineResponse}>
|
|
955
955
|
|
|
956
|
-
type
|
|
956
|
+
type GetCustomerEddTimelineRequest = { id : String,messageId : String }
|
|
957
|
+
|
|
958
|
+
type GetCustomerEddTimelineResponse = operations['GetCustomerEddTimeline']['responses']['200']['content']['application/json']
|
|
959
|
+
type GetCustomerEddTimelineResponsePromise = Promise<{fields: GetCustomerEddTimelineResponse}>
|
|
960
|
+
type DeleteCustomerEddTimelineResponse = operations['DeleteCustomerEddTimeline']['responses']['204']
|
|
961
|
+
type DeleteCustomerEddTimelineResponsePromise = Promise<{fields: DeleteCustomerEddTimelineResponse}>
|
|
962
|
+
|
|
963
|
+
type GetCustomerEddSearchResultCollectionRequest = operations['GetCustomerEddSearchResultCollection']['parameters']["query"] & (operations['GetCustomerEddSearchResultCollection']['parameters'] extends {path: {}} ? operations['GetCustomerEddSearchResultCollection']['parameters']["path"] : {}) & { id : String }
|
|
964
|
+
|
|
965
|
+
type GetCustomerEddSearchResultCollectionResponse = operations['GetCustomerEddSearchResultCollection']['responses']['200']['content']['application/json'][0]
|
|
966
|
+
type GetCustomerEddSearchResultCollectionResponsePromise = Promise<{ items: {fields: GetCustomerEddSearchResultCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
967
|
+
|
|
968
|
+
type GetCustomerEddSearchResultRequest = { id : String,searchResultId : String }
|
|
969
|
+
|
|
970
|
+
type GetCustomerEddSearchResultResponse = operations['GetCustomerEddSearchResult']['responses']['200']['content']['application/json']
|
|
971
|
+
type GetCustomerEddSearchResultResponsePromise = Promise<{fields: GetCustomerEddSearchResultResponse}>
|
|
957
972
|
|
|
958
|
-
|
|
959
|
-
type
|
|
973
|
+
|
|
974
|
+
type GetRiskScoreRulesResponse = operations['GetRiskScoreRules']['responses']['200']['content']['application/json']
|
|
975
|
+
type GetRiskScoreRulesResponsePromise = Promise<{fields: GetRiskScoreRulesResponse}>
|
|
976
|
+
type PutRiskScoreRulesRequest = operations['PutRiskScoreRules']['requestBody']['content']['application/json']
|
|
977
|
+
type PutRiskScoreRulesResponse = operations['PutRiskScoreRules']['responses']['201']['content']['application/json']
|
|
978
|
+
type PutRiskScoreRulesResponsePromise = Promise<{fields: PutRiskScoreRulesResponse}>
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
type GetRiskScoreBlocklistRulesResponse = operations['GetRiskScoreBlocklistRules']['responses']['200']['content']['application/json']
|
|
982
|
+
type GetRiskScoreBlocklistRulesResponsePromise = Promise<{fields: GetRiskScoreBlocklistRulesResponse}>
|
|
983
|
+
type PutRiskScoreBlocklistRulesRequest = operations['PutRiskScoreBlocklistRules']['requestBody']['content']['application/json']
|
|
984
|
+
type PutRiskScoreBlocklistRulesResponse = operations['PutRiskScoreBlocklistRules']['responses']['201']['content']['application/json']
|
|
985
|
+
type PutRiskScoreBlocklistRulesResponsePromise = Promise<{fields: PutRiskScoreBlocklistRulesResponse}>
|
|
960
986
|
|
|
961
987
|
type GetApplicationInstanceRequest = { applicationId : String }
|
|
962
988
|
|
|
@@ -1142,10 +1168,10 @@ declare module rebilly {
|
|
|
1142
1168
|
type GetOauth2CredentialHashItemCollectionResponse = operations['GetOauth2CredentialHashItemCollection']['responses']['200']['content']['application/json'][0]
|
|
1143
1169
|
type GetOauth2CredentialHashItemCollectionResponsePromise = Promise<{ items: {fields: GetOauth2CredentialHashItemCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1144
1170
|
|
|
1145
|
-
type
|
|
1171
|
+
type GetPlaidCredentialHashCollectionRequest = operations['GetPlaidCredentialHashCollection']['parameters']["query"] & (operations['GetPlaidCredentialHashCollection']['parameters'] extends {path: {}} ? operations['GetPlaidCredentialHashCollection']['parameters']["path"] : {})
|
|
1146
1172
|
|
|
1147
|
-
type
|
|
1148
|
-
type
|
|
1173
|
+
type GetPlaidCredentialHashCollectionResponse = operations['GetPlaidCredentialHashCollection']['responses']['200']['content']['application/json'][0]
|
|
1174
|
+
type GetPlaidCredentialHashCollectionResponsePromise = Promise<{ items: {fields: GetPlaidCredentialHashCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1149
1175
|
type PostPlaidCredentialHashRequest = operations['PostPlaidCredentialHash']['requestBody']['content']['application/json']
|
|
1150
1176
|
type CreatePlaidCredentialHashRequest = { id: String, data: PostPlaidCredentialHashRequest, expand?: String }
|
|
1151
1177
|
type PostPlaidCredentialHashResponse = operations['PostPlaidCredentialHash']['responses']['201']['content']['application/json']
|
|
@@ -1281,9 +1307,9 @@ declare module rebilly {
|
|
|
1281
1307
|
|
|
1282
1308
|
type GetEmailDeliverySettingResponse = operations['GetEmailDeliverySetting']['responses']['200']['content']['application/json']
|
|
1283
1309
|
type GetEmailDeliverySettingResponsePromise = Promise<{fields: GetEmailDeliverySettingResponse}>
|
|
1284
|
-
type
|
|
1285
|
-
type
|
|
1286
|
-
type
|
|
1310
|
+
type PatchEmailDeliverySettingRequest = operations['PatchEmailDeliverySetting']['requestBody']['content']['application/json']
|
|
1311
|
+
type PatchEmailDeliverySettingResponse = operations['PatchEmailDeliverySetting']['responses']['200']['content']['application/json']
|
|
1312
|
+
type PatchEmailDeliverySettingResponsePromise = Promise<{fields: PatchEmailDeliverySettingResponse}>
|
|
1287
1313
|
type DeleteEmailDeliverySettingResponse = operations['DeleteEmailDeliverySetting']['responses']['204']
|
|
1288
1314
|
type DeleteEmailDeliverySettingResponsePromise = Promise<{fields: DeleteEmailDeliverySettingResponse}>
|
|
1289
1315
|
|
|
@@ -1331,31 +1357,31 @@ declare module rebilly {
|
|
|
1331
1357
|
type PutEventRuleResponse = operations['PutEventRule']['responses']['200']['content']['application/json']
|
|
1332
1358
|
type PutEventRuleResponsePromise = Promise<{fields: PutEventRuleResponse}>
|
|
1333
1359
|
|
|
1334
|
-
type
|
|
1360
|
+
type GetRuleSetCollectionRequest = operations['GetRuleSetCollection']['parameters']["query"] & (operations['GetRuleSetCollection']['parameters'] extends {path: {}} ? operations['GetRuleSetCollection']['parameters']["path"] : {}) & { eventType : String }
|
|
1335
1361
|
|
|
1336
|
-
type
|
|
1337
|
-
type
|
|
1338
|
-
type
|
|
1339
|
-
type
|
|
1340
|
-
type
|
|
1341
|
-
type
|
|
1362
|
+
type GetRuleSetCollectionResponse = operations['GetRuleSetCollection']['responses']['200']['content']['application/json'][0]
|
|
1363
|
+
type GetRuleSetCollectionResponsePromise = Promise<{ items: {fields: GetRuleSetCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1364
|
+
type PostRuleSetTimelineRequest = operations['PostRuleSetTimeline']['requestBody']['content']['application/json']
|
|
1365
|
+
type CreateRuleSetTimelineRequest = { id: String, data: PostRuleSetTimelineRequest, expand?: String }
|
|
1366
|
+
type PostRuleSetTimelineResponse = operations['PostRuleSetTimeline']['responses']['201']['content']['application/json']
|
|
1367
|
+
type PostRuleSetTimelineResponsePromise = Promise<{fields: PostRuleSetTimelineResponse}>
|
|
1342
1368
|
|
|
1343
|
-
type
|
|
1369
|
+
type GetRuleSetTimelineRequest = { eventType : String,messageId : String }
|
|
1344
1370
|
|
|
1345
|
-
type
|
|
1346
|
-
type
|
|
1347
|
-
type
|
|
1348
|
-
type
|
|
1371
|
+
type GetRuleSetTimelineResponse = operations['GetRuleSetTimeline']['responses']['200']['content']['application/json']
|
|
1372
|
+
type GetRuleSetTimelineResponsePromise = Promise<{fields: GetRuleSetTimelineResponse}>
|
|
1373
|
+
type DeleteRuleSetTimelineResponse = operations['DeleteRuleSetTimeline']['responses']['204']
|
|
1374
|
+
type DeleteRuleSetTimelineResponsePromise = Promise<{fields: DeleteRuleSetTimelineResponse}>
|
|
1349
1375
|
|
|
1350
1376
|
type GetEventRuleHistoryCollectionRequest = operations['GetEventRuleHistoryCollection']['parameters']["query"] & (operations['GetEventRuleHistoryCollection']['parameters'] extends {path: {}} ? operations['GetEventRuleHistoryCollection']['parameters']["path"] : {}) & { eventType : String }
|
|
1351
1377
|
|
|
1352
1378
|
type GetEventRuleHistoryCollectionResponse = operations['GetEventRuleHistoryCollection']['responses']['200']['content']['application/json'][0]
|
|
1353
1379
|
type GetEventRuleHistoryCollectionResponsePromise = Promise<{ items: {fields: GetEventRuleHistoryCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1354
1380
|
|
|
1355
|
-
type
|
|
1381
|
+
type GetEventRuleHistoryRequest = operations['GetEventRuleHistory']['parameters'] & { eventType : String,version : String }
|
|
1356
1382
|
|
|
1357
|
-
type
|
|
1358
|
-
type
|
|
1383
|
+
type GetEventRuleHistoryResponse = operations['GetEventRuleHistory']['responses']['200']['content']['application/json']
|
|
1384
|
+
type GetEventRuleHistoryResponsePromise = Promise<{fields: GetEventRuleHistoryResponse}>
|
|
1359
1385
|
|
|
1360
1386
|
type GetEventRuleVersionRequest = operations['GetEventRuleVersion']['parameters'] & { eventType : String,version : String }
|
|
1361
1387
|
|
|
@@ -1903,6 +1929,11 @@ declare module rebilly {
|
|
|
1903
1929
|
type StorefrontPostOrderCancellationResponse = operations['StorefrontPostOrderCancellation']['responses']['201']['content']['application/json']
|
|
1904
1930
|
type StorefrontPostOrderCancellationResponsePromise = Promise<{fields: StorefrontPostOrderCancellationResponse}>
|
|
1905
1931
|
|
|
1932
|
+
type StorefrontPostOrderPauseRequest = operations['StorefrontPostOrderPause']['requestBody']['content']['application/json']
|
|
1933
|
+
type StorefrontCreateOrderPauseRequest = { id: String, data: StorefrontPostOrderPauseRequest, expand?: String }
|
|
1934
|
+
type StorefrontPostOrderPauseResponse = operations['StorefrontPostOrderPause']['responses']['201']['content']['application/json']
|
|
1935
|
+
type StorefrontPostOrderPauseResponsePromise = Promise<{fields: StorefrontPostOrderPauseResponse}>
|
|
1936
|
+
|
|
1906
1937
|
type StorefrontPostPaymentRequest = operations['StorefrontPostPayment']['requestBody']['content']['application/json']
|
|
1907
1938
|
type StorefrontCreatePaymentRequest = { id: String, data: StorefrontPostPaymentRequest, expand?: String }
|
|
1908
1939
|
type StorefrontPostPaymentResponse = operations['StorefrontPostPayment']['responses']['201']['content']['application/json']
|
|
@@ -2000,6 +2031,12 @@ declare module rebilly {
|
|
|
2000
2031
|
type StorefrontGetTransactionResponse = operations['StorefrontGetTransaction']['responses']['200']['content']['application/json']
|
|
2001
2032
|
type StorefrontGetTransactionResponsePromise = Promise<{fields: StorefrontGetTransactionResponse}>
|
|
2002
2033
|
|
|
2034
|
+
type StorefrontPostKycRequestContinueResponse = operations['StorefrontPostKycRequestContinue']['responses']['200']['content']['application/json']
|
|
2035
|
+
type StorefrontPostKycRequestContinueResponsePromise = Promise<{fields: StorefrontPostKycRequestContinueResponse}>
|
|
2036
|
+
|
|
2037
|
+
type StorefrontPostKycRequestBypassResponse = operations['StorefrontPostKycRequestBypass']['responses']['200']['content']['application/json']
|
|
2038
|
+
type StorefrontPostKycRequestBypassResponsePromise = Promise<{fields: StorefrontPostKycRequestBypassResponse}>
|
|
2039
|
+
|
|
2003
2040
|
type StorefrontGetWebsiteRequest = { id : String }
|
|
2004
2041
|
|
|
2005
2042
|
type StorefrontGetWebsiteResponse = operations['StorefrontGetWebsite']['responses']['200']['content']['application/json']
|
|
@@ -2019,8 +2056,8 @@ declare module rebilly {
|
|
|
2019
2056
|
type PostDataExportResponse = operations['PostDataExport']['responses']['201']['content']['application/json']
|
|
2020
2057
|
type PostDataExportResponsePromise = Promise<{fields: PostDataExportResponse}>
|
|
2021
2058
|
|
|
2022
|
-
type GetDataExportRequest = { id : String }
|
|
2023
|
-
|
|
2059
|
+
type GetDataExportRequest = operations['GetDataExport']['parameters'] & { id : String }
|
|
2060
|
+
|
|
2024
2061
|
type GetDataExportResponse = operations['GetDataExport']['responses']['200']['content']['application/json']
|
|
2025
2062
|
type GetDataExportResponsePromise = Promise<{fields: GetDataExportResponse}>
|
|
2026
2063
|
type PutDataExportRequest = operations['PutDataExport']['requestBody']['content']['application/json']
|
|
@@ -2457,7 +2494,7 @@ export interface corePaths {
|
|
|
2457
2494
|
* Performs a fuzzy search that uses Soundex.
|
|
2458
2495
|
* Note that some returned fields may not contain values.
|
|
2459
2496
|
*/
|
|
2460
|
-
get: operations["
|
|
2497
|
+
get: operations["GetCustomerAmlHit"];
|
|
2461
2498
|
parameters: {
|
|
2462
2499
|
path: {
|
|
2463
2500
|
/** ID of the resource. */
|
|
@@ -2512,7 +2549,7 @@ export interface corePaths {
|
|
|
2512
2549
|
path: {
|
|
2513
2550
|
/** ID of the resource. */
|
|
2514
2551
|
id: coreComponents["parameters"]["resourceId"];
|
|
2515
|
-
/**
|
|
2552
|
+
/** ID of the customer timeline message. */
|
|
2516
2553
|
messageId: string;
|
|
2517
2554
|
};
|
|
2518
2555
|
};
|
|
@@ -3242,7 +3279,7 @@ export interface corePaths {
|
|
|
3242
3279
|
"/subscription-cancellations/{id}": {
|
|
3243
3280
|
/** Retrieves an order cancellation with a specified ID. */
|
|
3244
3281
|
get: operations["GetSubscriptionCancellation"];
|
|
3245
|
-
/**
|
|
3282
|
+
/** Creates or updates (upserts) a cancellation order with a specified ID. */
|
|
3246
3283
|
put: operations["PutSubscriptionCancellation"];
|
|
3247
3284
|
/**
|
|
3248
3285
|
* Deletes an order cancellation with a specified ID.
|
|
@@ -3685,13 +3722,17 @@ export interface corePaths {
|
|
|
3685
3722
|
"/payout-requests": {
|
|
3686
3723
|
/** Retrieves a list of payout requests. */
|
|
3687
3724
|
get: operations["GetPayoutRequestCollection"];
|
|
3688
|
-
/**
|
|
3725
|
+
/**
|
|
3726
|
+
* Creates a payout request.
|
|
3727
|
+
* In the response, the `selectPaymentInstrumentUrl` field is used to redirect the customer to select a preferred payment instrument.
|
|
3728
|
+
* After a payment instrument is selected, the customer is redirected to the `selectedPaymentInstrumentRedirectUrl` value.
|
|
3729
|
+
*/
|
|
3689
3730
|
post: operations["PostPayoutRequest"];
|
|
3690
3731
|
};
|
|
3691
3732
|
"/payout-requests/{id}": {
|
|
3692
3733
|
/** Retrieves a payout request with a specified ID. */
|
|
3693
3734
|
get: operations["GetPayoutRequest"];
|
|
3694
|
-
/** Creates or updates (upserts) a payout request with specified
|
|
3735
|
+
/** Creates or updates (upserts) a payout request with a specified ID. */
|
|
3695
3736
|
put: operations["PutPayoutRequest"];
|
|
3696
3737
|
parameters: {
|
|
3697
3738
|
path: {
|
|
@@ -3731,19 +3772,33 @@ export interface corePaths {
|
|
|
3731
3772
|
};
|
|
3732
3773
|
"/customers/{id}/edd-timeline": {
|
|
3733
3774
|
/** Retrieves a list of EDD timeline messages. */
|
|
3734
|
-
get: operations["
|
|
3775
|
+
get: operations["GetCustomerEddTimelineCollection"];
|
|
3735
3776
|
/** Creates an EDD timeline comment. */
|
|
3736
|
-
post: operations["
|
|
3777
|
+
post: operations["PostCustomerEddTimeline"];
|
|
3778
|
+
parameters: {
|
|
3779
|
+
path: {
|
|
3780
|
+
/** ID of the resource. */
|
|
3781
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
3782
|
+
};
|
|
3783
|
+
};
|
|
3784
|
+
};
|
|
3785
|
+
"/customers/{id}/edd-timeline/{messageId}": {
|
|
3786
|
+
/** Retrieves an EDD message with a specified ID. */
|
|
3787
|
+
get: operations["GetCustomerEddTimeline"];
|
|
3788
|
+
/** Deletes an EDD timeline message with a specified ID. */
|
|
3789
|
+
delete: operations["DeleteCustomerEddTimeline"];
|
|
3737
3790
|
parameters: {
|
|
3738
3791
|
path: {
|
|
3739
3792
|
/** ID of the resource. */
|
|
3740
3793
|
id: coreComponents["parameters"]["resourceId"];
|
|
3794
|
+
/** ID of the EDD timeline message. */
|
|
3795
|
+
messageId: string;
|
|
3741
3796
|
};
|
|
3742
3797
|
};
|
|
3743
3798
|
};
|
|
3744
3799
|
"/customers/{id}/edd-search-results": {
|
|
3745
3800
|
/** Retrieve EDD search results for a customer with a specified ID. */
|
|
3746
|
-
get: operations["
|
|
3801
|
+
get: operations["GetCustomerEddSearchResultCollection"];
|
|
3747
3802
|
parameters: {
|
|
3748
3803
|
path: {
|
|
3749
3804
|
/** ID of the resource. */
|
|
@@ -3751,6 +3806,30 @@ export interface corePaths {
|
|
|
3751
3806
|
};
|
|
3752
3807
|
};
|
|
3753
3808
|
};
|
|
3809
|
+
"/customers/{id}/edd-search-results/{searchResultId}": {
|
|
3810
|
+
/** Retrieves an EDD search result for a customer with a specified ID. */
|
|
3811
|
+
get: operations["GetCustomerEddSearchResult"];
|
|
3812
|
+
parameters: {
|
|
3813
|
+
path: {
|
|
3814
|
+
/** ID of the resource. */
|
|
3815
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
3816
|
+
/** ID of the EDD search result. */
|
|
3817
|
+
searchResultId: string;
|
|
3818
|
+
};
|
|
3819
|
+
};
|
|
3820
|
+
};
|
|
3821
|
+
"/risk-score-rules": {
|
|
3822
|
+
/** Retrieves risk score rules. */
|
|
3823
|
+
get: operations["GetRiskScoreRules"];
|
|
3824
|
+
/** Modifies risk score rules. */
|
|
3825
|
+
put: operations["PutRiskScoreRules"];
|
|
3826
|
+
};
|
|
3827
|
+
"/risk-score-rules/blocklists": {
|
|
3828
|
+
/** Retrieves risk score blocklist rules. */
|
|
3829
|
+
get: operations["GetRiskScoreBlocklistRules"];
|
|
3830
|
+
/** Modifies risk score blocklist rules. */
|
|
3831
|
+
put: operations["PutRiskScoreBlocklistRules"];
|
|
3832
|
+
};
|
|
3754
3833
|
}
|
|
3755
3834
|
|
|
3756
3835
|
export interface coreComponents {
|
|
@@ -3864,9 +3943,11 @@ export interface coreComponents {
|
|
|
3864
3943
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
3865
3944
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
3866
3945
|
/** Website ID associated with the customer. */
|
|
3867
|
-
websiteId?:
|
|
3946
|
+
websiteId?: string;
|
|
3868
3947
|
/** User ID of the person who reviewed the AML check. */
|
|
3869
3948
|
reviewerId?: string | null;
|
|
3949
|
+
/** First and last name of the person who reviewed the AML check. */
|
|
3950
|
+
reviewerName?: string | null;
|
|
3870
3951
|
/** Date and time when the AML check review is completed. */
|
|
3871
3952
|
reviewTime?: string | null;
|
|
3872
3953
|
customer?: {
|
|
@@ -3880,8 +3961,18 @@ export interface coreComponents {
|
|
|
3880
3961
|
lastName?: string;
|
|
3881
3962
|
/** Customer's date of birth. */
|
|
3882
3963
|
dob?: string | null;
|
|
3883
|
-
/**
|
|
3964
|
+
/** First line of the customer's street address at the time of the AML check. */
|
|
3965
|
+
address?: string | null;
|
|
3966
|
+
/** Second line of the customer's street address at the time of the AML check. */
|
|
3967
|
+
address2?: string | null;
|
|
3968
|
+
/** Customer's city of residence at the time of the AML check. */
|
|
3969
|
+
city?: string | null;
|
|
3970
|
+
/** Customer's region of residence at the time of the AML check. */
|
|
3971
|
+
region?: string | null;
|
|
3972
|
+
/** Customer's country of residence at the time of the AML check. */
|
|
3884
3973
|
country?: string;
|
|
3974
|
+
/** Customer's postal code at the time of the AML check. */
|
|
3975
|
+
postalCode?: string | null;
|
|
3885
3976
|
};
|
|
3886
3977
|
/** List of tags that have been assigned to the customer. */
|
|
3887
3978
|
tags?: coreComponents["schemas"]["Tag"][];
|
|
@@ -3972,7 +4063,7 @@ export interface coreComponents {
|
|
|
3972
4063
|
| "subscription"
|
|
3973
4064
|
| "transaction"
|
|
3974
4065
|
| "transaction-timeline-comment";
|
|
3975
|
-
/**
|
|
4066
|
+
/** ID of the linked object. */
|
|
3976
4067
|
relatedId: string;
|
|
3977
4068
|
/** Name of original attachment. */
|
|
3978
4069
|
name?: string;
|
|
@@ -4008,7 +4099,7 @@ export interface coreComponents {
|
|
|
4008
4099
|
/** Specifies if a One-Time Password (OTP) is required to exchange a token. */
|
|
4009
4100
|
otpRequired?: boolean;
|
|
4010
4101
|
};
|
|
4011
|
-
/**
|
|
4102
|
+
/** ID of the customer resource. */
|
|
4012
4103
|
CustomerId: string;
|
|
4013
4104
|
CommonAuthenticationToken: {
|
|
4014
4105
|
/** ID of the authentication token. */
|
|
@@ -4058,9 +4149,9 @@ export interface coreComponents {
|
|
|
4058
4149
|
/** Array of account IDs. */
|
|
4059
4150
|
organizationId?: coreComponents["schemas"]["ResourceId"][];
|
|
4060
4151
|
/** Array of product IDs. */
|
|
4061
|
-
productId?:
|
|
4152
|
+
productId?: string[];
|
|
4062
4153
|
/** Array of plan IDs. */
|
|
4063
|
-
planId?:
|
|
4154
|
+
planId?: string[];
|
|
4064
4155
|
/** Array of custom field names. */
|
|
4065
4156
|
customFieldName?: string[];
|
|
4066
4157
|
};
|
|
@@ -4077,7 +4168,7 @@ export interface coreComponents {
|
|
|
4077
4168
|
}[];
|
|
4078
4169
|
CustomerJWT: {
|
|
4079
4170
|
/** ID of the session. */
|
|
4080
|
-
id?:
|
|
4171
|
+
id?: string;
|
|
4081
4172
|
/** Type of session. */
|
|
4082
4173
|
type?: "customer";
|
|
4083
4174
|
/** Token used for authentication. */
|
|
@@ -4105,7 +4196,7 @@ export interface coreComponents {
|
|
|
4105
4196
|
}[];
|
|
4106
4197
|
};
|
|
4107
4198
|
Blocklist: {
|
|
4108
|
-
/**
|
|
4199
|
+
/** ID of the blocklist. */
|
|
4109
4200
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
4110
4201
|
/** Type of blocklist. */
|
|
4111
4202
|
type:
|
|
@@ -4250,14 +4341,14 @@ export interface coreComponents {
|
|
|
4250
4341
|
/** One or more plan and quantity definitions that must be purchased to receive all plans and quantities that are defined in the `get` instruction. */
|
|
4251
4342
|
buy: {
|
|
4252
4343
|
/** Plan ID of what is being purchased. */
|
|
4253
|
-
planId:
|
|
4344
|
+
planId: string;
|
|
4254
4345
|
/** Total quantity of the associated plan ID that must be purchased for this restriction to apply. */
|
|
4255
4346
|
quantity: number;
|
|
4256
4347
|
}[];
|
|
4257
4348
|
/** One or more plan and quantity definitions added to a purchase if all definitions in the `buy` condition are met. */
|
|
4258
4349
|
get: {
|
|
4259
4350
|
/** Plan ID of what is to be received. */
|
|
4260
|
-
planId:
|
|
4351
|
+
planId: string;
|
|
4261
4352
|
/** Total quantity of the associated plan ID that is received. */
|
|
4262
4353
|
quantity: number;
|
|
4263
4354
|
}[];
|
|
@@ -4704,7 +4795,7 @@ export interface coreComponents {
|
|
|
4704
4795
|
/** Customer information. */
|
|
4705
4796
|
Customer: {
|
|
4706
4797
|
/** ID of the customer. */
|
|
4707
|
-
id?:
|
|
4798
|
+
id?: string;
|
|
4708
4799
|
/** Customer's email address. */
|
|
4709
4800
|
email?: string | null;
|
|
4710
4801
|
/** Customer's first name. */
|
|
@@ -4813,7 +4904,10 @@ export interface coreComponents {
|
|
|
4813
4904
|
subAffiliate?: string;
|
|
4814
4905
|
/** Name of the sales agent associated with the lead source. */
|
|
4815
4906
|
salesAgent?: string;
|
|
4816
|
-
/**
|
|
4907
|
+
/**
|
|
4908
|
+
* ID of the lead source click.
|
|
4909
|
+
* This value is passed in the ad click URL for tracking and campaign attribution.
|
|
4910
|
+
*/
|
|
4817
4911
|
clickId?: string;
|
|
4818
4912
|
/** URL from which the lead source originates. */
|
|
4819
4913
|
path?: string;
|
|
@@ -5352,7 +5446,7 @@ export interface coreComponents {
|
|
|
5352
5446
|
RebillyShipping: {
|
|
5353
5447
|
/** Shipping calculator. */
|
|
5354
5448
|
calculator: "rebilly";
|
|
5355
|
-
/**
|
|
5449
|
+
/** ID of the shipping rate. If unset the cheapest applicable shipping rate is chosen. */
|
|
5356
5450
|
rateId?: string | null;
|
|
5357
5451
|
/** Shipping amount which is calculated from [Shipping rates](https://all-rebilly.redoc.ly/tag/Shipping-rates). */
|
|
5358
5452
|
amount?: number;
|
|
@@ -5458,7 +5552,11 @@ export interface coreComponents {
|
|
|
5458
5552
|
/** Total price of the invoice item. */
|
|
5459
5553
|
price?: number;
|
|
5460
5554
|
/** ID of the product. */
|
|
5461
|
-
productId?:
|
|
5555
|
+
productId?: string;
|
|
5556
|
+
/** ID of the plan. */
|
|
5557
|
+
planId?: string | null;
|
|
5558
|
+
/** ID of the order. */
|
|
5559
|
+
subscriptionId?: string | null;
|
|
5462
5560
|
/** Discount amount applied to the invoice item. */
|
|
5463
5561
|
discountAmount?: number;
|
|
5464
5562
|
/** Date and time when the billing period starts. */
|
|
@@ -6679,8 +6777,9 @@ export interface coreComponents {
|
|
|
6679
6777
|
* List of invoices that the credit memo is allocated to.
|
|
6680
6778
|
*
|
|
6681
6779
|
* - To delete invoice allocations, send an empty invoice allocation array in the request.
|
|
6682
|
-
*
|
|
6780
|
+
* Only `unpaid`, `partially-paid`, and `past-due` invoices can be deleted.
|
|
6683
6781
|
* - To modify invoice allocations, send a modified invoice allocation array in the request.
|
|
6782
|
+
* Only `unpaid`, `partially-paid`, and `past-due` invoices can be modified.
|
|
6684
6783
|
* - If you do not want to modify or delete invoice allocations, do not send an invoice allocation array in the request.
|
|
6685
6784
|
*/
|
|
6686
6785
|
invoices?: {
|
|
@@ -6898,8 +6997,9 @@ export interface coreComponents {
|
|
|
6898
6997
|
faceProofRequired?: boolean;
|
|
6899
6998
|
}[];
|
|
6900
6999
|
/** KYC request information. */
|
|
6901
|
-
|
|
7000
|
+
KycRequest: {
|
|
6902
7001
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
7002
|
+
customerId: coreComponents["schemas"]["CustomerId"];
|
|
6903
7003
|
documents: coreComponents["schemas"]["KycRequestDocuments"];
|
|
6904
7004
|
/** Status of the request. */
|
|
6905
7005
|
status?:
|
|
@@ -6927,6 +7027,19 @@ export interface coreComponents {
|
|
|
6927
7027
|
* Example: `https://example.com?info=success`.
|
|
6928
7028
|
*/
|
|
6929
7029
|
redirectUrl?: string;
|
|
7030
|
+
/** Reason for uploading. */
|
|
7031
|
+
reason?: string;
|
|
7032
|
+
/**
|
|
7033
|
+
* Tolerance level setting for document matches.
|
|
7034
|
+
* The value of `1` is more tolerant and `2` is strict.
|
|
7035
|
+
*/
|
|
7036
|
+
matchLevel: number;
|
|
7037
|
+
/**
|
|
7038
|
+
* Number of times the KYC request data has been modified.
|
|
7039
|
+
*
|
|
7040
|
+
* Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
|
|
7041
|
+
*/
|
|
7042
|
+
revision?: number;
|
|
6930
7043
|
/**
|
|
6931
7044
|
* Date and time when the request expires.
|
|
6932
7045
|
* The default value is one hour in the future.
|
|
@@ -6934,6 +7047,17 @@ export interface coreComponents {
|
|
|
6934
7047
|
expirationTime?: string;
|
|
6935
7048
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
6936
7049
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7050
|
+
/** Related links. */
|
|
7051
|
+
_links?: {
|
|
7052
|
+
/** Link URL. */
|
|
7053
|
+
href?: string;
|
|
7054
|
+
/** Type of link. */
|
|
7055
|
+
rel?: "self" | "documents" | "gatherer";
|
|
7056
|
+
}[];
|
|
7057
|
+
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
7058
|
+
_embedded?: {
|
|
7059
|
+
documents?: any[];
|
|
7060
|
+
};
|
|
6937
7061
|
};
|
|
6938
7062
|
/** Reason the document is rejected. */
|
|
6939
7063
|
KycDocumentRejectionReasonTypes:
|
|
@@ -7422,33 +7546,6 @@ export interface coreComponents {
|
|
|
7422
7546
|
customer?: { [key: string]: any };
|
|
7423
7547
|
};
|
|
7424
7548
|
};
|
|
7425
|
-
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
7426
|
-
customerId: coreComponents["schemas"]["CustomerId"];
|
|
7427
|
-
/** Reason for uploading. */
|
|
7428
|
-
reason?: string;
|
|
7429
|
-
/**
|
|
7430
|
-
* Tolerance level setting for document matches.
|
|
7431
|
-
* The value of `1` is more tolerant and `2` is strict.
|
|
7432
|
-
*/
|
|
7433
|
-
matchLevel: number;
|
|
7434
|
-
/**
|
|
7435
|
-
* Number of times the KYC request data has been modified.
|
|
7436
|
-
*
|
|
7437
|
-
* Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
|
|
7438
|
-
*/
|
|
7439
|
-
revision?: number;
|
|
7440
|
-
/** Related links. */
|
|
7441
|
-
_links?: {
|
|
7442
|
-
/** Link URL. */
|
|
7443
|
-
href?: string;
|
|
7444
|
-
/** Type of link. */
|
|
7445
|
-
rel?: "self" | "documents" | "gatherer";
|
|
7446
|
-
}[];
|
|
7447
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
7448
|
-
_embedded?: {
|
|
7449
|
-
documents?: coreComponents["schemas"]["KycDocument"][];
|
|
7450
|
-
};
|
|
7451
|
-
};
|
|
7452
7549
|
/** Settings for KYC score calculation. */
|
|
7453
7550
|
KycSettings: {
|
|
7454
7551
|
identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
@@ -7484,9 +7581,10 @@ export interface coreComponents {
|
|
|
7484
7581
|
/** Specifies if this payment instrument can be used as a backup for invoice payment retries. */
|
|
7485
7582
|
UseAsBackup: boolean;
|
|
7486
7583
|
/** Payment card information. */
|
|
7487
|
-
|
|
7584
|
+
PaymentCard: {
|
|
7488
7585
|
/** ID of the payment instrument. */
|
|
7489
7586
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
7587
|
+
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7490
7588
|
/** Method of payment instrument. */
|
|
7491
7589
|
method?: "payment-card";
|
|
7492
7590
|
/**
|
|
@@ -7536,11 +7634,8 @@ export interface coreComponents {
|
|
|
7536
7634
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
7537
7635
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7538
7636
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
7539
|
-
};
|
|
7540
|
-
PaymentCard: coreComponents["schemas"]["CommonPaymentCard"] & {
|
|
7541
|
-
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7542
7637
|
/**
|
|
7543
|
-
*
|
|
7638
|
+
* ID of the sticky gateway account.
|
|
7544
7639
|
* All future payments are processed by this gateway account.
|
|
7545
7640
|
*
|
|
7546
7641
|
* For more information,
|
|
@@ -7569,9 +7664,10 @@ export interface coreComponents {
|
|
|
7569
7664
|
customer?: { [key: string]: any };
|
|
7570
7665
|
};
|
|
7571
7666
|
};
|
|
7572
|
-
|
|
7667
|
+
BankAccount: {
|
|
7573
7668
|
/** ID of the payment instrument. */
|
|
7574
7669
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
7670
|
+
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7575
7671
|
/** Method of payment instrument. */
|
|
7576
7672
|
method?: "ach";
|
|
7577
7673
|
/** Name of the bank. */
|
|
@@ -7602,21 +7698,18 @@ export interface coreComponents {
|
|
|
7602
7698
|
last4?: string;
|
|
7603
7699
|
/** Status of the bank account. */
|
|
7604
7700
|
status?: "active" | "deactivated";
|
|
7605
|
-
useAsBackup?: coreComponents["schemas"]["UseAsBackup"];
|
|
7606
|
-
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
7607
|
-
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7608
|
-
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
7609
|
-
};
|
|
7610
|
-
BankAccount: coreComponents["schemas"]["CommonBankAccount"] & {
|
|
7611
|
-
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7612
7701
|
/**
|
|
7613
|
-
*
|
|
7702
|
+
* ID of the sticky gateway account.
|
|
7614
7703
|
* All future payments are processed by this gateway account.
|
|
7615
7704
|
*
|
|
7616
7705
|
* For more information, see [Gateway routing](https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts).
|
|
7617
7706
|
*/
|
|
7618
7707
|
stickyGatewayAccountId?: string | null;
|
|
7619
7708
|
riskMetadata?: coreComponents["schemas"]["RiskMetadata"];
|
|
7709
|
+
useAsBackup?: coreComponents["schemas"]["UseAsBackup"];
|
|
7710
|
+
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
7711
|
+
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7712
|
+
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
7620
7713
|
/** Related links. */
|
|
7621
7714
|
_links?: {
|
|
7622
7715
|
/** Link URL. */
|
|
@@ -7629,13 +7722,14 @@ export interface coreComponents {
|
|
|
7629
7722
|
customer?: { [key: string]: any };
|
|
7630
7723
|
};
|
|
7631
7724
|
};
|
|
7632
|
-
|
|
7725
|
+
PayPalAccount: {
|
|
7633
7726
|
/** ID of the payment instrument. */
|
|
7634
7727
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
7728
|
+
customerId: coreComponents["schemas"]["CustomerId"];
|
|
7635
7729
|
/** Method of payment instrument. */
|
|
7636
|
-
method
|
|
7730
|
+
method: "paypal";
|
|
7637
7731
|
/** Billing address. */
|
|
7638
|
-
billingAddress
|
|
7732
|
+
billingAddress: coreComponents["schemas"]["ContactObject"];
|
|
7639
7733
|
/** PayPal username. */
|
|
7640
7734
|
username?: string;
|
|
7641
7735
|
/** PayPal account status. */
|
|
@@ -7644,11 +7738,8 @@ export interface coreComponents {
|
|
|
7644
7738
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
7645
7739
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7646
7740
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
7647
|
-
};
|
|
7648
|
-
PayPalAccount: coreComponents["schemas"]["CommonPayPalAccount"] & {
|
|
7649
|
-
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7650
7741
|
/**
|
|
7651
|
-
*
|
|
7742
|
+
* ID of the sticky gateway account.
|
|
7652
7743
|
* All future payments are processed by this gateway account.
|
|
7653
7744
|
*
|
|
7654
7745
|
* For more information, see [Gateway routing](https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts).
|
|
@@ -7668,9 +7759,10 @@ export interface coreComponents {
|
|
|
7668
7759
|
customer?: { [key: string]: any };
|
|
7669
7760
|
};
|
|
7670
7761
|
};
|
|
7671
|
-
|
|
7762
|
+
KhelocardCard: {
|
|
7672
7763
|
/** ID of the payment instrument. */
|
|
7673
7764
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
7765
|
+
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7674
7766
|
/** Method of payment instrument. */
|
|
7675
7767
|
method?: "Khelocard";
|
|
7676
7768
|
/**
|
|
@@ -7695,11 +7787,8 @@ export interface coreComponents {
|
|
|
7695
7787
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
7696
7788
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7697
7789
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
7698
|
-
};
|
|
7699
|
-
KhelocardCard: coreComponents["schemas"]["CommonKhelocardCard"] & {
|
|
7700
|
-
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7701
7790
|
/**
|
|
7702
|
-
*
|
|
7791
|
+
* ID of the sticky gateway account.
|
|
7703
7792
|
* All future payments are processed by this gateway account.
|
|
7704
7793
|
*
|
|
7705
7794
|
* For more information,
|
|
@@ -7868,26 +7957,24 @@ export interface coreComponents {
|
|
|
7868
7957
|
| "Yandex-money"
|
|
7869
7958
|
| "Zotapay"
|
|
7870
7959
|
| "Zimpler";
|
|
7871
|
-
|
|
7960
|
+
AlternativeInstrument: {
|
|
7872
7961
|
/** ID of the payment instrument. */
|
|
7873
7962
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
7963
|
+
customerId: coreComponents["schemas"]["CustomerId"];
|
|
7874
7964
|
/** Payment method of the payment instrument. */
|
|
7875
|
-
method
|
|
7965
|
+
method: coreComponents["schemas"]["AlternativePaymentMethods"] & {
|
|
7876
7966
|
[key: string]: any;
|
|
7877
7967
|
};
|
|
7878
7968
|
/** Billing address of the user that is associated with the payment instrument. */
|
|
7879
|
-
billingAddress
|
|
7969
|
+
billingAddress: coreComponents["schemas"]["ContactObject"];
|
|
7880
7970
|
/** Payment instrument status. */
|
|
7881
7971
|
status?: "active" | "deactivated";
|
|
7882
7972
|
useAsBackup?: coreComponents["schemas"]["UseAsBackup"];
|
|
7883
7973
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
7884
7974
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
7885
7975
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
7886
|
-
};
|
|
7887
|
-
AlternativeInstrument: coreComponents["schemas"]["CommonAlternativeInstrument"] & {
|
|
7888
|
-
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
7889
7976
|
/**
|
|
7890
|
-
*
|
|
7977
|
+
* ID of the sticky gateway account.
|
|
7891
7978
|
* All future payments are processed by this gateway account.
|
|
7892
7979
|
*
|
|
7893
7980
|
* For more information,
|
|
@@ -8005,7 +8092,7 @@ export interface coreComponents {
|
|
|
8005
8092
|
*/
|
|
8006
8093
|
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
8007
8094
|
/**
|
|
8008
|
-
*
|
|
8095
|
+
* ID of the sticky gateway account.
|
|
8009
8096
|
* All future payments are processed by this gateway account.
|
|
8010
8097
|
*
|
|
8011
8098
|
* For more information,
|
|
@@ -8025,7 +8112,7 @@ export interface coreComponents {
|
|
|
8025
8112
|
/** Billing address. */
|
|
8026
8113
|
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
8027
8114
|
/**
|
|
8028
|
-
*
|
|
8115
|
+
* ID of the sticky gateway account.
|
|
8029
8116
|
* All future payments are processed by this gateway account.
|
|
8030
8117
|
*
|
|
8031
8118
|
* For more information,
|
|
@@ -8043,7 +8130,7 @@ export interface coreComponents {
|
|
|
8043
8130
|
/** Billing address. */
|
|
8044
8131
|
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
8045
8132
|
/**
|
|
8046
|
-
*
|
|
8133
|
+
* ID of the sticky gateway account.
|
|
8047
8134
|
* All future payments are processed by this gateway account.
|
|
8048
8135
|
*
|
|
8049
8136
|
* For more information,
|
|
@@ -8267,7 +8354,7 @@ export interface coreComponents {
|
|
|
8267
8354
|
| coreComponents["schemas"]["volume"];
|
|
8268
8355
|
CommonPlan: {
|
|
8269
8356
|
/** ID of the plan. */
|
|
8270
|
-
id?:
|
|
8357
|
+
id?: string;
|
|
8271
8358
|
/**
|
|
8272
8359
|
* Name of the plan.
|
|
8273
8360
|
* This name is displayed on invoices and receipts.
|
|
@@ -8284,8 +8371,8 @@ export interface coreComponents {
|
|
|
8284
8371
|
* such as: bold, underline, italic, and hyperlinks.
|
|
8285
8372
|
*/
|
|
8286
8373
|
richDescription?: string;
|
|
8287
|
-
/**
|
|
8288
|
-
productId:
|
|
8374
|
+
/** ID of the related product. */
|
|
8375
|
+
productId: string;
|
|
8289
8376
|
/** Name-value pairs that specify the product options. */
|
|
8290
8377
|
productOptions?: { [key: string]: string } | null;
|
|
8291
8378
|
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
@@ -8456,9 +8543,9 @@ export interface coreComponents {
|
|
|
8456
8543
|
* Pricing and variations are set within plans.
|
|
8457
8544
|
* For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/tag/Plans/).
|
|
8458
8545
|
*/
|
|
8459
|
-
|
|
8546
|
+
Product: {
|
|
8460
8547
|
/** ID of the product. */
|
|
8461
|
-
id?:
|
|
8548
|
+
id?: string;
|
|
8462
8549
|
/** Name of the product. */
|
|
8463
8550
|
name: string;
|
|
8464
8551
|
/** Unit label, such as per `seat` or per `unit`. */
|
|
@@ -8476,11 +8563,6 @@ export interface coreComponents {
|
|
|
8476
8563
|
* For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/tag/Plans/).
|
|
8477
8564
|
*/
|
|
8478
8565
|
options?: string[];
|
|
8479
|
-
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
8480
|
-
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
8481
|
-
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
8482
|
-
};
|
|
8483
|
-
Product: coreComponents["schemas"]["CommonProduct"] & {
|
|
8484
8566
|
/**
|
|
8485
8567
|
* Tax category of the product.
|
|
8486
8568
|
* For a complete list of supported tax categories, see [TaxJar sales tax API reference](https://developers.taxjar.com/api/reference/#get-list-tax-categories).
|
|
@@ -8495,6 +8577,9 @@ export interface coreComponents {
|
|
|
8495
8577
|
/** ID of the credit journal account. */
|
|
8496
8578
|
creditAccountId?: string | null;
|
|
8497
8579
|
} | null;
|
|
8580
|
+
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
8581
|
+
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
8582
|
+
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
8498
8583
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
8499
8584
|
};
|
|
8500
8585
|
ReadyToPayAmount: {
|
|
@@ -8505,7 +8590,7 @@ export interface coreComponents {
|
|
|
8505
8590
|
ReadyToPayItems: {
|
|
8506
8591
|
items: {
|
|
8507
8592
|
/** ID of the plan. */
|
|
8508
|
-
planId:
|
|
8593
|
+
planId: string;
|
|
8509
8594
|
/** Number of product units in the specified plan. */
|
|
8510
8595
|
quantity: number;
|
|
8511
8596
|
}[];
|
|
@@ -8599,7 +8684,7 @@ export interface coreComponents {
|
|
|
8599
8684
|
name: "PayPal billing agreement";
|
|
8600
8685
|
/** ID of the PayPal merchant. */
|
|
8601
8686
|
paypalMerchantId: string;
|
|
8602
|
-
/** PayPal client
|
|
8687
|
+
/** ID of the PayPal client. */
|
|
8603
8688
|
paypalClientId: string;
|
|
8604
8689
|
/** PayPal billing agreement token. */
|
|
8605
8690
|
billingAgreementToken: string;
|
|
@@ -8679,7 +8764,7 @@ export interface coreComponents {
|
|
|
8679
8764
|
};
|
|
8680
8765
|
OrderItem: {
|
|
8681
8766
|
/** ID of the plan. */
|
|
8682
|
-
planId?:
|
|
8767
|
+
planId?: string;
|
|
8683
8768
|
/** Number of product units in the specified plan. */
|
|
8684
8769
|
quantity?: number;
|
|
8685
8770
|
/** Plan details. */
|
|
@@ -9156,16 +9241,16 @@ export interface coreComponents {
|
|
|
9156
9241
|
/** Description of the pause reason in free form. */
|
|
9157
9242
|
description?: string | null;
|
|
9158
9243
|
/**
|
|
9159
|
-
* Date when the service period pauses.
|
|
9244
|
+
* Date and time when the service period pauses.
|
|
9160
9245
|
*
|
|
9161
|
-
* This time
|
|
9246
|
+
* This time must be later than the current time.
|
|
9162
9247
|
* If this time is earlier then the current time, the current time is used.
|
|
9163
9248
|
*
|
|
9164
9249
|
* If this field is omitted, this value defaults to the current time.
|
|
9165
9250
|
*/
|
|
9166
9251
|
effectiveTime?: string | null;
|
|
9167
9252
|
/**
|
|
9168
|
-
*
|
|
9253
|
+
* Date and time when the pause ends and the subscription resumes billing.
|
|
9169
9254
|
*
|
|
9170
9255
|
* To resume a subscription from this point in time,
|
|
9171
9256
|
* use the current time or an earlier time.
|
|
@@ -9330,7 +9415,7 @@ export interface coreComponents {
|
|
|
9330
9415
|
/** ID of the subscription for which a usage is reported. */
|
|
9331
9416
|
subscriptionId: coreComponents["schemas"]["ResourceId"];
|
|
9332
9417
|
/** ID of the plan for which a usage is reported. */
|
|
9333
|
-
planId:
|
|
9418
|
+
planId: string;
|
|
9334
9419
|
/** ID of the invoice to which usage is applied. This value is populated when the invoice is issued. */
|
|
9335
9420
|
invoiceId?: string | null;
|
|
9336
9421
|
/** ID of the invoice item to which usage is applied. This value is populated when the invoice is issued. */
|
|
@@ -9407,7 +9492,7 @@ export interface coreComponents {
|
|
|
9407
9492
|
method: "paypal";
|
|
9408
9493
|
/** Paypal instrument details required for express checkout. */
|
|
9409
9494
|
paymentInstrument: {
|
|
9410
|
-
/** PayPal merchant
|
|
9495
|
+
/** ID of the PayPal merchant. */
|
|
9411
9496
|
paypalMerchantId: string;
|
|
9412
9497
|
/** PayPal billing agreement token. */
|
|
9413
9498
|
billingAgreementToken: string;
|
|
@@ -9546,7 +9631,7 @@ export interface coreComponents {
|
|
|
9546
9631
|
linkToken: string;
|
|
9547
9632
|
/** Plaid public token. */
|
|
9548
9633
|
publicToken: string;
|
|
9549
|
-
/** Plaid account
|
|
9634
|
+
/** ID of the Plaid account. */
|
|
9550
9635
|
accountId: string;
|
|
9551
9636
|
};
|
|
9552
9637
|
/** Billing address object. */
|
|
@@ -10069,7 +10154,8 @@ export interface coreComponents {
|
|
|
10069
10154
|
PayoutRequest: {
|
|
10070
10155
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
10071
10156
|
websiteId: coreComponents["schemas"]["WebsiteId"];
|
|
10072
|
-
|
|
10157
|
+
/** ID of the customer who is requesting a payout. */
|
|
10158
|
+
customerId: coreComponents["schemas"]["CustomerId"];
|
|
10073
10159
|
/** ID of the requested payment instrument to offer for the payout. */
|
|
10074
10160
|
paymentInstrumentId?: coreComponents["schemas"]["ResourceId"];
|
|
10075
10161
|
/** Currency of the payout. */
|
|
@@ -10107,6 +10193,11 @@ export interface coreComponents {
|
|
|
10107
10193
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10108
10194
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
10109
10195
|
}[];
|
|
10196
|
+
/**
|
|
10197
|
+
* URL where the customer is redirected when a payment instrument is selected. The default value is the website URL.
|
|
10198
|
+
* Use `{{id}}` as a placeholder for the payout request ID.
|
|
10199
|
+
*/
|
|
10200
|
+
selectedPaymentInstrumentRedirectUrl?: string;
|
|
10110
10201
|
/** Date and time when the payout request is created. */
|
|
10111
10202
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10112
10203
|
/** Date and time when the payout request is updated. */
|
|
@@ -10118,7 +10209,7 @@ export interface coreComponents {
|
|
|
10118
10209
|
/** Items details. */
|
|
10119
10210
|
items: {
|
|
10120
10211
|
/** ID of the plan. */
|
|
10121
|
-
planId:
|
|
10212
|
+
planId: string;
|
|
10122
10213
|
/** Number of product units in the specified plan. */
|
|
10123
10214
|
quantity?: number;
|
|
10124
10215
|
}[];
|
|
@@ -10142,9 +10233,9 @@ export interface coreComponents {
|
|
|
10142
10233
|
/** Total cost of the purchase item. */
|
|
10143
10234
|
price?: number;
|
|
10144
10235
|
/** ID of the related plan. */
|
|
10145
|
-
planId?:
|
|
10236
|
+
planId?: string;
|
|
10146
10237
|
/** ID of the related product. */
|
|
10147
|
-
productId?:
|
|
10238
|
+
productId?: string;
|
|
10148
10239
|
}[];
|
|
10149
10240
|
/** Available shipping rates. */
|
|
10150
10241
|
shippingRates?: coreComponents["schemas"]["ShippingOption"][];
|
|
@@ -10235,6 +10326,93 @@ export interface coreComponents {
|
|
|
10235
10326
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
10236
10327
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
10237
10328
|
};
|
|
10329
|
+
RiskScoreBoolean: {
|
|
10330
|
+
/** Value added to the risk score of the transaction. */
|
|
10331
|
+
value: number;
|
|
10332
|
+
} | null;
|
|
10333
|
+
RiskScoreBracket: {
|
|
10334
|
+
/** Risk factor values range with corresponding risk score increment value. First matched bracket is applied. */
|
|
10335
|
+
brackets: {
|
|
10336
|
+
/** Minimal risk factor value when condition is applied. */
|
|
10337
|
+
start: number;
|
|
10338
|
+
/** Maximal risk factor value when condition is applied. */
|
|
10339
|
+
end: number;
|
|
10340
|
+
/** Value added to the risk score of the transaction. */
|
|
10341
|
+
value: number;
|
|
10342
|
+
}[];
|
|
10343
|
+
} | null;
|
|
10344
|
+
/** Risk score rules. */
|
|
10345
|
+
RiskScoreRules: {
|
|
10346
|
+
/** Specifies whether the customer's IP address is related to a proxy. */
|
|
10347
|
+
isProxy: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10348
|
+
/** Specifies whether the customer's IP address is related to a VPN. */
|
|
10349
|
+
isVpn: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10350
|
+
/** Specifies whether the customer's IP address is related to TOR. */
|
|
10351
|
+
isTor: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10352
|
+
/** Specifies whether the customer's IP address is related to hosting. */
|
|
10353
|
+
isHosting: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10354
|
+
/** Specifies whether the customer's billing address country and geo-IP address are not the same. */
|
|
10355
|
+
hasMismatchedBillingAddressCountry: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10356
|
+
/** Specifies whether the customer's bank country and geo-IP address are not the same. */
|
|
10357
|
+
hasMismatchedBankCountry: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10358
|
+
/** Specifies whether the customer's browser time zone and the IP address associated time zone are not the same. */
|
|
10359
|
+
hasMismatchedTimeZone: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10360
|
+
/** Specifies whether the customer's billing address name and primary address name are not the same. */
|
|
10361
|
+
hasMismatchedHolderName: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10362
|
+
/** Specifies whether the holder name seems fake. */
|
|
10363
|
+
hasFakeName: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10364
|
+
/** Specifies whether the geo-IP country, or the customer's billing country, is considered a high risk country. */
|
|
10365
|
+
isHighRiskCountry: coreComponents["schemas"]["RiskScoreBoolean"];
|
|
10366
|
+
/** Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours. */
|
|
10367
|
+
paymentInstrumentVelocity: coreComponents["schemas"]["RiskScoreBracket"];
|
|
10368
|
+
/** Number of declined transactions for this payment instrument fingerprint in the last 24 hours. */
|
|
10369
|
+
declinedPaymentInstrumentVelocity: coreComponents["schemas"]["RiskScoreBracket"];
|
|
10370
|
+
/** Number of transactions for this device, based on fingerprint, in the last 24 hours. */
|
|
10371
|
+
deviceVelocity: coreComponents["schemas"]["RiskScoreBracket"];
|
|
10372
|
+
/** Number of transactions for this IP address in the last 24 hours. */
|
|
10373
|
+
ipVelocity: coreComponents["schemas"]["RiskScoreBracket"];
|
|
10374
|
+
/** Number of transactions for this email address in the last 24 hours. */
|
|
10375
|
+
emailVelocity: coreComponents["schemas"]["RiskScoreBracket"];
|
|
10376
|
+
/** Number of transactions for this billing address in the last 24 hours. */
|
|
10377
|
+
billingAddressVelocity: coreComponents["schemas"]["RiskScoreBracket"];
|
|
10378
|
+
};
|
|
10379
|
+
RiskScoreBlocklistType: {
|
|
10380
|
+
/** Pass and fail threshold for the blocklist. */
|
|
10381
|
+
riskScoreThreshold: number;
|
|
10382
|
+
/**
|
|
10383
|
+
* Amount of seconds a blocklist exists before it expires.
|
|
10384
|
+
* If value for this field is `0` then blocklist record never expires.
|
|
10385
|
+
*/
|
|
10386
|
+
ttl: number;
|
|
10387
|
+
} | null;
|
|
10388
|
+
/** Risk score blocklist configuration. */
|
|
10389
|
+
RiskScoreBlocklist: {
|
|
10390
|
+
/** House number and ZIP code of the customer's address. */
|
|
10391
|
+
address?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10392
|
+
/** Bank account being charged. */
|
|
10393
|
+
"bank-account"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10394
|
+
/** Bank Identification Number (BIN) of the payment card being charged. */
|
|
10395
|
+
bin?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10396
|
+
/** Country where the customer is making the purchase, and of the payment card billing address. */
|
|
10397
|
+
country?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10398
|
+
/** Rebilly `customerId` of the customer making the purchase. */
|
|
10399
|
+
"customer-id"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10400
|
+
/** Email address of the customer making the purchase. */
|
|
10401
|
+
email?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10402
|
+
/** Email address domain of the customer making the purchase. */
|
|
10403
|
+
"email-domain"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10404
|
+
/**
|
|
10405
|
+
* Fingerprint of the user's device.
|
|
10406
|
+
* A device fingerprint is a unique token that is used to identify the user.
|
|
10407
|
+
* The device fingerprint is generated based on device attributes,
|
|
10408
|
+
* such as: hardware, software, IP address, language, browser, and more.
|
|
10409
|
+
*/
|
|
10410
|
+
fingerprint?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10411
|
+
/** IP address of the customer making the purchase. */
|
|
10412
|
+
"ip-address"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10413
|
+
/** Payment card number being charged. */
|
|
10414
|
+
"payment-card"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
|
|
10415
|
+
};
|
|
10238
10416
|
};
|
|
10239
10417
|
responses: {
|
|
10240
10418
|
/** Unauthorized access. Invalid credentials used. */
|
|
@@ -10565,7 +10743,7 @@ export interface coreComponents {
|
|
|
10565
10743
|
CustomerRedirect: {
|
|
10566
10744
|
content: {
|
|
10567
10745
|
"application/json": {
|
|
10568
|
-
/**
|
|
10746
|
+
/** ID of the transaction. */
|
|
10569
10747
|
transactionId?: string;
|
|
10570
10748
|
/** URL customer redirected to. */
|
|
10571
10749
|
redirectUrl?: string;
|
|
@@ -10701,7 +10879,7 @@ export interface coreComponents {
|
|
|
10701
10879
|
InvoiceWebhook: {
|
|
10702
10880
|
content: {
|
|
10703
10881
|
"application/json": {
|
|
10704
|
-
/**
|
|
10882
|
+
/** ID of the invoice. */
|
|
10705
10883
|
invoiceId?: string;
|
|
10706
10884
|
/** Type of webhook event. */
|
|
10707
10885
|
eventType?:
|
|
@@ -10796,7 +10974,7 @@ export interface coreComponents {
|
|
|
10796
10974
|
SubscriptionWebhook: {
|
|
10797
10975
|
content: {
|
|
10798
10976
|
"application/json": {
|
|
10799
|
-
/**
|
|
10977
|
+
/** ID of the order. */
|
|
10800
10978
|
subscriptionId?: string;
|
|
10801
10979
|
/** Type of webhook event. */
|
|
10802
10980
|
eventType?:
|
|
@@ -10879,9 +11057,9 @@ export interface coreComponents {
|
|
|
10879
11057
|
RenewalInvoiceIssued: {
|
|
10880
11058
|
content: {
|
|
10881
11059
|
"application/json": {
|
|
10882
|
-
/**
|
|
11060
|
+
/** ID of the order. */
|
|
10883
11061
|
subscriptionId?: string;
|
|
10884
|
-
/**
|
|
11062
|
+
/** ID of the invoice. */
|
|
10885
11063
|
invoiceId?: string;
|
|
10886
11064
|
/** Type of webhook event. */
|
|
10887
11065
|
eventType?: "renewal-invoice-issued";
|
|
@@ -12190,7 +12368,7 @@ export interface operations {
|
|
|
12190
12368
|
* Performs a fuzzy search that uses Soundex.
|
|
12191
12369
|
* Note that some returned fields may not contain values.
|
|
12192
12370
|
*/
|
|
12193
|
-
|
|
12371
|
+
GetCustomerAmlHit: {
|
|
12194
12372
|
parameters: {
|
|
12195
12373
|
path: {
|
|
12196
12374
|
/** ID of the resource. */
|
|
@@ -12361,7 +12539,7 @@ export interface operations {
|
|
|
12361
12539
|
path: {
|
|
12362
12540
|
/** ID of the resource. */
|
|
12363
12541
|
id: coreComponents["parameters"]["resourceId"];
|
|
12364
|
-
/**
|
|
12542
|
+
/** ID of the customer timeline message. */
|
|
12365
12543
|
messageId: string;
|
|
12366
12544
|
};
|
|
12367
12545
|
};
|
|
@@ -12383,7 +12561,7 @@ export interface operations {
|
|
|
12383
12561
|
path: {
|
|
12384
12562
|
/** ID of the resource. */
|
|
12385
12563
|
id: coreComponents["parameters"]["resourceId"];
|
|
12386
|
-
/**
|
|
12564
|
+
/** ID of the customer timeline message. */
|
|
12387
12565
|
messageId: string;
|
|
12388
12566
|
};
|
|
12389
12567
|
};
|
|
@@ -15457,7 +15635,7 @@ export interface operations {
|
|
|
15457
15635
|
404: coreComponents["responses"]["NotFound"];
|
|
15458
15636
|
};
|
|
15459
15637
|
};
|
|
15460
|
-
/**
|
|
15638
|
+
/** Creates or updates (upserts) a cancellation order with a specified ID. */
|
|
15461
15639
|
PutSubscriptionCancellation: {
|
|
15462
15640
|
parameters: {
|
|
15463
15641
|
path: {
|
|
@@ -17092,7 +17270,11 @@ export interface operations {
|
|
|
17092
17270
|
403: coreComponents["responses"]["Forbidden"];
|
|
17093
17271
|
};
|
|
17094
17272
|
};
|
|
17095
|
-
/**
|
|
17273
|
+
/**
|
|
17274
|
+
* Creates a payout request.
|
|
17275
|
+
* In the response, the `selectPaymentInstrumentUrl` field is used to redirect the customer to select a preferred payment instrument.
|
|
17276
|
+
* After a payment instrument is selected, the customer is redirected to the `selectedPaymentInstrumentRedirectUrl` value.
|
|
17277
|
+
*/
|
|
17096
17278
|
PostPayoutRequest: {
|
|
17097
17279
|
responses: {
|
|
17098
17280
|
/** Payout request created. */
|
|
@@ -17133,7 +17315,7 @@ export interface operations {
|
|
|
17133
17315
|
404: coreComponents["responses"]["NotFound"];
|
|
17134
17316
|
};
|
|
17135
17317
|
};
|
|
17136
|
-
/** Creates or updates (upserts) a payout request with specified
|
|
17318
|
+
/** Creates or updates (upserts) a payout request with a specified ID. */
|
|
17137
17319
|
PutPayoutRequest: {
|
|
17138
17320
|
parameters: {
|
|
17139
17321
|
path: {
|
|
@@ -17273,7 +17455,7 @@ export interface operations {
|
|
|
17273
17455
|
};
|
|
17274
17456
|
};
|
|
17275
17457
|
/** Retrieves a list of EDD timeline messages. */
|
|
17276
|
-
|
|
17458
|
+
GetCustomerEddTimelineCollection: {
|
|
17277
17459
|
parameters: {
|
|
17278
17460
|
path: {
|
|
17279
17461
|
/** ID of the resource. */
|
|
@@ -17314,7 +17496,7 @@ export interface operations {
|
|
|
17314
17496
|
};
|
|
17315
17497
|
};
|
|
17316
17498
|
/** Creates an EDD timeline comment. */
|
|
17317
|
-
|
|
17499
|
+
PostCustomerEddTimeline: {
|
|
17318
17500
|
parameters: {
|
|
17319
17501
|
path: {
|
|
17320
17502
|
/** ID of the resource. */
|
|
@@ -17340,8 +17522,49 @@ export interface operations {
|
|
|
17340
17522
|
};
|
|
17341
17523
|
};
|
|
17342
17524
|
};
|
|
17525
|
+
/** Retrieves an EDD message with a specified ID. */
|
|
17526
|
+
GetCustomerEddTimeline: {
|
|
17527
|
+
parameters: {
|
|
17528
|
+
path: {
|
|
17529
|
+
/** ID of the resource. */
|
|
17530
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
17531
|
+
/** ID of the EDD timeline message. */
|
|
17532
|
+
messageId: string;
|
|
17533
|
+
};
|
|
17534
|
+
};
|
|
17535
|
+
responses: {
|
|
17536
|
+
/** EDD timeline message retrieved. */
|
|
17537
|
+
200: {
|
|
17538
|
+
content: {
|
|
17539
|
+
"application/json": coreComponents["schemas"]["EddTimeline"];
|
|
17540
|
+
};
|
|
17541
|
+
};
|
|
17542
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17543
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17544
|
+
404: coreComponents["responses"]["NotFound"];
|
|
17545
|
+
};
|
|
17546
|
+
};
|
|
17547
|
+
/** Deletes an EDD timeline message with a specified ID. */
|
|
17548
|
+
DeleteCustomerEddTimeline: {
|
|
17549
|
+
parameters: {
|
|
17550
|
+
path: {
|
|
17551
|
+
/** ID of the resource. */
|
|
17552
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
17553
|
+
/** ID of the EDD timeline message. */
|
|
17554
|
+
messageId: string;
|
|
17555
|
+
};
|
|
17556
|
+
};
|
|
17557
|
+
responses: {
|
|
17558
|
+
/** EDD timeline message deleted. */
|
|
17559
|
+
204: never;
|
|
17560
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17561
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17562
|
+
404: coreComponents["responses"]["NotFound"];
|
|
17563
|
+
409: coreComponents["responses"]["Conflict"];
|
|
17564
|
+
};
|
|
17565
|
+
};
|
|
17343
17566
|
/** Retrieve EDD search results for a customer with a specified ID. */
|
|
17344
|
-
|
|
17567
|
+
GetCustomerEddSearchResultCollection: {
|
|
17345
17568
|
parameters: {
|
|
17346
17569
|
path: {
|
|
17347
17570
|
/** ID of the resource. */
|
|
@@ -17366,6 +17589,108 @@ export interface operations {
|
|
|
17366
17589
|
404: coreComponents["responses"]["NotFound"];
|
|
17367
17590
|
};
|
|
17368
17591
|
};
|
|
17592
|
+
/** Retrieves an EDD search result for a customer with a specified ID. */
|
|
17593
|
+
GetCustomerEddSearchResult: {
|
|
17594
|
+
parameters: {
|
|
17595
|
+
path: {
|
|
17596
|
+
/** ID of the resource. */
|
|
17597
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
17598
|
+
/** ID of the EDD search result. */
|
|
17599
|
+
searchResultId: string;
|
|
17600
|
+
};
|
|
17601
|
+
};
|
|
17602
|
+
responses: {
|
|
17603
|
+
/** EDD search result retrieved. */
|
|
17604
|
+
200: {
|
|
17605
|
+
content: {
|
|
17606
|
+
"application/json": coreComponents["schemas"]["EddSearchResult"];
|
|
17607
|
+
};
|
|
17608
|
+
};
|
|
17609
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17610
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17611
|
+
404: coreComponents["responses"]["NotFound"];
|
|
17612
|
+
};
|
|
17613
|
+
};
|
|
17614
|
+
/** Retrieves risk score rules. */
|
|
17615
|
+
GetRiskScoreRules: {
|
|
17616
|
+
responses: {
|
|
17617
|
+
/** Risk score rules retrieved. */
|
|
17618
|
+
200: {
|
|
17619
|
+
content: {
|
|
17620
|
+
"application/json": coreComponents["schemas"]["RiskScoreRules"];
|
|
17621
|
+
};
|
|
17622
|
+
};
|
|
17623
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17624
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17625
|
+
};
|
|
17626
|
+
};
|
|
17627
|
+
/** Modifies risk score rules. */
|
|
17628
|
+
PutRiskScoreRules: {
|
|
17629
|
+
responses: {
|
|
17630
|
+
/** Risk score rules set. */
|
|
17631
|
+
200: {
|
|
17632
|
+
content: {
|
|
17633
|
+
"application/json": coreComponents["schemas"]["RiskScoreRules"];
|
|
17634
|
+
};
|
|
17635
|
+
};
|
|
17636
|
+
/** Risk score rules set. */
|
|
17637
|
+
201: {
|
|
17638
|
+
headers: {};
|
|
17639
|
+
content: {
|
|
17640
|
+
"application/json": coreComponents["schemas"]["RiskScoreRules"];
|
|
17641
|
+
};
|
|
17642
|
+
};
|
|
17643
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17644
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17645
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
17646
|
+
};
|
|
17647
|
+
/** Risk score rules. */
|
|
17648
|
+
requestBody: {
|
|
17649
|
+
content: {
|
|
17650
|
+
"application/json": coreComponents["schemas"]["RiskScoreRules"];
|
|
17651
|
+
};
|
|
17652
|
+
};
|
|
17653
|
+
};
|
|
17654
|
+
/** Retrieves risk score blocklist rules. */
|
|
17655
|
+
GetRiskScoreBlocklistRules: {
|
|
17656
|
+
responses: {
|
|
17657
|
+
/** Risk score blocklist rules retrieved. */
|
|
17658
|
+
200: {
|
|
17659
|
+
content: {
|
|
17660
|
+
"application/json": coreComponents["schemas"]["RiskScoreBlocklist"];
|
|
17661
|
+
};
|
|
17662
|
+
};
|
|
17663
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17664
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17665
|
+
};
|
|
17666
|
+
};
|
|
17667
|
+
/** Modifies risk score blocklist rules. */
|
|
17668
|
+
PutRiskScoreBlocklistRules: {
|
|
17669
|
+
responses: {
|
|
17670
|
+
/** Risk score blocklist rules set. */
|
|
17671
|
+
200: {
|
|
17672
|
+
content: {
|
|
17673
|
+
"application/json": coreComponents["schemas"]["RiskScoreBlocklist"];
|
|
17674
|
+
};
|
|
17675
|
+
};
|
|
17676
|
+
/** Risk score blocklist rules set. */
|
|
17677
|
+
201: {
|
|
17678
|
+
headers: {};
|
|
17679
|
+
content: {
|
|
17680
|
+
"application/json": coreComponents["schemas"]["RiskScoreBlocklist"];
|
|
17681
|
+
};
|
|
17682
|
+
};
|
|
17683
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
17684
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
17685
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
17686
|
+
};
|
|
17687
|
+
/** Risk score blocklist rules. */
|
|
17688
|
+
requestBody: {
|
|
17689
|
+
content: {
|
|
17690
|
+
"application/json": coreComponents["schemas"]["RiskScoreBlocklist"];
|
|
17691
|
+
};
|
|
17692
|
+
};
|
|
17693
|
+
};
|
|
17369
17694
|
}
|
|
17370
17695
|
/**
|
|
17371
17696
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -17633,7 +17958,7 @@ export interface usersPaths {
|
|
|
17633
17958
|
};
|
|
17634
17959
|
};
|
|
17635
17960
|
"/credential-hashes/plaid": {
|
|
17636
|
-
get: operations["
|
|
17961
|
+
get: operations["GetPlaidCredentialHashCollection"];
|
|
17637
17962
|
/** Creates a Plaid credential. */
|
|
17638
17963
|
post: operations["PostPlaidCredentialHash"];
|
|
17639
17964
|
};
|
|
@@ -17795,7 +18120,7 @@ export interface usersPaths {
|
|
|
17795
18120
|
/** Deletes an email delivery setting with a specified ID. */
|
|
17796
18121
|
delete: operations["DeleteEmailDeliverySetting"];
|
|
17797
18122
|
/** Updates an email delivery setting with a specified ID. */
|
|
17798
|
-
patch: operations["
|
|
18123
|
+
patch: operations["PatchEmailDeliverySetting"];
|
|
17799
18124
|
parameters: {
|
|
17800
18125
|
path: {
|
|
17801
18126
|
/** ID of the resource. */
|
|
@@ -17865,9 +18190,9 @@ export interface usersPaths {
|
|
|
17865
18190
|
};
|
|
17866
18191
|
"/events/{eventType}/timeline": {
|
|
17867
18192
|
/** Retrieves a list of rules engine timeline messages. */
|
|
17868
|
-
get: operations["
|
|
18193
|
+
get: operations["GetRuleSetCollection"];
|
|
17869
18194
|
/** Creates a rules engine timeline comment. */
|
|
17870
|
-
post: operations["
|
|
18195
|
+
post: operations["PostRuleSetTimeline"];
|
|
17871
18196
|
parameters: {
|
|
17872
18197
|
path: {
|
|
17873
18198
|
/** Type of event. */
|
|
@@ -17877,9 +18202,9 @@ export interface usersPaths {
|
|
|
17877
18202
|
};
|
|
17878
18203
|
"/events/{eventType}/timeline/{messageId}": {
|
|
17879
18204
|
/** Retrieves a rules engine timeline message with a specified ID. */
|
|
17880
|
-
get: operations["
|
|
18205
|
+
get: operations["GetRuleSetTimeline"];
|
|
17881
18206
|
/** Deletes a rules engine timeline message with a specified ID. */
|
|
17882
|
-
delete: operations["
|
|
18207
|
+
delete: operations["DeleteRuleSetTimeline"];
|
|
17883
18208
|
parameters: {
|
|
17884
18209
|
path: {
|
|
17885
18210
|
/** Type of event. */
|
|
@@ -17907,7 +18232,7 @@ export interface usersPaths {
|
|
|
17907
18232
|
* Retrieves the change history record of a ruleset with a specified event type.
|
|
17908
18233
|
* A history record is created each time rules are changed.
|
|
17909
18234
|
*/
|
|
17910
|
-
get: operations["
|
|
18235
|
+
get: operations["GetEventRuleHistory"];
|
|
17911
18236
|
parameters: {
|
|
17912
18237
|
path: {
|
|
17913
18238
|
/** Type of event. */
|
|
@@ -18499,9 +18824,9 @@ export interface usersPaths {
|
|
|
18499
18824
|
post: operations["PostUser"];
|
|
18500
18825
|
};
|
|
18501
18826
|
"/users/{id}": {
|
|
18502
|
-
/** Retrieves a user with specified ID. */
|
|
18827
|
+
/** Retrieves a user with a specified ID. */
|
|
18503
18828
|
get: operations["GetUser"];
|
|
18504
|
-
/** Creates or updates (upserts) a user with specified ID. */
|
|
18829
|
+
/** Creates or updates (upserts) a user with a specified ID. */
|
|
18505
18830
|
put: operations["PutUser"];
|
|
18506
18831
|
parameters: {
|
|
18507
18832
|
path: {
|
|
@@ -18550,9 +18875,9 @@ export interface usersPaths {
|
|
|
18550
18875
|
post: operations["PostWebhook"];
|
|
18551
18876
|
};
|
|
18552
18877
|
"/webhooks/{id}": {
|
|
18553
|
-
/** Retrieves a webhook with specified ID. */
|
|
18878
|
+
/** Retrieves a webhook with a specified ID. */
|
|
18554
18879
|
get: operations["GetWebhook"];
|
|
18555
|
-
/** Creates or updates (upserts) a webhook with specified ID. */
|
|
18880
|
+
/** Creates or updates (upserts) a webhook with a specified ID. */
|
|
18556
18881
|
put: operations["PutWebhook"];
|
|
18557
18882
|
parameters: {
|
|
18558
18883
|
path: {
|
|
@@ -18568,11 +18893,11 @@ export interface usersPaths {
|
|
|
18568
18893
|
post: operations["PostWebsite"];
|
|
18569
18894
|
};
|
|
18570
18895
|
"/websites/{id}": {
|
|
18571
|
-
/** Retrieves a website with specified ID. */
|
|
18896
|
+
/** Retrieves a website with a specified ID. */
|
|
18572
18897
|
get: operations["GetWebsite"];
|
|
18573
|
-
/** Creates or updates (upserts) a website with specified ID. */
|
|
18898
|
+
/** Creates or updates (upserts) a website with a specified ID. */
|
|
18574
18899
|
put: operations["PutWebsite"];
|
|
18575
|
-
/** Deletes a website with specified ID. */
|
|
18900
|
+
/** Deletes a website with a specified ID. */
|
|
18576
18901
|
delete: operations["DeleteWebsite"];
|
|
18577
18902
|
parameters: {
|
|
18578
18903
|
path: {
|
|
@@ -18671,15 +18996,15 @@ export interface usersComponents {
|
|
|
18671
18996
|
/** HTTP status code. */
|
|
18672
18997
|
status?: number;
|
|
18673
18998
|
} & usersComponents["schemas"]["BaseProblem"];
|
|
18674
|
-
/**
|
|
18999
|
+
/** ID of the customer resource. */
|
|
18675
19000
|
CustomerId: string;
|
|
18676
19001
|
ApiKeyScope: {
|
|
18677
19002
|
/** Array of account IDs. */
|
|
18678
19003
|
organizationId?: usersComponents["schemas"]["ResourceId"][];
|
|
18679
19004
|
/** Array of product IDs. */
|
|
18680
|
-
productId?:
|
|
19005
|
+
productId?: string[];
|
|
18681
19006
|
/** Array of plan IDs. */
|
|
18682
|
-
planId?:
|
|
19007
|
+
planId?: string[];
|
|
18683
19008
|
/** Array of custom field names. */
|
|
18684
19009
|
customFieldName?: string[];
|
|
18685
19010
|
};
|
|
@@ -19170,12 +19495,11 @@ export interface usersComponents {
|
|
|
19170
19495
|
rel?: "self" | "applicationInstance" | "logoUrl" | "authorLogoUrl";
|
|
19171
19496
|
}[];
|
|
19172
19497
|
};
|
|
19173
|
-
ApplicationInstanceEmbed: {
|
|
19174
|
-
applicationInstance?: usersComponents["schemas"]["ApplicationInstance"];
|
|
19175
|
-
};
|
|
19176
19498
|
UserApplication: usersComponents["schemas"]["Application"] & {
|
|
19177
19499
|
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
19178
|
-
_embedded?:
|
|
19500
|
+
_embedded?: {
|
|
19501
|
+
applicationInstance?: usersComponents["schemas"]["ApplicationInstance"];
|
|
19502
|
+
};
|
|
19179
19503
|
};
|
|
19180
19504
|
OwnerApplicationInstance: usersComponents["schemas"]["ApplicationInstance"] & {
|
|
19181
19505
|
organizationId?: usersComponents["schemas"]["OrganizationId"];
|
|
@@ -19193,7 +19517,7 @@ export interface usersComponents {
|
|
|
19193
19517
|
RebillyShipping: {
|
|
19194
19518
|
/** Shipping calculator. */
|
|
19195
19519
|
calculator: "rebilly";
|
|
19196
|
-
/**
|
|
19520
|
+
/** ID of the shipping rate. If unset the cheapest applicable shipping rate is chosen. */
|
|
19197
19521
|
rateId?: string | null;
|
|
19198
19522
|
/** Shipping amount which is calculated from [Shipping rates](https://all-rebilly.redoc.ly/tag/Shipping-rates). */
|
|
19199
19523
|
amount?: number;
|
|
@@ -19299,7 +19623,11 @@ export interface usersComponents {
|
|
|
19299
19623
|
/** Total price of the invoice item. */
|
|
19300
19624
|
price?: number;
|
|
19301
19625
|
/** ID of the product. */
|
|
19302
|
-
productId?:
|
|
19626
|
+
productId?: string;
|
|
19627
|
+
/** ID of the plan. */
|
|
19628
|
+
planId?: string | null;
|
|
19629
|
+
/** ID of the order. */
|
|
19630
|
+
subscriptionId?: string | null;
|
|
19303
19631
|
/** Discount amount applied to the invoice item. */
|
|
19304
19632
|
discountAmount?: number;
|
|
19305
19633
|
/** Date and time when the billing period starts. */
|
|
@@ -20682,25 +21010,14 @@ export interface usersComponents {
|
|
|
20682
21010
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
20683
21011
|
_links?: usersComponents["schemas"]["SelfLink"];
|
|
20684
21012
|
};
|
|
20685
|
-
/** Balance transaction. */
|
|
20686
|
-
BalanceTransactionEmbed: {
|
|
20687
|
-
transaction?: usersComponents["schemas"]["BalanceTransaction"];
|
|
20688
|
-
};
|
|
20689
|
-
/** Transaction object. */
|
|
20690
|
-
TransactionEmbed: {
|
|
20691
|
-
transaction?: usersComponents["schemas"]["Transaction"];
|
|
20692
|
-
};
|
|
20693
21013
|
BalanceTransactionLinks: {
|
|
20694
21014
|
/** Related links. */
|
|
20695
21015
|
_links?: {
|
|
20696
21016
|
/** Link URL. */
|
|
20697
21017
|
href?: string;
|
|
20698
21018
|
/** Type of link. */
|
|
20699
|
-
rel?: "self"
|
|
21019
|
+
rel?: "self";
|
|
20700
21020
|
}[];
|
|
20701
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
20702
|
-
_embedded?: (Partial<usersComponents["schemas"]["BalanceTransactionEmbed"]> &
|
|
20703
|
-
Partial<usersComponents["schemas"]["TransactionEmbed"]>)[];
|
|
20704
21021
|
};
|
|
20705
21022
|
ChargeTransaction: usersComponents["schemas"]["BalanceTransaction"] &
|
|
20706
21023
|
usersComponents["schemas"]["BalanceTransactionLinks"];
|
|
@@ -20726,15 +21043,21 @@ export interface usersComponents {
|
|
|
20726
21043
|
} & usersComponents["schemas"]["BalanceTransactionLinks"];
|
|
20727
21044
|
RiskReserveReleaseTransaction: usersComponents["schemas"]["BalanceTransaction"] &
|
|
20728
21045
|
usersComponents["schemas"]["BalanceTransactionLinks"];
|
|
20729
|
-
|
|
21046
|
+
BillingPortal: {
|
|
20730
21047
|
/** ID of the billing portal. */
|
|
20731
21048
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
21049
|
+
websiteId: usersComponents["schemas"]["WebsiteId"];
|
|
20732
21050
|
/**
|
|
20733
21051
|
* Path segment that is appended to the billing portal URL to help make it human-readable.
|
|
20734
21052
|
* Example: `https://example.com/billing-portal/{slug}`.
|
|
20735
21053
|
*/
|
|
20736
21054
|
slug: string;
|
|
20737
|
-
|
|
21055
|
+
/**
|
|
21056
|
+
* Billing portal name.
|
|
21057
|
+
* This name is for internal use and helps you to organize and differentiate billing portals.
|
|
21058
|
+
* This value is not displayed to your customers.
|
|
21059
|
+
*/
|
|
21060
|
+
name: string;
|
|
20738
21061
|
/**
|
|
20739
21062
|
* Custom domain for the billing portal.
|
|
20740
21063
|
* The default domain is: `portal.secure-payments.app`.
|
|
@@ -20776,21 +21099,13 @@ export interface usersComponents {
|
|
|
20776
21099
|
termsOfService?: string;
|
|
20777
21100
|
};
|
|
20778
21101
|
};
|
|
20779
|
-
createdTime?: usersComponents["schemas"]["CreatedTime"];
|
|
20780
|
-
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
20781
|
-
};
|
|
20782
|
-
BillingPortal: usersComponents["schemas"]["CommonBillingPortal"] & {
|
|
20783
|
-
/**
|
|
20784
|
-
* Billing portal name.
|
|
20785
|
-
* This name is for internal use and helps you to organize and differentiate billing portals.
|
|
20786
|
-
* This value is not displayed to your customers.
|
|
20787
|
-
*/
|
|
20788
|
-
name: string;
|
|
20789
21102
|
/**
|
|
20790
21103
|
* Status of the billing portal. If the status is `inactive`,
|
|
20791
21104
|
* the billing portal URL results in a 404 error.
|
|
20792
21105
|
*/
|
|
20793
21106
|
status: "active" | "inactive";
|
|
21107
|
+
createdTime?: usersComponents["schemas"]["CreatedTime"];
|
|
21108
|
+
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
20794
21109
|
_links?: usersComponents["schemas"]["SelfLink"];
|
|
20795
21110
|
};
|
|
20796
21111
|
BroadcastMessage: {
|
|
@@ -20877,7 +21192,7 @@ export interface usersComponents {
|
|
|
20877
21192
|
};
|
|
20878
21193
|
CheckoutFormFixedPlan: {
|
|
20879
21194
|
/** ID of the plan. */
|
|
20880
|
-
planId:
|
|
21195
|
+
planId: string;
|
|
20881
21196
|
/**
|
|
20882
21197
|
* Type of plan. If this value is set to `fixed`,
|
|
20883
21198
|
* customers cannot choose the plan quantity.
|
|
@@ -20890,7 +21205,7 @@ export interface usersComponents {
|
|
|
20890
21205
|
};
|
|
20891
21206
|
CheckoutFormVariablePlan: {
|
|
20892
21207
|
/** ID of the plan. */
|
|
20893
|
-
planId:
|
|
21208
|
+
planId: string;
|
|
20894
21209
|
/**
|
|
20895
21210
|
* Type of plan. If this value is set to `variable`,
|
|
20896
21211
|
* customers can choose the plan quantity.
|
|
@@ -20962,7 +21277,7 @@ export interface usersComponents {
|
|
|
20962
21277
|
paymentMethods?: usersComponents["schemas"]["PaymentMethod"][];
|
|
20963
21278
|
/** Visual customization options for the checkout form. */
|
|
20964
21279
|
customization?: {
|
|
20965
|
-
/**
|
|
21280
|
+
/** ID of the linked file object. */
|
|
20966
21281
|
logoId?: usersComponents["schemas"]["ResourceId"];
|
|
20967
21282
|
/** Summary text. */
|
|
20968
21283
|
summary?: string;
|
|
@@ -21112,7 +21427,7 @@ export interface usersComponents {
|
|
|
21112
21427
|
* ID of the website that is assigned to the Plaid account.
|
|
21113
21428
|
* If this value is not set, credentials are for all websites.
|
|
21114
21429
|
*/
|
|
21115
|
-
websiteId?:
|
|
21430
|
+
websiteId?: string;
|
|
21116
21431
|
/** ID of the Plaid client. */
|
|
21117
21432
|
clientId: string;
|
|
21118
21433
|
/** Plaid secret token. */
|
|
@@ -21186,7 +21501,7 @@ export interface usersComponents {
|
|
|
21186
21501
|
AvalaraCredential: usersComponents["schemas"]["Credential"] & {
|
|
21187
21502
|
/** Avalara license key. */
|
|
21188
21503
|
licenseKey: string;
|
|
21189
|
-
/** Avalara account
|
|
21504
|
+
/** ID of the Avalara account. */
|
|
21190
21505
|
accountId: string;
|
|
21191
21506
|
_links?: usersComponents["schemas"]["SelfLink"];
|
|
21192
21507
|
};
|
|
@@ -21214,7 +21529,7 @@ export interface usersComponents {
|
|
|
21214
21529
|
name: string;
|
|
21215
21530
|
/** Status of the email message. */
|
|
21216
21531
|
status?: "pending" | "verified";
|
|
21217
|
-
/** SMTP or Email Service Provider (ESP) credential
|
|
21532
|
+
/** ID of the SMTP or Email Service Provider (ESP) credential. */
|
|
21218
21533
|
credentialId?: string;
|
|
21219
21534
|
/** Email service provider name. */
|
|
21220
21535
|
provider?:
|
|
@@ -21237,7 +21552,7 @@ export interface usersComponents {
|
|
|
21237
21552
|
status: "draft" | "outbox" | "sending" | "sent" | "failed";
|
|
21238
21553
|
/** Metadata associated with the email message. */
|
|
21239
21554
|
metadata?: { [key: string]: string };
|
|
21240
|
-
/** SMTP or Email Service Provider (ESP) credential
|
|
21555
|
+
/** ID of the SMTP or Email Service Provider (ESP) credential. */
|
|
21241
21556
|
credentialHash?: string;
|
|
21242
21557
|
/** Email address of the sender. */
|
|
21243
21558
|
from: string;
|
|
@@ -21459,9 +21774,9 @@ export interface usersComponents {
|
|
|
21459
21774
|
};
|
|
21460
21775
|
/** Create an Intuit QuickBooks balance transaction entry. */
|
|
21461
21776
|
"create-intuit-quickbooks-balance-transaction-entry": usersComponents["schemas"]["RuleAction"] & {
|
|
21462
|
-
/**
|
|
21777
|
+
/** ID of the debit QuickBooks account. */
|
|
21463
21778
|
debitAccount: string;
|
|
21464
|
-
/**
|
|
21779
|
+
/** ID of the credit QuickBooks account. */
|
|
21465
21780
|
creditAccount: string;
|
|
21466
21781
|
/**
|
|
21467
21782
|
* QuickBooks balance transaction entry description.
|
|
@@ -21492,13 +21807,19 @@ export interface usersComponents {
|
|
|
21492
21807
|
};
|
|
21493
21808
|
/** Update an Intuit QuickBooks invoice. */
|
|
21494
21809
|
"update-intuit-quickbooks-invoice": usersComponents["schemas"]["RuleAction"] & {
|
|
21495
|
-
/**
|
|
21810
|
+
/** ID of the unearned revenue QuickBooks account. */
|
|
21496
21811
|
unearnedRevenueAccount: string;
|
|
21497
|
-
/**
|
|
21812
|
+
/**
|
|
21813
|
+
* ID of the taxes QuickBooks account.
|
|
21814
|
+
* If supplied taxes are represented as separate line items instead of integrated tax field.
|
|
21815
|
+
*/
|
|
21498
21816
|
taxesAccount?: string | null;
|
|
21499
|
-
/**
|
|
21817
|
+
/**
|
|
21818
|
+
* ID of the discounts QuickBooks account.
|
|
21819
|
+
* If not set `unearnedRevenueAccount` is used for discounts.
|
|
21820
|
+
*/
|
|
21500
21821
|
discountsAccount?: string | null;
|
|
21501
|
-
/** QuickBooks department
|
|
21822
|
+
/** ID of the QuickBooks department. */
|
|
21502
21823
|
department?: string | null;
|
|
21503
21824
|
template?: usersComponents["schemas"]["QuickbooksTemplate"];
|
|
21504
21825
|
/** ID of the OAuth2 credential. */
|
|
@@ -21518,25 +21839,25 @@ export interface usersComponents {
|
|
|
21518
21839
|
};
|
|
21519
21840
|
/** Create an Intuit QuickBooks payment. */
|
|
21520
21841
|
"create-intuit-quickbooks-payment": usersComponents["schemas"]["RuleAction"] & {
|
|
21521
|
-
/**
|
|
21842
|
+
/** ID of the deposit QuickBooks account. */
|
|
21522
21843
|
depositAccount: string;
|
|
21523
21844
|
/** ID of the OAuth2 credential. */
|
|
21524
21845
|
credentialHash: string;
|
|
21525
21846
|
};
|
|
21526
21847
|
/** Create an Intuit QuickBooks refund receipt. */
|
|
21527
21848
|
"create-intuit-quickbooks-refund-receipt": usersComponents["schemas"]["RuleAction"] & {
|
|
21528
|
-
/**
|
|
21849
|
+
/** ID of the deposit QuickBooks account. */
|
|
21529
21850
|
depositAccount: string;
|
|
21530
|
-
/** QuickBooks department
|
|
21851
|
+
/** ID of the QuickBooks department. */
|
|
21531
21852
|
department?: string | null;
|
|
21532
21853
|
/** ID of the OAuth2 credential. */
|
|
21533
21854
|
credentialHash: string;
|
|
21534
21855
|
};
|
|
21535
21856
|
/** Create an Intuit QuickBooks revenue recognition entry. */
|
|
21536
21857
|
"create-intuit-quickbooks-revenue-recognition-entry": usersComponents["schemas"]["RuleAction"] & {
|
|
21537
|
-
/**
|
|
21858
|
+
/** ID of the debit QuickBooks account. */
|
|
21538
21859
|
debitAccount: string;
|
|
21539
|
-
/**
|
|
21860
|
+
/** ID of the credit QuickBooks account. */
|
|
21540
21861
|
creditAccount: string;
|
|
21541
21862
|
/**
|
|
21542
21863
|
* QuickBooks revenue recognition entry description.
|
|
@@ -22149,7 +22470,7 @@ export interface usersComponents {
|
|
|
22149
22470
|
A1Gateway: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22150
22471
|
/** A1Gateway credentials object. */
|
|
22151
22472
|
credentials: {
|
|
22152
|
-
/** A1Gateway account
|
|
22473
|
+
/** ID of the A1Gateway account. */
|
|
22153
22474
|
accountId: string;
|
|
22154
22475
|
/** A1Gateway password. */
|
|
22155
22476
|
password: string;
|
|
@@ -22259,7 +22580,7 @@ export interface usersComponents {
|
|
|
22259
22580
|
credentials: {
|
|
22260
22581
|
/** Airpay username. */
|
|
22261
22582
|
username: string;
|
|
22262
|
-
/** Airpay merchant
|
|
22583
|
+
/** ID of the Airpay merchant. */
|
|
22263
22584
|
merchantId: string;
|
|
22264
22585
|
/** Airpay password. */
|
|
22265
22586
|
password: string;
|
|
@@ -22270,13 +22591,13 @@ export interface usersComponents {
|
|
|
22270
22591
|
/** AmazonPay gateway configuration. */
|
|
22271
22592
|
AmazonPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22272
22593
|
credentials: {
|
|
22273
|
-
/** AmazonPay merchant
|
|
22594
|
+
/** ID of the AmazonPay merchant. */
|
|
22274
22595
|
merchantId: string;
|
|
22275
|
-
/** AmazonPay store
|
|
22596
|
+
/** ID of the AmazonPay store. */
|
|
22276
22597
|
storeId: string;
|
|
22277
|
-
/** AmazonPay public key
|
|
22598
|
+
/** ID of the AmazonPay public key. */
|
|
22278
22599
|
publicKeyId: string;
|
|
22279
|
-
/** AmazonPay private key
|
|
22600
|
+
/** ID of the AmazonPay private key. */
|
|
22280
22601
|
privateKey: string;
|
|
22281
22602
|
};
|
|
22282
22603
|
};
|
|
@@ -22284,7 +22605,7 @@ export interface usersComponents {
|
|
|
22284
22605
|
AmexVPC: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22285
22606
|
/** AmexVPC credentials object. */
|
|
22286
22607
|
credentials: {
|
|
22287
|
-
/** AmexVPC merchant
|
|
22608
|
+
/** ID of the AmexVPC merchant. */
|
|
22288
22609
|
merchantId: string;
|
|
22289
22610
|
/** AmexVPC access Code. */
|
|
22290
22611
|
accessCode: string;
|
|
@@ -22303,11 +22624,11 @@ export interface usersComponents {
|
|
|
22303
22624
|
ApcoPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22304
22625
|
/** ApcoPay credentials object. */
|
|
22305
22626
|
credentials: {
|
|
22306
|
-
/** ApcoPay profile
|
|
22627
|
+
/** ID of the ApcoPay profile. */
|
|
22307
22628
|
profileID: string;
|
|
22308
22629
|
/** ApcoPay secret word. */
|
|
22309
22630
|
secretWord: string;
|
|
22310
|
-
/** ApcoPay merchant
|
|
22631
|
+
/** ID of the ApcoPay merchant. */
|
|
22311
22632
|
MerchantID: string;
|
|
22312
22633
|
/** ApcoPay merchant password. */
|
|
22313
22634
|
MerchantPassword: string;
|
|
@@ -22370,7 +22691,7 @@ export interface usersComponents {
|
|
|
22370
22691
|
/** AuthorizeNet gateway configuration. */
|
|
22371
22692
|
AuthorizeNet: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22372
22693
|
credentials: {
|
|
22373
|
-
/** AuthorizeNet API login
|
|
22694
|
+
/** ID of the AuthorizeNet API login. */
|
|
22374
22695
|
apiLoginId: string;
|
|
22375
22696
|
/** AuthorizeNet transaction key. */
|
|
22376
22697
|
transactionKey: string;
|
|
@@ -22380,7 +22701,7 @@ export interface usersComponents {
|
|
|
22380
22701
|
Awepay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22381
22702
|
/** Awepay credentials object. */
|
|
22382
22703
|
credentials: {
|
|
22383
|
-
/** Awepay site
|
|
22704
|
+
/** ID of the Awepay site. */
|
|
22384
22705
|
sid: string;
|
|
22385
22706
|
/** Awepay rcode. */
|
|
22386
22707
|
rcode: string;
|
|
@@ -22389,7 +22710,7 @@ export interface usersComponents {
|
|
|
22389
22710
|
/** Bambora gateway configuration. */
|
|
22390
22711
|
Bambora: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22391
22712
|
credentials: {
|
|
22392
|
-
/** Bambora merchant
|
|
22713
|
+
/** ID of the Bambora merchant. */
|
|
22393
22714
|
merchantId: string;
|
|
22394
22715
|
/** Bambora API passcode. */
|
|
22395
22716
|
apiPasscode: string;
|
|
@@ -22399,7 +22720,7 @@ export interface usersComponents {
|
|
|
22399
22720
|
BankSEND: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22400
22721
|
/** BankSEND credentials object. */
|
|
22401
22722
|
credentials: {
|
|
22402
|
-
/** BankSEND merchant
|
|
22723
|
+
/** ID of the BankSEND merchant. */
|
|
22403
22724
|
merchantId: string;
|
|
22404
22725
|
/** BankSEND merchant token. */
|
|
22405
22726
|
merchantToken: string;
|
|
@@ -22450,9 +22771,9 @@ export interface usersComponents {
|
|
|
22450
22771
|
publicKey: string;
|
|
22451
22772
|
/** BraintreePayments private key. */
|
|
22452
22773
|
privateKey: string;
|
|
22453
|
-
/** BraintreePayments merchant
|
|
22774
|
+
/** ID of the BraintreePayments merchant. */
|
|
22454
22775
|
merchantId: string;
|
|
22455
|
-
/** BraintreePayments merchant account
|
|
22776
|
+
/** ID of the BraintreePayments merchant account. */
|
|
22456
22777
|
merchantAccountId: string;
|
|
22457
22778
|
};
|
|
22458
22779
|
};
|
|
@@ -22462,7 +22783,7 @@ export interface usersComponents {
|
|
|
22462
22783
|
credentials: {
|
|
22463
22784
|
/** CASHlib API key. */
|
|
22464
22785
|
apiKey: string;
|
|
22465
|
-
/** CASHlib merchant
|
|
22786
|
+
/** ID of the CASHlib merchant. */
|
|
22466
22787
|
merchantId: string;
|
|
22467
22788
|
};
|
|
22468
22789
|
};
|
|
@@ -22514,7 +22835,7 @@ export interface usersComponents {
|
|
|
22514
22835
|
privateKey: string;
|
|
22515
22836
|
/** CoinPayments IPN secret. */
|
|
22516
22837
|
ipnSecret: string;
|
|
22517
|
-
/** CoinPayments merchant
|
|
22838
|
+
/** ID of the CoinPayments merchant. */
|
|
22518
22839
|
merchantId?: string;
|
|
22519
22840
|
};
|
|
22520
22841
|
settings?: {
|
|
@@ -22532,9 +22853,9 @@ export interface usersComponents {
|
|
|
22532
22853
|
/** Cashflows gateway configuration. */
|
|
22533
22854
|
Cashflows: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22534
22855
|
credentials: {
|
|
22535
|
-
/** Cashflows authentication
|
|
22856
|
+
/** ID of the Cashflows authentication. */
|
|
22536
22857
|
authenticationId?: string;
|
|
22537
|
-
/** Cashflows authentication password. */
|
|
22858
|
+
/** ID of the Cashflows authentication password. */
|
|
22538
22859
|
authPassword: string;
|
|
22539
22860
|
};
|
|
22540
22861
|
};
|
|
@@ -22582,7 +22903,7 @@ export interface usersComponents {
|
|
|
22582
22903
|
/** Cayan gateway configuration. */
|
|
22583
22904
|
Cayan: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22584
22905
|
credentials: {
|
|
22585
|
-
/** Cayan merchant site
|
|
22906
|
+
/** ID of the Cayan merchant site. */
|
|
22586
22907
|
merchantSiteId: string;
|
|
22587
22908
|
/** Cayan merchant name. */
|
|
22588
22909
|
merchantName: string;
|
|
@@ -22594,7 +22915,7 @@ export interface usersComponents {
|
|
|
22594
22915
|
CCAvenue: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22595
22916
|
/** CCAvenue credentials object. */
|
|
22596
22917
|
credentials: {
|
|
22597
|
-
/** CCAvenue merchant
|
|
22918
|
+
/** ID of the CCAvenue merchant. */
|
|
22598
22919
|
merchantId: string;
|
|
22599
22920
|
/** CCAvenue access code. */
|
|
22600
22921
|
accessCode: string;
|
|
@@ -22615,7 +22936,7 @@ export interface usersComponents {
|
|
|
22615
22936
|
password: string;
|
|
22616
22937
|
/** Chase CO number used for delimited file reports. */
|
|
22617
22938
|
coNumber: string;
|
|
22618
|
-
/** Chase division
|
|
22939
|
+
/** ID of the Chase division. */
|
|
22619
22940
|
divisionId: string;
|
|
22620
22941
|
/** Specifies whether to support partial authentications. */
|
|
22621
22942
|
partialAuth: boolean;
|
|
@@ -22655,7 +22976,7 @@ export interface usersComponents {
|
|
|
22655
22976
|
credentials: {
|
|
22656
22977
|
/** Citadel store name. */
|
|
22657
22978
|
storeName: string;
|
|
22658
|
-
/** Citadel store
|
|
22979
|
+
/** ID of the Citadel store. */
|
|
22659
22980
|
storeId: string;
|
|
22660
22981
|
/** Citadel username. */
|
|
22661
22982
|
username: string;
|
|
@@ -22704,7 +23025,7 @@ export interface usersComponents {
|
|
|
22704
23025
|
Coppr: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22705
23026
|
/** Coppr credentials object. */
|
|
22706
23027
|
credentials: {
|
|
22707
|
-
/** Coppr organization
|
|
23028
|
+
/** ID of the Coppr organization. */
|
|
22708
23029
|
organizationId: string;
|
|
22709
23030
|
/** Coppr API key. */
|
|
22710
23031
|
apiKey: string;
|
|
@@ -22722,7 +23043,7 @@ export interface usersComponents {
|
|
|
22722
23043
|
/** Credorax gateway configuration. */
|
|
22723
23044
|
Credorax: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22724
23045
|
credentials: {
|
|
22725
|
-
/** Credorax merchant
|
|
23046
|
+
/** ID of the Credorax merchant. */
|
|
22726
23047
|
merchantId: string;
|
|
22727
23048
|
/** Credorax MD5 signature. */
|
|
22728
23049
|
merchantMd5Signature: string;
|
|
@@ -22732,7 +23053,7 @@ export interface usersComponents {
|
|
|
22732
23053
|
Cryptonator: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22733
23054
|
/** Cryptonator credentials object. */
|
|
22734
23055
|
credentials: {
|
|
22735
|
-
/** Cryptonator merchant
|
|
23056
|
+
/** ID of the Cryptonator merchant. */
|
|
22736
23057
|
merchant_id: string;
|
|
22737
23058
|
/** Cryptonator secret. */
|
|
22738
23059
|
secret: string;
|
|
@@ -22744,7 +23065,7 @@ export interface usersComponents {
|
|
|
22744
23065
|
credentials: {
|
|
22745
23066
|
/** CyberSource access key. */
|
|
22746
23067
|
accessKey: string;
|
|
22747
|
-
/** CyberSource profile
|
|
23068
|
+
/** ID of the CyberSource profile. */
|
|
22748
23069
|
profileId: string;
|
|
22749
23070
|
/** CyberSource secret key. */
|
|
22750
23071
|
secretKey: string;
|
|
@@ -22790,7 +23111,7 @@ export interface usersComponents {
|
|
|
22790
23111
|
/** Dengi gateway configuration. */
|
|
22791
23112
|
Dengi: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22792
23113
|
credentials: {
|
|
22793
|
-
/** Dengi project
|
|
23114
|
+
/** ID of the Dengi project. */
|
|
22794
23115
|
projectId: string;
|
|
22795
23116
|
/** Dengi public key. */
|
|
22796
23117
|
publicKey: string;
|
|
@@ -22801,11 +23122,11 @@ export interface usersComponents {
|
|
|
22801
23122
|
/** Dimoco gateway configuration. */
|
|
22802
23123
|
Dimoco: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22803
23124
|
credentials: {
|
|
22804
|
-
/** Dimoc merchant
|
|
23125
|
+
/** ID of the Dimoc merchant. */
|
|
22805
23126
|
merchantId: string;
|
|
22806
|
-
/** Dimoc project
|
|
23127
|
+
/** ID of the Dimoc project. */
|
|
22807
23128
|
orderId: string;
|
|
22808
|
-
/** Dimoc project
|
|
23129
|
+
/** ID of the Dimoc project. */
|
|
22809
23130
|
password: string;
|
|
22810
23131
|
};
|
|
22811
23132
|
};
|
|
@@ -22835,7 +23156,7 @@ export interface usersComponents {
|
|
|
22835
23156
|
Dragonphoenix: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22836
23157
|
/** Dragonphoenix credentials object. */
|
|
22837
23158
|
credentials: {
|
|
22838
|
-
/** Dragonphoenix site
|
|
23159
|
+
/** ID of the Dragonphoenix site. */
|
|
22839
23160
|
sid: string;
|
|
22840
23161
|
/** Dragonphoenix rcode. */
|
|
22841
23162
|
rcode: string;
|
|
@@ -22847,7 +23168,7 @@ export interface usersComponents {
|
|
|
22847
23168
|
credentials: {
|
|
22848
23169
|
/** Dropayment login. */
|
|
22849
23170
|
login: string;
|
|
22850
|
-
/** Dropayment end point
|
|
23171
|
+
/** ID of the Dropayment end point. */
|
|
22851
23172
|
endpointId: string;
|
|
22852
23173
|
/** Dropayment secret key. */
|
|
22853
23174
|
secretKey: string;
|
|
@@ -22962,9 +23283,9 @@ export interface usersComponents {
|
|
|
22962
23283
|
EPG: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22963
23284
|
/** EPG credentials object. */
|
|
22964
23285
|
credentials: {
|
|
22965
|
-
/**
|
|
23286
|
+
/** ID of the merchant. */
|
|
22966
23287
|
merchantId: string;
|
|
22967
|
-
/**
|
|
23288
|
+
/** ID of the product. */
|
|
22968
23289
|
productId: string;
|
|
22969
23290
|
/** Merchant password. */
|
|
22970
23291
|
merchantPassword: string;
|
|
@@ -22983,7 +23304,7 @@ export interface usersComponents {
|
|
|
22983
23304
|
/** EcorePay gateway configuration. */
|
|
22984
23305
|
EcorePay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22985
23306
|
credentials: {
|
|
22986
|
-
/** EcorePay account
|
|
23307
|
+
/** ID of the EcorePay account. */
|
|
22987
23308
|
accountId: string;
|
|
22988
23309
|
/** EcorePay account authentication. */
|
|
22989
23310
|
accountAuth: string;
|
|
@@ -22993,9 +23314,9 @@ export interface usersComponents {
|
|
|
22993
23314
|
Elavon: usersComponents["schemas"]["GatewayAccount"] & {
|
|
22994
23315
|
/** Elavon credentials object. */
|
|
22995
23316
|
credentials: {
|
|
22996
|
-
/** Elavon merchant
|
|
23317
|
+
/** ID of the Elavon merchant. */
|
|
22997
23318
|
ssl_merchant_id: string;
|
|
22998
|
-
/** Elavon user
|
|
23319
|
+
/** ID of the Elavon user. */
|
|
22999
23320
|
ssl_user_id: string;
|
|
23000
23321
|
/** Elavon pin. */
|
|
23001
23322
|
ssl_pin: string;
|
|
@@ -23017,9 +23338,9 @@ export interface usersComponents {
|
|
|
23017
23338
|
};
|
|
23018
23339
|
/** EMS credentials object. */
|
|
23019
23340
|
credentials: {
|
|
23020
|
-
/** EMS store
|
|
23341
|
+
/** ID of the EMS store. */
|
|
23021
23342
|
storeId: string;
|
|
23022
|
-
/** EMS account
|
|
23343
|
+
/** ID of the EMS account. */
|
|
23023
23344
|
userId: string;
|
|
23024
23345
|
/** EMS password. */
|
|
23025
23346
|
password: string;
|
|
@@ -23044,7 +23365,7 @@ export interface usersComponents {
|
|
|
23044
23365
|
ePay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23045
23366
|
/** ePay credentials object. */
|
|
23046
23367
|
credentials: {
|
|
23047
|
-
/** ePay merchant
|
|
23368
|
+
/** ID of the ePay merchant. */
|
|
23048
23369
|
merchantId: string;
|
|
23049
23370
|
/** ePay secret key. */
|
|
23050
23371
|
secretKey: string;
|
|
@@ -23074,7 +23395,7 @@ export interface usersComponents {
|
|
|
23074
23395
|
ezyEFT: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23075
23396
|
/** ezyEFT credentials object. */
|
|
23076
23397
|
credentials: {
|
|
23077
|
-
/** ezyEFT merchant
|
|
23398
|
+
/** ID of the ezyEFT merchant. */
|
|
23078
23399
|
merchantId: string;
|
|
23079
23400
|
/** ezyEFT merchant token. */
|
|
23080
23401
|
merchantToken: string;
|
|
@@ -23103,7 +23424,7 @@ export interface usersComponents {
|
|
|
23103
23424
|
Finrax: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23104
23425
|
/** Finrax credentials object. */
|
|
23105
23426
|
credentials: {
|
|
23106
|
-
/** Finrax business
|
|
23427
|
+
/** ID of the Finrax business. */
|
|
23107
23428
|
businessId: string;
|
|
23108
23429
|
/** Finrax API key. */
|
|
23109
23430
|
apiKey: string;
|
|
@@ -23127,11 +23448,11 @@ export interface usersComponents {
|
|
|
23127
23448
|
/** Forte gateway configuration. */
|
|
23128
23449
|
Forte: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23129
23450
|
credentials: {
|
|
23130
|
-
/** Forte account
|
|
23451
|
+
/** ID of the Forte account. */
|
|
23131
23452
|
accountId: string;
|
|
23132
|
-
/** Forte location
|
|
23453
|
+
/** ID of the Forte location. */
|
|
23133
23454
|
locationId: string;
|
|
23134
|
-
/** Forte API access
|
|
23455
|
+
/** ID of the Forte API access. */
|
|
23135
23456
|
apiAccessId: string;
|
|
23136
23457
|
/** Forte API secret key. */
|
|
23137
23458
|
apiSecretKey: string;
|
|
@@ -23140,7 +23461,7 @@ export interface usersComponents {
|
|
|
23140
23461
|
/** FundSend gateway configuration. */
|
|
23141
23462
|
FundSend: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23142
23463
|
credentials: {
|
|
23143
|
-
/** FundSend client
|
|
23464
|
+
/** ID of the FundSend client. */
|
|
23144
23465
|
clientId: string;
|
|
23145
23466
|
/** FundSend secret word. */
|
|
23146
23467
|
secretWord: string;
|
|
@@ -23156,7 +23477,7 @@ export interface usersComponents {
|
|
|
23156
23477
|
/** GET gateway configuration. */
|
|
23157
23478
|
GET: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23158
23479
|
credentials: {
|
|
23159
|
-
/** GET account
|
|
23480
|
+
/** ID of the GET account. */
|
|
23160
23481
|
accountId: string;
|
|
23161
23482
|
};
|
|
23162
23483
|
threeDSecureServer?: usersComponents["schemas"]["GET3dsServers"];
|
|
@@ -23165,7 +23486,7 @@ export interface usersComponents {
|
|
|
23165
23486
|
Gigadat: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23166
23487
|
/** Gigadat credentials object. */
|
|
23167
23488
|
credentials: {
|
|
23168
|
-
/** Gigadat campaign
|
|
23489
|
+
/** ID of the Gigadat campaign. */
|
|
23169
23490
|
campaignId: string;
|
|
23170
23491
|
/** Gigadat access token. */
|
|
23171
23492
|
accessToken: string;
|
|
@@ -23180,7 +23501,7 @@ export interface usersComponents {
|
|
|
23180
23501
|
/** GlobalOne gateway configuration. */
|
|
23181
23502
|
GlobalOne: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23182
23503
|
credentials: {
|
|
23183
|
-
/** GlobalOne terminal
|
|
23504
|
+
/** ID of the GlobalOne terminal. */
|
|
23184
23505
|
terminalId: string;
|
|
23185
23506
|
/** GlobalOne shared secret. */
|
|
23186
23507
|
sharedSecret: string;
|
|
@@ -23211,9 +23532,9 @@ export interface usersComponents {
|
|
|
23211
23532
|
Greenbox: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23212
23533
|
/** Greenbox credentials object. */
|
|
23213
23534
|
credentials: {
|
|
23214
|
-
/** Greenbox client
|
|
23535
|
+
/** ID of the Greenbox client. */
|
|
23215
23536
|
clientId: string;
|
|
23216
|
-
/** Greenbox location
|
|
23537
|
+
/** ID of the Greenbox location. */
|
|
23217
23538
|
locationId: string;
|
|
23218
23539
|
/** Greenbox client secret. */
|
|
23219
23540
|
clientSecret: string;
|
|
@@ -23233,7 +23554,7 @@ export interface usersComponents {
|
|
|
23233
23554
|
ICEPAY: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23234
23555
|
/** ICEPAY credentials object. */
|
|
23235
23556
|
credentials: {
|
|
23236
|
-
/** ICEPAY merchant
|
|
23557
|
+
/** ID of the ICEPAY merchant. */
|
|
23237
23558
|
merchantId: string;
|
|
23238
23559
|
/** ICEPAY API secret key. */
|
|
23239
23560
|
secretKey: string;
|
|
@@ -23259,9 +23580,9 @@ export interface usersComponents {
|
|
|
23259
23580
|
Ilixium: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23260
23581
|
/** Ilixium credentials object. */
|
|
23261
23582
|
credentials: {
|
|
23262
|
-
/** Ilixium merchant
|
|
23583
|
+
/** ID of the Ilixium merchant. */
|
|
23263
23584
|
merchantId: string;
|
|
23264
|
-
/** Ilixium account
|
|
23585
|
+
/** ID of the Ilixium account. */
|
|
23265
23586
|
accountId: string;
|
|
23266
23587
|
/** Ilixium digest password. */
|
|
23267
23588
|
digestPassword: string;
|
|
@@ -23288,9 +23609,9 @@ export interface usersComponents {
|
|
|
23288
23609
|
/** Ingenico gateway configuration. */
|
|
23289
23610
|
Ingenico: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23290
23611
|
credentials: {
|
|
23291
|
-
/** Ingenico merchant
|
|
23612
|
+
/** ID of the Ingenico merchant. */
|
|
23292
23613
|
merchantId: string;
|
|
23293
|
-
/** Ingenico API key
|
|
23614
|
+
/** ID of the Ingenico API key. */
|
|
23294
23615
|
apiKeyId: string;
|
|
23295
23616
|
/** Ingenico API secret key. */
|
|
23296
23617
|
apiSecretKey: string;
|
|
@@ -23316,11 +23637,11 @@ export interface usersComponents {
|
|
|
23316
23637
|
};
|
|
23317
23638
|
/** Inovio settings object. */
|
|
23318
23639
|
settings: {
|
|
23319
|
-
/** Inovio website
|
|
23640
|
+
/** ID of the Inovio website. */
|
|
23320
23641
|
websiteId: string;
|
|
23321
|
-
/** Inovio merchant account
|
|
23642
|
+
/** ID of the Inovio merchant account. */
|
|
23322
23643
|
merchantAccountId: string;
|
|
23323
|
-
/** Inovio product
|
|
23644
|
+
/** ID of the Inovio product. */
|
|
23324
23645
|
productId: string;
|
|
23325
23646
|
};
|
|
23326
23647
|
threeDSecureServer?: usersComponents["schemas"]["Inovio3dsServers"];
|
|
@@ -23335,7 +23656,7 @@ export interface usersComponents {
|
|
|
23335
23656
|
password: string;
|
|
23336
23657
|
};
|
|
23337
23658
|
settings?: {
|
|
23338
|
-
/**
|
|
23659
|
+
/** Sub ID of the merchant or organization. */
|
|
23339
23660
|
merchantSubId?: number;
|
|
23340
23661
|
};
|
|
23341
23662
|
};
|
|
@@ -23352,7 +23673,7 @@ export interface usersComponents {
|
|
|
23352
23673
|
IpayOptions: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23353
23674
|
/** Ipay Options credentials object. */
|
|
23354
23675
|
credentials: {
|
|
23355
|
-
/** Ipay Options website
|
|
23676
|
+
/** ID of the Ipay Options website. */
|
|
23356
23677
|
sid: string;
|
|
23357
23678
|
/** Ipay Options rcode. */
|
|
23358
23679
|
rcode: string;
|
|
@@ -23372,7 +23693,7 @@ export interface usersComponents {
|
|
|
23372
23693
|
/** JetPay gateway configuration. */
|
|
23373
23694
|
JetPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23374
23695
|
credentials: {
|
|
23375
|
-
/** JetPay terminal
|
|
23696
|
+
/** ID of the JetPay terminal. */
|
|
23376
23697
|
TerminalID: string;
|
|
23377
23698
|
};
|
|
23378
23699
|
};
|
|
@@ -23391,7 +23712,7 @@ export interface usersComponents {
|
|
|
23391
23712
|
Khelocard: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23392
23713
|
/** Credentials object. */
|
|
23393
23714
|
credentials: {
|
|
23394
|
-
/** Khelocard merchant
|
|
23715
|
+
/** ID of the Khelocard merchant. */
|
|
23395
23716
|
merchantId: string;
|
|
23396
23717
|
/** Referrer URL registered at Khelocard. */
|
|
23397
23718
|
referrer: string;
|
|
@@ -23420,7 +23741,7 @@ export interface usersComponents {
|
|
|
23420
23741
|
Konnektive: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23421
23742
|
/** Credentials object. */
|
|
23422
23743
|
credentials: {
|
|
23423
|
-
/** Konnektive API login
|
|
23744
|
+
/** ID of the Konnektive API login. */
|
|
23424
23745
|
loginId: string;
|
|
23425
23746
|
/** Konnektive API password. */
|
|
23426
23747
|
password: string;
|
|
@@ -23437,7 +23758,7 @@ export interface usersComponents {
|
|
|
23437
23758
|
loonie: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23438
23759
|
/** loonie credentials object. */
|
|
23439
23760
|
credentials: {
|
|
23440
|
-
/** loonie merchant
|
|
23761
|
+
/** ID of the loonie merchant. */
|
|
23441
23762
|
merchantId: string;
|
|
23442
23763
|
/** loonie merchant token. */
|
|
23443
23764
|
merchantToken: string;
|
|
@@ -23461,7 +23782,7 @@ export interface usersComponents {
|
|
|
23461
23782
|
MaxiCash: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23462
23783
|
/** MaxiCash credentials object. */
|
|
23463
23784
|
credentials: {
|
|
23464
|
-
/** MaxiCash API merchant
|
|
23785
|
+
/** ID of the MaxiCash API merchant. */
|
|
23465
23786
|
merchantId: string;
|
|
23466
23787
|
/** MaxiCash API password. */
|
|
23467
23788
|
password: string;
|
|
@@ -23485,7 +23806,7 @@ export interface usersComponents {
|
|
|
23485
23806
|
apiKey: string;
|
|
23486
23807
|
/** MiFinity account number. */
|
|
23487
23808
|
mifinityAccountNumber: string;
|
|
23488
|
-
/** MiFinity account holder
|
|
23809
|
+
/** ID of the MiFinity account holder. */
|
|
23489
23810
|
accountHolderId: string;
|
|
23490
23811
|
/** Three-digit ID provided by MiFinity which indicates through which brand the call made. */
|
|
23491
23812
|
brandId?: string;
|
|
@@ -23496,16 +23817,16 @@ export interface usersComponents {
|
|
|
23496
23817
|
credentials: {
|
|
23497
23818
|
/** Moneris API token. */
|
|
23498
23819
|
apiToken: string;
|
|
23499
|
-
/** Moneris store
|
|
23820
|
+
/** ID of the Moneris store. */
|
|
23500
23821
|
storeId: string;
|
|
23501
23822
|
};
|
|
23502
23823
|
};
|
|
23503
23824
|
/** MTA Pay gateway configuration. */
|
|
23504
23825
|
MtaPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23505
23826
|
credentials: {
|
|
23506
|
-
/** MTA Pay account
|
|
23827
|
+
/** ID of the MTA Pay account. */
|
|
23507
23828
|
accountId: string;
|
|
23508
|
-
/** MTA Pay party
|
|
23829
|
+
/** ID of the MTA Pay party. */
|
|
23509
23830
|
partyId: string;
|
|
23510
23831
|
/** MTA Pay MD5 key. */
|
|
23511
23832
|
md5key: string;
|
|
@@ -23522,7 +23843,7 @@ export interface usersComponents {
|
|
|
23522
23843
|
MuchBetter: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23523
23844
|
/** MuchBetter credentials object. */
|
|
23524
23845
|
credentials: {
|
|
23525
|
-
/** MuchBetter merchant account
|
|
23846
|
+
/** ID of the MuchBetter merchant account. */
|
|
23526
23847
|
merchantAccountId: string;
|
|
23527
23848
|
/** MuchBetter API key. */
|
|
23528
23849
|
apiKey: string;
|
|
@@ -23557,7 +23878,7 @@ export interface usersComponents {
|
|
|
23557
23878
|
Neosurf: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23558
23879
|
/** Neosurf credentials object. */
|
|
23559
23880
|
credentials: {
|
|
23560
|
-
/** Neosurf merchant
|
|
23881
|
+
/** ID of the Neosurf merchant. */
|
|
23561
23882
|
merchantId: string;
|
|
23562
23883
|
/** Neosurf API secret key. */
|
|
23563
23884
|
secretKey: string;
|
|
@@ -23578,7 +23899,7 @@ export interface usersComponents {
|
|
|
23578
23899
|
credentials: {
|
|
23579
23900
|
/** NMI API token. */
|
|
23580
23901
|
username: string;
|
|
23581
|
-
/** NMI store
|
|
23902
|
+
/** ID of the NMI store. */
|
|
23582
23903
|
password: string;
|
|
23583
23904
|
};
|
|
23584
23905
|
settings?: {
|
|
@@ -23621,7 +23942,7 @@ export interface usersComponents {
|
|
|
23621
23942
|
NGenius: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23622
23943
|
/** NGenius credentials object. */
|
|
23623
23944
|
credentials: {
|
|
23624
|
-
/** NGenius outlet
|
|
23945
|
+
/** ID of the NGenius outlet. */
|
|
23625
23946
|
outletId: string;
|
|
23626
23947
|
/** NGenius API key. */
|
|
23627
23948
|
apiKey: string;
|
|
@@ -23660,7 +23981,7 @@ export interface usersComponents {
|
|
|
23660
23981
|
nuaPayCommonName: string;
|
|
23661
23982
|
/** NuaPay serial number. */
|
|
23662
23983
|
nuaPaySerialNumber: string;
|
|
23663
|
-
/** NuaPay account
|
|
23984
|
+
/** ID of the NuaPay account. */
|
|
23664
23985
|
nuaPayAccountId: string;
|
|
23665
23986
|
/** NuaPay origiantor IBAN. */
|
|
23666
23987
|
nuaPayOriginatorIban: string;
|
|
@@ -23729,9 +24050,9 @@ export interface usersComponents {
|
|
|
23729
24050
|
/** Pagsmile gateway configuration. */
|
|
23730
24051
|
Pagsmile: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23731
24052
|
credentials: {
|
|
23732
|
-
/** Pagsmile merchant
|
|
24053
|
+
/** ID of the Pagsmile merchant. */
|
|
23733
24054
|
merchantId: string;
|
|
23734
|
-
/** Pagsmile application
|
|
24055
|
+
/** ID of the Pagsmile application. */
|
|
23735
24056
|
appId: string;
|
|
23736
24057
|
/** Pagsmile secret key. */
|
|
23737
24058
|
secretKey: string;
|
|
@@ -23776,7 +24097,7 @@ export interface usersComponents {
|
|
|
23776
24097
|
ParamountEft: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23777
24098
|
/** Paramount credentials object. */
|
|
23778
24099
|
credentials: {
|
|
23779
|
-
/**
|
|
24100
|
+
/** ID of the merchant account. */
|
|
23780
24101
|
merchant_id: string;
|
|
23781
24102
|
/** Merchant account password. */
|
|
23782
24103
|
merchant_pass: string;
|
|
@@ -23788,7 +24109,7 @@ export interface usersComponents {
|
|
|
23788
24109
|
ParamountInterac: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23789
24110
|
/** ParamountInterac credentials object. */
|
|
23790
24111
|
credentials: {
|
|
23791
|
-
/** ParamountInterac merchant
|
|
24112
|
+
/** ID of the ParamountInterac merchant. */
|
|
23792
24113
|
merchantId: string;
|
|
23793
24114
|
/** ParamountInterac encryption key. */
|
|
23794
24115
|
encryptionKey: string;
|
|
@@ -23798,7 +24119,7 @@ export interface usersComponents {
|
|
|
23798
24119
|
settings?: {
|
|
23799
24120
|
/** Specifies if the gateway account is in sandbox mode. */
|
|
23800
24121
|
sandbox: boolean;
|
|
23801
|
-
/**
|
|
24122
|
+
/** Sub ID of the merchant or organization. */
|
|
23802
24123
|
merchantSubId?: number;
|
|
23803
24124
|
};
|
|
23804
24125
|
};
|
|
@@ -23806,7 +24127,7 @@ export interface usersComponents {
|
|
|
23806
24127
|
Pay4Fun: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23807
24128
|
/** Pay4Fun credentials object. */
|
|
23808
24129
|
credentials: {
|
|
23809
|
-
/** Pay4Fun merchant
|
|
24130
|
+
/** ID of the Pay4Fun merchant. */
|
|
23810
24131
|
merchantId: string;
|
|
23811
24132
|
/** Pay4Fun merchant secret. */
|
|
23812
24133
|
merchantSecret: string;
|
|
@@ -23828,7 +24149,7 @@ export interface usersComponents {
|
|
|
23828
24149
|
PayClub: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23829
24150
|
/** PayClub credentials object. */
|
|
23830
24151
|
credentials: {
|
|
23831
|
-
/** PayClub merchant
|
|
24152
|
+
/** ID of the PayClub merchant. */
|
|
23832
24153
|
merchantId?: string;
|
|
23833
24154
|
/** PayClub account number. */
|
|
23834
24155
|
accountNumber: string;
|
|
@@ -23889,7 +24210,7 @@ export interface usersComponents {
|
|
|
23889
24210
|
/** Payeezy gateway configuration. */
|
|
23890
24211
|
Payeezy: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23891
24212
|
credentials: {
|
|
23892
|
-
/** Payeezy merchant
|
|
24213
|
+
/** ID of the Payeezy merchant. */
|
|
23893
24214
|
merchantId: string;
|
|
23894
24215
|
/** Merchant token. */
|
|
23895
24216
|
merchantToken: string;
|
|
@@ -23911,7 +24232,7 @@ export interface usersComponents {
|
|
|
23911
24232
|
* `user` has the same value as `vendor`.
|
|
23912
24233
|
*/
|
|
23913
24234
|
user: string;
|
|
23914
|
-
/** Payflow merchant login
|
|
24235
|
+
/** ID of the Payflow merchant login. */
|
|
23915
24236
|
vendor: string;
|
|
23916
24237
|
/** Payflow merchant password. */
|
|
23917
24238
|
password: string;
|
|
@@ -23928,7 +24249,7 @@ export interface usersComponents {
|
|
|
23928
24249
|
/** PaymenTechnologies gateway configuration. */
|
|
23929
24250
|
PaymenTechnologies: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23930
24251
|
credentials: {
|
|
23931
|
-
/** PaymenTechnologies authenticate
|
|
24252
|
+
/** ID of the PaymenTechnologies authenticate. */
|
|
23932
24253
|
authenticateId: string;
|
|
23933
24254
|
/** PaymenTechnologies authenticate password. */
|
|
23934
24255
|
authenticatePw: string;
|
|
@@ -23954,7 +24275,7 @@ export interface usersComponents {
|
|
|
23954
24275
|
/** PaymentsOS gateway configuration. */
|
|
23955
24276
|
PaymentsOS: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23956
24277
|
credentials: {
|
|
23957
|
-
/** PaymentsOS application
|
|
24278
|
+
/** ID of the PaymentsOS application. */
|
|
23958
24279
|
appId: string;
|
|
23959
24280
|
/** PaymentsOS public key. */
|
|
23960
24281
|
publicKey: string;
|
|
@@ -23991,7 +24312,7 @@ export interface usersComponents {
|
|
|
23991
24312
|
/** Payr gateway configuration. */
|
|
23992
24313
|
Payr: usersComponents["schemas"]["GatewayAccount"] & {
|
|
23993
24314
|
credentials: {
|
|
23994
|
-
/** Payr client
|
|
24315
|
+
/** ID of the Payr client. */
|
|
23995
24316
|
clientId: string;
|
|
23996
24317
|
/** Payr secret word. */
|
|
23997
24318
|
secretWord: string;
|
|
@@ -24016,7 +24337,7 @@ export interface usersComponents {
|
|
|
24016
24337
|
/** Paysafe gateway configuration. */
|
|
24017
24338
|
Paysafe: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24018
24339
|
credentials: {
|
|
24019
|
-
/** Paysafe store
|
|
24340
|
+
/** ID of the Paysafe store. */
|
|
24020
24341
|
storeId: string;
|
|
24021
24342
|
/** Paysafe store password. */
|
|
24022
24343
|
storePwd: string;
|
|
@@ -24043,7 +24364,7 @@ export interface usersComponents {
|
|
|
24043
24364
|
PayTabs: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24044
24365
|
/** PayTabs credentials object. */
|
|
24045
24366
|
credentials: {
|
|
24046
|
-
/** PayTabs profile
|
|
24367
|
+
/** ID of the PayTabs profile. */
|
|
24047
24368
|
profileId: string;
|
|
24048
24369
|
/** PayTabs client key. */
|
|
24049
24370
|
clientKey: string;
|
|
@@ -24055,9 +24376,9 @@ export interface usersComponents {
|
|
|
24055
24376
|
PayULatam: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24056
24377
|
/** PayULatam credentials object. */
|
|
24057
24378
|
credentials: {
|
|
24058
|
-
/** PayULatam merchant
|
|
24379
|
+
/** ID of the PayULatam merchant. */
|
|
24059
24380
|
merchantId: string;
|
|
24060
|
-
/** PayULatam account
|
|
24381
|
+
/** ID of the PayULatam account. */
|
|
24061
24382
|
accountId: string;
|
|
24062
24383
|
/** PayULatam API login. */
|
|
24063
24384
|
apiLogin: string;
|
|
@@ -24080,7 +24401,7 @@ export interface usersComponents {
|
|
|
24080
24401
|
/** Payvision gateway configuration. */
|
|
24081
24402
|
Payvision: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24082
24403
|
credentials: {
|
|
24083
|
-
/** Payvision member
|
|
24404
|
+
/** ID of the Payvision member. */
|
|
24084
24405
|
memberId: string;
|
|
24085
24406
|
/** Payvision member guid. */
|
|
24086
24407
|
memberGuid: string;
|
|
@@ -24106,7 +24427,7 @@ export interface usersComponents {
|
|
|
24106
24427
|
Piastrix: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24107
24428
|
/** Piastrix credentials object. */
|
|
24108
24429
|
credentials: {
|
|
24109
|
-
/** Piastrix shop
|
|
24430
|
+
/** ID of the Piastrix shop. */
|
|
24110
24431
|
shopId: string;
|
|
24111
24432
|
/** Piastrix secret key. */
|
|
24112
24433
|
secretKey: string;
|
|
@@ -24135,7 +24456,7 @@ export interface usersComponents {
|
|
|
24135
24456
|
/** Plugnpay gateway configuration. */
|
|
24136
24457
|
Plugnpay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24137
24458
|
credentials: {
|
|
24138
|
-
/** Plugnpay member
|
|
24459
|
+
/** ID of the Plugnpay member. */
|
|
24139
24460
|
"publisher-name": string;
|
|
24140
24461
|
/** Plugnpay AVS. */
|
|
24141
24462
|
"publisher-password": string;
|
|
@@ -24145,9 +24466,9 @@ export interface usersComponents {
|
|
|
24145
24466
|
PostFinance: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24146
24467
|
/** PostFinance credentials object. */
|
|
24147
24468
|
credentials: {
|
|
24148
|
-
/** PostFinance PSP
|
|
24469
|
+
/** ID of the PostFinance PSP. */
|
|
24149
24470
|
pspId: string;
|
|
24150
|
-
/** PostFinance merchant
|
|
24471
|
+
/** ID of the PostFinance merchant. */
|
|
24151
24472
|
merchantId: string;
|
|
24152
24473
|
/** PostFinance SFTP username. */
|
|
24153
24474
|
sftpUsername: string;
|
|
@@ -24177,7 +24498,10 @@ export interface usersComponents {
|
|
|
24177
24498
|
login: string;
|
|
24178
24499
|
/** PPRO merchant API password. */
|
|
24179
24500
|
password: string;
|
|
24180
|
-
/**
|
|
24501
|
+
/**
|
|
24502
|
+
* ID of the PPRO contract.
|
|
24503
|
+
* This value is used for API credentials.
|
|
24504
|
+
*/
|
|
24181
24505
|
contractId: string;
|
|
24182
24506
|
/** PPRO private key. */
|
|
24183
24507
|
privateKey: string;
|
|
@@ -24204,7 +24528,7 @@ export interface usersComponents {
|
|
|
24204
24528
|
Prosa: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24205
24529
|
/** Prosa credentials object. */
|
|
24206
24530
|
credentials: {
|
|
24207
|
-
/** Prosa entity
|
|
24531
|
+
/** ID of the Prosa entity. */
|
|
24208
24532
|
entityId: string;
|
|
24209
24533
|
/** Prosa access token. */
|
|
24210
24534
|
accessToken: string;
|
|
@@ -24241,7 +24565,7 @@ export interface usersComponents {
|
|
|
24241
24565
|
/** Realex gateway configuration. */
|
|
24242
24566
|
Realex: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24243
24567
|
credentials: {
|
|
24244
|
-
/** Realex merchant
|
|
24568
|
+
/** ID of the Realex merchant. */
|
|
24245
24569
|
merchantId: string;
|
|
24246
24570
|
/** Realex secret key. */
|
|
24247
24571
|
secretKey: string;
|
|
@@ -24254,7 +24578,7 @@ export interface usersComponents {
|
|
|
24254
24578
|
/** Realtime gateway configuration. */
|
|
24255
24579
|
Realtime: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24256
24580
|
credentials: {
|
|
24257
|
-
/** Realtime client
|
|
24581
|
+
/** ID of the Realtime client. */
|
|
24258
24582
|
clientId: string;
|
|
24259
24583
|
/** Realtime secret word. */
|
|
24260
24584
|
secretWord: string;
|
|
@@ -24298,9 +24622,9 @@ export interface usersComponents {
|
|
|
24298
24622
|
Safecharge: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24299
24623
|
/** Safecharge credentials object. */
|
|
24300
24624
|
credentials: {
|
|
24301
|
-
/** Safecharge merchant
|
|
24625
|
+
/** ID of the Safecharge merchant. */
|
|
24302
24626
|
merchantId: string;
|
|
24303
|
-
/** Safecharge site
|
|
24627
|
+
/** ID of the Safecharge site. */
|
|
24304
24628
|
siteId: string;
|
|
24305
24629
|
/** Safecharge secret key. */
|
|
24306
24630
|
secretKey: string;
|
|
@@ -24320,7 +24644,7 @@ export interface usersComponents {
|
|
|
24320
24644
|
/** SMSVoucher gateway configuration. */
|
|
24321
24645
|
SMSVoucher: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24322
24646
|
credentials: {
|
|
24323
|
-
/** SMSVoucher application
|
|
24647
|
+
/** ID of the SMSVoucher application. */
|
|
24324
24648
|
AppId: string;
|
|
24325
24649
|
};
|
|
24326
24650
|
};
|
|
@@ -24339,7 +24663,7 @@ export interface usersComponents {
|
|
|
24339
24663
|
/** Sagepay gateway configuration. */
|
|
24340
24664
|
Sagepay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24341
24665
|
credentials: {
|
|
24342
|
-
/** Sagepay merchant
|
|
24666
|
+
/** ID of the Sagepay merchant. */
|
|
24343
24667
|
M_ID: string;
|
|
24344
24668
|
/** Sagepay merchant key. */
|
|
24345
24669
|
M_KEY: string;
|
|
@@ -24368,7 +24692,7 @@ export interface usersComponents {
|
|
|
24368
24692
|
SecureTrading: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24369
24693
|
/** SecureTrading credentials object. */
|
|
24370
24694
|
credentials: {
|
|
24371
|
-
/** SecureTrading website
|
|
24695
|
+
/** ID of the SecureTrading website. */
|
|
24372
24696
|
websiteId: string;
|
|
24373
24697
|
/** SecureTrading web service username. */
|
|
24374
24698
|
username: string;
|
|
@@ -24435,7 +24759,7 @@ export interface usersComponents {
|
|
|
24435
24759
|
SparkPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24436
24760
|
/** SparkPay credentials object. */
|
|
24437
24761
|
credentials: {
|
|
24438
|
-
/** SparkPay shop
|
|
24762
|
+
/** ID of the SparkPay shop. */
|
|
24439
24763
|
shopId: string;
|
|
24440
24764
|
/** SparkPay secret key. */
|
|
24441
24765
|
secretKey: string;
|
|
@@ -24583,7 +24907,7 @@ export interface usersComponents {
|
|
|
24583
24907
|
* The credentials object may be provided to control the Stripe Connect account to which the gateway account is connected.
|
|
24584
24908
|
*/
|
|
24585
24909
|
credentials?: {
|
|
24586
|
-
/** Stripe account client
|
|
24910
|
+
/** ID of the Stripe account client. */
|
|
24587
24911
|
stripeClientId?: string;
|
|
24588
24912
|
/** Stripe Connect account secret key account. */
|
|
24589
24913
|
stripeSecret?: string;
|
|
@@ -24702,7 +25026,7 @@ export interface usersComponents {
|
|
|
24702
25026
|
credentials: {
|
|
24703
25027
|
/** TWINT store UUID. */
|
|
24704
25028
|
storeUuid: string;
|
|
24705
|
-
/**
|
|
25029
|
+
/** ID of the cash register. */
|
|
24706
25030
|
cashRegisterId: string;
|
|
24707
25031
|
/** TWINT public key. */
|
|
24708
25032
|
publicKey: string;
|
|
@@ -24755,7 +25079,7 @@ export interface usersComponents {
|
|
|
24755
25079
|
username: string;
|
|
24756
25080
|
/** VantivLitle password. */
|
|
24757
25081
|
password: string;
|
|
24758
|
-
/** VantivLitle merchant
|
|
25082
|
+
/** ID of the VantivLitle merchant. */
|
|
24759
25083
|
merchantId: string;
|
|
24760
25084
|
};
|
|
24761
25085
|
threeDSecureServer?: usersComponents["schemas"]["VantivLitle3dsServers"];
|
|
@@ -24781,7 +25105,7 @@ export interface usersComponents {
|
|
|
24781
25105
|
Wallet88: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24782
25106
|
/** Wallet88 credentials object. */
|
|
24783
25107
|
credentials: {
|
|
24784
|
-
/** Wallet88 API site
|
|
25108
|
+
/** ID of the Wallet88 API site. */
|
|
24785
25109
|
sid: string;
|
|
24786
25110
|
/** Wallet88 API rcode. */
|
|
24787
25111
|
rcode: string;
|
|
@@ -24808,7 +25132,7 @@ export interface usersComponents {
|
|
|
24808
25132
|
WesternUnion: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24809
25133
|
/** WesternUnion credentials object. */
|
|
24810
25134
|
credentials: {
|
|
24811
|
-
/** WesternUnion client
|
|
25135
|
+
/** ID of the WesternUnion client. */
|
|
24812
25136
|
clientId: string;
|
|
24813
25137
|
/** WesternUnion certificate Common Name (CN). */
|
|
24814
25138
|
certificateCommonName: string;
|
|
@@ -24911,9 +25235,9 @@ export interface usersComponents {
|
|
|
24911
25235
|
/** Zotapay gateway configuration. */
|
|
24912
25236
|
Zotapay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24913
25237
|
credentials: {
|
|
24914
|
-
/** Zotapay endpoint
|
|
25238
|
+
/** ID of the Zotapay endpoint. */
|
|
24915
25239
|
endpointId: string;
|
|
24916
|
-
/** Zotapay merchant
|
|
25240
|
+
/** ID of the Zotapay merchant. */
|
|
24917
25241
|
merchantId: string;
|
|
24918
25242
|
/** Zotapay merchant secret key. */
|
|
24919
25243
|
merchantSecretKey: string;
|
|
@@ -24934,7 +25258,7 @@ export interface usersComponents {
|
|
|
24934
25258
|
/** eMerchantPay gateway configuration. */
|
|
24935
25259
|
eMerchantPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24936
25260
|
credentials: {
|
|
24937
|
-
/** eMerchantPay client
|
|
25261
|
+
/** ID of the eMerchantPay client. */
|
|
24938
25262
|
clientId?: string;
|
|
24939
25263
|
/** eMerchantPay API key. */
|
|
24940
25264
|
apiKey?: string;
|
|
@@ -24956,7 +25280,7 @@ export interface usersComponents {
|
|
|
24956
25280
|
ecoPayz: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24957
25281
|
/** ecoPayz credentials object. */
|
|
24958
25282
|
credentials: {
|
|
24959
|
-
/** ecoPayz payment page
|
|
25283
|
+
/** ID of the ecoPayz payment page. */
|
|
24960
25284
|
paymentPageId: string;
|
|
24961
25285
|
/** ecoPayz merchant account number. */
|
|
24962
25286
|
merchantAccountNumber: string;
|
|
@@ -24972,7 +25296,7 @@ export interface usersComponents {
|
|
|
24972
25296
|
/** iCanPay gateway configuration. */
|
|
24973
25297
|
iCanPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24974
25298
|
credentials: {
|
|
24975
|
-
/** iCanPay
|
|
25299
|
+
/** Authenticate ID of the iCanPay account. */
|
|
24976
25300
|
authenticateId: string;
|
|
24977
25301
|
/** iCanPay authenticate password. */
|
|
24978
25302
|
authenticatePw: string;
|
|
@@ -24989,7 +25313,7 @@ export interface usersComponents {
|
|
|
24989
25313
|
/** iCheque gateway configuration. */
|
|
24990
25314
|
iCheque: usersComponents["schemas"]["GatewayAccount"] & {
|
|
24991
25315
|
credentials: {
|
|
24992
|
-
/** iCheque client
|
|
25316
|
+
/** ID of the iCheque client. */
|
|
24993
25317
|
clientId: string;
|
|
24994
25318
|
/** iCheque secret word. */
|
|
24995
25319
|
secretWord: string;
|
|
@@ -25009,14 +25333,14 @@ export interface usersComponents {
|
|
|
25009
25333
|
password: string;
|
|
25010
25334
|
};
|
|
25011
25335
|
settings?: {
|
|
25012
|
-
/**
|
|
25336
|
+
/** ID of the merchant or organization. */
|
|
25013
25337
|
merchantSubId?: number;
|
|
25014
25338
|
};
|
|
25015
25339
|
};
|
|
25016
25340
|
/** vegaaH gateway configuration. */
|
|
25017
25341
|
vegaaH: usersComponents["schemas"]["GatewayAccount"] & {
|
|
25018
25342
|
credentials: {
|
|
25019
|
-
/** vegaaH terminal
|
|
25343
|
+
/** ID of the vegaaH terminal. */
|
|
25020
25344
|
terminalId: string;
|
|
25021
25345
|
/** vegaaH password. */
|
|
25022
25346
|
password: string;
|
|
@@ -25026,7 +25350,7 @@ export interface usersComponents {
|
|
|
25026
25350
|
XPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
25027
25351
|
/** XPay credentials object. */
|
|
25028
25352
|
credentials: {
|
|
25029
|
-
/** XPay merchant
|
|
25353
|
+
/** ID of the XPay merchant. */
|
|
25030
25354
|
merchantId: string;
|
|
25031
25355
|
/** XPay encryption key. */
|
|
25032
25356
|
encryptionKey: string;
|
|
@@ -25036,7 +25360,7 @@ export interface usersComponents {
|
|
|
25036
25360
|
Zimpler: usersComponents["schemas"]["GatewayAccount"] & {
|
|
25037
25361
|
/** Zimpler credentials object. */
|
|
25038
25362
|
credentials: {
|
|
25039
|
-
/** Zimpler merchant
|
|
25363
|
+
/** ID of the Zimpler merchant. */
|
|
25040
25364
|
merchantId: string;
|
|
25041
25365
|
/** Zimpler API key. */
|
|
25042
25366
|
apiKey: string;
|
|
@@ -25261,7 +25585,7 @@ export interface usersComponents {
|
|
|
25261
25585
|
userIds?: usersComponents["schemas"]["ResourceId"][];
|
|
25262
25586
|
/** List of user details with which this segment is shared. */
|
|
25263
25587
|
users?: {
|
|
25264
|
-
/**
|
|
25588
|
+
/** ID of the user. */
|
|
25265
25589
|
id?: string;
|
|
25266
25590
|
/** First and last name. */
|
|
25267
25591
|
name?: string;
|
|
@@ -25588,7 +25912,7 @@ export interface usersComponents {
|
|
|
25588
25912
|
};
|
|
25589
25913
|
Session: {
|
|
25590
25914
|
/** ID of the session. */
|
|
25591
|
-
id?:
|
|
25915
|
+
id?: string;
|
|
25592
25916
|
/** Authentication token of the session. */
|
|
25593
25917
|
token?: string;
|
|
25594
25918
|
/**
|
|
@@ -26075,6 +26399,18 @@ export interface usersComponents {
|
|
|
26075
26399
|
};
|
|
26076
26400
|
/** Website settings. */
|
|
26077
26401
|
WebsiteSettings: {
|
|
26402
|
+
/** Cashier form settings. */
|
|
26403
|
+
cashierForm?: {
|
|
26404
|
+
/** Various theme settings used in the cashier form. */
|
|
26405
|
+
theme?: {
|
|
26406
|
+
/** Primary color for the cashier form in hexadecimal format. */
|
|
26407
|
+
colorPrimary: string;
|
|
26408
|
+
/** Secondary color for the cashier form in hexadecimal format. */
|
|
26409
|
+
colorSecondary: string;
|
|
26410
|
+
/** Submit button template. `{{amount}}` can be used as a placeholder for amount and currency. */
|
|
26411
|
+
buttonTemplate?: string;
|
|
26412
|
+
} | null;
|
|
26413
|
+
};
|
|
26078
26414
|
/** Payment form settings. */
|
|
26079
26415
|
paymentForm?: {
|
|
26080
26416
|
/** Hosted payment form [CSS options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles). */
|
|
@@ -26101,13 +26437,15 @@ export interface usersComponents {
|
|
|
26101
26437
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
26102
26438
|
customFields?: usersComponents["schemas"]["ResourceCustomFields"];
|
|
26103
26439
|
settings?: usersComponents["schemas"]["WebsiteSettings"];
|
|
26440
|
+
/** ID of the linked file object. */
|
|
26441
|
+
logoId?: string | null;
|
|
26104
26442
|
organizationId?: usersComponents["schemas"]["OrganizationId"];
|
|
26105
26443
|
/** Related links. */
|
|
26106
26444
|
_links?: {
|
|
26107
26445
|
/** Link URL. */
|
|
26108
26446
|
href?: string;
|
|
26109
26447
|
/** Type of link. */
|
|
26110
|
-
rel?: "self" | "
|
|
26448
|
+
rel?: "self" | "logoUrl";
|
|
26111
26449
|
}[];
|
|
26112
26450
|
};
|
|
26113
26451
|
OrganizationExportResource: {
|
|
@@ -27608,7 +27946,7 @@ export interface operations {
|
|
|
27608
27946
|
403: usersComponents["responses"]["Forbidden"];
|
|
27609
27947
|
};
|
|
27610
27948
|
};
|
|
27611
|
-
|
|
27949
|
+
GetPlaidCredentialHashCollection: {
|
|
27612
27950
|
parameters: {
|
|
27613
27951
|
query: {
|
|
27614
27952
|
/**
|
|
@@ -28487,7 +28825,7 @@ export interface operations {
|
|
|
28487
28825
|
};
|
|
28488
28826
|
};
|
|
28489
28827
|
/** Updates an email delivery setting with a specified ID. */
|
|
28490
|
-
|
|
28828
|
+
PatchEmailDeliverySetting: {
|
|
28491
28829
|
parameters: {
|
|
28492
28830
|
path: {
|
|
28493
28831
|
/** ID of the resource. */
|
|
@@ -28755,7 +29093,7 @@ export interface operations {
|
|
|
28755
29093
|
requestBody: usersComponents["requestBodies"]["RuleSet"];
|
|
28756
29094
|
};
|
|
28757
29095
|
/** Retrieves a list of rules engine timeline messages. */
|
|
28758
|
-
|
|
29096
|
+
GetRuleSetCollection: {
|
|
28759
29097
|
parameters: {
|
|
28760
29098
|
path: {
|
|
28761
29099
|
/** Type of event. */
|
|
@@ -28796,7 +29134,7 @@ export interface operations {
|
|
|
28796
29134
|
};
|
|
28797
29135
|
};
|
|
28798
29136
|
/** Creates a rules engine timeline comment. */
|
|
28799
|
-
|
|
29137
|
+
PostRuleSetTimeline: {
|
|
28800
29138
|
parameters: {
|
|
28801
29139
|
path: {
|
|
28802
29140
|
/** Type of event. */
|
|
@@ -28823,7 +29161,7 @@ export interface operations {
|
|
|
28823
29161
|
};
|
|
28824
29162
|
};
|
|
28825
29163
|
/** Retrieves a rules engine timeline message with a specified ID. */
|
|
28826
|
-
|
|
29164
|
+
GetRuleSetTimeline: {
|
|
28827
29165
|
parameters: {
|
|
28828
29166
|
path: {
|
|
28829
29167
|
/** Type of event. */
|
|
@@ -28845,7 +29183,7 @@ export interface operations {
|
|
|
28845
29183
|
};
|
|
28846
29184
|
};
|
|
28847
29185
|
/** Deletes a rules engine timeline message with a specified ID. */
|
|
28848
|
-
|
|
29186
|
+
DeleteRuleSetTimeline: {
|
|
28849
29187
|
parameters: {
|
|
28850
29188
|
path: {
|
|
28851
29189
|
/** Type of event. */
|
|
@@ -28917,7 +29255,7 @@ export interface operations {
|
|
|
28917
29255
|
* Retrieves the change history record of a ruleset with a specified event type.
|
|
28918
29256
|
* A history record is created each time rules are changed.
|
|
28919
29257
|
*/
|
|
28920
|
-
|
|
29258
|
+
GetEventRuleHistory: {
|
|
28921
29259
|
parameters: {
|
|
28922
29260
|
path: {
|
|
28923
29261
|
/** Type of event. */
|
|
@@ -31182,7 +31520,7 @@ export interface operations {
|
|
|
31182
31520
|
};
|
|
31183
31521
|
requestBody: usersComponents["requestBodies"]["User"];
|
|
31184
31522
|
};
|
|
31185
|
-
/** Retrieves a user with specified ID. */
|
|
31523
|
+
/** Retrieves a user with a specified ID. */
|
|
31186
31524
|
GetUser: {
|
|
31187
31525
|
parameters: {
|
|
31188
31526
|
path: {
|
|
@@ -31202,7 +31540,7 @@ export interface operations {
|
|
|
31202
31540
|
404: usersComponents["responses"]["NotFound"];
|
|
31203
31541
|
};
|
|
31204
31542
|
};
|
|
31205
|
-
/** Creates or updates (upserts) a user with specified ID. */
|
|
31543
|
+
/** Creates or updates (upserts) a user with a specified ID. */
|
|
31206
31544
|
PutUser: {
|
|
31207
31545
|
parameters: {
|
|
31208
31546
|
path: {
|
|
@@ -31342,7 +31680,7 @@ export interface operations {
|
|
|
31342
31680
|
};
|
|
31343
31681
|
requestBody: usersComponents["requestBodies"]["GlobalWebhook"];
|
|
31344
31682
|
};
|
|
31345
|
-
/** Retrieves a webhook with specified ID. */
|
|
31683
|
+
/** Retrieves a webhook with a specified ID. */
|
|
31346
31684
|
GetWebhook: {
|
|
31347
31685
|
parameters: {
|
|
31348
31686
|
path: {
|
|
@@ -31362,7 +31700,7 @@ export interface operations {
|
|
|
31362
31700
|
404: usersComponents["responses"]["NotFound"];
|
|
31363
31701
|
};
|
|
31364
31702
|
};
|
|
31365
|
-
/** Creates or updates (upserts) a webhook with specified ID. */
|
|
31703
|
+
/** Creates or updates (upserts) a webhook with a specified ID. */
|
|
31366
31704
|
PutWebhook: {
|
|
31367
31705
|
parameters: {
|
|
31368
31706
|
path: {
|
|
@@ -31448,7 +31786,7 @@ export interface operations {
|
|
|
31448
31786
|
};
|
|
31449
31787
|
requestBody: usersComponents["requestBodies"]["Website"];
|
|
31450
31788
|
};
|
|
31451
|
-
/** Retrieves a website with specified ID. */
|
|
31789
|
+
/** Retrieves a website with a specified ID. */
|
|
31452
31790
|
GetWebsite: {
|
|
31453
31791
|
parameters: {
|
|
31454
31792
|
path: {
|
|
@@ -31468,7 +31806,7 @@ export interface operations {
|
|
|
31468
31806
|
404: usersComponents["responses"]["NotFound"];
|
|
31469
31807
|
};
|
|
31470
31808
|
};
|
|
31471
|
-
/** Creates or updates (upserts) a website with specified ID. */
|
|
31809
|
+
/** Creates or updates (upserts) a website with a specified ID. */
|
|
31472
31810
|
PutWebsite: {
|
|
31473
31811
|
parameters: {
|
|
31474
31812
|
path: {
|
|
@@ -31497,7 +31835,7 @@ export interface operations {
|
|
|
31497
31835
|
};
|
|
31498
31836
|
requestBody: usersComponents["requestBodies"]["Website"];
|
|
31499
31837
|
};
|
|
31500
|
-
/** Deletes a website with specified ID. */
|
|
31838
|
+
/** Deletes a website with a specified ID. */
|
|
31501
31839
|
DeleteWebsite: {
|
|
31502
31840
|
parameters: {
|
|
31503
31841
|
path: {
|
|
@@ -31752,6 +32090,16 @@ export interface storefrontPaths {
|
|
|
31752
32090
|
};
|
|
31753
32091
|
};
|
|
31754
32092
|
};
|
|
32093
|
+
"/orders/{id}/pause": {
|
|
32094
|
+
/** Pauses an order with a specified ID. */
|
|
32095
|
+
post: operations["StorefrontPostOrderPause"];
|
|
32096
|
+
parameters: {
|
|
32097
|
+
path: {
|
|
32098
|
+
/** ID of the resource. */
|
|
32099
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
32100
|
+
};
|
|
32101
|
+
};
|
|
32102
|
+
};
|
|
31755
32103
|
"/payment": {
|
|
31756
32104
|
/**
|
|
31757
32105
|
* Performs a payment for a transaction or an invoice.
|
|
@@ -31928,6 +32276,38 @@ export interface storefrontPaths {
|
|
|
31928
32276
|
};
|
|
31929
32277
|
};
|
|
31930
32278
|
};
|
|
32279
|
+
"/transactions/{id}/{token}/continue": {
|
|
32280
|
+
/**
|
|
32281
|
+
* Process a KYC interrupted transaction with a specified ID.
|
|
32282
|
+
*
|
|
32283
|
+
* Use this operation to process the transaction after all documents of the KYC request with a specified token have been uploaded.
|
|
32284
|
+
*/
|
|
32285
|
+
post: operations["StorefrontPostKycRequestContinue"];
|
|
32286
|
+
parameters: {
|
|
32287
|
+
path: {
|
|
32288
|
+
/** ID of the resource. */
|
|
32289
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
32290
|
+
/** Token string. */
|
|
32291
|
+
token: storefrontComponents["parameters"]["token"];
|
|
32292
|
+
};
|
|
32293
|
+
};
|
|
32294
|
+
};
|
|
32295
|
+
"/transactions/{id}/{token}/bypass": {
|
|
32296
|
+
/**
|
|
32297
|
+
* Skips an optional KYC request with a specified token, for a transaction with a specified ID.
|
|
32298
|
+
*
|
|
32299
|
+
* Use this operation to skip a KYC request that has been marked as optional in a transaction flow, so that you can further process the transaction.
|
|
32300
|
+
*/
|
|
32301
|
+
post: operations["StorefrontPostKycRequestBypass"];
|
|
32302
|
+
parameters: {
|
|
32303
|
+
path: {
|
|
32304
|
+
/** ID of the resource. */
|
|
32305
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
32306
|
+
/** Token string. */
|
|
32307
|
+
token: storefrontComponents["parameters"]["token"];
|
|
32308
|
+
};
|
|
32309
|
+
};
|
|
32310
|
+
};
|
|
31931
32311
|
"/websites/{id}": {
|
|
31932
32312
|
/**
|
|
31933
32313
|
* Retrieves a website with a specified ID.
|
|
@@ -32012,7 +32392,7 @@ export interface storefrontComponents {
|
|
|
32012
32392
|
/** HTTP status code. */
|
|
32013
32393
|
status?: number;
|
|
32014
32394
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
32015
|
-
/**
|
|
32395
|
+
/** ID of the customer resource. */
|
|
32016
32396
|
CustomerId: string;
|
|
32017
32397
|
/** Currency code in ISO 4217 format. */
|
|
32018
32398
|
CurrencyCode: string;
|
|
@@ -32289,7 +32669,10 @@ export interface storefrontComponents {
|
|
|
32289
32669
|
subAffiliate?: string;
|
|
32290
32670
|
/** Name of the sales agent associated with the lead source. */
|
|
32291
32671
|
salesAgent?: string;
|
|
32292
|
-
/**
|
|
32672
|
+
/**
|
|
32673
|
+
* ID of the lead source click.
|
|
32674
|
+
* This value is passed in the ad click URL for tracking and campaign attribution.
|
|
32675
|
+
*/
|
|
32293
32676
|
clickId?: string;
|
|
32294
32677
|
/** URL from which the lead source originates. */
|
|
32295
32678
|
path?: string;
|
|
@@ -32318,7 +32701,7 @@ export interface storefrontComponents {
|
|
|
32318
32701
|
RebillyShipping: {
|
|
32319
32702
|
/** Shipping calculator. */
|
|
32320
32703
|
calculator: "rebilly";
|
|
32321
|
-
/**
|
|
32704
|
+
/** ID of the shipping rate. If unset the cheapest applicable shipping rate is chosen. */
|
|
32322
32705
|
rateId?: string | null;
|
|
32323
32706
|
/** Shipping amount which is calculated from [Shipping rates](https://all-rebilly.redoc.ly/tag/Shipping-rates). */
|
|
32324
32707
|
amount?: number;
|
|
@@ -32424,7 +32807,11 @@ export interface storefrontComponents {
|
|
|
32424
32807
|
/** Total price of the invoice item. */
|
|
32425
32808
|
price?: number;
|
|
32426
32809
|
/** ID of the product. */
|
|
32427
|
-
productId?:
|
|
32810
|
+
productId?: string;
|
|
32811
|
+
/** ID of the plan. */
|
|
32812
|
+
planId?: string | null;
|
|
32813
|
+
/** ID of the order. */
|
|
32814
|
+
subscriptionId?: string | null;
|
|
32428
32815
|
/** Discount amount applied to the invoice item. */
|
|
32429
32816
|
discountAmount?: number;
|
|
32430
32817
|
/** Date and time when the billing period starts. */
|
|
@@ -33026,44 +33413,6 @@ export interface storefrontComponents {
|
|
|
33026
33413
|
/** Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document. */
|
|
33027
33414
|
faceProofRequired?: boolean;
|
|
33028
33415
|
}[];
|
|
33029
|
-
/** KYC request information. */
|
|
33030
|
-
CommonKycRequest: {
|
|
33031
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33032
|
-
documents: storefrontComponents["schemas"]["KycRequestDocuments"];
|
|
33033
|
-
/** Status of the request. */
|
|
33034
|
-
status?:
|
|
33035
|
-
| "gathering"
|
|
33036
|
-
| "attempted"
|
|
33037
|
-
| "partial"
|
|
33038
|
-
| "pending-review"
|
|
33039
|
-
| "fulfilled"
|
|
33040
|
-
| "failed"
|
|
33041
|
-
| "abandoned"
|
|
33042
|
-
| "expired";
|
|
33043
|
-
/**
|
|
33044
|
-
* URL where the customer is redirected when a KYC document upload is complete.
|
|
33045
|
-
* When the customer is redirected,
|
|
33046
|
-
* Rebilly appends an `info` query parameter that has one of the following values:
|
|
33047
|
-
* - `back`: Customer clicked the `back to website` link.
|
|
33048
|
-
* - `token_expired`: Customer's token expired.
|
|
33049
|
-
* - `success`: Customer uploaded KYC documents that have been analyzed.
|
|
33050
|
-
* - `manual`: Customer uploaded KYC documents that require a manual review.
|
|
33051
|
-
* This is because the analyzer rejected the documents or could not process them.
|
|
33052
|
-
* - `partial`: Some of the customer's KYC documents have been analyzed,
|
|
33053
|
-
* but other documents have not.
|
|
33054
|
-
* For example, this may occur when a proof of address document is analyzed but proof of ID is not.
|
|
33055
|
-
*
|
|
33056
|
-
* Example: `https://example.com?info=success`.
|
|
33057
|
-
*/
|
|
33058
|
-
redirectUrl?: string;
|
|
33059
|
-
/**
|
|
33060
|
-
* Date and time when the request expires.
|
|
33061
|
-
* The default value is one hour in the future.
|
|
33062
|
-
*/
|
|
33063
|
-
expirationTime?: string;
|
|
33064
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
33065
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
33066
|
-
};
|
|
33067
33416
|
/** Reason the document is rejected. */
|
|
33068
33417
|
KycDocumentRejectionReasonTypes:
|
|
33069
33418
|
| "document-unreadable"
|
|
@@ -33324,142 +33673,6 @@ export interface storefrontComponents {
|
|
|
33324
33673
|
| "AstroPay Card";
|
|
33325
33674
|
/** Specifies if this payment instrument can be used as a backup for invoice payment retries. */
|
|
33326
33675
|
UseAsBackup: boolean;
|
|
33327
|
-
/** Payment card information. */
|
|
33328
|
-
CommonPaymentCard: {
|
|
33329
|
-
/** ID of the payment instrument. */
|
|
33330
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33331
|
-
/** Method of payment instrument. */
|
|
33332
|
-
method?: "payment-card";
|
|
33333
|
-
/**
|
|
33334
|
-
* Status of the payment instrument.
|
|
33335
|
-
* An `active` status means that a payment instrument has been used at least once for an approved transaction.
|
|
33336
|
-
* To remove an instrument from use, set this value to `deactivated`.
|
|
33337
|
-
*
|
|
33338
|
-
* For more information, see [Deactivate a payment instrument](../PostPaymentInstrumentDeactivation).
|
|
33339
|
-
*/
|
|
33340
|
-
status?:
|
|
33341
|
-
| "active"
|
|
33342
|
-
| "inactive"
|
|
33343
|
-
| "expired"
|
|
33344
|
-
| "deactivated"
|
|
33345
|
-
| "verification-needed";
|
|
33346
|
-
/**
|
|
33347
|
-
* Unique value that is used to identify the payment instrument.
|
|
33348
|
-
* This value is generated from the `bin` and the `last4` values.
|
|
33349
|
-
* This value contains alphanumeric characters.
|
|
33350
|
-
*/
|
|
33351
|
-
fingerprint?: string;
|
|
33352
|
-
/**
|
|
33353
|
-
* Bank Identification Number (BIN) of the payment card.
|
|
33354
|
-
* This value is the same as the first 6 digits of the associated Primary Account Number (PAN).
|
|
33355
|
-
*/
|
|
33356
|
-
bin?: string;
|
|
33357
|
-
/** Last 4 digits of the associated Primary Account Number (PAN). */
|
|
33358
|
-
last4?: string;
|
|
33359
|
-
/** Primary Account Number (PAN) of the payment card. */
|
|
33360
|
-
pan?: string;
|
|
33361
|
-
/** Expiration year of the payment card. */
|
|
33362
|
-
expYear?: number;
|
|
33363
|
-
/** Expiration month of the payment card. */
|
|
33364
|
-
expMonth?: number;
|
|
33365
|
-
/** Card Verification Value (CVV) of the payment card. */
|
|
33366
|
-
cvv?: string;
|
|
33367
|
-
brand?: storefrontComponents["schemas"]["PaymentCardBrand"];
|
|
33368
|
-
/** Bank country of the payment instrument. */
|
|
33369
|
-
bankCountry?: string;
|
|
33370
|
-
/** Bank name of the payment instrument. */
|
|
33371
|
-
bankName?: string;
|
|
33372
|
-
/** Contact's billing address. */
|
|
33373
|
-
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
33374
|
-
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
33375
|
-
/** URL of the billing portal where the card can be updated. */
|
|
33376
|
-
billingPortalUrl?: string;
|
|
33377
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
33378
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
33379
|
-
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
33380
|
-
};
|
|
33381
|
-
CommonBankAccount: {
|
|
33382
|
-
/** ID of the payment instrument. */
|
|
33383
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33384
|
-
/** Method of payment instrument. */
|
|
33385
|
-
method?: "ach";
|
|
33386
|
-
/** Name of the bank. */
|
|
33387
|
-
bankName?: string;
|
|
33388
|
-
/** Bank routing number. */
|
|
33389
|
-
routingNumber?: string;
|
|
33390
|
-
/**
|
|
33391
|
-
* Type of bank account number.
|
|
33392
|
-
* A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).
|
|
33393
|
-
*/
|
|
33394
|
-
accountNumberType: "BBAN" | "IBAN";
|
|
33395
|
-
/** Type of bank account. */
|
|
33396
|
-
accountType?: "checking" | "savings" | "other";
|
|
33397
|
-
/** Bank Identifier Code (BIC). */
|
|
33398
|
-
bic?: string;
|
|
33399
|
-
/** Customer's billing address. */
|
|
33400
|
-
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
33401
|
-
/**
|
|
33402
|
-
* Unique value which identifies the bank account.
|
|
33403
|
-
* This value contains alphanumeric characters.
|
|
33404
|
-
* Depending on the type of bank account number,
|
|
33405
|
-
* a bank account fingerprint is generated using one of the following:
|
|
33406
|
-
* - BBAN: `last4` and `routingNumber` values.
|
|
33407
|
-
* - IBAN: First 8 characters of the IBAN and the `last4` value.
|
|
33408
|
-
*/
|
|
33409
|
-
fingerprint?: string;
|
|
33410
|
-
/** Last 4 digits of the bank account number. */
|
|
33411
|
-
last4?: string;
|
|
33412
|
-
/** Status of the bank account. */
|
|
33413
|
-
status?: "active" | "deactivated";
|
|
33414
|
-
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
33415
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
33416
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
33417
|
-
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
33418
|
-
};
|
|
33419
|
-
CommonPayPalAccount: {
|
|
33420
|
-
/** ID of the payment instrument. */
|
|
33421
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33422
|
-
/** Method of payment instrument. */
|
|
33423
|
-
method?: "paypal";
|
|
33424
|
-
/** Billing address. */
|
|
33425
|
-
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
33426
|
-
/** PayPal username. */
|
|
33427
|
-
username?: string;
|
|
33428
|
-
/** PayPal account status. */
|
|
33429
|
-
status?: "inactive" | "active" | "deactivated";
|
|
33430
|
-
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
33431
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
33432
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
33433
|
-
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
33434
|
-
};
|
|
33435
|
-
CommonKhelocardCard: {
|
|
33436
|
-
/** ID of the payment instrument. */
|
|
33437
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33438
|
-
/** Method of payment instrument. */
|
|
33439
|
-
method?: "Khelocard";
|
|
33440
|
-
/**
|
|
33441
|
-
* Unique value which identifies the payment instrument.
|
|
33442
|
-
* This value contains alphanumeric characters.
|
|
33443
|
-
* This value is generated from the card number, CVV, and expiration date.
|
|
33444
|
-
*/
|
|
33445
|
-
fingerprint?: string;
|
|
33446
|
-
/** Khelocard card masked number. */
|
|
33447
|
-
number?: string;
|
|
33448
|
-
/** Last 4 digits of the number. */
|
|
33449
|
-
last4?: string;
|
|
33450
|
-
/** Khelocard card expiration year. */
|
|
33451
|
-
expYear?: number;
|
|
33452
|
-
/** Khelocard card expiration month. */
|
|
33453
|
-
expMonth?: number;
|
|
33454
|
-
/** Billing address. */
|
|
33455
|
-
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
33456
|
-
/** Payment instrument status. */
|
|
33457
|
-
status?: "active" | "deactivated";
|
|
33458
|
-
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
33459
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
33460
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
33461
|
-
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
33462
|
-
};
|
|
33463
33676
|
/** Payment method. */
|
|
33464
33677
|
AlternativePaymentMethods:
|
|
33465
33678
|
| "cash"
|
|
@@ -33609,22 +33822,6 @@ export interface storefrontComponents {
|
|
|
33609
33822
|
| "Yandex-money"
|
|
33610
33823
|
| "Zotapay"
|
|
33611
33824
|
| "Zimpler";
|
|
33612
|
-
CommonAlternativeInstrument: {
|
|
33613
|
-
/** ID of the payment instrument. */
|
|
33614
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33615
|
-
/** Payment method of the payment instrument. */
|
|
33616
|
-
method?: storefrontComponents["schemas"]["AlternativePaymentMethods"] & {
|
|
33617
|
-
[key: string]: any;
|
|
33618
|
-
};
|
|
33619
|
-
/** Billing address of the user that is associated with the payment instrument. */
|
|
33620
|
-
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
33621
|
-
/** Payment instrument status. */
|
|
33622
|
-
status?: "active" | "deactivated";
|
|
33623
|
-
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
33624
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
33625
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
33626
|
-
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
33627
|
-
};
|
|
33628
33825
|
PaymentCardCreatePlain: {
|
|
33629
33826
|
/** Method of the payment instrument. */
|
|
33630
33827
|
method: "payment-card";
|
|
@@ -33914,7 +34111,7 @@ export interface storefrontComponents {
|
|
|
33914
34111
|
| storefrontComponents["schemas"]["volume"];
|
|
33915
34112
|
CommonPlan: {
|
|
33916
34113
|
/** ID of the plan. */
|
|
33917
|
-
id?:
|
|
34114
|
+
id?: string;
|
|
33918
34115
|
/**
|
|
33919
34116
|
* Name of the plan.
|
|
33920
34117
|
* This name is displayed on invoices and receipts.
|
|
@@ -33931,8 +34128,8 @@ export interface storefrontComponents {
|
|
|
33931
34128
|
* such as: bold, underline, italic, and hyperlinks.
|
|
33932
34129
|
*/
|
|
33933
34130
|
richDescription?: string;
|
|
33934
|
-
/**
|
|
33935
|
-
productId:
|
|
34131
|
+
/** ID of the related product. */
|
|
34132
|
+
productId: string;
|
|
33936
34133
|
/** Name-value pairs that specify the product options. */
|
|
33937
34134
|
productOptions?: { [key: string]: string } | null;
|
|
33938
34135
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
@@ -34094,39 +34291,6 @@ export interface storefrontComponents {
|
|
|
34094
34291
|
| storefrontComponents["schemas"]["OneTimeSalePlan"]
|
|
34095
34292
|
| storefrontComponents["schemas"]["SubscriptionOrderPlan"]
|
|
34096
34293
|
| storefrontComponents["schemas"]["TrialOnlyPlan"];
|
|
34097
|
-
/**
|
|
34098
|
-
* Products are the items that your business sells.
|
|
34099
|
-
* Products include digital goods, services, and physical goods.
|
|
34100
|
-
* Products appear on invoice line items.
|
|
34101
|
-
* If you set a tax category identifier, taxes are calculated at invoice generation.
|
|
34102
|
-
* If the product is shippable, shipping costs are calculated at invoice generation.
|
|
34103
|
-
* Pricing and variations are set within plans.
|
|
34104
|
-
* For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/tag/Plans/).
|
|
34105
|
-
*/
|
|
34106
|
-
CommonProduct: {
|
|
34107
|
-
/** ID of the product. */
|
|
34108
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
34109
|
-
/** Name of the product. */
|
|
34110
|
-
name: string;
|
|
34111
|
-
/** Unit label, such as per `seat` or per `unit`. */
|
|
34112
|
-
unitLabel: string;
|
|
34113
|
-
/** Description of the product. */
|
|
34114
|
-
description?: string | null;
|
|
34115
|
-
/**
|
|
34116
|
-
* Specifies if the product requires shipping.
|
|
34117
|
-
* If this value is `true`, shipping calculations are applied.
|
|
34118
|
-
*/
|
|
34119
|
-
requiresShipping?: boolean;
|
|
34120
|
-
/**
|
|
34121
|
-
* Product options such as color, size, and so forth.
|
|
34122
|
-
* Product option values are defined in plans.
|
|
34123
|
-
* For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/tag/Plans/).
|
|
34124
|
-
*/
|
|
34125
|
-
options?: string[];
|
|
34126
|
-
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
34127
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
34128
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
34129
|
-
};
|
|
34130
34294
|
ReadyToPayAmount: {
|
|
34131
34295
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
34132
34296
|
/** Amount to pay. */
|
|
@@ -34135,7 +34299,7 @@ export interface storefrontComponents {
|
|
|
34135
34299
|
ReadyToPayItems: {
|
|
34136
34300
|
items: {
|
|
34137
34301
|
/** ID of the plan. */
|
|
34138
|
-
planId:
|
|
34302
|
+
planId: string;
|
|
34139
34303
|
/** Number of product units in the specified plan. */
|
|
34140
34304
|
quantity: number;
|
|
34141
34305
|
}[];
|
|
@@ -34226,7 +34390,7 @@ export interface storefrontComponents {
|
|
|
34226
34390
|
name: "PayPal billing agreement";
|
|
34227
34391
|
/** ID of the PayPal merchant. */
|
|
34228
34392
|
paypalMerchantId: string;
|
|
34229
|
-
/** PayPal client
|
|
34393
|
+
/** ID of the PayPal client. */
|
|
34230
34394
|
paypalClientId: string;
|
|
34231
34395
|
/** PayPal billing agreement token. */
|
|
34232
34396
|
billingAgreementToken: string;
|
|
@@ -34306,7 +34470,7 @@ export interface storefrontComponents {
|
|
|
34306
34470
|
};
|
|
34307
34471
|
OrderItem: {
|
|
34308
34472
|
/** ID of the plan. */
|
|
34309
|
-
planId?:
|
|
34473
|
+
planId?: string;
|
|
34310
34474
|
/** Number of product units in the specified plan. */
|
|
34311
34475
|
quantity?: number;
|
|
34312
34476
|
/** Plan details. */
|
|
@@ -34368,59 +34532,6 @@ export interface storefrontComponents {
|
|
|
34368
34532
|
| storefrontComponents["schemas"]["PaymentMethods"]
|
|
34369
34533
|
| storefrontComponents["schemas"]["PaymentCardCreatePlain"]
|
|
34370
34534
|
| storefrontComponents["schemas"]["BankAccountCreatePlain"];
|
|
34371
|
-
CommonBillingPortal: {
|
|
34372
|
-
/** ID of the billing portal. */
|
|
34373
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
34374
|
-
/**
|
|
34375
|
-
* Path segment that is appended to the billing portal URL to help make it human-readable.
|
|
34376
|
-
* Example: `https://example.com/billing-portal/{slug}`.
|
|
34377
|
-
*/
|
|
34378
|
-
slug: string;
|
|
34379
|
-
websiteId: storefrontComponents["schemas"]["WebsiteId"];
|
|
34380
|
-
/**
|
|
34381
|
-
* Custom domain for the billing portal.
|
|
34382
|
-
* The default domain is: `portal.secure-payments.app`.
|
|
34383
|
-
*/
|
|
34384
|
-
customDomain?: string | null;
|
|
34385
|
-
/** Features that can be enabled for the billing portal. */
|
|
34386
|
-
features?: {
|
|
34387
|
-
/** Specifies if a customer can authenticate with a password. */
|
|
34388
|
-
authenticateWithPassword: boolean;
|
|
34389
|
-
/** Specifies if a customer can cancel an order. */
|
|
34390
|
-
orderCancel: boolean;
|
|
34391
|
-
/** Specifies if a customer can change an order address. */
|
|
34392
|
-
orderAddressEdit: boolean;
|
|
34393
|
-
/** Specifies if a customer can add a new payment instrument. */
|
|
34394
|
-
paymentInstrumentAdd: boolean;
|
|
34395
|
-
/** Specifies if a customer can update their payment instruments. */
|
|
34396
|
-
paymentInstrumentUpdate: boolean;
|
|
34397
|
-
/** Specifies if a customer can disable their payment instruments. */
|
|
34398
|
-
paymentInstrumentDeactivate: boolean;
|
|
34399
|
-
};
|
|
34400
|
-
/** Visual customization options for the billing portal. */
|
|
34401
|
-
customization?: {
|
|
34402
|
-
/** ID of the linked file object. */
|
|
34403
|
-
logoId?: storefrontComponents["schemas"]["ResourceId"];
|
|
34404
|
-
/** Various colors used in the billing portal. */
|
|
34405
|
-
colors?: {
|
|
34406
|
-
/** Primary color for the billing portal in hexadecimal format. */
|
|
34407
|
-
primary: string;
|
|
34408
|
-
/** Secondary color for the billing portal in hexadecimal format. */
|
|
34409
|
-
secondary: string;
|
|
34410
|
-
};
|
|
34411
|
-
/** URLs that are displayed in the billing portal. */
|
|
34412
|
-
links?: {
|
|
34413
|
-
/** Website refund policy URL. */
|
|
34414
|
-
refundPolicy?: string;
|
|
34415
|
-
/** Website privacy policy URL. */
|
|
34416
|
-
privacyPolicy?: string;
|
|
34417
|
-
/** Website terms of service URL. */
|
|
34418
|
-
termsOfService?: string;
|
|
34419
|
-
};
|
|
34420
|
-
};
|
|
34421
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
34422
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
34423
|
-
};
|
|
34424
34535
|
/**
|
|
34425
34536
|
* Custom amount restrictions.
|
|
34426
34537
|
* If this value is `null`, custom amounts are prohibited.
|
|
@@ -34486,7 +34597,7 @@ export interface storefrontComponents {
|
|
|
34486
34597
|
};
|
|
34487
34598
|
CheckoutFormFixedPlan: {
|
|
34488
34599
|
/** ID of the plan. */
|
|
34489
|
-
planId:
|
|
34600
|
+
planId: string;
|
|
34490
34601
|
/**
|
|
34491
34602
|
* Type of plan. If this value is set to `fixed`,
|
|
34492
34603
|
* customers cannot choose the plan quantity.
|
|
@@ -34499,7 +34610,7 @@ export interface storefrontComponents {
|
|
|
34499
34610
|
};
|
|
34500
34611
|
CheckoutFormVariablePlan: {
|
|
34501
34612
|
/** ID of the plan. */
|
|
34502
|
-
planId:
|
|
34613
|
+
planId: string;
|
|
34503
34614
|
/**
|
|
34504
34615
|
* Type of plan. If this value is set to `variable`,
|
|
34505
34616
|
* customers can choose the plan quantity.
|
|
@@ -34571,7 +34682,7 @@ export interface storefrontComponents {
|
|
|
34571
34682
|
paymentMethods?: storefrontComponents["schemas"]["PaymentMethod"][];
|
|
34572
34683
|
/** Visual customization options for the checkout form. */
|
|
34573
34684
|
customization?: {
|
|
34574
|
-
/**
|
|
34685
|
+
/** ID of the linked file object. */
|
|
34575
34686
|
logoId?: storefrontComponents["schemas"]["ResourceId"];
|
|
34576
34687
|
/** Summary text. */
|
|
34577
34688
|
summary?: string;
|
|
@@ -34622,7 +34733,7 @@ export interface storefrontComponents {
|
|
|
34622
34733
|
/** Items details. */
|
|
34623
34734
|
items: {
|
|
34624
34735
|
/** ID of the plan. */
|
|
34625
|
-
planId:
|
|
34736
|
+
planId: string;
|
|
34626
34737
|
/** Number of product units in the specified plan. */
|
|
34627
34738
|
quantity?: number;
|
|
34628
34739
|
}[];
|
|
@@ -34646,9 +34757,9 @@ export interface storefrontComponents {
|
|
|
34646
34757
|
/** Total cost of the purchase item. */
|
|
34647
34758
|
price?: number;
|
|
34648
34759
|
/** ID of the related plan. */
|
|
34649
|
-
planId?:
|
|
34760
|
+
planId?: string;
|
|
34650
34761
|
/** ID of the related product. */
|
|
34651
|
-
productId?:
|
|
34762
|
+
productId?: string;
|
|
34652
34763
|
}[];
|
|
34653
34764
|
/** Available shipping rates. */
|
|
34654
34765
|
shippingRates?: storefrontComponents["schemas"]["ShippingOption"][];
|
|
@@ -34681,6 +34792,18 @@ export interface storefrontComponents {
|
|
|
34681
34792
|
};
|
|
34682
34793
|
/** Website settings. */
|
|
34683
34794
|
WebsiteSettings: {
|
|
34795
|
+
/** Cashier form settings. */
|
|
34796
|
+
cashierForm?: {
|
|
34797
|
+
/** Various theme settings used in the cashier form. */
|
|
34798
|
+
theme?: {
|
|
34799
|
+
/** Primary color for the cashier form in hexadecimal format. */
|
|
34800
|
+
colorPrimary: string;
|
|
34801
|
+
/** Secondary color for the cashier form in hexadecimal format. */
|
|
34802
|
+
colorSecondary: string;
|
|
34803
|
+
/** Submit button template. `{{amount}}` can be used as a placeholder for amount and currency. */
|
|
34804
|
+
buttonTemplate?: string;
|
|
34805
|
+
} | null;
|
|
34806
|
+
};
|
|
34684
34807
|
/** Payment form settings. */
|
|
34685
34808
|
paymentForm?: {
|
|
34686
34809
|
/** Hosted payment form [CSS options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles). */
|
|
@@ -34707,13 +34830,15 @@ export interface storefrontComponents {
|
|
|
34707
34830
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
34708
34831
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
34709
34832
|
settings?: storefrontComponents["schemas"]["WebsiteSettings"];
|
|
34833
|
+
/** ID of the linked file object. */
|
|
34834
|
+
logoId?: string | null;
|
|
34710
34835
|
organizationId?: storefrontComponents["schemas"]["OrganizationId"];
|
|
34711
34836
|
/** Related links. */
|
|
34712
34837
|
_links?: {
|
|
34713
34838
|
/** Link URL. */
|
|
34714
34839
|
href?: string;
|
|
34715
34840
|
/** Type of link. */
|
|
34716
|
-
rel?: "self" | "
|
|
34841
|
+
rel?: "self" | "logoUrl";
|
|
34717
34842
|
}[];
|
|
34718
34843
|
};
|
|
34719
34844
|
/** Default payment instrument information. */
|
|
@@ -34746,9 +34871,55 @@ export interface storefrontComponents {
|
|
|
34746
34871
|
website?: { [key: string]: any };
|
|
34747
34872
|
};
|
|
34748
34873
|
};
|
|
34749
|
-
StorefrontBillingPortal:
|
|
34874
|
+
StorefrontBillingPortal: {
|
|
34875
|
+
/** ID of the billing portal. */
|
|
34876
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
34750
34877
|
/** Session's token used for authentication. */
|
|
34751
34878
|
token?: string;
|
|
34879
|
+
/**
|
|
34880
|
+
* Path segment that is appended to the billing portal URL to help make it human-readable.
|
|
34881
|
+
* Example: `https://example.com/billing-portal/{slug}`.
|
|
34882
|
+
*/
|
|
34883
|
+
slug: string;
|
|
34884
|
+
websiteId: storefrontComponents["schemas"]["WebsiteId"];
|
|
34885
|
+
/** Features that can be enabled for the billing portal. */
|
|
34886
|
+
features?: {
|
|
34887
|
+
/** Specifies if a customer can authenticate with a password. */
|
|
34888
|
+
authenticateWithPassword: boolean;
|
|
34889
|
+
/** Specifies if a customer can cancel an order. */
|
|
34890
|
+
orderCancel: boolean;
|
|
34891
|
+
/** Specifies if a customer can change an order address. */
|
|
34892
|
+
orderAddressEdit: boolean;
|
|
34893
|
+
/** Specifies if a customer can add a new payment instrument. */
|
|
34894
|
+
paymentInstrumentAdd: boolean;
|
|
34895
|
+
/** Specifies if a customer can update their payment instruments. */
|
|
34896
|
+
paymentInstrumentUpdate: boolean;
|
|
34897
|
+
/** Specifies if a customer can disable their payment instruments. */
|
|
34898
|
+
paymentInstrumentDeactivate: boolean;
|
|
34899
|
+
};
|
|
34900
|
+
/** Visual customization options for the billing portal. */
|
|
34901
|
+
customization?: {
|
|
34902
|
+
/** ID of the linked file object. */
|
|
34903
|
+
logoId?: storefrontComponents["schemas"]["ResourceId"];
|
|
34904
|
+
/** Various colors used in the billing portal. */
|
|
34905
|
+
colors?: {
|
|
34906
|
+
/** Primary color for the billing portal in hexadecimal format. */
|
|
34907
|
+
primary: string;
|
|
34908
|
+
/** Secondary color for the billing portal in hexadecimal format. */
|
|
34909
|
+
secondary: string;
|
|
34910
|
+
};
|
|
34911
|
+
/** URLs that are displayed in the billing portal. */
|
|
34912
|
+
links?: {
|
|
34913
|
+
/** Website refund policy URL. */
|
|
34914
|
+
refundPolicy?: string;
|
|
34915
|
+
/** Website privacy policy URL. */
|
|
34916
|
+
privacyPolicy?: string;
|
|
34917
|
+
/** Website terms of service URL. */
|
|
34918
|
+
termsOfService?: string;
|
|
34919
|
+
};
|
|
34920
|
+
};
|
|
34921
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
34922
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
34752
34923
|
/** Related links. */
|
|
34753
34924
|
_links?: {
|
|
34754
34925
|
/** Link URL. */
|
|
@@ -34822,7 +34993,43 @@ export interface storefrontComponents {
|
|
|
34822
34993
|
| storefrontComponents["schemas"]["StorefrontProofOfFundsKycDocument"]
|
|
34823
34994
|
| storefrontComponents["schemas"]["StorefrontProofOfPurchaseKycDocument"]
|
|
34824
34995
|
| storefrontComponents["schemas"]["StorefrontProofOfCreditFileKycDocument"];
|
|
34825
|
-
|
|
34996
|
+
/** KYC request information. */
|
|
34997
|
+
StorefrontKycRequest: {
|
|
34998
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
34999
|
+
documents?: storefrontComponents["schemas"]["KycRequestDocuments"];
|
|
35000
|
+
/** Status of the request. */
|
|
35001
|
+
status?:
|
|
35002
|
+
| "gathering"
|
|
35003
|
+
| "attempted"
|
|
35004
|
+
| "partial"
|
|
35005
|
+
| "pending-review"
|
|
35006
|
+
| "fulfilled"
|
|
35007
|
+
| "failed"
|
|
35008
|
+
| "abandoned"
|
|
35009
|
+
| "expired";
|
|
35010
|
+
/**
|
|
35011
|
+
* URL where the customer is redirected when a KYC document upload is complete.
|
|
35012
|
+
* When the customer is redirected,
|
|
35013
|
+
* Rebilly appends an `info` query parameter that has one of the following values:
|
|
35014
|
+
* - `back`: Customer clicked the `back to website` link.
|
|
35015
|
+
* - `token_expired`: Customer's token expired.
|
|
35016
|
+
* - `success`: Customer uploaded KYC documents that have been analyzed.
|
|
35017
|
+
* - `manual`: Customer uploaded KYC documents that require a manual review.
|
|
35018
|
+
* This is because the analyzer rejected the documents or could not process them.
|
|
35019
|
+
* - `partial`: Some of the customer's KYC documents have been analyzed,
|
|
35020
|
+
* but other documents have not.
|
|
35021
|
+
* For example, this may occur when a proof of address document is analyzed but proof of ID is not.
|
|
35022
|
+
*
|
|
35023
|
+
* Example: `https://example.com?info=success`.
|
|
35024
|
+
*/
|
|
35025
|
+
redirectUrl?: string;
|
|
35026
|
+
/**
|
|
35027
|
+
* Date and time when the request expires.
|
|
35028
|
+
* The default value is one hour in the future.
|
|
35029
|
+
*/
|
|
35030
|
+
expirationTime?: string;
|
|
35031
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35032
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
34826
35033
|
/** Related links. */
|
|
34827
35034
|
_links?: {
|
|
34828
35035
|
/** Link URL. */
|
|
@@ -34830,14 +35037,14 @@ export interface storefrontComponents {
|
|
|
34830
35037
|
/** Type of link. */
|
|
34831
35038
|
rel?: "self" | "documents";
|
|
34832
35039
|
}[];
|
|
34833
|
-
/** Embedded objects that are requested by the `expand` query parameter
|
|
35040
|
+
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
34834
35041
|
_embedded?: {
|
|
34835
35042
|
documents?: any[];
|
|
34836
35043
|
};
|
|
34837
35044
|
};
|
|
34838
35045
|
StorefrontCustomerJWT: {
|
|
34839
|
-
/**
|
|
34840
|
-
id?:
|
|
35046
|
+
/** ID of the session. */
|
|
35047
|
+
id?: string;
|
|
34841
35048
|
/** Session's token used for authentication. */
|
|
34842
35049
|
token?: string;
|
|
34843
35050
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -35058,7 +35265,7 @@ export interface storefrontComponents {
|
|
|
35058
35265
|
orderType?: "subscription-order" | "one-time-order";
|
|
35059
35266
|
};
|
|
35060
35267
|
PaymentInstructionsToken: {
|
|
35061
|
-
/**
|
|
35268
|
+
/** ID of the payment token. */
|
|
35062
35269
|
token: string;
|
|
35063
35270
|
};
|
|
35064
35271
|
PaymentInstructionsInstrument: {
|
|
@@ -35081,13 +35288,125 @@ export interface storefrontComponents {
|
|
|
35081
35288
|
* You may use `{id}` or `{result}` as placeholders in the URL and we replace them with the transaction id and result accordingly.
|
|
35082
35289
|
*/
|
|
35083
35290
|
StorefrontTransactionRedirectUrl: string | null;
|
|
35084
|
-
|
|
35085
|
-
|
|
35086
|
-
|
|
35087
|
-
|
|
35088
|
-
|
|
35089
|
-
|
|
35090
|
-
|
|
35291
|
+
/** Payment card information. */
|
|
35292
|
+
StorefrontPaymentCard: {
|
|
35293
|
+
/** ID of the payment instrument. */
|
|
35294
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35295
|
+
/** Method of payment instrument. */
|
|
35296
|
+
method?: "payment-card";
|
|
35297
|
+
/**
|
|
35298
|
+
* Status of the payment instrument.
|
|
35299
|
+
* An `active` status means that a payment instrument has been used at least once for an approved transaction.
|
|
35300
|
+
* To remove an instrument from use, set this value to `deactivated`.
|
|
35301
|
+
*
|
|
35302
|
+
* For more information, see [Deactivate a payment instrument](../PostPaymentInstrumentDeactivation).
|
|
35303
|
+
*/
|
|
35304
|
+
status?:
|
|
35305
|
+
| "active"
|
|
35306
|
+
| "inactive"
|
|
35307
|
+
| "expired"
|
|
35308
|
+
| "deactivated"
|
|
35309
|
+
| "verification-needed";
|
|
35310
|
+
/**
|
|
35311
|
+
* Unique value that is used to identify the payment instrument.
|
|
35312
|
+
* This value is generated from the `bin` and the `last4` values.
|
|
35313
|
+
* This value contains alphanumeric characters.
|
|
35314
|
+
*/
|
|
35315
|
+
fingerprint?: string;
|
|
35316
|
+
/**
|
|
35317
|
+
* Bank Identification Number (BIN) of the payment card.
|
|
35318
|
+
* This value is the same as the first 6 digits of the associated Primary Account Number (PAN).
|
|
35319
|
+
*/
|
|
35320
|
+
bin?: string;
|
|
35321
|
+
/** Last 4 digits of the associated Primary Account Number (PAN). */
|
|
35322
|
+
last4?: string;
|
|
35323
|
+
/** Primary Account Number (PAN) of the payment card. */
|
|
35324
|
+
pan?: string;
|
|
35325
|
+
/** Expiration year of the payment card. */
|
|
35326
|
+
expYear?: number;
|
|
35327
|
+
/** Expiration month of the payment card. */
|
|
35328
|
+
expMonth?: number;
|
|
35329
|
+
/** Card Verification Value (CVV) of the payment card. */
|
|
35330
|
+
cvv?: string;
|
|
35331
|
+
brand?: storefrontComponents["schemas"]["PaymentCardBrand"];
|
|
35332
|
+
/** Bank country of the payment instrument. */
|
|
35333
|
+
bankCountry?: string;
|
|
35334
|
+
/** Bank name of the payment instrument. */
|
|
35335
|
+
bankName?: string;
|
|
35336
|
+
/** Contact's billing address. */
|
|
35337
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
35338
|
+
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
35339
|
+
/** URL of the billing portal where the card can be updated. */
|
|
35340
|
+
billingPortalUrl?: string;
|
|
35341
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35342
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
35343
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35344
|
+
/**
|
|
35345
|
+
* New customer JSON Web Token (JWT) that is used for further requests.
|
|
35346
|
+
* This value is null if the customer is already authenticated.
|
|
35347
|
+
*/
|
|
35348
|
+
token?: string | null;
|
|
35349
|
+
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35350
|
+
};
|
|
35351
|
+
StorefrontBankAccount: {
|
|
35352
|
+
/** ID of the payment instrument. */
|
|
35353
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35354
|
+
/** Method of payment instrument. */
|
|
35355
|
+
method?: "ach";
|
|
35356
|
+
/** Name of the bank. */
|
|
35357
|
+
bankName?: string;
|
|
35358
|
+
/** Bank routing number. */
|
|
35359
|
+
routingNumber?: string;
|
|
35360
|
+
/**
|
|
35361
|
+
* Type of bank account number.
|
|
35362
|
+
* A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).
|
|
35363
|
+
*/
|
|
35364
|
+
accountNumberType: "BBAN" | "IBAN";
|
|
35365
|
+
/** Type of bank account. */
|
|
35366
|
+
accountType?: "checking" | "savings" | "other";
|
|
35367
|
+
/** Bank Identifier Code (BIC). */
|
|
35368
|
+
bic?: string;
|
|
35369
|
+
/** Customer's billing address. */
|
|
35370
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
35371
|
+
/**
|
|
35372
|
+
* Unique value which identifies the bank account.
|
|
35373
|
+
* This value contains alphanumeric characters.
|
|
35374
|
+
* Depending on the type of bank account number,
|
|
35375
|
+
* a bank account fingerprint is generated using one of the following:
|
|
35376
|
+
* - BBAN: `last4` and `routingNumber` values.
|
|
35377
|
+
* - IBAN: First 8 characters of the IBAN and the `last4` value.
|
|
35378
|
+
*/
|
|
35379
|
+
fingerprint?: string;
|
|
35380
|
+
/** Last 4 digits of the bank account number. */
|
|
35381
|
+
last4?: string;
|
|
35382
|
+
/** Status of the bank account. */
|
|
35383
|
+
status?: "active" | "deactivated";
|
|
35384
|
+
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
35385
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35386
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
35387
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35388
|
+
/**
|
|
35389
|
+
* New customer JSON Web Token (JWT) that is used for further requests.
|
|
35390
|
+
* This value is null if the customer is already authenticated.
|
|
35391
|
+
*/
|
|
35392
|
+
token?: string | null;
|
|
35393
|
+
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35394
|
+
};
|
|
35395
|
+
StorefrontPayPalAccount: {
|
|
35396
|
+
/** ID of the payment instrument. */
|
|
35397
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35398
|
+
/** Method of payment instrument. */
|
|
35399
|
+
method?: "paypal";
|
|
35400
|
+
/** Billing address. */
|
|
35401
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
35402
|
+
/** PayPal username. */
|
|
35403
|
+
username?: string;
|
|
35404
|
+
/** PayPal account status. */
|
|
35405
|
+
status?: "inactive" | "active" | "deactivated";
|
|
35406
|
+
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
35407
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35408
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
35409
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35091
35410
|
/**
|
|
35092
35411
|
* New customer JSON Web Token (JWT) that is used for further requests.
|
|
35093
35412
|
* This value is null if the customer is already authenticated.
|
|
@@ -35095,6 +35414,68 @@ export interface storefrontComponents {
|
|
|
35095
35414
|
token?: string | null;
|
|
35096
35415
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35097
35416
|
};
|
|
35417
|
+
StorefrontKhelocardCard: {
|
|
35418
|
+
/** ID of the payment instrument. */
|
|
35419
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35420
|
+
/** Method of payment instrument. */
|
|
35421
|
+
method?: "Khelocard";
|
|
35422
|
+
/**
|
|
35423
|
+
* Unique value which identifies the payment instrument.
|
|
35424
|
+
* This value contains alphanumeric characters.
|
|
35425
|
+
* This value is generated from the card number, CVV, and expiration date.
|
|
35426
|
+
*/
|
|
35427
|
+
fingerprint?: string;
|
|
35428
|
+
/** Khelocard card masked number. */
|
|
35429
|
+
number?: string;
|
|
35430
|
+
/** Last 4 digits of the number. */
|
|
35431
|
+
last4?: string;
|
|
35432
|
+
/** Khelocard card expiration year. */
|
|
35433
|
+
expYear?: number;
|
|
35434
|
+
/** Khelocard card expiration month. */
|
|
35435
|
+
expMonth?: number;
|
|
35436
|
+
/** Billing address. */
|
|
35437
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
35438
|
+
/** Payment instrument status. */
|
|
35439
|
+
status?: "active" | "deactivated";
|
|
35440
|
+
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
35441
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35442
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
35443
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35444
|
+
/**
|
|
35445
|
+
* New customer JSON Web Token (JWT) that is used for further requests.
|
|
35446
|
+
* This value is null if the customer is already authenticated.
|
|
35447
|
+
*/
|
|
35448
|
+
token?: string | null;
|
|
35449
|
+
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35450
|
+
};
|
|
35451
|
+
StorefrontAlternativeInstrument: {
|
|
35452
|
+
/** ID of the payment instrument. */
|
|
35453
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35454
|
+
/** Payment method of the payment instrument. */
|
|
35455
|
+
method?: storefrontComponents["schemas"]["AlternativePaymentMethods"] & {
|
|
35456
|
+
[key: string]: any;
|
|
35457
|
+
};
|
|
35458
|
+
/** Billing address of the user that is associated with the payment instrument. */
|
|
35459
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
35460
|
+
/** Payment instrument status. */
|
|
35461
|
+
status?: "active" | "deactivated";
|
|
35462
|
+
useAsBackup?: storefrontComponents["schemas"]["UseAsBackup"];
|
|
35463
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35464
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
35465
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35466
|
+
/**
|
|
35467
|
+
* New customer JSON Web Token (JWT) that is used for further requests.
|
|
35468
|
+
* This value is null if the customer is already authenticated.
|
|
35469
|
+
*/
|
|
35470
|
+
token?: string | null;
|
|
35471
|
+
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35472
|
+
};
|
|
35473
|
+
StorefrontPaymentInstrument:
|
|
35474
|
+
| storefrontComponents["schemas"]["StorefrontPaymentCard"]
|
|
35475
|
+
| storefrontComponents["schemas"]["StorefrontBankAccount"]
|
|
35476
|
+
| storefrontComponents["schemas"]["StorefrontPayPalAccount"]
|
|
35477
|
+
| storefrontComponents["schemas"]["StorefrontKhelocardCard"]
|
|
35478
|
+
| storefrontComponents["schemas"]["StorefrontAlternativeInstrument"];
|
|
35098
35479
|
StorefrontPayoutRequest: {
|
|
35099
35480
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35100
35481
|
websiteId?: storefrontComponents["schemas"]["WebsiteId"];
|
|
@@ -35125,7 +35506,38 @@ export interface storefrontComponents {
|
|
|
35125
35506
|
};
|
|
35126
35507
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35127
35508
|
};
|
|
35128
|
-
|
|
35509
|
+
/**
|
|
35510
|
+
* Products are the items that your business sells.
|
|
35511
|
+
* Products include digital goods, services, and physical goods.
|
|
35512
|
+
* Products appear on invoice line items.
|
|
35513
|
+
* If you set a tax category identifier, taxes are calculated at invoice generation.
|
|
35514
|
+
* If the product is shippable, shipping costs are calculated at invoice generation.
|
|
35515
|
+
* Pricing and variations are set within plans.
|
|
35516
|
+
* For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/tag/Plans/).
|
|
35517
|
+
*/
|
|
35518
|
+
StorefrontProduct: {
|
|
35519
|
+
/** ID of the product. */
|
|
35520
|
+
id?: string;
|
|
35521
|
+
/** Name of the product. */
|
|
35522
|
+
name: string;
|
|
35523
|
+
/** Unit label, such as per `seat` or per `unit`. */
|
|
35524
|
+
unitLabel: string;
|
|
35525
|
+
/** Description of the product. */
|
|
35526
|
+
description?: string | null;
|
|
35527
|
+
/**
|
|
35528
|
+
* Specifies if the product requires shipping.
|
|
35529
|
+
* If this value is `true`, shipping calculations are applied.
|
|
35530
|
+
*/
|
|
35531
|
+
requiresShipping?: boolean;
|
|
35532
|
+
/**
|
|
35533
|
+
* Product options such as color, size, and so forth.
|
|
35534
|
+
* Product option values are defined in plans.
|
|
35535
|
+
* For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/tag/Plans/).
|
|
35536
|
+
*/
|
|
35537
|
+
options?: string[];
|
|
35538
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35539
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
35540
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
35129
35541
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
35130
35542
|
};
|
|
35131
35543
|
Purchase: {
|
|
@@ -35143,7 +35555,7 @@ export interface storefrontComponents {
|
|
|
35143
35555
|
websiteId: storefrontComponents["schemas"]["WebsiteId"];
|
|
35144
35556
|
items: {
|
|
35145
35557
|
/** ID of the plan. */
|
|
35146
|
-
planId:
|
|
35558
|
+
planId: string;
|
|
35147
35559
|
/** Number of product units in the specified plan. */
|
|
35148
35560
|
quantity?: number;
|
|
35149
35561
|
}[];
|
|
@@ -35185,7 +35597,10 @@ export interface storefrontComponents {
|
|
|
35185
35597
|
redirectUrl?: string | null;
|
|
35186
35598
|
};
|
|
35187
35599
|
StorefrontOrderPreview: storefrontComponents["schemas"]["CommonOrderPreview"] & {
|
|
35188
|
-
/**
|
|
35600
|
+
/**
|
|
35601
|
+
* ID of the shipping rate.
|
|
35602
|
+
* If unset the cheapest applicable shipping rate is chosen.
|
|
35603
|
+
*/
|
|
35189
35604
|
shippingRateId?: storefrontComponents["schemas"]["ResourceId"];
|
|
35190
35605
|
};
|
|
35191
35606
|
};
|
|
@@ -35304,6 +35719,33 @@ export interface storefrontComponents {
|
|
|
35304
35719
|
};
|
|
35305
35720
|
};
|
|
35306
35721
|
};
|
|
35722
|
+
/** Order resource. */
|
|
35723
|
+
PostOrderPause: {
|
|
35724
|
+
content: {
|
|
35725
|
+
"application/json": {
|
|
35726
|
+
/** Description of the pause reason in free form. */
|
|
35727
|
+
description?: string | null;
|
|
35728
|
+
/**
|
|
35729
|
+
* Date and time when the service period pauses.
|
|
35730
|
+
*
|
|
35731
|
+
* This time must be later than the current time.
|
|
35732
|
+
* If this time is earlier then the current time, the current time is used.
|
|
35733
|
+
*
|
|
35734
|
+
* If this field is omitted, this value defaults to the current time.
|
|
35735
|
+
*/
|
|
35736
|
+
effectiveTime?: string | null;
|
|
35737
|
+
/**
|
|
35738
|
+
* Date and time when the pause ends and the subscription resumes billing.
|
|
35739
|
+
*
|
|
35740
|
+
* To resume a subscription from this point in time,
|
|
35741
|
+
* use the current time or an earlier time.
|
|
35742
|
+
* If `endTime` is earlier then the current time, the current time is used.
|
|
35743
|
+
* If this field is empty, the subscription is indefinitely paused.
|
|
35744
|
+
*/
|
|
35745
|
+
endTime?: string | null;
|
|
35746
|
+
};
|
|
35747
|
+
};
|
|
35748
|
+
};
|
|
35307
35749
|
PostPayment: {
|
|
35308
35750
|
content: {
|
|
35309
35751
|
"application/json":
|
|
@@ -35340,7 +35782,7 @@ export interface storefrontComponents {
|
|
|
35340
35782
|
StorefrontPostPaymentInstrument: {
|
|
35341
35783
|
content: {
|
|
35342
35784
|
"application/json": {
|
|
35343
|
-
/**
|
|
35785
|
+
/** Token ID of the payment instrument. */
|
|
35344
35786
|
token: string;
|
|
35345
35787
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35346
35788
|
};
|
|
@@ -35965,6 +36407,30 @@ export interface operations {
|
|
|
35965
36407
|
};
|
|
35966
36408
|
requestBody: storefrontComponents["requestBodies"]["PostOrderCancellation"];
|
|
35967
36409
|
};
|
|
36410
|
+
/** Pauses an order with a specified ID. */
|
|
36411
|
+
StorefrontPostOrderPause: {
|
|
36412
|
+
parameters: {
|
|
36413
|
+
path: {
|
|
36414
|
+
/** ID of the resource. */
|
|
36415
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
36416
|
+
};
|
|
36417
|
+
};
|
|
36418
|
+
responses: {
|
|
36419
|
+
/** Order paused. */
|
|
36420
|
+
201: {
|
|
36421
|
+
headers: {};
|
|
36422
|
+
content: {
|
|
36423
|
+
"application/json": storefrontComponents["schemas"]["StorefrontOrder"];
|
|
36424
|
+
};
|
|
36425
|
+
};
|
|
36426
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
36427
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
36428
|
+
404: storefrontComponents["responses"]["NotFound"];
|
|
36429
|
+
409: storefrontComponents["responses"]["Conflict"];
|
|
36430
|
+
422: storefrontComponents["responses"]["ValidationError"];
|
|
36431
|
+
};
|
|
36432
|
+
requestBody: storefrontComponents["requestBodies"]["PostOrderPause"];
|
|
36433
|
+
};
|
|
35968
36434
|
/**
|
|
35969
36435
|
* Performs a payment for a transaction or an invoice.
|
|
35970
36436
|
*
|
|
@@ -36562,6 +37028,58 @@ export interface operations {
|
|
|
36562
37028
|
404: storefrontComponents["responses"]["NotFound"];
|
|
36563
37029
|
};
|
|
36564
37030
|
};
|
|
37031
|
+
/**
|
|
37032
|
+
* Process a KYC interrupted transaction with a specified ID.
|
|
37033
|
+
*
|
|
37034
|
+
* Use this operation to process the transaction after all documents of the KYC request with a specified token have been uploaded.
|
|
37035
|
+
*/
|
|
37036
|
+
StorefrontPostKycRequestContinue: {
|
|
37037
|
+
parameters: {
|
|
37038
|
+
path: {
|
|
37039
|
+
/** ID of the resource. */
|
|
37040
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
37041
|
+
/** Token string. */
|
|
37042
|
+
token: storefrontComponents["parameters"]["token"];
|
|
37043
|
+
};
|
|
37044
|
+
};
|
|
37045
|
+
responses: {
|
|
37046
|
+
/** KYC verification finished. */
|
|
37047
|
+
200: {
|
|
37048
|
+
content: {
|
|
37049
|
+
"application/json": storefrontComponents["schemas"]["StorefrontTransaction"];
|
|
37050
|
+
};
|
|
37051
|
+
};
|
|
37052
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
37053
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
37054
|
+
404: storefrontComponents["responses"]["NotFound"];
|
|
37055
|
+
};
|
|
37056
|
+
};
|
|
37057
|
+
/**
|
|
37058
|
+
* Skips an optional KYC request with a specified token, for a transaction with a specified ID.
|
|
37059
|
+
*
|
|
37060
|
+
* Use this operation to skip a KYC request that has been marked as optional in a transaction flow, so that you can further process the transaction.
|
|
37061
|
+
*/
|
|
37062
|
+
StorefrontPostKycRequestBypass: {
|
|
37063
|
+
parameters: {
|
|
37064
|
+
path: {
|
|
37065
|
+
/** ID of the resource. */
|
|
37066
|
+
id: storefrontComponents["parameters"]["resourceId"];
|
|
37067
|
+
/** Token string. */
|
|
37068
|
+
token: storefrontComponents["parameters"]["token"];
|
|
37069
|
+
};
|
|
37070
|
+
};
|
|
37071
|
+
responses: {
|
|
37072
|
+
/** KYC verification skipped. */
|
|
37073
|
+
200: {
|
|
37074
|
+
content: {
|
|
37075
|
+
"application/json": storefrontComponents["schemas"]["StorefrontTransaction"];
|
|
37076
|
+
};
|
|
37077
|
+
};
|
|
37078
|
+
401: storefrontComponents["responses"]["Unauthorized"];
|
|
37079
|
+
403: storefrontComponents["responses"]["Forbidden"];
|
|
37080
|
+
404: storefrontComponents["responses"]["NotFound"];
|
|
37081
|
+
};
|
|
37082
|
+
};
|
|
36565
37083
|
/**
|
|
36566
37084
|
* Retrieves a website with a specified ID.
|
|
36567
37085
|
* Use this operation to find the website name, logo, or more.
|
|
@@ -36820,7 +37338,7 @@ export interface reportsComponents {
|
|
|
36820
37338
|
message?: string;
|
|
36821
37339
|
}[];
|
|
36822
37340
|
};
|
|
36823
|
-
/**
|
|
37341
|
+
/** ID of the customer resource. */
|
|
36824
37342
|
CustomerId: string;
|
|
36825
37343
|
/** Currency code in ISO 4217 format. */
|
|
36826
37344
|
CurrencyCode: string;
|
|
@@ -36996,6 +37514,11 @@ export interface reportsComponents {
|
|
|
36996
37514
|
/** Type of link. */
|
|
36997
37515
|
rel?: "self" | "user" | "download" | "signedLink";
|
|
36998
37516
|
}[];
|
|
37517
|
+
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
37518
|
+
_embedded?: {
|
|
37519
|
+
file?: { [key: string]: any };
|
|
37520
|
+
user?: { [key: string]: any };
|
|
37521
|
+
};
|
|
36999
37522
|
};
|
|
37000
37523
|
/**
|
|
37001
37524
|
* Date range of the data export.
|
|
@@ -37277,7 +37800,7 @@ export interface reportsComponents {
|
|
|
37277
37800
|
/** Plan within the aggregation. */
|
|
37278
37801
|
plansCount?: {
|
|
37279
37802
|
/** ID of the plan. */
|
|
37280
|
-
planId?:
|
|
37803
|
+
planId?: string;
|
|
37281
37804
|
/** Total number of future renewals of a plan. */
|
|
37282
37805
|
count?: number;
|
|
37283
37806
|
}[];
|
|
@@ -37546,7 +38069,7 @@ export interface reportsComponents {
|
|
|
37546
38069
|
/** Subscription renewal data. */
|
|
37547
38070
|
data?: {
|
|
37548
38071
|
/** Plan ID for which subscriptions are counted. */
|
|
37549
|
-
planId?:
|
|
38072
|
+
planId?: string;
|
|
37550
38073
|
/** Total number of renewed subscriptions. */
|
|
37551
38074
|
allRenewalCount?: number;
|
|
37552
38075
|
/**
|
|
@@ -37724,6 +38247,14 @@ export interface reportsComponents {
|
|
|
37724
38247
|
collectionQuery: string;
|
|
37725
38248
|
/** ID of the resource. */
|
|
37726
38249
|
resourceId: string;
|
|
38250
|
+
/**
|
|
38251
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
38252
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
38253
|
+
*
|
|
38254
|
+
* For more information, see
|
|
38255
|
+
* [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
|
|
38256
|
+
*/
|
|
38257
|
+
collectionExpand: string;
|
|
37727
38258
|
/** Criteria parameter for requesting a collection. */
|
|
37728
38259
|
collectionCriteria: string;
|
|
37729
38260
|
};
|
|
@@ -37810,6 +38341,14 @@ export interface operations {
|
|
|
37810
38341
|
* order, prefix with `-`.
|
|
37811
38342
|
*/
|
|
37812
38343
|
sort?: reportsComponents["parameters"]["collectionSort"];
|
|
38344
|
+
/**
|
|
38345
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
38346
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
38347
|
+
*
|
|
38348
|
+
* For more information, see
|
|
38349
|
+
* [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
|
|
38350
|
+
*/
|
|
38351
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
37813
38352
|
/**
|
|
37814
38353
|
* Filters the collection items. This field requires
|
|
37815
38354
|
* a special format. Use `,` for multiple allowed values. Use `;` for multiple fields.
|
|
@@ -37839,6 +38378,18 @@ export interface operations {
|
|
|
37839
38378
|
};
|
|
37840
38379
|
/** Requests the export of a specific data resource. */
|
|
37841
38380
|
PostDataExport: {
|
|
38381
|
+
parameters: {
|
|
38382
|
+
query: {
|
|
38383
|
+
/**
|
|
38384
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
38385
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
38386
|
+
*
|
|
38387
|
+
* For more information, see
|
|
38388
|
+
* [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
|
|
38389
|
+
*/
|
|
38390
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
38391
|
+
};
|
|
38392
|
+
};
|
|
37842
38393
|
responses: {
|
|
37843
38394
|
/** Data export request received. */
|
|
37844
38395
|
201: {
|
|
@@ -37860,6 +38411,16 @@ export interface operations {
|
|
|
37860
38411
|
/** ID of the resource. */
|
|
37861
38412
|
id: reportsComponents["parameters"]["resourceId"];
|
|
37862
38413
|
};
|
|
38414
|
+
query: {
|
|
38415
|
+
/**
|
|
38416
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
38417
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
38418
|
+
*
|
|
38419
|
+
* For more information, see
|
|
38420
|
+
* [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
|
|
38421
|
+
*/
|
|
38422
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
38423
|
+
};
|
|
37863
38424
|
};
|
|
37864
38425
|
responses: {
|
|
37865
38426
|
/** Data export request. */
|
|
@@ -37881,6 +38442,16 @@ export interface operations {
|
|
|
37881
38442
|
/** ID of the resource. */
|
|
37882
38443
|
id: reportsComponents["parameters"]["resourceId"];
|
|
37883
38444
|
};
|
|
38445
|
+
query: {
|
|
38446
|
+
/**
|
|
38447
|
+
* Expands a request to include embedded objects within the `_embedded`
|
|
38448
|
+
* property of the response. This field accepts a comma-separated list of objects.
|
|
38449
|
+
*
|
|
38450
|
+
* For more information, see
|
|
38451
|
+
* [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
|
|
38452
|
+
*/
|
|
38453
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
38454
|
+
};
|
|
37884
38455
|
};
|
|
37885
38456
|
responses: {
|
|
37886
38457
|
/** Data export modified. */
|
|
@@ -39354,7 +39925,7 @@ declare module "resources/credential-hashes-resource" {
|
|
|
39354
39925
|
data: any;
|
|
39355
39926
|
}): any;
|
|
39356
39927
|
getOAuth2CredentialItems({ hash, limit, offset, filter, q, fields, sort, }: rebilly.GetOauth2CredentialHashItemCollectionRequest): rebilly.GetOauth2CredentialHashItemCollectionResponsePromise;
|
|
39357
|
-
getAllPlaidCredentials({ filter, limit, offset, sort, q, }?: rebilly.
|
|
39928
|
+
getAllPlaidCredentials({ filter, limit, offset, sort, q, }?: rebilly.GetPlaidCredentialHashCollectionRequest): rebilly.GetPlaidCredentialHashCollectionResponsePromise;
|
|
39358
39929
|
createPlaidCredential({ data }: {
|
|
39359
39930
|
data: any;
|
|
39360
39931
|
}): any;
|
|
@@ -39572,7 +40143,9 @@ declare module "resources/customers-resource" {
|
|
|
39572
40143
|
id: any;
|
|
39573
40144
|
targetCustomerId: any;
|
|
39574
40145
|
}): any;
|
|
39575
|
-
getAml({ id }:
|
|
40146
|
+
getAml({ id }: {
|
|
40147
|
+
id: any;
|
|
40148
|
+
}): rebilly.GetCustomerAmlHitResponsePromise;
|
|
39576
40149
|
getLeadSource({ id }: {
|
|
39577
40150
|
id: any;
|
|
39578
40151
|
}): rebilly.GetCustomerLeadSourceResponsePromise;
|
|
@@ -39607,16 +40180,24 @@ declare module "resources/customers-resource" {
|
|
|
39607
40180
|
id: any;
|
|
39608
40181
|
data: any;
|
|
39609
40182
|
}): any;
|
|
39610
|
-
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.
|
|
40183
|
+
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetCustomerEddTimelineCollectionRequest): rebilly.GetCustomerEddTimelineCollectionResponsePromise;
|
|
39611
40184
|
createEddTimelineComment({ id, data }: {
|
|
39612
40185
|
id: any;
|
|
39613
40186
|
data: any;
|
|
39614
40187
|
}): any;
|
|
39615
|
-
|
|
40188
|
+
getEddTimelineMessage({ id, messageId }: {
|
|
39616
40189
|
id: any;
|
|
39617
|
-
|
|
39618
|
-
|
|
39619
|
-
}
|
|
40190
|
+
messageId: any;
|
|
40191
|
+
}): rebilly.GetCustomerEddTimelineResponsePromise;
|
|
40192
|
+
deleteEddTimelineMessage({ id, messageId }: {
|
|
40193
|
+
id: any;
|
|
40194
|
+
messageId: any;
|
|
40195
|
+
}): any;
|
|
40196
|
+
getAllEddSearchResults({ id, limit, offset }: rebilly.GetCustomerEddSearchResultCollectionRequest): rebilly.GetCustomerEddSearchResultCollectionResponsePromise;
|
|
40197
|
+
getEddSearchResult({ id, searchResultId }: {
|
|
40198
|
+
id: any;
|
|
40199
|
+
searchResultId: any;
|
|
40200
|
+
}): rebilly.GetCustomerEddSearchResultResponsePromise;
|
|
39620
40201
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
39621
40202
|
limit?: any;
|
|
39622
40203
|
offset?: any;
|
|
@@ -39737,14 +40318,7 @@ declare module "resources/events-resource" {
|
|
|
39737
40318
|
eventType: any;
|
|
39738
40319
|
data: any;
|
|
39739
40320
|
}): rebilly.PutEventRuleResponsePromise;
|
|
39740
|
-
getAllTimelineMessages({ eventType, limit, offset, filter, sort, q, }:
|
|
39741
|
-
eventType: any;
|
|
39742
|
-
limit?: any;
|
|
39743
|
-
offset?: any;
|
|
39744
|
-
filter?: any;
|
|
39745
|
-
sort?: any;
|
|
39746
|
-
q?: any;
|
|
39747
|
-
}): rebilly.GetRulesEngineTimelineCollectionResponsePromise;
|
|
40321
|
+
getAllTimelineMessages({ eventType, limit, offset, filter, sort, q, }: rebilly.GetRuleSetCollectionRequest): rebilly.GetRuleSetCollectionResponsePromise;
|
|
39748
40322
|
createTimelineComment({ eventType, data }: {
|
|
39749
40323
|
eventType: any;
|
|
39750
40324
|
data: any;
|
|
@@ -39752,7 +40326,7 @@ declare module "resources/events-resource" {
|
|
|
39752
40326
|
getTimelineMessage({ eventType, messageId }: {
|
|
39753
40327
|
eventType: any;
|
|
39754
40328
|
messageId: any;
|
|
39755
|
-
}): rebilly.
|
|
40329
|
+
}): rebilly.GetRuleSetTimelineResponsePromise;
|
|
39756
40330
|
deleteTimelineMessage({ eventType, messageId }: {
|
|
39757
40331
|
eventType: any;
|
|
39758
40332
|
messageId: any;
|
|
@@ -39770,7 +40344,7 @@ declare module "resources/events-resource" {
|
|
|
39770
40344
|
eventType: any;
|
|
39771
40345
|
version: any;
|
|
39772
40346
|
fields?: any;
|
|
39773
|
-
}): rebilly.
|
|
40347
|
+
}): rebilly.GetEventRuleHistoryResponsePromise;
|
|
39774
40348
|
getRulesVersionDetail({ eventType, version, fields }: {
|
|
39775
40349
|
eventType: any;
|
|
39776
40350
|
version: any;
|
|
@@ -40429,6 +41003,20 @@ declare module "resources/purchase-resource" {
|
|
|
40429
41003
|
}): any;
|
|
40430
41004
|
};
|
|
40431
41005
|
}
|
|
41006
|
+
declare module "resources/risk-score-rules-resource" {
|
|
41007
|
+
export default function RiskScoreRulesResource({ apiHandler }: {
|
|
41008
|
+
apiHandler: any;
|
|
41009
|
+
}): {
|
|
41010
|
+
getAll(): rebilly.GetRiskScoreRulesResponsePromise;
|
|
41011
|
+
updateRiskScoreRules({ data }: {
|
|
41012
|
+
data: any;
|
|
41013
|
+
}): rebilly.PutRiskScoreRulesResponsePromise;
|
|
41014
|
+
getAllBlocklistRules(): rebilly.GetRiskScoreBlocklistRulesResponsePromise;
|
|
41015
|
+
updateRiskScoreBlocklistRules({ data }: {
|
|
41016
|
+
data: any;
|
|
41017
|
+
}): rebilly.PutRiskScoreBlocklistRulesResponsePromise;
|
|
41018
|
+
};
|
|
41019
|
+
}
|
|
40432
41020
|
declare module "resources/roles-resource" {
|
|
40433
41021
|
export default function RolesResource({ apiHandler }: {
|
|
40434
41022
|
apiHandler: any;
|
|
@@ -41149,7 +41737,7 @@ declare module "resources/api-instance" {
|
|
|
41149
41737
|
offset?: number;
|
|
41150
41738
|
sort?: string[];
|
|
41151
41739
|
q?: string;
|
|
41152
|
-
}): rebilly.
|
|
41740
|
+
}): rebilly.GetPlaidCredentialHashCollectionResponsePromise;
|
|
41153
41741
|
createPlaidCredential({ data }: {
|
|
41154
41742
|
data: any;
|
|
41155
41743
|
}): any;
|
|
@@ -41394,7 +41982,9 @@ declare module "resources/api-instance" {
|
|
|
41394
41982
|
id: any;
|
|
41395
41983
|
targetCustomerId: any;
|
|
41396
41984
|
}): any;
|
|
41397
|
-
getAml({ id }:
|
|
41985
|
+
getAml({ id }: {
|
|
41986
|
+
id: any;
|
|
41987
|
+
}): rebilly.GetCustomerAmlHitResponsePromise;
|
|
41398
41988
|
getLeadSource({ id }: {
|
|
41399
41989
|
id: any;
|
|
41400
41990
|
}): rebilly.GetCustomerLeadSourceResponsePromise;
|
|
@@ -41429,16 +42019,24 @@ declare module "resources/api-instance" {
|
|
|
41429
42019
|
id: any;
|
|
41430
42020
|
data: any;
|
|
41431
42021
|
}): any;
|
|
41432
|
-
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.
|
|
42022
|
+
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetCustomerEddTimelineCollectionRequest): rebilly.GetCustomerEddTimelineCollectionResponsePromise;
|
|
41433
42023
|
createEddTimelineComment({ id, data }: {
|
|
41434
42024
|
id: any;
|
|
41435
42025
|
data: any;
|
|
41436
42026
|
}): any;
|
|
41437
|
-
|
|
42027
|
+
getEddTimelineMessage({ id, messageId }: {
|
|
41438
42028
|
id: any;
|
|
41439
|
-
|
|
41440
|
-
|
|
41441
|
-
}
|
|
42029
|
+
messageId: any;
|
|
42030
|
+
}): rebilly.GetCustomerEddTimelineResponsePromise;
|
|
42031
|
+
deleteEddTimelineMessage({ id, messageId }: {
|
|
42032
|
+
id: any;
|
|
42033
|
+
messageId: any;
|
|
42034
|
+
}): any;
|
|
42035
|
+
getAllEddSearchResults({ id, limit, offset }: rebilly.GetCustomerEddSearchResultCollectionRequest): rebilly.GetCustomerEddSearchResultCollectionResponsePromise;
|
|
42036
|
+
getEddSearchResult({ id, searchResultId }: {
|
|
42037
|
+
id: any;
|
|
42038
|
+
searchResultId: any;
|
|
42039
|
+
}): rebilly.GetCustomerEddSearchResultResponsePromise;
|
|
41442
42040
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
41443
42041
|
limit?: any;
|
|
41444
42042
|
offset?: any;
|
|
@@ -41557,14 +42155,7 @@ declare module "resources/api-instance" {
|
|
|
41557
42155
|
eventType: any;
|
|
41558
42156
|
data: any;
|
|
41559
42157
|
}): rebilly.PutEventRuleResponsePromise;
|
|
41560
|
-
getAllTimelineMessages({ eventType, limit, offset, filter, sort, q, }:
|
|
41561
|
-
eventType: any;
|
|
41562
|
-
limit?: any;
|
|
41563
|
-
offset?: any;
|
|
41564
|
-
filter?: any;
|
|
41565
|
-
sort?: any;
|
|
41566
|
-
q?: any;
|
|
41567
|
-
}): rebilly.GetRulesEngineTimelineCollectionResponsePromise;
|
|
42158
|
+
getAllTimelineMessages({ eventType, limit, offset, filter, sort, q, }: rebilly.GetRuleSetCollectionRequest): rebilly.GetRuleSetCollectionResponsePromise;
|
|
41568
42159
|
createTimelineComment({ eventType, data }: {
|
|
41569
42160
|
eventType: any;
|
|
41570
42161
|
data: any;
|
|
@@ -41572,7 +42163,7 @@ declare module "resources/api-instance" {
|
|
|
41572
42163
|
getTimelineMessage({ eventType, messageId }: {
|
|
41573
42164
|
eventType: any;
|
|
41574
42165
|
messageId: any;
|
|
41575
|
-
}): rebilly.
|
|
42166
|
+
}): rebilly.GetRuleSetTimelineResponsePromise;
|
|
41576
42167
|
deleteTimelineMessage({ eventType, messageId }: {
|
|
41577
42168
|
eventType: any;
|
|
41578
42169
|
messageId: any;
|
|
@@ -41590,7 +42181,7 @@ declare module "resources/api-instance" {
|
|
|
41590
42181
|
eventType: any;
|
|
41591
42182
|
version: any;
|
|
41592
42183
|
fields?: any;
|
|
41593
|
-
}): rebilly.
|
|
42184
|
+
}): rebilly.GetEventRuleHistoryResponsePromise;
|
|
41594
42185
|
getRulesVersionDetail({ eventType, version, fields }: {
|
|
41595
42186
|
eventType: any;
|
|
41596
42187
|
version: any;
|
|
@@ -42260,6 +42851,16 @@ declare module "resources/api-instance" {
|
|
|
42260
42851
|
data: any;
|
|
42261
42852
|
}): any;
|
|
42262
42853
|
};
|
|
42854
|
+
riskScoreRules: {
|
|
42855
|
+
getAll(): rebilly.GetRiskScoreRulesResponsePromise;
|
|
42856
|
+
updateRiskScoreRules({ data }: {
|
|
42857
|
+
data: any;
|
|
42858
|
+
}): rebilly.PutRiskScoreRulesResponsePromise;
|
|
42859
|
+
getAllBlocklistRules(): rebilly.GetRiskScoreBlocklistRulesResponsePromise;
|
|
42860
|
+
updateRiskScoreBlocklistRules({ data }: {
|
|
42861
|
+
data: any;
|
|
42862
|
+
}): rebilly.PutRiskScoreBlocklistRulesResponsePromise;
|
|
42863
|
+
};
|
|
42263
42864
|
roles: {
|
|
42264
42865
|
getAll({ limit, offset, filter, sort, q, expand, }?: {
|
|
42265
42866
|
limit?: number;
|
|
@@ -42725,14 +43326,16 @@ declare module "resources/experimental/data-exports-resource" {
|
|
|
42725
43326
|
export default function DataExportsResource({ apiHandler }: {
|
|
42726
43327
|
apiHandler: any;
|
|
42727
43328
|
}): {
|
|
42728
|
-
getAll({ limit, offset, sort, filter, q, criteria, }?: rebilly.GetDataExportCollectionRequest): rebilly.GetDataExportCollectionResponsePromise;
|
|
42729
|
-
queue({ id, data }: rebilly.CreateDataExportRequest): rebilly.PostDataExportResponsePromise;
|
|
42730
|
-
get({ id }: {
|
|
43329
|
+
getAll({ limit, offset, sort, expand, filter, q, criteria, }?: rebilly.GetDataExportCollectionRequest): rebilly.GetDataExportCollectionResponsePromise;
|
|
43330
|
+
queue({ id, data, expand }: rebilly.CreateDataExportRequest): rebilly.PostDataExportResponsePromise;
|
|
43331
|
+
get({ id, expand }: {
|
|
42731
43332
|
id: any;
|
|
43333
|
+
expand?: any;
|
|
42732
43334
|
}): rebilly.GetDataExportResponsePromise;
|
|
42733
|
-
update({ id, data }: {
|
|
43335
|
+
update({ id, data, expand }: {
|
|
42734
43336
|
id: any;
|
|
42735
43337
|
data: any;
|
|
43338
|
+
expand?: any;
|
|
42736
43339
|
}): rebilly.PutDataExportResponsePromise;
|
|
42737
43340
|
delete({ id }: {
|
|
42738
43341
|
id: any;
|
|
@@ -42969,21 +43572,24 @@ declare module "resources/experimental/experimental-resources" {
|
|
|
42969
43572
|
}): rebilly.GetCustomerSummaryMetricReportResponsePromise;
|
|
42970
43573
|
};
|
|
42971
43574
|
dataExports: {
|
|
42972
|
-
getAll({ limit, offset, sort, filter, q, criteria, }?: {
|
|
43575
|
+
getAll({ limit, offset, sort, expand, filter, q, criteria, }?: {
|
|
42973
43576
|
limit?: number;
|
|
42974
43577
|
offset?: number;
|
|
42975
43578
|
sort?: string[];
|
|
43579
|
+
expand?: string;
|
|
42976
43580
|
filter?: string;
|
|
42977
43581
|
q?: string;
|
|
42978
43582
|
criteria?: string;
|
|
42979
43583
|
}): rebilly.GetDataExportCollectionResponsePromise;
|
|
42980
|
-
queue({ id, data }: rebilly.CreateDataExportRequest): rebilly.PostDataExportResponsePromise;
|
|
42981
|
-
get({ id }: {
|
|
43584
|
+
queue({ id, data, expand }: rebilly.CreateDataExportRequest): rebilly.PostDataExportResponsePromise;
|
|
43585
|
+
get({ id, expand }: {
|
|
42982
43586
|
id: any;
|
|
43587
|
+
expand?: any;
|
|
42983
43588
|
}): rebilly.GetDataExportResponsePromise;
|
|
42984
|
-
update({ id, data }: {
|
|
43589
|
+
update({ id, data, expand }: {
|
|
42985
43590
|
id: any;
|
|
42986
43591
|
data: any;
|
|
43592
|
+
expand?: any;
|
|
42987
43593
|
}): rebilly.PutDataExportResponsePromise;
|
|
42988
43594
|
delete({ id }: {
|
|
42989
43595
|
id: any;
|
|
@@ -43333,6 +43939,10 @@ declare module "resources/storefront/orders-resource" {
|
|
|
43333
43939
|
id: any;
|
|
43334
43940
|
data: any;
|
|
43335
43941
|
}): any;
|
|
43942
|
+
pause({ id, data }: {
|
|
43943
|
+
id: any;
|
|
43944
|
+
data: any;
|
|
43945
|
+
}): any;
|
|
43336
43946
|
};
|
|
43337
43947
|
}
|
|
43338
43948
|
declare module "resources/storefront/payment-instruments-resource" {
|
|
@@ -43425,6 +44035,14 @@ declare module "resources/storefront/transactions-resource" {
|
|
|
43425
44035
|
get({ id }: {
|
|
43426
44036
|
id: any;
|
|
43427
44037
|
}): rebilly.StorefrontGetTransactionResponsePromise;
|
|
44038
|
+
finishKyc({ id, token }: {
|
|
44039
|
+
id: any;
|
|
44040
|
+
token: any;
|
|
44041
|
+
}): any;
|
|
44042
|
+
skipKyc({ id, token }: {
|
|
44043
|
+
id: any;
|
|
44044
|
+
token: any;
|
|
44045
|
+
}): any;
|
|
43428
44046
|
update({ id, data }: {
|
|
43429
44047
|
id: any;
|
|
43430
44048
|
data: any;
|
|
@@ -43555,6 +44173,10 @@ declare module "resources/storefront/storefront-api-instance" {
|
|
|
43555
44173
|
id: any;
|
|
43556
44174
|
data: any;
|
|
43557
44175
|
}): any;
|
|
44176
|
+
pause({ id, data }: {
|
|
44177
|
+
id: any;
|
|
44178
|
+
data: any;
|
|
44179
|
+
}): any;
|
|
43558
44180
|
};
|
|
43559
44181
|
paymentInstruments: {
|
|
43560
44182
|
getAll({ filter, sort, limit, offset, q, }?: {
|
|
@@ -43654,6 +44276,14 @@ declare module "resources/storefront/storefront-api-instance" {
|
|
|
43654
44276
|
get({ id }: {
|
|
43655
44277
|
id: any;
|
|
43656
44278
|
}): rebilly.StorefrontGetTransactionResponsePromise;
|
|
44279
|
+
finishKyc({ id, token }: {
|
|
44280
|
+
id: any;
|
|
44281
|
+
token: any;
|
|
44282
|
+
}): any;
|
|
44283
|
+
skipKyc({ id, token }: {
|
|
44284
|
+
id: any;
|
|
44285
|
+
token: any;
|
|
44286
|
+
}): any;
|
|
43657
44287
|
update({ id, data }: {
|
|
43658
44288
|
id: any;
|
|
43659
44289
|
data: any;
|