rebilly-js-sdk 45.3.0 → 45.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/rebilly-js-sdk.d.ts +723 -1286
- package/dist/rebilly-js-sdk.js +6 -6
- package/dist/rebilly-js-sdk.node.js +3 -3
- package/package.json +1 -1
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -323,21 +323,24 @@ declare module rebilly {
|
|
|
323
323
|
type GetCustomerUpcomingInvoiceCollectionResponse = operations['GetCustomerUpcomingInvoiceCollection']['responses']['200']['content']['application/json'][0]
|
|
324
324
|
type GetCustomerUpcomingInvoiceCollectionResponsePromise = Promise<{ items: {fields: GetCustomerUpcomingInvoiceCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
325
325
|
|
|
326
|
-
type
|
|
326
|
+
type GetKycRequestCollectionRequest = operations['GetKycRequestCollection']['parameters']["query"] & (operations['GetKycRequestCollection']['parameters'] extends {path: {}} ? operations['GetKycRequestCollection']['parameters']["path"] : {})
|
|
327
327
|
|
|
328
|
-
type
|
|
329
|
-
type
|
|
330
|
-
type
|
|
331
|
-
type
|
|
332
|
-
type
|
|
333
|
-
type
|
|
328
|
+
type GetKycRequestCollectionResponse = operations['GetKycRequestCollection']['responses']['200']['content']['application/json'][0]
|
|
329
|
+
type GetKycRequestCollectionResponsePromise = Promise<{ items: {fields: GetKycRequestCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
330
|
+
type PostKycRequestRequest = operations['PostKycRequest']['requestBody']['content']['application/json']
|
|
331
|
+
type CreateKycRequestRequest = { id: String, data: PostKycRequestRequest, expand?: String }
|
|
332
|
+
type PostKycRequestResponse = operations['PostKycRequest']['responses']['201']['content']['application/json']
|
|
333
|
+
type PostKycRequestResponsePromise = Promise<{fields: PostKycRequestResponse}>
|
|
334
334
|
|
|
335
|
-
type
|
|
335
|
+
type GetKycRequestRequest = { id : String }
|
|
336
336
|
|
|
337
|
-
type
|
|
338
|
-
type
|
|
339
|
-
type
|
|
340
|
-
type
|
|
337
|
+
type GetKycRequestResponse = operations['GetKycRequest']['responses']['200']['content']['application/json']
|
|
338
|
+
type GetKycRequestResponsePromise = Promise<{fields: GetKycRequestResponse}>
|
|
339
|
+
type PatchKycRequestRequest = operations['PatchKycRequest']['requestBody']['content']['application/json']
|
|
340
|
+
type PatchKycRequestResponse = operations['PatchKycRequest']['responses']['200']['content']['application/json']
|
|
341
|
+
type PatchKycRequestResponsePromise = Promise<{fields: PatchKycRequestResponse}>
|
|
342
|
+
type DeleteKycRequestResponse = operations['DeleteKycRequest']['responses']['204']
|
|
343
|
+
type DeleteKycRequestResponsePromise = Promise<{fields: DeleteKycRequestResponse}>
|
|
341
344
|
|
|
342
345
|
type GetKycDocumentCollectionRequest = operations['GetKycDocumentCollection']['parameters']["query"] & (operations['GetKycDocumentCollection']['parameters'] extends {path: {}} ? operations['GetKycDocumentCollection']['parameters']["path"] : {})
|
|
343
346
|
|
|
@@ -378,25 +381,6 @@ declare module rebilly {
|
|
|
378
381
|
type PostKycDocumentStopReviewResponse = operations['PostKycDocumentStopReview']['responses']['201']['content']['application/json']
|
|
379
382
|
type PostKycDocumentStopReviewResponsePromise = Promise<{fields: PostKycDocumentStopReviewResponse}>
|
|
380
383
|
|
|
381
|
-
type GetKycRequestCollectionRequest = operations['GetKycRequestCollection']['parameters']["query"] & (operations['GetKycRequestCollection']['parameters'] extends {path: {}} ? operations['GetKycRequestCollection']['parameters']["path"] : {})
|
|
382
|
-
|
|
383
|
-
type GetKycRequestCollectionResponse = operations['GetKycRequestCollection']['responses']['200']['content']['application/json'][0]
|
|
384
|
-
type GetKycRequestCollectionResponsePromise = Promise<{ items: {fields: GetKycRequestCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
385
|
-
type PostKycRequestRequest = operations['PostKycRequest']['requestBody']['content']['application/json']
|
|
386
|
-
type CreateKycRequestRequest = { id: String, data: PostKycRequestRequest, expand?: String }
|
|
387
|
-
type PostKycRequestResponse = operations['PostKycRequest']['responses']['201']['content']['application/json']
|
|
388
|
-
type PostKycRequestResponsePromise = Promise<{fields: PostKycRequestResponse}>
|
|
389
|
-
|
|
390
|
-
type GetKycRequestRequest = { id : String }
|
|
391
|
-
|
|
392
|
-
type GetKycRequestResponse = operations['GetKycRequest']['responses']['200']['content']['application/json']
|
|
393
|
-
type GetKycRequestResponsePromise = Promise<{fields: GetKycRequestResponse}>
|
|
394
|
-
type PatchKycRequestRequest = operations['PatchKycRequest']['requestBody']['content']['application/json']
|
|
395
|
-
type PatchKycRequestResponse = operations['PatchKycRequest']['responses']['200']['content']['application/json']
|
|
396
|
-
type PatchKycRequestResponsePromise = Promise<{fields: PatchKycRequestResponse}>
|
|
397
|
-
type DeleteKycRequestResponse = operations['DeleteKycRequest']['responses']['204']
|
|
398
|
-
type DeleteKycRequestResponsePromise = Promise<{fields: DeleteKycRequestResponse}>
|
|
399
|
-
|
|
400
384
|
type GetPasswordTokenCollectionRequest = operations['GetPasswordTokenCollection']['parameters']["query"] & (operations['GetPasswordTokenCollection']['parameters'] extends {path: {}} ? operations['GetPasswordTokenCollection']['parameters']["path"] : {})
|
|
401
385
|
|
|
402
386
|
type GetPasswordTokenCollectionResponse = operations['GetPasswordTokenCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -505,25 +489,6 @@ declare module rebilly {
|
|
|
505
489
|
type DeleteShippingRateResponse = operations['DeleteShippingRate']['responses']['204']
|
|
506
490
|
type DeleteShippingRateResponsePromise = Promise<{fields: DeleteShippingRateResponse}>
|
|
507
491
|
|
|
508
|
-
type GetShippingZoneCollectionRequest = operations['GetShippingZoneCollection']['parameters']["query"] & (operations['GetShippingZoneCollection']['parameters'] extends {path: {}} ? operations['GetShippingZoneCollection']['parameters']["path"] : {})
|
|
509
|
-
|
|
510
|
-
type GetShippingZoneCollectionResponse = operations['GetShippingZoneCollection']['responses']['200']['content']['application/json'][0]
|
|
511
|
-
type GetShippingZoneCollectionResponsePromise = Promise<{ items: {fields: GetShippingZoneCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
512
|
-
type PostShippingZoneRequest = operations['PostShippingZone']['requestBody']['content']['application/json']
|
|
513
|
-
type CreateShippingZoneRequest = { id: String, data: PostShippingZoneRequest, expand?: String }
|
|
514
|
-
type PostShippingZoneResponse = operations['PostShippingZone']['responses']['201']['content']['application/json']
|
|
515
|
-
type PostShippingZoneResponsePromise = Promise<{fields: PostShippingZoneResponse}>
|
|
516
|
-
|
|
517
|
-
type GetShippingZoneRequest = { id : String }
|
|
518
|
-
|
|
519
|
-
type GetShippingZoneResponse = operations['GetShippingZone']['responses']['200']['content']['application/json']
|
|
520
|
-
type GetShippingZoneResponsePromise = Promise<{fields: GetShippingZoneResponse}>
|
|
521
|
-
type PutShippingZoneRequest = operations['PutShippingZone']['requestBody']['content']['application/json']
|
|
522
|
-
type PutShippingZoneResponse = operations['PutShippingZone']['responses']['201']['content']['application/json']
|
|
523
|
-
type PutShippingZoneResponsePromise = Promise<{fields: PutShippingZoneResponse}>
|
|
524
|
-
type DeleteShippingZoneResponse = operations['DeleteShippingZone']['responses']['204']
|
|
525
|
-
type DeleteShippingZoneResponsePromise = Promise<{fields: DeleteShippingZoneResponse}>
|
|
526
|
-
|
|
527
492
|
type GetSubscriptionCollectionRequest = operations['GetSubscriptionCollection']['parameters']["query"] & (operations['GetSubscriptionCollection']['parameters'] extends {path: {}} ? operations['GetSubscriptionCollection']['parameters']["path"] : {})
|
|
528
493
|
|
|
529
494
|
type GetSubscriptionCollectionResponse = operations['GetSubscriptionCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -572,6 +537,9 @@ declare module rebilly {
|
|
|
572
537
|
type PutSubscriptionCancellationRequest = operations['PutSubscriptionCancellation']['requestBody']['content']['application/json']
|
|
573
538
|
type PutSubscriptionCancellationResponse = operations['PutSubscriptionCancellation']['responses']['201']['content']['application/json']
|
|
574
539
|
type PutSubscriptionCancellationResponsePromise = Promise<{fields: PutSubscriptionCancellationResponse}>
|
|
540
|
+
type PatchSubscriptionCancellationRequest = operations['PatchSubscriptionCancellation']['requestBody']['content']['application/json']
|
|
541
|
+
type PatchSubscriptionCancellationResponse = operations['PatchSubscriptionCancellation']['responses']['200']['content']['application/json']
|
|
542
|
+
type PatchSubscriptionCancellationResponsePromise = Promise<{fields: PatchSubscriptionCancellationResponse}>
|
|
575
543
|
type DeleteSubscriptionCancellationResponse = operations['DeleteSubscriptionCancellation']['responses']['204']
|
|
576
544
|
type DeleteSubscriptionCancellationResponsePromise = Promise<{fields: DeleteSubscriptionCancellationResponse}>
|
|
577
545
|
|
|
@@ -599,22 +567,6 @@ declare module rebilly {
|
|
|
599
567
|
type PostUpcomingInvoiceIssuanceResponse = operations['PostUpcomingInvoiceIssuance']['responses']['201']['content']['application/json']
|
|
600
568
|
type PostUpcomingInvoiceIssuanceResponsePromise = Promise<{fields: PostUpcomingInvoiceIssuanceResponse}>
|
|
601
569
|
|
|
602
|
-
type GetSubscriptionTimelineCollectionRequest = operations['GetSubscriptionTimelineCollection']['parameters']["query"] & (operations['GetSubscriptionTimelineCollection']['parameters'] extends {path: {}} ? operations['GetSubscriptionTimelineCollection']['parameters']["path"] : {}) & { id : String }
|
|
603
|
-
|
|
604
|
-
type GetSubscriptionTimelineCollectionResponse = operations['GetSubscriptionTimelineCollection']['responses']['200']['content']['application/json'][0]
|
|
605
|
-
type GetSubscriptionTimelineCollectionResponsePromise = Promise<{ items: {fields: GetSubscriptionTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
606
|
-
type PostSubscriptionTimelineRequest = operations['PostSubscriptionTimeline']['requestBody']['content']['application/json']
|
|
607
|
-
type CreateSubscriptionTimelineRequest = { id: String, data: PostSubscriptionTimelineRequest, expand?: String }
|
|
608
|
-
type PostSubscriptionTimelineResponse = operations['PostSubscriptionTimeline']['responses']['201']['content']['application/json']
|
|
609
|
-
type PostSubscriptionTimelineResponsePromise = Promise<{fields: PostSubscriptionTimelineResponse}>
|
|
610
|
-
|
|
611
|
-
type GetSubscriptionTimelineRequest = { id : String,messageId : String }
|
|
612
|
-
|
|
613
|
-
type GetSubscriptionTimelineResponse = operations['GetSubscriptionTimeline']['responses']['200']['content']['application/json']
|
|
614
|
-
type GetSubscriptionTimelineResponsePromise = Promise<{fields: GetSubscriptionTimelineResponse}>
|
|
615
|
-
type DeleteSubscriptionTimelineResponse = operations['DeleteSubscriptionTimeline']['responses']['204']
|
|
616
|
-
type DeleteSubscriptionTimelineResponsePromise = Promise<{fields: DeleteSubscriptionTimelineResponse}>
|
|
617
|
-
|
|
618
570
|
type GetTagCollectionRequest = operations['GetTagCollection']['parameters']["query"] & (operations['GetTagCollection']['parameters'] extends {path: {}} ? operations['GetTagCollection']['parameters']["path"] : {})
|
|
619
571
|
|
|
620
572
|
type GetTagCollectionResponse = operations['GetTagCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -714,22 +666,6 @@ declare module rebilly {
|
|
|
714
666
|
type PostTransactionRefundResponse = operations['PostTransactionRefund']['responses']['201']['content']['application/json']
|
|
715
667
|
type PostTransactionRefundResponsePromise = Promise<{fields: PostTransactionRefundResponse}>
|
|
716
668
|
|
|
717
|
-
type GetTransactionTimelineCollectionRequest = operations['GetTransactionTimelineCollection']['parameters']["query"] & (operations['GetTransactionTimelineCollection']['parameters'] extends {path: {}} ? operations['GetTransactionTimelineCollection']['parameters']["path"] : {}) & { id : String }
|
|
718
|
-
|
|
719
|
-
type GetTransactionTimelineCollectionResponse = operations['GetTransactionTimelineCollection']['responses']['200']['content']['application/json'][0]
|
|
720
|
-
type GetTransactionTimelineCollectionResponsePromise = Promise<{ items: {fields: GetTransactionTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
721
|
-
type PostTransactionTimelineRequest = operations['PostTransactionTimeline']['requestBody']['content']['application/json']
|
|
722
|
-
type CreateTransactionTimelineRequest = { id: String, data: PostTransactionTimelineRequest, expand?: String }
|
|
723
|
-
type PostTransactionTimelineResponse = operations['PostTransactionTimeline']['responses']['201']['content']['application/json']
|
|
724
|
-
type PostTransactionTimelineResponsePromise = Promise<{fields: PostTransactionTimelineResponse}>
|
|
725
|
-
|
|
726
|
-
type GetTransactionTimelineRequest = { id : String,messageId : String }
|
|
727
|
-
|
|
728
|
-
type GetTransactionTimelineResponse = operations['GetTransactionTimeline']['responses']['200']['content']['application/json']
|
|
729
|
-
type GetTransactionTimelineResponsePromise = Promise<{fields: GetTransactionTimelineResponse}>
|
|
730
|
-
type DeleteTransactionTimelineResponse = operations['DeleteTransactionTimeline']['responses']['204']
|
|
731
|
-
type DeleteTransactionTimelineResponsePromise = Promise<{fields: DeleteTransactionTimelineResponse}>
|
|
732
|
-
|
|
733
669
|
type GetFeeCollectionRequest = operations['GetFeeCollection']['parameters']["query"] & (operations['GetFeeCollection']['parameters'] extends {path: {}} ? operations['GetFeeCollection']['parameters']["path"] : {})
|
|
734
670
|
|
|
735
671
|
type GetFeeCollectionResponse = operations['GetFeeCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -929,8 +865,8 @@ declare module rebilly {
|
|
|
929
865
|
type PatchOauth2CredentialHashResponse = operations['PatchOauth2CredentialHash']['responses']['200']['content']['application/json']
|
|
930
866
|
type PatchOauth2CredentialHashResponsePromise = Promise<{fields: PatchOauth2CredentialHashResponse}>
|
|
931
867
|
|
|
932
|
-
type GetOauth2CredentialHashItemCollectionRequest = { hash : String }
|
|
933
|
-
|
|
868
|
+
type GetOauth2CredentialHashItemCollectionRequest = operations['GetOauth2CredentialHashItemCollection']['parameters']["query"] & (operations['GetOauth2CredentialHashItemCollection']['parameters'] extends {path: {}} ? operations['GetOauth2CredentialHashItemCollection']['parameters']["path"] : {}) & { hash : String }
|
|
869
|
+
|
|
934
870
|
type GetOauth2CredentialHashItemCollectionResponse = operations['GetOauth2CredentialHashItemCollection']['responses']['200']['content']['application/json'][0]
|
|
935
871
|
type GetOauth2CredentialHashItemCollectionResponsePromise = Promise<{ items: {fields: GetOauth2CredentialHashItemCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
936
872
|
|
|
@@ -2629,16 +2565,17 @@ export interface corePaths {
|
|
|
2629
2565
|
};
|
|
2630
2566
|
};
|
|
2631
2567
|
};
|
|
2632
|
-
"/
|
|
2633
|
-
/** Retrieve a list of
|
|
2634
|
-
get: operations["
|
|
2635
|
-
/**
|
|
2636
|
-
|
|
2568
|
+
"/kyc-requests": {
|
|
2569
|
+
/** Retrieve a list of KYC requests. */
|
|
2570
|
+
get: operations["GetKycRequestCollection"];
|
|
2571
|
+
/**
|
|
2572
|
+
* Create a KYC Request.
|
|
2573
|
+
* Then, redirect the customer to the `kycGatherer` link.
|
|
2574
|
+
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
2575
|
+
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
2576
|
+
*/
|
|
2577
|
+
post: operations["PostKycRequest"];
|
|
2637
2578
|
parameters: {
|
|
2638
|
-
path: {
|
|
2639
|
-
/** The resource identifier string. */
|
|
2640
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
2641
|
-
};
|
|
2642
2579
|
header: {
|
|
2643
2580
|
/**
|
|
2644
2581
|
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
@@ -2649,17 +2586,17 @@ export interface corePaths {
|
|
|
2649
2586
|
};
|
|
2650
2587
|
};
|
|
2651
2588
|
};
|
|
2652
|
-
"/
|
|
2653
|
-
/** Retrieve a
|
|
2654
|
-
get: operations["
|
|
2655
|
-
/** Delete
|
|
2656
|
-
delete: operations["
|
|
2589
|
+
"/kyc-requests/{id}": {
|
|
2590
|
+
/** Retrieve a KYC request with specified identifier string. */
|
|
2591
|
+
get: operations["GetKycRequest"];
|
|
2592
|
+
/** Delete the KYC request with the predefined identifier string. */
|
|
2593
|
+
delete: operations["DeleteKycRequest"];
|
|
2594
|
+
/** Update a KYC request. */
|
|
2595
|
+
patch: operations["PatchKycRequest"];
|
|
2657
2596
|
parameters: {
|
|
2658
2597
|
path: {
|
|
2659
2598
|
/** The resource identifier string. */
|
|
2660
2599
|
id: coreComponents["parameters"]["resourceId"];
|
|
2661
|
-
/** The Invoice Timeline message ID. */
|
|
2662
|
-
messageId: string;
|
|
2663
2600
|
};
|
|
2664
2601
|
header: {
|
|
2665
2602
|
/**
|
|
@@ -2815,44 +2752,6 @@ export interface corePaths {
|
|
|
2815
2752
|
};
|
|
2816
2753
|
};
|
|
2817
2754
|
};
|
|
2818
|
-
"/kyc-requests": {
|
|
2819
|
-
/** Retrieve a list of KYC requests. */
|
|
2820
|
-
get: operations["GetKycRequestCollection"];
|
|
2821
|
-
/** Create a KYC Request. */
|
|
2822
|
-
post: operations["PostKycRequest"];
|
|
2823
|
-
parameters: {
|
|
2824
|
-
header: {
|
|
2825
|
-
/**
|
|
2826
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
2827
|
-
*
|
|
2828
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
2829
|
-
*/
|
|
2830
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
2831
|
-
};
|
|
2832
|
-
};
|
|
2833
|
-
};
|
|
2834
|
-
"/kyc-requests/{id}": {
|
|
2835
|
-
/** Retrieve a KYC request with specified identifier string. */
|
|
2836
|
-
get: operations["GetKycRequest"];
|
|
2837
|
-
/** Delete the KYC request with the predefined identifier string. */
|
|
2838
|
-
delete: operations["DeleteKycRequest"];
|
|
2839
|
-
/** Update a KYC request. */
|
|
2840
|
-
patch: operations["PatchKycRequest"];
|
|
2841
|
-
parameters: {
|
|
2842
|
-
path: {
|
|
2843
|
-
/** The resource identifier string. */
|
|
2844
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
2845
|
-
};
|
|
2846
|
-
header: {
|
|
2847
|
-
/**
|
|
2848
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
2849
|
-
*
|
|
2850
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
2851
|
-
*/
|
|
2852
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
2853
|
-
};
|
|
2854
|
-
};
|
|
2855
|
-
};
|
|
2856
2755
|
"/password-tokens": {
|
|
2857
2756
|
/** Retrieve a list of tokens. */
|
|
2858
2757
|
get: operations["GetPasswordTokenCollection"];
|
|
@@ -3116,44 +3015,6 @@ export interface corePaths {
|
|
|
3116
3015
|
};
|
|
3117
3016
|
};
|
|
3118
3017
|
};
|
|
3119
|
-
"/shipping-zones": {
|
|
3120
|
-
/** Retrieve a list of shipping zones. */
|
|
3121
|
-
get: operations["GetShippingZoneCollection"];
|
|
3122
|
-
/** Create a Shipping Zone. */
|
|
3123
|
-
post: operations["PostShippingZone"];
|
|
3124
|
-
parameters: {
|
|
3125
|
-
header: {
|
|
3126
|
-
/**
|
|
3127
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
3128
|
-
*
|
|
3129
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
3130
|
-
*/
|
|
3131
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
3132
|
-
};
|
|
3133
|
-
};
|
|
3134
|
-
};
|
|
3135
|
-
"/shipping-zones/{id}": {
|
|
3136
|
-
/** Retrieve a shipping zone with specified identifier string. */
|
|
3137
|
-
get: operations["GetShippingZone"];
|
|
3138
|
-
/** Create a shipping zone with predefined identifier string. */
|
|
3139
|
-
put: operations["PutShippingZone"];
|
|
3140
|
-
/** Delete a shipping zone with predefined identifier string. */
|
|
3141
|
-
delete: operations["DeleteShippingZone"];
|
|
3142
|
-
parameters: {
|
|
3143
|
-
path: {
|
|
3144
|
-
/** The resource identifier string. */
|
|
3145
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
3146
|
-
};
|
|
3147
|
-
header: {
|
|
3148
|
-
/**
|
|
3149
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
3150
|
-
*
|
|
3151
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
3152
|
-
*/
|
|
3153
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
3154
|
-
};
|
|
3155
|
-
};
|
|
3156
|
-
};
|
|
3157
3018
|
"/subscriptions": {
|
|
3158
3019
|
/** Retrieve a list of orders. */
|
|
3159
3020
|
get: operations["GetSubscriptionCollection"];
|
|
@@ -3276,6 +3137,8 @@ export interface corePaths {
|
|
|
3276
3137
|
put: operations["PutSubscriptionCancellation"];
|
|
3277
3138
|
/** Delete an order's cancellation. Only draft can be deleted. */
|
|
3278
3139
|
delete: operations["DeleteSubscriptionCancellation"];
|
|
3140
|
+
/** Update a subscription cancellation, used for updating cancellation reason and description. */
|
|
3141
|
+
patch: operations["PatchSubscriptionCancellation"];
|
|
3279
3142
|
parameters: {
|
|
3280
3143
|
path: {
|
|
3281
3144
|
/** The resource identifier string. */
|
|
@@ -3366,48 +3229,6 @@ export interface corePaths {
|
|
|
3366
3229
|
};
|
|
3367
3230
|
};
|
|
3368
3231
|
};
|
|
3369
|
-
"/subscriptions/{id}/timeline": {
|
|
3370
|
-
/** Retrieve a list of order timeline messages. */
|
|
3371
|
-
get: operations["GetSubscriptionTimelineCollection"];
|
|
3372
|
-
/** Create an order Timeline comment. */
|
|
3373
|
-
post: operations["PostSubscriptionTimeline"];
|
|
3374
|
-
parameters: {
|
|
3375
|
-
path: {
|
|
3376
|
-
/** The resource identifier string. */
|
|
3377
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
3378
|
-
};
|
|
3379
|
-
header: {
|
|
3380
|
-
/**
|
|
3381
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
3382
|
-
*
|
|
3383
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
3384
|
-
*/
|
|
3385
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
3386
|
-
};
|
|
3387
|
-
};
|
|
3388
|
-
};
|
|
3389
|
-
"/subscriptions/{id}/timeline/{messageId}": {
|
|
3390
|
-
/** Retrieve a order message with specified identifier string. */
|
|
3391
|
-
get: operations["GetSubscriptionTimeline"];
|
|
3392
|
-
/** Delete an Order Timeline message with predefined identifier string. */
|
|
3393
|
-
delete: operations["DeleteSubscriptionTimeline"];
|
|
3394
|
-
parameters: {
|
|
3395
|
-
path: {
|
|
3396
|
-
/** The resource identifier string. */
|
|
3397
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
3398
|
-
/** The Order Timeline message ID. */
|
|
3399
|
-
messageId: string;
|
|
3400
|
-
};
|
|
3401
|
-
header: {
|
|
3402
|
-
/**
|
|
3403
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
3404
|
-
*
|
|
3405
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
3406
|
-
*/
|
|
3407
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
3408
|
-
};
|
|
3409
|
-
};
|
|
3410
|
-
};
|
|
3411
3232
|
"/tags": {
|
|
3412
3233
|
/** Retrieve a list of tags. */
|
|
3413
3234
|
get: operations["GetTagCollection"];
|
|
@@ -3735,48 +3556,6 @@ export interface corePaths {
|
|
|
3735
3556
|
};
|
|
3736
3557
|
};
|
|
3737
3558
|
};
|
|
3738
|
-
"/transactions/{id}/timeline": {
|
|
3739
|
-
/** Retrieve a list of transaction timeline messages. */
|
|
3740
|
-
get: operations["GetTransactionTimelineCollection"];
|
|
3741
|
-
/** Create a transaction Timeline comment. */
|
|
3742
|
-
post: operations["PostTransactionTimeline"];
|
|
3743
|
-
parameters: {
|
|
3744
|
-
path: {
|
|
3745
|
-
/** The resource identifier string. */
|
|
3746
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
3747
|
-
};
|
|
3748
|
-
header: {
|
|
3749
|
-
/**
|
|
3750
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
3751
|
-
*
|
|
3752
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
3753
|
-
*/
|
|
3754
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
3755
|
-
};
|
|
3756
|
-
};
|
|
3757
|
-
};
|
|
3758
|
-
"/transactions/{id}/timeline/{messageId}": {
|
|
3759
|
-
/** Retrieve a timeline message with specified identifier string. */
|
|
3760
|
-
get: operations["GetTransactionTimeline"];
|
|
3761
|
-
/** Delete a Transaction Timeline message with predefined identifier string. */
|
|
3762
|
-
delete: operations["DeleteTransactionTimeline"];
|
|
3763
|
-
parameters: {
|
|
3764
|
-
path: {
|
|
3765
|
-
/** The resource identifier string. */
|
|
3766
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
3767
|
-
/** The Transaction Timeline message ID. */
|
|
3768
|
-
messageId: string;
|
|
3769
|
-
};
|
|
3770
|
-
header: {
|
|
3771
|
-
/**
|
|
3772
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
3773
|
-
*
|
|
3774
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
3775
|
-
*/
|
|
3776
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
3777
|
-
};
|
|
3778
|
-
};
|
|
3779
|
-
};
|
|
3780
3559
|
"/fees": {
|
|
3781
3560
|
/**
|
|
3782
3561
|
* Retrieve a list of Fees entries.
|
|
@@ -4823,61 +4602,77 @@ export interface coreComponents {
|
|
|
4823
4602
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
4824
4603
|
/** Timeline message type. */
|
|
4825
4604
|
type?:
|
|
4826
|
-
| "
|
|
4827
|
-
| "
|
|
4828
|
-
| "
|
|
4829
|
-
| "default-payment-instrument-changed"
|
|
4830
|
-
| "lead-source-changed"
|
|
4831
|
-
| "custom-fields-changed"
|
|
4605
|
+
| "account-password-reset-requested"
|
|
4606
|
+
| "account-verification-requested"
|
|
4607
|
+
| "aml-list-was-possibly-matched"
|
|
4832
4608
|
| "coupon-applied"
|
|
4833
4609
|
| "coupon-redeemed"
|
|
4834
4610
|
| "coupon-redemption-canceled"
|
|
4835
|
-
| "
|
|
4836
|
-
| "
|
|
4837
|
-
| "
|
|
4838
|
-
| "kyc-document-rejected"
|
|
4839
|
-
| "kyc-document-manually-rejected"
|
|
4840
|
-
| "kyc-document-modified"
|
|
4841
|
-
| "payment-card-expired"
|
|
4842
|
-
| "payment-instrument-created"
|
|
4843
|
-
| "payment-instrument-deactivated"
|
|
4611
|
+
| "custom-event"
|
|
4612
|
+
| "custom-event-processed"
|
|
4613
|
+
| "custom-fields-changed"
|
|
4844
4614
|
| "customer-bank-account-blocked"
|
|
4845
4615
|
| "customer-blocked"
|
|
4616
|
+
| "customer-comment-created"
|
|
4617
|
+
| "customer-created"
|
|
4618
|
+
| "customer-merged"
|
|
4846
4619
|
| "customer-payment-card-blocked"
|
|
4620
|
+
| "customer-requested-otp"
|
|
4621
|
+
| "customer-tagged"
|
|
4622
|
+
| "customer-untagged"
|
|
4623
|
+
| "default-payment-instrument-changed"
|
|
4624
|
+
| "email-message-sent"
|
|
4625
|
+
| "experian-check-performed"
|
|
4626
|
+
| "invoice-abandoned"
|
|
4847
4627
|
| "invoice-created"
|
|
4628
|
+
| "invoice-disputed"
|
|
4848
4629
|
| "invoice-issued"
|
|
4849
|
-
| "invoice-abandoned"
|
|
4850
|
-
| "invoice-voided"
|
|
4851
|
-
| "invoice-past-due"
|
|
4852
4630
|
| "invoice-paid"
|
|
4853
4631
|
| "invoice-partially-paid"
|
|
4854
|
-
| "invoice-disputed"
|
|
4855
|
-
| "invoice-refunded"
|
|
4856
4632
|
| "invoice-partially-refunded"
|
|
4857
|
-
| "
|
|
4858
|
-
| "
|
|
4633
|
+
| "invoice-past-due"
|
|
4634
|
+
| "invoice-refunded"
|
|
4635
|
+
| "invoice-reissued"
|
|
4636
|
+
| "invoice-revenue-recognized"
|
|
4637
|
+
| "invoice-voided"
|
|
4638
|
+
| "kyc-document-accepted"
|
|
4639
|
+
| "kyc-document-created"
|
|
4640
|
+
| "kyc-document-modified"
|
|
4641
|
+
| "kyc-document-rejected"
|
|
4642
|
+
| "kyc-document-reviewed"
|
|
4643
|
+
| "lead-source-changed"
|
|
4859
4644
|
| "order-activated"
|
|
4860
|
-
| "order-completed"
|
|
4861
|
-
| "order-reactivated"
|
|
4862
4645
|
| "order-canceled"
|
|
4863
|
-
| "order-upgraded"
|
|
4864
|
-
| "order-downgraded"
|
|
4865
4646
|
| "order-churned"
|
|
4647
|
+
| "order-completed"
|
|
4648
|
+
| "order-created"
|
|
4649
|
+
| "order-downgraded"
|
|
4866
4650
|
| "order-paid-early"
|
|
4651
|
+
| "order-reactivated"
|
|
4652
|
+
| "order-renewed"
|
|
4653
|
+
| "order-upgraded"
|
|
4654
|
+
| "payment-card-expiration-was-modified"
|
|
4655
|
+
| "payment-card-expired"
|
|
4656
|
+
| "payment-instrument-created"
|
|
4657
|
+
| "payment-instrument-deactivated"
|
|
4658
|
+
| "primary-address-changed"
|
|
4659
|
+
| "quickbooks-customer-created"
|
|
4660
|
+
| "quickbooks-customer-task-failed"
|
|
4661
|
+
| "refund-was-reflected-in-invoices"
|
|
4662
|
+
| "subscription-paused"
|
|
4663
|
+
| "subscription-resumed"
|
|
4664
|
+
| "subscription-trial-end-changed"
|
|
4665
|
+
| "transaction-abandoned"
|
|
4666
|
+
| "transaction-amount-discrepancy-found"
|
|
4867
4667
|
| "transaction-approved"
|
|
4868
4668
|
| "transaction-canceled"
|
|
4869
4669
|
| "transaction-declined"
|
|
4870
|
-
| "transaction-
|
|
4670
|
+
| "transaction-discrepancy-found"
|
|
4671
|
+
| "transaction-disputed"
|
|
4672
|
+
| "transaction-reconciled"
|
|
4871
4673
|
| "transaction-refunded"
|
|
4872
4674
|
| "transaction-voided"
|
|
4873
|
-
| "transaction-
|
|
4874
|
-
| "transaction-amount-discrepancy-found"
|
|
4875
|
-
| "email-message-sent"
|
|
4876
|
-
| "custom-event-processed"
|
|
4877
|
-
| "custom-event"
|
|
4878
|
-
| "transaction-waiting-gateway"
|
|
4879
|
-
| "aml-list-was-possibly-matched"
|
|
4880
|
-
| "experian-check-performed";
|
|
4675
|
+
| "transaction-waiting-gateway";
|
|
4881
4676
|
/** Timeline custom event type. Used with `custom-event` type. Must be defined using [Customer Timeline custom event API](#operation/PostCustomerTimelineCustomEventType). */
|
|
4882
4677
|
customEventType?: string | null;
|
|
4883
4678
|
/** Timeline custom event data. Used with `custom-event` type. Will be transformed to `extraData` two-column table in response. */
|
|
@@ -8304,6 +8099,10 @@ export interface coreComponents {
|
|
|
8304
8099
|
| "Laser"
|
|
8305
8100
|
| "China UnionPay"
|
|
8306
8101
|
| "AstroPay Card";
|
|
8102
|
+
/** The ISO 3166 alpha-2 country code. */
|
|
8103
|
+
Country: string;
|
|
8104
|
+
/** The ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your payment service provider (PSP) to determine the appropriate country code. */
|
|
8105
|
+
DigitalWalletCountry: coreComponents["schemas"]["Country"];
|
|
8307
8106
|
/** Configure which digital wallets are enabled. */
|
|
8308
8107
|
DigitalWallets: {
|
|
8309
8108
|
/** The Apple Pay digital wallet configuration. Skip if not using Apple Pay. */
|
|
@@ -8312,6 +8111,7 @@ export interface coreComponents {
|
|
|
8312
8111
|
isEnabled: boolean;
|
|
8313
8112
|
/** A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name. */
|
|
8314
8113
|
displayName?: string;
|
|
8114
|
+
country?: coreComponents["schemas"]["DigitalWalletCountry"];
|
|
8315
8115
|
};
|
|
8316
8116
|
/** The Google Pay™ digital wallet configuration. Skip if not using Google Pay™. */
|
|
8317
8117
|
googlePay?: {
|
|
@@ -8321,6 +8121,7 @@ export interface coreComponents {
|
|
|
8321
8121
|
merchantName?: string;
|
|
8322
8122
|
/** The merchant origin in Google Pay. The fully qualified domain name. */
|
|
8323
8123
|
merchantOrigin?: string;
|
|
8124
|
+
country?: coreComponents["schemas"]["DigitalWalletCountry"];
|
|
8324
8125
|
};
|
|
8325
8126
|
};
|
|
8326
8127
|
OnBoardingUrlLink: coreComponents["schemas"]["Link"] & {
|
|
@@ -8385,6 +8186,8 @@ export interface coreComponents {
|
|
|
8385
8186
|
bankName?: string;
|
|
8386
8187
|
/** The billing address. */
|
|
8387
8188
|
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
8189
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
8190
|
+
useAsBackup: boolean;
|
|
8388
8191
|
/** Payment instrument created time. */
|
|
8389
8192
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8390
8193
|
/** Payment instrument updated time. */
|
|
@@ -8406,7 +8209,7 @@ export interface coreComponents {
|
|
|
8406
8209
|
/** Time expiration reminder event will be triggered. */
|
|
8407
8210
|
expirationReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
8408
8211
|
/** Number of expiration reminder events triggered. */
|
|
8409
|
-
expirationReminderNumber?: number;
|
|
8212
|
+
expirationReminderNumber?: number | null;
|
|
8410
8213
|
/** Payment instrument reference data. */
|
|
8411
8214
|
referenceData?: { [key: string]: string };
|
|
8412
8215
|
/** The links related to resource. */
|
|
@@ -8447,6 +8250,8 @@ export interface coreComponents {
|
|
|
8447
8250
|
last4?: string;
|
|
8448
8251
|
/** Bank account status. */
|
|
8449
8252
|
status?: "active" | "deactivated";
|
|
8253
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
8254
|
+
useAsBackup: boolean;
|
|
8450
8255
|
/** Bank account created time. */
|
|
8451
8256
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8452
8257
|
/** Bank account updated time. */
|
|
@@ -8475,9 +8280,11 @@ export interface coreComponents {
|
|
|
8475
8280
|
/** The invoice's shipping amount. */
|
|
8476
8281
|
amount: number;
|
|
8477
8282
|
};
|
|
8478
|
-
/** Rebilly-based shipping which is calculated by shipping
|
|
8283
|
+
/** Rebilly-based shipping which is calculated by shipping rates. */
|
|
8479
8284
|
rebilly: coreComponents["schemas"]["Shipping"] & {
|
|
8480
|
-
/** The
|
|
8285
|
+
/** The shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
8286
|
+
rateId?: coreComponents["schemas"]["ResourceId"] | null;
|
|
8287
|
+
/** The invoice's shipping amount which is calculated from [Shipping Rates](#tag/Shipping-Rates). */
|
|
8481
8288
|
amount?: number;
|
|
8482
8289
|
};
|
|
8483
8290
|
/** Invoice taxes. */
|
|
@@ -9028,6 +8835,84 @@ export interface coreComponents {
|
|
|
9028
8835
|
/** Desired time to go live. */
|
|
9029
8836
|
launchTiming?: string;
|
|
9030
8837
|
};
|
|
8838
|
+
KycSettingsIdentity: {
|
|
8839
|
+
/** The weights of all matched properties. */
|
|
8840
|
+
weights?: {
|
|
8841
|
+
/** The weight of containsImage. */
|
|
8842
|
+
containsImage?: number;
|
|
8843
|
+
/** The weight of isIdentityDocument. */
|
|
8844
|
+
isIdentityDocument?: number;
|
|
8845
|
+
/** The weight of isPublishedOnline. */
|
|
8846
|
+
isPublishedOnline?: number;
|
|
8847
|
+
/** The weight of firstName. */
|
|
8848
|
+
firstName?: number;
|
|
8849
|
+
/** The weight of lastName. */
|
|
8850
|
+
lastName?: number;
|
|
8851
|
+
/** The weight of expiryDate. */
|
|
8852
|
+
expiryDate?: number;
|
|
8853
|
+
/** The weight of dateOfBirth. */
|
|
8854
|
+
dateOfBirth?: number;
|
|
8855
|
+
/** The weight of matchesDateOfBirth. */
|
|
8856
|
+
matchesDateOfBirth?: number;
|
|
8857
|
+
/** The weight of issueDate. */
|
|
8858
|
+
issueDate?: number;
|
|
8859
|
+
/** The weight of hasMinimalAge. */
|
|
8860
|
+
hasMinimalAge?: number;
|
|
8861
|
+
/** The weight of hasMatchingFaceProof. */
|
|
8862
|
+
hasMatchingFaceProof?: number;
|
|
8863
|
+
/** The weight of nationality. */
|
|
8864
|
+
nationality?: number;
|
|
8865
|
+
};
|
|
8866
|
+
/** The thresholds to determine the document status. */
|
|
8867
|
+
thresholds?: {
|
|
8868
|
+
/** The weight of rejectBelow. */
|
|
8869
|
+
rejectBelow?: number;
|
|
8870
|
+
/** The weight of acceptAbove. */
|
|
8871
|
+
acceptAbove?: number;
|
|
8872
|
+
};
|
|
8873
|
+
};
|
|
8874
|
+
KycSettingsAddress: {
|
|
8875
|
+
/** The weights of all matched properties. */
|
|
8876
|
+
weights?: {
|
|
8877
|
+
/** The weight of firstName. */
|
|
8878
|
+
firstName?: number;
|
|
8879
|
+
/** The weight of lastName. */
|
|
8880
|
+
lastName?: number;
|
|
8881
|
+
/** The weight of line1. */
|
|
8882
|
+
line1?: number;
|
|
8883
|
+
/** The weight of city. */
|
|
8884
|
+
city?: number;
|
|
8885
|
+
/** The weight of region. */
|
|
8886
|
+
region?: number;
|
|
8887
|
+
/** The weight of postalCode. */
|
|
8888
|
+
postalCode?: number;
|
|
8889
|
+
/** The weight of date. */
|
|
8890
|
+
date?: number;
|
|
8891
|
+
/** The weight of phone. */
|
|
8892
|
+
phone?: number;
|
|
8893
|
+
};
|
|
8894
|
+
/** The thresholds to determine the document status. */
|
|
8895
|
+
thresholds?: {
|
|
8896
|
+
/** The weight of rejectBelow. */
|
|
8897
|
+
rejectBelow?: number;
|
|
8898
|
+
/** The weight of acceptAbove. */
|
|
8899
|
+
acceptAbove?: number;
|
|
8900
|
+
};
|
|
8901
|
+
};
|
|
8902
|
+
OrganizationSettings: {
|
|
8903
|
+
/** The settings for tax calculation. */
|
|
8904
|
+
defaultTaxCalculator?: {
|
|
8905
|
+
/** The type of the tax calculator. */
|
|
8906
|
+
type: "taxjar" | "flat";
|
|
8907
|
+
/** The rate for flat tax calculation. */
|
|
8908
|
+
rate?: number | null;
|
|
8909
|
+
};
|
|
8910
|
+
/** The settings for tax calculation. */
|
|
8911
|
+
kyc?: {
|
|
8912
|
+
"identity-proof"?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
8913
|
+
"address-proof"?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
8914
|
+
};
|
|
8915
|
+
};
|
|
9031
8916
|
Organization: {
|
|
9032
8917
|
/** The organization identifier string. */
|
|
9033
8918
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
@@ -9058,6 +8943,7 @@ export interface coreComponents {
|
|
|
9058
8943
|
/** True, if Organization is primary (available to set as true only, other organizations will become as isPrimary=false). */
|
|
9059
8944
|
isPrimary?: boolean;
|
|
9060
8945
|
questionnaire?: coreComponents["schemas"]["OrganizationQuestionnaire"];
|
|
8946
|
+
settings?: coreComponents["schemas"]["OrganizationSettings"];
|
|
9061
8947
|
/** The links related to resource. */
|
|
9062
8948
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
9063
8949
|
};
|
|
@@ -9075,6 +8961,8 @@ export interface coreComponents {
|
|
|
9075
8961
|
attempts: {
|
|
9076
8962
|
scheduleInstruction: coreComponents["schemas"]["InvoiceRetryScheduleInstruction"];
|
|
9077
8963
|
amountAdjustmentInstruction?: coreComponents["schemas"]["InvoiceRetryAmountAdjustmentInstruction"];
|
|
8964
|
+
/** Whether to use backup payment instruments on invoice payment retry or not. */
|
|
8965
|
+
tryBackupInstruments: boolean;
|
|
9078
8966
|
}[];
|
|
9079
8967
|
/** The policy on the attempt finishes. */
|
|
9080
8968
|
afterAttemptPolicies: "change-subscription-renewal-time"[];
|
|
@@ -9099,7 +8987,7 @@ export interface coreComponents {
|
|
|
9099
8987
|
/** Time past due reminder event will be triggered. */
|
|
9100
8988
|
dueReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
9101
8989
|
/** Number of past due reminder events triggered. */
|
|
9102
|
-
dueReminderNumber?: number;
|
|
8990
|
+
dueReminderNumber?: number | null;
|
|
9103
8991
|
/** The links related to resource. */
|
|
9104
8992
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9105
8993
|
Partial<coreComponents["schemas"]["CustomerLink"]> &
|
|
@@ -9407,42 +9295,6 @@ export interface coreComponents {
|
|
|
9407
9295
|
/** Amount which needs to be applied to the invoice. Can't be more than the transaction's amount. If omitted, the lesser of the transaction's unused amount or the invoice's amount due will be used. */
|
|
9408
9296
|
amount?: number;
|
|
9409
9297
|
};
|
|
9410
|
-
InvoiceTimeline: {
|
|
9411
|
-
/** The Timeline message identifier string. */
|
|
9412
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
9413
|
-
/** Timeline message type. */
|
|
9414
|
-
type?:
|
|
9415
|
-
| "timeline-comment-created"
|
|
9416
|
-
| "invoice-created"
|
|
9417
|
-
| "invoice-issued"
|
|
9418
|
-
| "invoice-abandoned"
|
|
9419
|
-
| "invoice-voided"
|
|
9420
|
-
| "invoice-past-due"
|
|
9421
|
-
| "invoice-paid"
|
|
9422
|
-
| "invoice-partially-paid"
|
|
9423
|
-
| "invoice-disputed"
|
|
9424
|
-
| "invoice-refunded"
|
|
9425
|
-
| "invoice-partially-refunded"
|
|
9426
|
-
| "invoice-renewal-payment-declined"
|
|
9427
|
-
| "email-message-sent"
|
|
9428
|
-
| "coupon-applied"
|
|
9429
|
-
| "transaction-approved"
|
|
9430
|
-
| "transaction-abandoned"
|
|
9431
|
-
| "transaction-canceled"
|
|
9432
|
-
| "transaction-declined"
|
|
9433
|
-
| "transaction-initiated"
|
|
9434
|
-
| "transaction-refunded"
|
|
9435
|
-
| "transaction-voided";
|
|
9436
|
-
/** Shows who or what triggered the Timeline event. */
|
|
9437
|
-
triggeredBy?: "rebilly" | "app" | "direct-api";
|
|
9438
|
-
/** The message that describes the message details. */
|
|
9439
|
-
message?: string;
|
|
9440
|
-
extraData?: coreComponents["schemas"]["TimelineExtraData"];
|
|
9441
|
-
/** Timeline message time. */
|
|
9442
|
-
occurredTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9443
|
-
/** The links related to resource. */
|
|
9444
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
9445
|
-
};
|
|
9446
9298
|
KycDocumentTypes:
|
|
9447
9299
|
| "identity-proof"
|
|
9448
9300
|
| "address-proof"
|
|
@@ -9470,6 +9322,64 @@ export interface coreComponents {
|
|
|
9470
9322
|
| "ewallet-holder-details"
|
|
9471
9323
|
| "ewallet-transaction-statement"
|
|
9472
9324
|
| "other";
|
|
9325
|
+
CommonKycRequest: {
|
|
9326
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
9327
|
+
/** Documents to be requested from customer. */
|
|
9328
|
+
documents: {
|
|
9329
|
+
/** Document type to be requested from customer. */
|
|
9330
|
+
type: coreComponents["schemas"]["KycDocumentTypes"];
|
|
9331
|
+
/** Document subtype allowed for customer. */
|
|
9332
|
+
subtypes?: coreComponents["schemas"]["KycDocumentSubtypes"][];
|
|
9333
|
+
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
9334
|
+
maxAttempts: number;
|
|
9335
|
+
/** If `true` uploading matching face photo (selfie) is required. */
|
|
9336
|
+
faceProofRequired?: boolean;
|
|
9337
|
+
}[];
|
|
9338
|
+
/** Status of the request. */
|
|
9339
|
+
status?: "unfulfilled" | "pending" | "rejected" | "fulfilled" | "expired";
|
|
9340
|
+
/**
|
|
9341
|
+
* The URL to redirect the customer when an upload is completed.
|
|
9342
|
+
* When the customer is redirected, Rebilly will append an `info` query parameter which may have one of the following values (example: `https://example.com?info=success`):
|
|
9343
|
+
*
|
|
9344
|
+
* - **back** - The customer clicked the `back to website` link;
|
|
9345
|
+
* - **token_expired** - The customer's token expired;
|
|
9346
|
+
* - **success** - The customer uploaded docs that were successfully analyzed;
|
|
9347
|
+
* - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
|
|
9348
|
+
* - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
|
|
9349
|
+
*/
|
|
9350
|
+
redirectUrl?: string;
|
|
9351
|
+
/** Expiration date-time. Default value is one hour in the future. */
|
|
9352
|
+
expirationTime?: string;
|
|
9353
|
+
/** Creation date-time. */
|
|
9354
|
+
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9355
|
+
/** Latest update date-time. */
|
|
9356
|
+
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9357
|
+
};
|
|
9358
|
+
KycDocumentsLink: coreComponents["schemas"]["Link"] & {
|
|
9359
|
+
/** The link type. */
|
|
9360
|
+
rel: "kycDocuments";
|
|
9361
|
+
};
|
|
9362
|
+
KycGathererLink: {
|
|
9363
|
+
/** The link type. */
|
|
9364
|
+
rel: "kycGatherer";
|
|
9365
|
+
/** The KYC gatherer URL to redirect the customer to complete the KYC process. */
|
|
9366
|
+
href: string;
|
|
9367
|
+
};
|
|
9368
|
+
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
9369
|
+
/** The customer ID. */
|
|
9370
|
+
customerId: coreComponents["schemas"]["ResourceId"];
|
|
9371
|
+
/** Reason for uploading. */
|
|
9372
|
+
reason?: string;
|
|
9373
|
+
/**
|
|
9374
|
+
* The level of strictness for the document matches.
|
|
9375
|
+
* The value of `1` is less strict and `2` is strict.
|
|
9376
|
+
*/
|
|
9377
|
+
matchLevel: number;
|
|
9378
|
+
/** The links related to the resource. */
|
|
9379
|
+
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9380
|
+
Partial<coreComponents["schemas"]["KycDocumentsLink"]> &
|
|
9381
|
+
Partial<coreComponents["schemas"]["KycGathererLink"]>)[];
|
|
9382
|
+
};
|
|
9473
9383
|
KycDocumentRejection: {
|
|
9474
9384
|
type?:
|
|
9475
9385
|
| "document-unreadable"
|
|
@@ -9484,7 +9394,11 @@ export interface coreComponents {
|
|
|
9484
9394
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
9485
9395
|
/** Linked file object id. */
|
|
9486
9396
|
fileId?: coreComponents["schemas"]["ResourceId"];
|
|
9487
|
-
/**
|
|
9397
|
+
/**
|
|
9398
|
+
* Linked file object id's.
|
|
9399
|
+
*
|
|
9400
|
+
* Files uploaded for identity-proof must have following corresponding tags attached `['kyc', 'id-front']`, `['kyc', 'id-back']`, `['kyc', 'face-proof']` in order to be properly recognized as identity-proof files.
|
|
9401
|
+
*/
|
|
9488
9402
|
fileIds?: coreComponents["schemas"]["ResourceId"][];
|
|
9489
9403
|
/** Document type submitted for validation, only identity-proof type is analyzed in an automated manner. */
|
|
9490
9404
|
documentType: coreComponents["schemas"]["KycDocumentTypes"];
|
|
@@ -9517,10 +9431,14 @@ export interface coreComponents {
|
|
|
9517
9431
|
reviewTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
9518
9432
|
/** Reviewer notes. */
|
|
9519
9433
|
notes?: string | null;
|
|
9434
|
+
/** A list of kyc document tags. */
|
|
9435
|
+
tags?: coreComponents["schemas"]["Tag"][];
|
|
9520
9436
|
/** Reason for uploading. */
|
|
9521
9437
|
reason?: string;
|
|
9522
9438
|
/** The level of strictness for the document matches. */
|
|
9523
9439
|
matchLevel?: number;
|
|
9440
|
+
/** The settings used to score the document. */
|
|
9441
|
+
settings?: { [key: string]: any } | null;
|
|
9524
9442
|
};
|
|
9525
9443
|
IdentityMatches: {
|
|
9526
9444
|
/** Flag that indicates if there is an image that contains a face on it. */
|
|
@@ -9555,6 +9473,7 @@ export interface coreComponents {
|
|
|
9555
9473
|
score?: number;
|
|
9556
9474
|
data?: coreComponents["schemas"]["IdentityMatches"];
|
|
9557
9475
|
};
|
|
9476
|
+
settings?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
9558
9477
|
/** The links related to resource. */
|
|
9559
9478
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9560
9479
|
Partial<coreComponents["schemas"]["FileLink"]> &
|
|
@@ -9597,6 +9516,7 @@ export interface coreComponents {
|
|
|
9597
9516
|
score?: number;
|
|
9598
9517
|
data?: coreComponents["schemas"]["AddressMatches"];
|
|
9599
9518
|
};
|
|
9519
|
+
settings?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
9600
9520
|
/** The links related to resource. */
|
|
9601
9521
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9602
9522
|
Partial<coreComponents["schemas"]["FileLink"]> &
|
|
@@ -9633,48 +9553,6 @@ export interface coreComponents {
|
|
|
9633
9553
|
| coreComponents["schemas"]["ProofOfAddress"]
|
|
9634
9554
|
| coreComponents["schemas"]["ProofOfFunds"]
|
|
9635
9555
|
| coreComponents["schemas"]["ProofOfPurchase"];
|
|
9636
|
-
CommonKycRequest: {
|
|
9637
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
9638
|
-
/** Documents to be requested from customer. */
|
|
9639
|
-
documents: {
|
|
9640
|
-
/** Document type to be requested from customer. */
|
|
9641
|
-
type: coreComponents["schemas"]["KycDocumentTypes"];
|
|
9642
|
-
/** Document subtype allowed for customer. */
|
|
9643
|
-
subtypes?: coreComponents["schemas"]["KycDocumentSubtypes"][];
|
|
9644
|
-
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
9645
|
-
maxAttempts: number;
|
|
9646
|
-
}[];
|
|
9647
|
-
/** Status of the request. */
|
|
9648
|
-
status?: "unfulfilled" | "pending" | "rejected" | "fulfilled" | "expired";
|
|
9649
|
-
/** The URL to redirect the customer when an upload is completed. */
|
|
9650
|
-
redirectUrl?: string;
|
|
9651
|
-
/** Expiration date/time. */
|
|
9652
|
-
expirationTime?: string;
|
|
9653
|
-
/** Creation date/time. */
|
|
9654
|
-
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9655
|
-
/** Latest update date/time. */
|
|
9656
|
-
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9657
|
-
};
|
|
9658
|
-
KycDocumentsLink: coreComponents["schemas"]["Link"] & {
|
|
9659
|
-
/** The link type. */
|
|
9660
|
-
rel: "kycDocuments";
|
|
9661
|
-
};
|
|
9662
|
-
KycGathererLink: coreComponents["schemas"]["Link"] & {
|
|
9663
|
-
/** The link type. */
|
|
9664
|
-
rel: "kycGatherer";
|
|
9665
|
-
};
|
|
9666
|
-
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
9667
|
-
/** The customer ID. */
|
|
9668
|
-
customerId: coreComponents["schemas"]["ResourceId"];
|
|
9669
|
-
/** Reason for uploading. */
|
|
9670
|
-
reason?: string;
|
|
9671
|
-
/** The level of strictness for the document matches. */
|
|
9672
|
-
matchLevel?: number;
|
|
9673
|
-
/** The links related to resource. */
|
|
9674
|
-
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9675
|
-
Partial<coreComponents["schemas"]["KycDocumentsLink"]> &
|
|
9676
|
-
Partial<coreComponents["schemas"]["KycGathererLink"]>)[];
|
|
9677
|
-
};
|
|
9678
9556
|
ResetPasswordToken: {
|
|
9679
9557
|
/** The token's identifier string. */
|
|
9680
9558
|
token?: string;
|
|
@@ -9700,6 +9578,8 @@ export interface coreComponents {
|
|
|
9700
9578
|
username?: string;
|
|
9701
9579
|
/** PayPal account status. */
|
|
9702
9580
|
status?: "inactive" | "active" | "deactivated";
|
|
9581
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
9582
|
+
useAsBackup: boolean;
|
|
9703
9583
|
/** PayPal account created time. */
|
|
9704
9584
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9705
9585
|
/** PayPal account updated time. */
|
|
@@ -9899,6 +9779,8 @@ export interface coreComponents {
|
|
|
9899
9779
|
billingAddress: coreComponents["schemas"]["ContactObject"];
|
|
9900
9780
|
/** The payment instrument status. */
|
|
9901
9781
|
status?: "active" | "deactivated";
|
|
9782
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
9783
|
+
useAsBackup: boolean;
|
|
9902
9784
|
/** The payment instrument created time. */
|
|
9903
9785
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
9904
9786
|
/** The payment instrument updated time. */
|
|
@@ -10025,6 +9907,17 @@ export interface coreComponents {
|
|
|
10025
9907
|
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
10026
9908
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
10027
9909
|
};
|
|
9910
|
+
ShippingOption: {
|
|
9911
|
+
/** The shipping rate identifier string. */
|
|
9912
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
9913
|
+
/** The shipping rate name. */
|
|
9914
|
+
name: string;
|
|
9915
|
+
/** The shipping rate description. */
|
|
9916
|
+
descriptions?: string;
|
|
9917
|
+
/** The shipping rate price - 0 is a valid value (for free). */
|
|
9918
|
+
price: number;
|
|
9919
|
+
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
9920
|
+
};
|
|
10028
9921
|
CommonOrderPreview: {
|
|
10029
9922
|
/** The website identifier string. */
|
|
10030
9923
|
websiteId: coreComponents["schemas"]["ResourceId"];
|
|
@@ -10058,6 +9951,8 @@ export interface coreComponents {
|
|
|
10058
9951
|
/** The item product identifier string. */
|
|
10059
9952
|
productId?: coreComponents["schemas"]["ResourceId"];
|
|
10060
9953
|
}[];
|
|
9954
|
+
/** Available shipping rates. */
|
|
9955
|
+
shippingRates?: coreComponents["schemas"]["ShippingOption"][];
|
|
10061
9956
|
/** Taxes applied to this purchase. */
|
|
10062
9957
|
taxes?: {
|
|
10063
9958
|
/** Tax amount. */
|
|
@@ -10121,6 +10016,7 @@ export interface coreComponents {
|
|
|
10121
10016
|
name?: coreComponents["schemas"]["ApplePayFeatureName"];
|
|
10122
10017
|
/** A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name. */
|
|
10123
10018
|
displayName?: string;
|
|
10019
|
+
country?: coreComponents["schemas"]["DigitalWalletCountry"];
|
|
10124
10020
|
};
|
|
10125
10021
|
/** The feature name. */
|
|
10126
10022
|
GooglePayFeatureName: "Google Pay";
|
|
@@ -10130,6 +10026,7 @@ export interface coreComponents {
|
|
|
10130
10026
|
merchantName?: string;
|
|
10131
10027
|
/** The merchant origin in Google Pay. The fully qualified domain name. */
|
|
10132
10028
|
merchantOrigin?: string;
|
|
10029
|
+
country?: coreComponents["schemas"]["DigitalWalletCountry"];
|
|
10133
10030
|
};
|
|
10134
10031
|
/**
|
|
10135
10032
|
* For the method to be applicable any of the following filters should match.
|
|
@@ -10428,11 +10325,11 @@ export interface coreComponents {
|
|
|
10428
10325
|
/** Time renewal reminder event will be triggered. */
|
|
10429
10326
|
renewalReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
10430
10327
|
/** Number of renewal reminder events triggered. */
|
|
10431
|
-
renewalReminderNumber?: number;
|
|
10328
|
+
renewalReminderNumber?: number | null;
|
|
10432
10329
|
/** Time renewal reminder event will be triggered. */
|
|
10433
10330
|
trialReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
10434
10331
|
/** Number of renewal reminder events triggered. */
|
|
10435
|
-
trialReminderNumber?: number;
|
|
10332
|
+
trialReminderNumber?: number | null;
|
|
10436
10333
|
} & coreComponents["schemas"]["SubscriptionCancellationState"] &
|
|
10437
10334
|
coreComponents["schemas"]["SubscriptionMetadata"];
|
|
10438
10335
|
CommonOneTimeOrder: coreComponents["schemas"]["CommonOrder"] & {
|
|
@@ -10459,17 +10356,6 @@ export interface coreComponents {
|
|
|
10459
10356
|
/** Names of searched resources, even if they returned nothing. */
|
|
10460
10357
|
searched?: string[];
|
|
10461
10358
|
};
|
|
10462
|
-
ShippingOption: {
|
|
10463
|
-
/** The shipping rate identifier string. */
|
|
10464
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
10465
|
-
/** The shipping rate name. */
|
|
10466
|
-
name: string;
|
|
10467
|
-
/** The shipping rate description. */
|
|
10468
|
-
descriptions?: string;
|
|
10469
|
-
/** The shipping rate price - 0 is a valid value (for free). */
|
|
10470
|
-
price: number;
|
|
10471
|
-
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
10472
|
-
};
|
|
10473
10359
|
/** This follows our standard filter format. See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format. */
|
|
10474
10360
|
FilterString: string;
|
|
10475
10361
|
ShippingRate: coreComponents["schemas"]["ShippingOption"] & {
|
|
@@ -10482,40 +10368,6 @@ export interface coreComponents {
|
|
|
10482
10368
|
/** The shipping rate updated time. */
|
|
10483
10369
|
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10484
10370
|
};
|
|
10485
|
-
PriceBasedShippingRate: {
|
|
10486
|
-
/** The shipping rate name. */
|
|
10487
|
-
name: string;
|
|
10488
|
-
/** Minimum order subtotal for which this shipping rate is applicable, defaults to 0.00. */
|
|
10489
|
-
minOrderSubtotal: number;
|
|
10490
|
-
/** Maximum order subtotal for which this shipping rate is applicable (NULL if no maximum). */
|
|
10491
|
-
maxOrderSubtotal?: number;
|
|
10492
|
-
/** The shipping price - 0 is a valid value (for free). */
|
|
10493
|
-
price: number;
|
|
10494
|
-
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
10495
|
-
/** The links related to resource. */
|
|
10496
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10497
|
-
};
|
|
10498
|
-
ShippingZone: {
|
|
10499
|
-
/** The shipping zone identifier string. */
|
|
10500
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
10501
|
-
/** The shipping zone name. */
|
|
10502
|
-
name: string;
|
|
10503
|
-
/**
|
|
10504
|
-
* Countries covered by the shipping zone. A country can only belong to one shipping zone (no overlapping).
|
|
10505
|
-
* This property can be empty or null to create a default shipping zone for countries that were not specified in other zones.
|
|
10506
|
-
*/
|
|
10507
|
-
countries?: string[];
|
|
10508
|
-
/** Price-based shipping rate instructions. */
|
|
10509
|
-
rates?: coreComponents["schemas"]["PriceBasedShippingRate"][];
|
|
10510
|
-
/** Is this Shipping Zone default. */
|
|
10511
|
-
isDefault?: { [key: string]: any };
|
|
10512
|
-
/** The shipping zone created time. */
|
|
10513
|
-
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10514
|
-
/** The shipping zone updated time. */
|
|
10515
|
-
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10516
|
-
/** The links related to resource. */
|
|
10517
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10518
|
-
};
|
|
10519
10371
|
SubscriptionChange: {
|
|
10520
10372
|
items: {
|
|
10521
10373
|
plan:
|
|
@@ -10619,53 +10471,6 @@ export interface coreComponents {
|
|
|
10619
10471
|
/** The links related to resource. */
|
|
10620
10472
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10621
10473
|
};
|
|
10622
|
-
OrderTimeline: {
|
|
10623
|
-
/** The Timeline message identifier string. */
|
|
10624
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
10625
|
-
/** Timeline message type. */
|
|
10626
|
-
type?:
|
|
10627
|
-
| "timeline-comment-created"
|
|
10628
|
-
| "order-renewed"
|
|
10629
|
-
| "order-activated"
|
|
10630
|
-
| "order-completed"
|
|
10631
|
-
| "order-reactivated"
|
|
10632
|
-
| "order-canceled"
|
|
10633
|
-
| "order-upgraded"
|
|
10634
|
-
| "order-downgraded"
|
|
10635
|
-
| "order-billing-address-changed"
|
|
10636
|
-
| "order-delivery-address-changed"
|
|
10637
|
-
| "order-renewal-time-changed"
|
|
10638
|
-
| "order-churned"
|
|
10639
|
-
| "order-custom-fields-changed"
|
|
10640
|
-
| "order-items-changed"
|
|
10641
|
-
| "order-billing-anchor-changed"
|
|
10642
|
-
| "order-recurring-interval-changed"
|
|
10643
|
-
| "order-risk-metadata-changed"
|
|
10644
|
-
| "order-paid-early"
|
|
10645
|
-
| "order-quantity-changed"
|
|
10646
|
-
| "email-message-sent"
|
|
10647
|
-
| "coupon-applied"
|
|
10648
|
-
| "invoice-created"
|
|
10649
|
-
| "invoice-issued"
|
|
10650
|
-
| "invoice-abandoned"
|
|
10651
|
-
| "invoice-voided"
|
|
10652
|
-
| "invoice-past-due"
|
|
10653
|
-
| "invoice-paid"
|
|
10654
|
-
| "invoice-partially-paid"
|
|
10655
|
-
| "invoice-disputed"
|
|
10656
|
-
| "invoice-refunded"
|
|
10657
|
-
| "invoice-partially-refunded"
|
|
10658
|
-
| "invoice-renewal-payment-declined";
|
|
10659
|
-
/** Shows who or what triggered the Timeline message. */
|
|
10660
|
-
triggeredBy?: "rebilly" | "app" | "direct-api";
|
|
10661
|
-
/** The message that describes the message details. */
|
|
10662
|
-
message?: string;
|
|
10663
|
-
extraData?: coreComponents["schemas"]["TimelineExtraData"];
|
|
10664
|
-
/** Timeline message time. */
|
|
10665
|
-
occurredTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10666
|
-
/** The links related to resource. */
|
|
10667
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10668
|
-
};
|
|
10669
10474
|
CommonPaymentToken: {
|
|
10670
10475
|
/** The token identifier string. */
|
|
10671
10476
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
@@ -10864,7 +10669,7 @@ export interface coreComponents {
|
|
|
10864
10669
|
/** The validation request. */
|
|
10865
10670
|
validationRequest: {
|
|
10866
10671
|
/** The URL provided by the Apple Pay SDK to perform the validation. */
|
|
10867
|
-
|
|
10672
|
+
validationUrl?: string;
|
|
10868
10673
|
/** The domain where the client code like FramePay is executed. Should be registered in the Apple Pay console by Rebilly before using. */
|
|
10869
10674
|
domainName?: string;
|
|
10870
10675
|
/** A name of your store, suitable for display. */
|
|
@@ -10989,60 +10794,6 @@ export interface coreComponents {
|
|
|
10989
10794
|
/** True if refund was processed outside Rebilly. */
|
|
10990
10795
|
isProcessedOutside: boolean;
|
|
10991
10796
|
};
|
|
10992
|
-
TransactionTimeline: {
|
|
10993
|
-
/** The Timeline message identifier string. */
|
|
10994
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
10995
|
-
/** Timeline message type. */
|
|
10996
|
-
type?:
|
|
10997
|
-
| "amount-adjusted"
|
|
10998
|
-
| "blocklist-matched"
|
|
10999
|
-
| "bump-offer-accepted"
|
|
11000
|
-
| "bump-offer-presented"
|
|
11001
|
-
| "bump-offer-rejected"
|
|
11002
|
-
| "customer-redirected-offsite"
|
|
11003
|
-
| "customer-returned"
|
|
11004
|
-
| "dcc-offer-accepted"
|
|
11005
|
-
| "dcc-offer-forced"
|
|
11006
|
-
| "dcc-offer-presented"
|
|
11007
|
-
| "dcc-offer-rejected"
|
|
11008
|
-
| "dispute-changed"
|
|
11009
|
-
| "dispute-created"
|
|
11010
|
-
| "dispute-forfeited"
|
|
11011
|
-
| "dispute-lost"
|
|
11012
|
-
| "dispute-responded"
|
|
11013
|
-
| "dispute-won"
|
|
11014
|
-
| "gateway-connection-failed"
|
|
11015
|
-
| "gateway-connection-timed-out"
|
|
11016
|
-
| "gateway-response-received"
|
|
11017
|
-
| "risk-score-changed"
|
|
11018
|
-
| "timeline-comment-created"
|
|
11019
|
-
| "transaction-abandoned"
|
|
11020
|
-
| "transaction-amount-discrepancy-found"
|
|
11021
|
-
| "transaction-approved"
|
|
11022
|
-
| "transaction-canceled"
|
|
11023
|
-
| "transaction-capture-delayed"
|
|
11024
|
-
| "transaction-captured"
|
|
11025
|
-
| "transaction-declined"
|
|
11026
|
-
| "transaction-discrepancy-found"
|
|
11027
|
-
| "transaction-initiated"
|
|
11028
|
-
| "transaction-reconciled"
|
|
11029
|
-
| "transaction-refunded"
|
|
11030
|
-
| "transaction-rules-processed"
|
|
11031
|
-
| "transaction-timeout-resolved"
|
|
11032
|
-
| "transaction-voided"
|
|
11033
|
-
| "transaction-waiting-gateway"
|
|
11034
|
-
| "transaction-queried"
|
|
11035
|
-
| "transaction-updated";
|
|
11036
|
-
/** Shows who or what triggered the Timeline message. */
|
|
11037
|
-
triggeredBy?: "rebilly" | "app" | "direct-api";
|
|
11038
|
-
/** The message that describes the message details. */
|
|
11039
|
-
message?: string;
|
|
11040
|
-
extraData?: coreComponents["schemas"]["TimelineExtraData"];
|
|
11041
|
-
/** Timeline message time. */
|
|
11042
|
-
occurredTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
11043
|
-
/** The links related to resource. */
|
|
11044
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
11045
|
-
};
|
|
11046
10797
|
FixedFeeFormula: {
|
|
11047
10798
|
type: "fixed-fee";
|
|
11048
10799
|
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
@@ -11087,7 +10838,10 @@ export interface coreComponents {
|
|
|
11087
10838
|
GlobalWebhookEventType:
|
|
11088
10839
|
| "aml-list-possibly-matched"
|
|
11089
10840
|
| "application-instance-disabled"
|
|
10841
|
+
| "application-instance-disabled"
|
|
10842
|
+
| "application-instance-enabled"
|
|
11090
10843
|
| "application-instance-enabled"
|
|
10844
|
+
| "balance-transaction-settled"
|
|
11091
10845
|
| "customer-created"
|
|
11092
10846
|
| "customer-merged"
|
|
11093
10847
|
| "customer-one-time-password-requested"
|
|
@@ -11109,11 +10863,12 @@ export interface coreComponents {
|
|
|
11109
10863
|
| "invoice-modified"
|
|
11110
10864
|
| "invoice-paid"
|
|
11111
10865
|
| "invoice-partially-paid"
|
|
11112
|
-
| "invoice-refunded"
|
|
11113
10866
|
| "invoice-partially-refunded"
|
|
11114
10867
|
| "invoice-past-due"
|
|
11115
10868
|
| "invoice-past-due-reminder"
|
|
10869
|
+
| "invoice-refunded"
|
|
11116
10870
|
| "invoice-reissued"
|
|
10871
|
+
| "invoice-revenue-recognized"
|
|
11117
10872
|
| "invoice-tax-calculation-failed"
|
|
11118
10873
|
| "invoice-voided"
|
|
11119
10874
|
| "kyc-document-accepted"
|
|
@@ -11141,9 +10896,9 @@ export interface coreComponents {
|
|
|
11141
10896
|
| "subscription-renewal-reminder"
|
|
11142
10897
|
| "subscription-renewed"
|
|
11143
10898
|
| "subscription-trial-converted"
|
|
10899
|
+
| "subscription-trial-end-changed"
|
|
11144
10900
|
| "subscription-trial-end-reminder"
|
|
11145
10901
|
| "subscription-trial-ended"
|
|
11146
|
-
| "subscription-trial-end-changed"
|
|
11147
10902
|
| "subscription-upgraded"
|
|
11148
10903
|
| "transaction-amount-discrepancy-found"
|
|
11149
10904
|
| "transaction-declined"
|
|
@@ -11152,9 +10907,7 @@ export interface coreComponents {
|
|
|
11152
10907
|
| "transaction-processed"
|
|
11153
10908
|
| "transaction-reconciled"
|
|
11154
10909
|
| "transaction-timeout-resolved"
|
|
11155
|
-
| "waiting-gateway-transaction-completed"
|
|
11156
|
-
| "application-instance-enabled"
|
|
11157
|
-
| "application-instance-disabled";
|
|
10910
|
+
| "waiting-gateway-transaction-completed";
|
|
11158
10911
|
GatewayAccountLimit: {
|
|
11159
10912
|
/** The gateway account limit identifier. */
|
|
11160
10913
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
@@ -11482,6 +11235,28 @@ export interface coreComponents {
|
|
|
11482
11235
|
};
|
|
11483
11236
|
};
|
|
11484
11237
|
};
|
|
11238
|
+
/** Invoice webhook request body resource. */
|
|
11239
|
+
InvoiceRevenueRecognized: {
|
|
11240
|
+
content: {
|
|
11241
|
+
"application/json": {
|
|
11242
|
+
/** The invoice revenue recognition ID. */
|
|
11243
|
+
recognitionId?: string;
|
|
11244
|
+
/** The invoice ID. */
|
|
11245
|
+
invoiceId?: string;
|
|
11246
|
+
/** The invoice item ID. */
|
|
11247
|
+
itemId?: string;
|
|
11248
|
+
/** The recognized amount. */
|
|
11249
|
+
amount?: number;
|
|
11250
|
+
currency?: coreComponents["schemas"]["CurrencyCode"];
|
|
11251
|
+
eventType?: coreComponents["schemas"]["GlobalWebhookEventType"];
|
|
11252
|
+
_embedded?: {
|
|
11253
|
+
invoice?: coreComponents["schemas"]["Invoice"];
|
|
11254
|
+
};
|
|
11255
|
+
/** The links related to resource. */
|
|
11256
|
+
_links?: Partial<coreComponents["schemas"]["InvoiceLink"]>[];
|
|
11257
|
+
};
|
|
11258
|
+
};
|
|
11259
|
+
};
|
|
11485
11260
|
/** Dispute webhook request body resource. */
|
|
11486
11261
|
Dispute2: {
|
|
11487
11262
|
content: {
|
|
@@ -14300,13 +14075,9 @@ export interface operations {
|
|
|
14300
14075
|
404: coreComponents["responses"]["NotFound"];
|
|
14301
14076
|
};
|
|
14302
14077
|
};
|
|
14303
|
-
/** Retrieve a list of
|
|
14304
|
-
|
|
14078
|
+
/** Retrieve a list of KYC requests. */
|
|
14079
|
+
GetKycRequestCollection: {
|
|
14305
14080
|
parameters: {
|
|
14306
|
-
path: {
|
|
14307
|
-
/** The resource identifier string. */
|
|
14308
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
14309
|
-
};
|
|
14310
14081
|
header: {
|
|
14311
14082
|
/**
|
|
14312
14083
|
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
@@ -14328,29 +14099,28 @@ export interface operations {
|
|
|
14328
14099
|
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
14329
14100
|
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
14330
14101
|
sort?: coreComponents["parameters"]["collectionSort"];
|
|
14331
|
-
/** The partial search of the text fields. */
|
|
14332
|
-
q?: coreComponents["parameters"]["collectionQuery"];
|
|
14333
14102
|
};
|
|
14334
14103
|
};
|
|
14335
14104
|
responses: {
|
|
14336
|
-
/** A list of
|
|
14105
|
+
/** A list of KYC requests was retrieved successfully. */
|
|
14337
14106
|
200: {
|
|
14338
14107
|
headers: {};
|
|
14339
14108
|
content: {
|
|
14340
|
-
"application/json": coreComponents["schemas"]["
|
|
14109
|
+
"application/json": coreComponents["schemas"]["KycRequest"][];
|
|
14341
14110
|
};
|
|
14342
14111
|
};
|
|
14343
14112
|
401: coreComponents["responses"]["Unauthorized"];
|
|
14344
14113
|
403: coreComponents["responses"]["Forbidden"];
|
|
14345
14114
|
};
|
|
14346
14115
|
};
|
|
14347
|
-
/**
|
|
14348
|
-
|
|
14116
|
+
/**
|
|
14117
|
+
* Create a KYC Request.
|
|
14118
|
+
* Then, redirect the customer to the `kycGatherer` link.
|
|
14119
|
+
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
14120
|
+
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
14121
|
+
*/
|
|
14122
|
+
PostKycRequest: {
|
|
14349
14123
|
parameters: {
|
|
14350
|
-
path: {
|
|
14351
|
-
/** The resource identifier string. */
|
|
14352
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
14353
|
-
};
|
|
14354
14124
|
header: {
|
|
14355
14125
|
/**
|
|
14356
14126
|
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
@@ -14361,31 +14131,29 @@ export interface operations {
|
|
|
14361
14131
|
};
|
|
14362
14132
|
};
|
|
14363
14133
|
responses: {
|
|
14364
|
-
/**
|
|
14134
|
+
/** Kyc request was created. */
|
|
14365
14135
|
201: {
|
|
14366
14136
|
content: {
|
|
14367
|
-
"application/json": coreComponents["schemas"]["
|
|
14137
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14368
14138
|
};
|
|
14369
14139
|
};
|
|
14370
14140
|
401: coreComponents["responses"]["Unauthorized"];
|
|
14371
14141
|
403: coreComponents["responses"]["Forbidden"];
|
|
14372
14142
|
422: coreComponents["responses"]["ValidationError"];
|
|
14373
14143
|
};
|
|
14374
|
-
/**
|
|
14144
|
+
/** Kyc request resource. */
|
|
14375
14145
|
requestBody: {
|
|
14376
14146
|
content: {
|
|
14377
|
-
"application/json": coreComponents["schemas"]["
|
|
14147
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14378
14148
|
};
|
|
14379
14149
|
};
|
|
14380
14150
|
};
|
|
14381
|
-
/** Retrieve a
|
|
14382
|
-
|
|
14151
|
+
/** Retrieve a KYC request with specified identifier string. */
|
|
14152
|
+
GetKycRequest: {
|
|
14383
14153
|
parameters: {
|
|
14384
14154
|
path: {
|
|
14385
14155
|
/** The resource identifier string. */
|
|
14386
14156
|
id: coreComponents["parameters"]["resourceId"];
|
|
14387
|
-
/** The Invoice Timeline message ID. */
|
|
14388
|
-
messageId: string;
|
|
14389
14157
|
};
|
|
14390
14158
|
header: {
|
|
14391
14159
|
/**
|
|
@@ -14397,10 +14165,10 @@ export interface operations {
|
|
|
14397
14165
|
};
|
|
14398
14166
|
};
|
|
14399
14167
|
responses: {
|
|
14400
|
-
/**
|
|
14168
|
+
/** KYC request was retrieved successfully. */
|
|
14401
14169
|
200: {
|
|
14402
14170
|
content: {
|
|
14403
|
-
"application/json": coreComponents["schemas"]["
|
|
14171
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14404
14172
|
};
|
|
14405
14173
|
};
|
|
14406
14174
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14408,14 +14176,12 @@ export interface operations {
|
|
|
14408
14176
|
404: coreComponents["responses"]["NotFound"];
|
|
14409
14177
|
};
|
|
14410
14178
|
};
|
|
14411
|
-
/** Delete
|
|
14412
|
-
|
|
14179
|
+
/** Delete the KYC request with the predefined identifier string. */
|
|
14180
|
+
DeleteKycRequest: {
|
|
14413
14181
|
parameters: {
|
|
14414
14182
|
path: {
|
|
14415
14183
|
/** The resource identifier string. */
|
|
14416
14184
|
id: coreComponents["parameters"]["resourceId"];
|
|
14417
|
-
/** The Invoice Timeline message ID. */
|
|
14418
|
-
messageId: string;
|
|
14419
14185
|
};
|
|
14420
14186
|
header: {
|
|
14421
14187
|
/**
|
|
@@ -14427,13 +14193,41 @@ export interface operations {
|
|
|
14427
14193
|
};
|
|
14428
14194
|
};
|
|
14429
14195
|
responses: {
|
|
14430
|
-
/**
|
|
14196
|
+
/** The KYC request was deleted. */
|
|
14431
14197
|
204: never;
|
|
14432
14198
|
401: coreComponents["responses"]["Unauthorized"];
|
|
14199
|
+
404: coreComponents["responses"]["NotFound"];
|
|
14200
|
+
};
|
|
14201
|
+
};
|
|
14202
|
+
/** Update a KYC request. */
|
|
14203
|
+
PatchKycRequest: {
|
|
14204
|
+
parameters: {
|
|
14205
|
+
path: {
|
|
14206
|
+
/** The resource identifier string. */
|
|
14207
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
14208
|
+
};
|
|
14209
|
+
header: {
|
|
14210
|
+
/**
|
|
14211
|
+
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
14212
|
+
*
|
|
14213
|
+
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
14214
|
+
*/
|
|
14215
|
+
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
14216
|
+
};
|
|
14217
|
+
};
|
|
14218
|
+
responses: {
|
|
14219
|
+
/** KYC request was updated. */
|
|
14220
|
+
200: {
|
|
14221
|
+
content: {
|
|
14222
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14223
|
+
};
|
|
14224
|
+
};
|
|
14225
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
14433
14226
|
403: coreComponents["responses"]["Forbidden"];
|
|
14434
14227
|
404: coreComponents["responses"]["NotFound"];
|
|
14435
|
-
|
|
14228
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
14436
14229
|
};
|
|
14230
|
+
requestBody: coreComponents["requestBodies"]["PatchKycRequest"];
|
|
14437
14231
|
};
|
|
14438
14232
|
/** Retrieve a list of KYC documents. */
|
|
14439
14233
|
GetKycDocumentCollection: {
|
|
@@ -14753,155 +14547,6 @@ export interface operations {
|
|
|
14753
14547
|
422: coreComponents["responses"]["ValidationError"];
|
|
14754
14548
|
};
|
|
14755
14549
|
};
|
|
14756
|
-
/** Retrieve a list of KYC requests. */
|
|
14757
|
-
GetKycRequestCollection: {
|
|
14758
|
-
parameters: {
|
|
14759
|
-
header: {
|
|
14760
|
-
/**
|
|
14761
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
14762
|
-
*
|
|
14763
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
14764
|
-
*/
|
|
14765
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
14766
|
-
};
|
|
14767
|
-
query: {
|
|
14768
|
-
/** The collection items limit. */
|
|
14769
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
14770
|
-
/** The collection items offset. */
|
|
14771
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
14772
|
-
/**
|
|
14773
|
-
* The collection items filter requires a special format.
|
|
14774
|
-
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
14775
|
-
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
14776
|
-
*/
|
|
14777
|
-
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
14778
|
-
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
14779
|
-
sort?: coreComponents["parameters"]["collectionSort"];
|
|
14780
|
-
};
|
|
14781
|
-
};
|
|
14782
|
-
responses: {
|
|
14783
|
-
/** A list of KYC requests was retrieved successfully. */
|
|
14784
|
-
200: {
|
|
14785
|
-
headers: {};
|
|
14786
|
-
content: {
|
|
14787
|
-
"application/json": coreComponents["schemas"]["KycRequest"][];
|
|
14788
|
-
};
|
|
14789
|
-
};
|
|
14790
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
14791
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
14792
|
-
};
|
|
14793
|
-
};
|
|
14794
|
-
/** Create a KYC Request. */
|
|
14795
|
-
PostKycRequest: {
|
|
14796
|
-
parameters: {
|
|
14797
|
-
header: {
|
|
14798
|
-
/**
|
|
14799
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
14800
|
-
*
|
|
14801
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
14802
|
-
*/
|
|
14803
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
14804
|
-
};
|
|
14805
|
-
};
|
|
14806
|
-
responses: {
|
|
14807
|
-
/** Kyc request was created. */
|
|
14808
|
-
201: {
|
|
14809
|
-
content: {
|
|
14810
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14811
|
-
};
|
|
14812
|
-
};
|
|
14813
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
14814
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
14815
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
14816
|
-
};
|
|
14817
|
-
/** Kyc request resource. */
|
|
14818
|
-
requestBody: {
|
|
14819
|
-
content: {
|
|
14820
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14821
|
-
};
|
|
14822
|
-
};
|
|
14823
|
-
};
|
|
14824
|
-
/** Retrieve a KYC request with specified identifier string. */
|
|
14825
|
-
GetKycRequest: {
|
|
14826
|
-
parameters: {
|
|
14827
|
-
path: {
|
|
14828
|
-
/** The resource identifier string. */
|
|
14829
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
14830
|
-
};
|
|
14831
|
-
header: {
|
|
14832
|
-
/**
|
|
14833
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
14834
|
-
*
|
|
14835
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
14836
|
-
*/
|
|
14837
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
14838
|
-
};
|
|
14839
|
-
};
|
|
14840
|
-
responses: {
|
|
14841
|
-
/** KYC request was retrieved successfully. */
|
|
14842
|
-
200: {
|
|
14843
|
-
content: {
|
|
14844
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14845
|
-
};
|
|
14846
|
-
};
|
|
14847
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
14848
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
14849
|
-
404: coreComponents["responses"]["NotFound"];
|
|
14850
|
-
};
|
|
14851
|
-
};
|
|
14852
|
-
/** Delete the KYC request with the predefined identifier string. */
|
|
14853
|
-
DeleteKycRequest: {
|
|
14854
|
-
parameters: {
|
|
14855
|
-
path: {
|
|
14856
|
-
/** The resource identifier string. */
|
|
14857
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
14858
|
-
};
|
|
14859
|
-
header: {
|
|
14860
|
-
/**
|
|
14861
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
14862
|
-
*
|
|
14863
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
14864
|
-
*/
|
|
14865
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
14866
|
-
};
|
|
14867
|
-
};
|
|
14868
|
-
responses: {
|
|
14869
|
-
/** The KYC request was deleted. */
|
|
14870
|
-
204: never;
|
|
14871
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
14872
|
-
404: coreComponents["responses"]["NotFound"];
|
|
14873
|
-
};
|
|
14874
|
-
};
|
|
14875
|
-
/** Update a KYC request. */
|
|
14876
|
-
PatchKycRequest: {
|
|
14877
|
-
parameters: {
|
|
14878
|
-
path: {
|
|
14879
|
-
/** The resource identifier string. */
|
|
14880
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
14881
|
-
};
|
|
14882
|
-
header: {
|
|
14883
|
-
/**
|
|
14884
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
14885
|
-
*
|
|
14886
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
14887
|
-
*/
|
|
14888
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
14889
|
-
};
|
|
14890
|
-
};
|
|
14891
|
-
responses: {
|
|
14892
|
-
/** KYC request was updated. */
|
|
14893
|
-
200: {
|
|
14894
|
-
content: {
|
|
14895
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
14896
|
-
};
|
|
14897
|
-
};
|
|
14898
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
14899
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
14900
|
-
404: coreComponents["responses"]["NotFound"];
|
|
14901
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
14902
|
-
};
|
|
14903
|
-
requestBody: coreComponents["requestBodies"]["PatchKycRequest"];
|
|
14904
|
-
};
|
|
14905
14550
|
/** Retrieve a list of tokens. */
|
|
14906
14551
|
GetPasswordTokenCollection: {
|
|
14907
14552
|
parameters: {
|
|
@@ -15756,168 +15401,6 @@ export interface operations {
|
|
|
15756
15401
|
404: coreComponents["responses"]["NotFound"];
|
|
15757
15402
|
};
|
|
15758
15403
|
};
|
|
15759
|
-
/** Retrieve a list of shipping zones. */
|
|
15760
|
-
GetShippingZoneCollection: {
|
|
15761
|
-
parameters: {
|
|
15762
|
-
header: {
|
|
15763
|
-
/**
|
|
15764
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
15765
|
-
*
|
|
15766
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
15767
|
-
*/
|
|
15768
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
15769
|
-
};
|
|
15770
|
-
query: {
|
|
15771
|
-
/** The collection items limit. */
|
|
15772
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
15773
|
-
/** The collection items offset. */
|
|
15774
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
15775
|
-
/**
|
|
15776
|
-
* The collection items filter requires a special format.
|
|
15777
|
-
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
15778
|
-
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
15779
|
-
*/
|
|
15780
|
-
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
15781
|
-
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
15782
|
-
sort?: coreComponents["parameters"]["collectionSort"];
|
|
15783
|
-
/** The partial search of the text fields. */
|
|
15784
|
-
q?: coreComponents["parameters"]["collectionQuery"];
|
|
15785
|
-
};
|
|
15786
|
-
};
|
|
15787
|
-
responses: {
|
|
15788
|
-
/** A list of shipping zones was retrieved successfully. */
|
|
15789
|
-
200: {
|
|
15790
|
-
headers: {};
|
|
15791
|
-
content: {
|
|
15792
|
-
"application/json": coreComponents["schemas"]["ShippingZone"][];
|
|
15793
|
-
};
|
|
15794
|
-
};
|
|
15795
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
15796
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
15797
|
-
};
|
|
15798
|
-
};
|
|
15799
|
-
/** Create a Shipping Zone. */
|
|
15800
|
-
PostShippingZone: {
|
|
15801
|
-
parameters: {
|
|
15802
|
-
header: {
|
|
15803
|
-
/**
|
|
15804
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
15805
|
-
*
|
|
15806
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
15807
|
-
*/
|
|
15808
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
15809
|
-
};
|
|
15810
|
-
};
|
|
15811
|
-
responses: {
|
|
15812
|
-
/** Shipping Zone was created. */
|
|
15813
|
-
201: {
|
|
15814
|
-
content: {
|
|
15815
|
-
"application/json": coreComponents["schemas"]["ShippingZone"];
|
|
15816
|
-
};
|
|
15817
|
-
};
|
|
15818
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
15819
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
15820
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
15821
|
-
};
|
|
15822
|
-
/** Shipping Zone resource. */
|
|
15823
|
-
requestBody: {
|
|
15824
|
-
content: {
|
|
15825
|
-
"application/json": coreComponents["schemas"]["ShippingZone"];
|
|
15826
|
-
};
|
|
15827
|
-
};
|
|
15828
|
-
};
|
|
15829
|
-
/** Retrieve a shipping zone with specified identifier string. */
|
|
15830
|
-
GetShippingZone: {
|
|
15831
|
-
parameters: {
|
|
15832
|
-
path: {
|
|
15833
|
-
/** The resource identifier string. */
|
|
15834
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
15835
|
-
};
|
|
15836
|
-
header: {
|
|
15837
|
-
/**
|
|
15838
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
15839
|
-
*
|
|
15840
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
15841
|
-
*/
|
|
15842
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
15843
|
-
};
|
|
15844
|
-
};
|
|
15845
|
-
responses: {
|
|
15846
|
-
/** Shipping zone was retrieved successfully. */
|
|
15847
|
-
200: {
|
|
15848
|
-
content: {
|
|
15849
|
-
"application/json": coreComponents["schemas"]["ShippingZone"];
|
|
15850
|
-
};
|
|
15851
|
-
};
|
|
15852
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
15853
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
15854
|
-
404: coreComponents["responses"]["NotFound"];
|
|
15855
|
-
};
|
|
15856
|
-
};
|
|
15857
|
-
/** Create a shipping zone with predefined identifier string. */
|
|
15858
|
-
PutShippingZone: {
|
|
15859
|
-
parameters: {
|
|
15860
|
-
path: {
|
|
15861
|
-
/** The resource identifier string. */
|
|
15862
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
15863
|
-
};
|
|
15864
|
-
header: {
|
|
15865
|
-
/**
|
|
15866
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
15867
|
-
*
|
|
15868
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
15869
|
-
*/
|
|
15870
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
15871
|
-
};
|
|
15872
|
-
};
|
|
15873
|
-
responses: {
|
|
15874
|
-
/** Shipping zone was updated. */
|
|
15875
|
-
200: {
|
|
15876
|
-
content: {
|
|
15877
|
-
"application/json": coreComponents["schemas"]["ShippingZone"];
|
|
15878
|
-
};
|
|
15879
|
-
};
|
|
15880
|
-
/** Shipping zone was created. */
|
|
15881
|
-
201: {
|
|
15882
|
-
content: {
|
|
15883
|
-
"application/json": coreComponents["schemas"]["ShippingZone"];
|
|
15884
|
-
};
|
|
15885
|
-
};
|
|
15886
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
15887
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
15888
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
15889
|
-
};
|
|
15890
|
-
/** Shipping zone resource. */
|
|
15891
|
-
requestBody: {
|
|
15892
|
-
content: {
|
|
15893
|
-
"application/json": coreComponents["schemas"]["ShippingZone"];
|
|
15894
|
-
};
|
|
15895
|
-
};
|
|
15896
|
-
};
|
|
15897
|
-
/** Delete a shipping zone with predefined identifier string. */
|
|
15898
|
-
DeleteShippingZone: {
|
|
15899
|
-
parameters: {
|
|
15900
|
-
path: {
|
|
15901
|
-
/** The resource identifier string. */
|
|
15902
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
15903
|
-
};
|
|
15904
|
-
header: {
|
|
15905
|
-
/**
|
|
15906
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
15907
|
-
*
|
|
15908
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
15909
|
-
*/
|
|
15910
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
15911
|
-
};
|
|
15912
|
-
};
|
|
15913
|
-
responses: {
|
|
15914
|
-
/** Shipping zone was deleted. */
|
|
15915
|
-
204: never;
|
|
15916
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
15917
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
15918
|
-
404: coreComponents["responses"]["NotFound"];
|
|
15919
|
-
};
|
|
15920
|
-
};
|
|
15921
15404
|
/** Retrieve a list of orders. */
|
|
15922
15405
|
GetSubscriptionCollection: {
|
|
15923
15406
|
parameters: {
|
|
@@ -16381,6 +15864,44 @@ export interface operations {
|
|
|
16381
15864
|
409: coreComponents["responses"]["Conflict"];
|
|
16382
15865
|
};
|
|
16383
15866
|
};
|
|
15867
|
+
/** Update a subscription cancellation, used for updating cancellation reason and description. */
|
|
15868
|
+
PatchSubscriptionCancellation: {
|
|
15869
|
+
parameters: {
|
|
15870
|
+
path: {
|
|
15871
|
+
/** The resource identifier string. */
|
|
15872
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
15873
|
+
};
|
|
15874
|
+
header: {
|
|
15875
|
+
/**
|
|
15876
|
+
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
15877
|
+
*
|
|
15878
|
+
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
15879
|
+
*/
|
|
15880
|
+
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
15881
|
+
};
|
|
15882
|
+
};
|
|
15883
|
+
responses: {
|
|
15884
|
+
/** Cancellation was updated. */
|
|
15885
|
+
200: {
|
|
15886
|
+
content: {
|
|
15887
|
+
"application/json": coreComponents["schemas"]["SubscriptionCancellation"];
|
|
15888
|
+
};
|
|
15889
|
+
};
|
|
15890
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
15891
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
15892
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
15893
|
+
};
|
|
15894
|
+
/** Patch cancellation resource. */
|
|
15895
|
+
requestBody: {
|
|
15896
|
+
content: {
|
|
15897
|
+
"application/json": {
|
|
15898
|
+
canceledBy?: { [key: string]: any };
|
|
15899
|
+
status?: { [key: string]: any };
|
|
15900
|
+
churnTime?: { [key: string]: any };
|
|
15901
|
+
} & coreComponents["schemas"]["SubscriptionCancellation"];
|
|
15902
|
+
};
|
|
15903
|
+
};
|
|
15904
|
+
};
|
|
16384
15905
|
/** Retrieve a list of reactivations for all subscriptions. */
|
|
16385
15906
|
GetSubscriptionReactivationCollection: {
|
|
16386
15907
|
parameters: {
|
|
@@ -16556,140 +16077,6 @@ export interface operations {
|
|
|
16556
16077
|
};
|
|
16557
16078
|
};
|
|
16558
16079
|
};
|
|
16559
|
-
/** Retrieve a list of order timeline messages. */
|
|
16560
|
-
GetSubscriptionTimelineCollection: {
|
|
16561
|
-
parameters: {
|
|
16562
|
-
path: {
|
|
16563
|
-
/** The resource identifier string. */
|
|
16564
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
16565
|
-
};
|
|
16566
|
-
header: {
|
|
16567
|
-
/**
|
|
16568
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
16569
|
-
*
|
|
16570
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
16571
|
-
*/
|
|
16572
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
16573
|
-
};
|
|
16574
|
-
query: {
|
|
16575
|
-
/** The collection items limit. */
|
|
16576
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
16577
|
-
/** The collection items offset. */
|
|
16578
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
16579
|
-
/**
|
|
16580
|
-
* The collection items filter requires a special format.
|
|
16581
|
-
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
16582
|
-
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
16583
|
-
*/
|
|
16584
|
-
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
16585
|
-
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
16586
|
-
sort?: coreComponents["parameters"]["collectionSort"];
|
|
16587
|
-
/** The partial search of the text fields. */
|
|
16588
|
-
q?: coreComponents["parameters"]["collectionQuery"];
|
|
16589
|
-
};
|
|
16590
|
-
};
|
|
16591
|
-
responses: {
|
|
16592
|
-
/** A list of order timeline messages was retrieved successfully. */
|
|
16593
|
-
200: {
|
|
16594
|
-
headers: {};
|
|
16595
|
-
content: {
|
|
16596
|
-
"application/json": coreComponents["schemas"]["OrderTimeline"][];
|
|
16597
|
-
};
|
|
16598
|
-
};
|
|
16599
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
16600
|
-
};
|
|
16601
|
-
};
|
|
16602
|
-
/** Create an order Timeline comment. */
|
|
16603
|
-
PostSubscriptionTimeline: {
|
|
16604
|
-
parameters: {
|
|
16605
|
-
path: {
|
|
16606
|
-
/** The resource identifier string. */
|
|
16607
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
16608
|
-
};
|
|
16609
|
-
header: {
|
|
16610
|
-
/**
|
|
16611
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
16612
|
-
*
|
|
16613
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
16614
|
-
*/
|
|
16615
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
16616
|
-
};
|
|
16617
|
-
};
|
|
16618
|
-
responses: {
|
|
16619
|
-
/** Order Timeline comment was created. */
|
|
16620
|
-
201: {
|
|
16621
|
-
content: {
|
|
16622
|
-
"application/json": coreComponents["schemas"]["OrderTimeline"];
|
|
16623
|
-
};
|
|
16624
|
-
};
|
|
16625
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
16626
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
16627
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
16628
|
-
};
|
|
16629
|
-
/** Order Timeline resource. */
|
|
16630
|
-
requestBody: {
|
|
16631
|
-
content: {
|
|
16632
|
-
"application/json": coreComponents["schemas"]["OrderTimeline"];
|
|
16633
|
-
};
|
|
16634
|
-
};
|
|
16635
|
-
};
|
|
16636
|
-
/** Retrieve a order message with specified identifier string. */
|
|
16637
|
-
GetSubscriptionTimeline: {
|
|
16638
|
-
parameters: {
|
|
16639
|
-
path: {
|
|
16640
|
-
/** The resource identifier string. */
|
|
16641
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
16642
|
-
/** The Order Timeline message ID. */
|
|
16643
|
-
messageId: string;
|
|
16644
|
-
};
|
|
16645
|
-
header: {
|
|
16646
|
-
/**
|
|
16647
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
16648
|
-
*
|
|
16649
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
16650
|
-
*/
|
|
16651
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
16652
|
-
};
|
|
16653
|
-
};
|
|
16654
|
-
responses: {
|
|
16655
|
-
/** Order message was retrieved successfully. */
|
|
16656
|
-
200: {
|
|
16657
|
-
content: {
|
|
16658
|
-
"application/json": coreComponents["schemas"]["OrderTimeline"];
|
|
16659
|
-
};
|
|
16660
|
-
};
|
|
16661
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
16662
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
16663
|
-
404: coreComponents["responses"]["NotFound"];
|
|
16664
|
-
};
|
|
16665
|
-
};
|
|
16666
|
-
/** Delete an Order Timeline message with predefined identifier string. */
|
|
16667
|
-
DeleteSubscriptionTimeline: {
|
|
16668
|
-
parameters: {
|
|
16669
|
-
path: {
|
|
16670
|
-
/** The resource identifier string. */
|
|
16671
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
16672
|
-
/** The Order Timeline message ID. */
|
|
16673
|
-
messageId: string;
|
|
16674
|
-
};
|
|
16675
|
-
header: {
|
|
16676
|
-
/**
|
|
16677
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
16678
|
-
*
|
|
16679
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
16680
|
-
*/
|
|
16681
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
16682
|
-
};
|
|
16683
|
-
};
|
|
16684
|
-
responses: {
|
|
16685
|
-
/** Order Timeline message was deleted. */
|
|
16686
|
-
204: never;
|
|
16687
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
16688
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
16689
|
-
404: coreComponents["responses"]["NotFound"];
|
|
16690
|
-
409: coreComponents["responses"]["Conflict"];
|
|
16691
|
-
};
|
|
16692
|
-
};
|
|
16693
16080
|
/** Retrieve a list of tags. */
|
|
16694
16081
|
GetTagCollection: {
|
|
16695
16082
|
parameters: {
|
|
@@ -17509,137 +16896,6 @@ export interface operations {
|
|
|
17509
16896
|
};
|
|
17510
16897
|
};
|
|
17511
16898
|
};
|
|
17512
|
-
/** Retrieve a list of transaction timeline messages. */
|
|
17513
|
-
GetTransactionTimelineCollection: {
|
|
17514
|
-
parameters: {
|
|
17515
|
-
path: {
|
|
17516
|
-
/** The resource identifier string. */
|
|
17517
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
17518
|
-
};
|
|
17519
|
-
header: {
|
|
17520
|
-
/**
|
|
17521
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
17522
|
-
*
|
|
17523
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
17524
|
-
*/
|
|
17525
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
17526
|
-
};
|
|
17527
|
-
query: {
|
|
17528
|
-
/** The collection items limit. */
|
|
17529
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
17530
|
-
/** The collection items offset. */
|
|
17531
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
17532
|
-
/**
|
|
17533
|
-
* The collection items filter requires a special format.
|
|
17534
|
-
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
17535
|
-
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
17536
|
-
*/
|
|
17537
|
-
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
17538
|
-
};
|
|
17539
|
-
};
|
|
17540
|
-
responses: {
|
|
17541
|
-
/** A list of transaction timeline messages was retrieved successfully. */
|
|
17542
|
-
200: {
|
|
17543
|
-
headers: {};
|
|
17544
|
-
content: {
|
|
17545
|
-
"application/json": coreComponents["schemas"]["TransactionTimeline"][];
|
|
17546
|
-
};
|
|
17547
|
-
};
|
|
17548
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
17549
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
17550
|
-
};
|
|
17551
|
-
};
|
|
17552
|
-
/** Create a transaction Timeline comment. */
|
|
17553
|
-
PostTransactionTimeline: {
|
|
17554
|
-
parameters: {
|
|
17555
|
-
path: {
|
|
17556
|
-
/** The resource identifier string. */
|
|
17557
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
17558
|
-
};
|
|
17559
|
-
header: {
|
|
17560
|
-
/**
|
|
17561
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
17562
|
-
*
|
|
17563
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
17564
|
-
*/
|
|
17565
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
17566
|
-
};
|
|
17567
|
-
};
|
|
17568
|
-
responses: {
|
|
17569
|
-
/** Transaction Timeline comment was created. */
|
|
17570
|
-
201: {
|
|
17571
|
-
content: {
|
|
17572
|
-
"application/json": coreComponents["schemas"]["TransactionTimeline"];
|
|
17573
|
-
};
|
|
17574
|
-
};
|
|
17575
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
17576
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
17577
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
17578
|
-
};
|
|
17579
|
-
/** Transaction Timeline resource. */
|
|
17580
|
-
requestBody: {
|
|
17581
|
-
content: {
|
|
17582
|
-
"application/json": coreComponents["schemas"]["TransactionTimeline"];
|
|
17583
|
-
};
|
|
17584
|
-
};
|
|
17585
|
-
};
|
|
17586
|
-
/** Retrieve a timeline message with specified identifier string. */
|
|
17587
|
-
GetTransactionTimeline: {
|
|
17588
|
-
parameters: {
|
|
17589
|
-
path: {
|
|
17590
|
-
/** The resource identifier string. */
|
|
17591
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
17592
|
-
/** The Transaction Timeline message ID. */
|
|
17593
|
-
messageId: string;
|
|
17594
|
-
};
|
|
17595
|
-
header: {
|
|
17596
|
-
/**
|
|
17597
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
17598
|
-
*
|
|
17599
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
17600
|
-
*/
|
|
17601
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
17602
|
-
};
|
|
17603
|
-
};
|
|
17604
|
-
responses: {
|
|
17605
|
-
/** Timeline message was retrieved successfully. */
|
|
17606
|
-
200: {
|
|
17607
|
-
content: {
|
|
17608
|
-
"application/json": coreComponents["schemas"]["TransactionTimeline"];
|
|
17609
|
-
};
|
|
17610
|
-
};
|
|
17611
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
17612
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
17613
|
-
404: coreComponents["responses"]["NotFound"];
|
|
17614
|
-
};
|
|
17615
|
-
};
|
|
17616
|
-
/** Delete a Transaction Timeline message with predefined identifier string. */
|
|
17617
|
-
DeleteTransactionTimeline: {
|
|
17618
|
-
parameters: {
|
|
17619
|
-
path: {
|
|
17620
|
-
/** The resource identifier string. */
|
|
17621
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
17622
|
-
/** The Transaction Timeline message ID. */
|
|
17623
|
-
messageId: string;
|
|
17624
|
-
};
|
|
17625
|
-
header: {
|
|
17626
|
-
/**
|
|
17627
|
-
* @deprecated Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
|
|
17628
|
-
*
|
|
17629
|
-
* It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
|
|
17630
|
-
*/
|
|
17631
|
-
"Organization-Id"?: coreComponents["parameters"]["organizationId"];
|
|
17632
|
-
};
|
|
17633
|
-
};
|
|
17634
|
-
responses: {
|
|
17635
|
-
/** Transaction Timeline message was deleted. */
|
|
17636
|
-
204: never;
|
|
17637
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
17638
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
17639
|
-
404: coreComponents["responses"]["NotFound"];
|
|
17640
|
-
409: coreComponents["responses"]["Conflict"];
|
|
17641
|
-
};
|
|
17642
|
-
};
|
|
17643
16899
|
/**
|
|
17644
16900
|
* Retrieve a list of Fees entries.
|
|
17645
16901
|
*
|
|
@@ -23596,6 +22852,10 @@ export interface usersComponents {
|
|
|
23596
22852
|
| "Laser"
|
|
23597
22853
|
| "China UnionPay"
|
|
23598
22854
|
| "AstroPay Card";
|
|
22855
|
+
/** The ISO 3166 alpha-2 country code. */
|
|
22856
|
+
Country: string;
|
|
22857
|
+
/** The ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your payment service provider (PSP) to determine the appropriate country code. */
|
|
22858
|
+
DigitalWalletCountry: usersComponents["schemas"]["Country"];
|
|
23599
22859
|
/** Configure which digital wallets are enabled. */
|
|
23600
22860
|
DigitalWallets: {
|
|
23601
22861
|
/** The Apple Pay digital wallet configuration. Skip if not using Apple Pay. */
|
|
@@ -23604,6 +22864,7 @@ export interface usersComponents {
|
|
|
23604
22864
|
isEnabled: boolean;
|
|
23605
22865
|
/** A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name. */
|
|
23606
22866
|
displayName?: string;
|
|
22867
|
+
country?: usersComponents["schemas"]["DigitalWalletCountry"];
|
|
23607
22868
|
};
|
|
23608
22869
|
/** The Google Pay™ digital wallet configuration. Skip if not using Google Pay™. */
|
|
23609
22870
|
googlePay?: {
|
|
@@ -23613,6 +22874,7 @@ export interface usersComponents {
|
|
|
23613
22874
|
merchantName?: string;
|
|
23614
22875
|
/** The merchant origin in Google Pay. The fully qualified domain name. */
|
|
23615
22876
|
merchantOrigin?: string;
|
|
22877
|
+
country?: usersComponents["schemas"]["DigitalWalletCountry"];
|
|
23616
22878
|
};
|
|
23617
22879
|
};
|
|
23618
22880
|
OnBoardingUrlLink: usersComponents["schemas"]["Link"] & {
|
|
@@ -23797,6 +23059,8 @@ export interface usersComponents {
|
|
|
23797
23059
|
bankName?: string;
|
|
23798
23060
|
/** The billing address. */
|
|
23799
23061
|
billingAddress?: usersComponents["schemas"]["ContactObject"];
|
|
23062
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
23063
|
+
useAsBackup: boolean;
|
|
23800
23064
|
/** Payment instrument created time. */
|
|
23801
23065
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23802
23066
|
/** Payment instrument updated time. */
|
|
@@ -23818,7 +23082,7 @@ export interface usersComponents {
|
|
|
23818
23082
|
/** Time expiration reminder event will be triggered. */
|
|
23819
23083
|
expirationReminderTime?: usersComponents["schemas"]["ServerTimestamp"] | null;
|
|
23820
23084
|
/** Number of expiration reminder events triggered. */
|
|
23821
|
-
expirationReminderNumber?: number;
|
|
23085
|
+
expirationReminderNumber?: number | null;
|
|
23822
23086
|
/** Payment instrument reference data. */
|
|
23823
23087
|
referenceData?: { [key: string]: string };
|
|
23824
23088
|
/** The links related to resource. */
|
|
@@ -23859,6 +23123,8 @@ export interface usersComponents {
|
|
|
23859
23123
|
last4?: string;
|
|
23860
23124
|
/** Bank account status. */
|
|
23861
23125
|
status?: "active" | "deactivated";
|
|
23126
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
23127
|
+
useAsBackup: boolean;
|
|
23862
23128
|
/** Bank account created time. */
|
|
23863
23129
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23864
23130
|
/** Bank account updated time. */
|
|
@@ -23887,9 +23153,11 @@ export interface usersComponents {
|
|
|
23887
23153
|
/** The invoice's shipping amount. */
|
|
23888
23154
|
amount: number;
|
|
23889
23155
|
};
|
|
23890
|
-
/** Rebilly-based shipping which is calculated by shipping
|
|
23156
|
+
/** Rebilly-based shipping which is calculated by shipping rates. */
|
|
23891
23157
|
rebilly: usersComponents["schemas"]["Shipping"] & {
|
|
23892
|
-
/** The
|
|
23158
|
+
/** The shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
23159
|
+
rateId?: usersComponents["schemas"]["ResourceId"] | null;
|
|
23160
|
+
/** The invoice's shipping amount which is calculated from [Shipping Rates](#tag/Shipping-Rates). */
|
|
23893
23161
|
amount?: number;
|
|
23894
23162
|
};
|
|
23895
23163
|
/** Invoice taxes. */
|
|
@@ -24442,6 +23710,84 @@ export interface usersComponents {
|
|
|
24442
23710
|
/** Desired time to go live. */
|
|
24443
23711
|
launchTiming?: string;
|
|
24444
23712
|
};
|
|
23713
|
+
KycSettingsIdentity: {
|
|
23714
|
+
/** The weights of all matched properties. */
|
|
23715
|
+
weights?: {
|
|
23716
|
+
/** The weight of containsImage. */
|
|
23717
|
+
containsImage?: number;
|
|
23718
|
+
/** The weight of isIdentityDocument. */
|
|
23719
|
+
isIdentityDocument?: number;
|
|
23720
|
+
/** The weight of isPublishedOnline. */
|
|
23721
|
+
isPublishedOnline?: number;
|
|
23722
|
+
/** The weight of firstName. */
|
|
23723
|
+
firstName?: number;
|
|
23724
|
+
/** The weight of lastName. */
|
|
23725
|
+
lastName?: number;
|
|
23726
|
+
/** The weight of expiryDate. */
|
|
23727
|
+
expiryDate?: number;
|
|
23728
|
+
/** The weight of dateOfBirth. */
|
|
23729
|
+
dateOfBirth?: number;
|
|
23730
|
+
/** The weight of matchesDateOfBirth. */
|
|
23731
|
+
matchesDateOfBirth?: number;
|
|
23732
|
+
/** The weight of issueDate. */
|
|
23733
|
+
issueDate?: number;
|
|
23734
|
+
/** The weight of hasMinimalAge. */
|
|
23735
|
+
hasMinimalAge?: number;
|
|
23736
|
+
/** The weight of hasMatchingFaceProof. */
|
|
23737
|
+
hasMatchingFaceProof?: number;
|
|
23738
|
+
/** The weight of nationality. */
|
|
23739
|
+
nationality?: number;
|
|
23740
|
+
};
|
|
23741
|
+
/** The thresholds to determine the document status. */
|
|
23742
|
+
thresholds?: {
|
|
23743
|
+
/** The weight of rejectBelow. */
|
|
23744
|
+
rejectBelow?: number;
|
|
23745
|
+
/** The weight of acceptAbove. */
|
|
23746
|
+
acceptAbove?: number;
|
|
23747
|
+
};
|
|
23748
|
+
};
|
|
23749
|
+
KycSettingsAddress: {
|
|
23750
|
+
/** The weights of all matched properties. */
|
|
23751
|
+
weights?: {
|
|
23752
|
+
/** The weight of firstName. */
|
|
23753
|
+
firstName?: number;
|
|
23754
|
+
/** The weight of lastName. */
|
|
23755
|
+
lastName?: number;
|
|
23756
|
+
/** The weight of line1. */
|
|
23757
|
+
line1?: number;
|
|
23758
|
+
/** The weight of city. */
|
|
23759
|
+
city?: number;
|
|
23760
|
+
/** The weight of region. */
|
|
23761
|
+
region?: number;
|
|
23762
|
+
/** The weight of postalCode. */
|
|
23763
|
+
postalCode?: number;
|
|
23764
|
+
/** The weight of date. */
|
|
23765
|
+
date?: number;
|
|
23766
|
+
/** The weight of phone. */
|
|
23767
|
+
phone?: number;
|
|
23768
|
+
};
|
|
23769
|
+
/** The thresholds to determine the document status. */
|
|
23770
|
+
thresholds?: {
|
|
23771
|
+
/** The weight of rejectBelow. */
|
|
23772
|
+
rejectBelow?: number;
|
|
23773
|
+
/** The weight of acceptAbove. */
|
|
23774
|
+
acceptAbove?: number;
|
|
23775
|
+
};
|
|
23776
|
+
};
|
|
23777
|
+
OrganizationSettings: {
|
|
23778
|
+
/** The settings for tax calculation. */
|
|
23779
|
+
defaultTaxCalculator?: {
|
|
23780
|
+
/** The type of the tax calculator. */
|
|
23781
|
+
type: "taxjar" | "flat";
|
|
23782
|
+
/** The rate for flat tax calculation. */
|
|
23783
|
+
rate?: number | null;
|
|
23784
|
+
};
|
|
23785
|
+
/** The settings for tax calculation. */
|
|
23786
|
+
kyc?: {
|
|
23787
|
+
"identity-proof"?: usersComponents["schemas"]["KycSettingsIdentity"];
|
|
23788
|
+
"address-proof"?: usersComponents["schemas"]["KycSettingsAddress"];
|
|
23789
|
+
};
|
|
23790
|
+
};
|
|
24445
23791
|
Organization: {
|
|
24446
23792
|
/** The organization identifier string. */
|
|
24447
23793
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
@@ -24472,6 +23818,7 @@ export interface usersComponents {
|
|
|
24472
23818
|
/** True, if Organization is primary (available to set as true only, other organizations will become as isPrimary=false). */
|
|
24473
23819
|
isPrimary?: boolean;
|
|
24474
23820
|
questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
|
|
23821
|
+
settings?: usersComponents["schemas"]["OrganizationSettings"];
|
|
24475
23822
|
/** The links related to resource. */
|
|
24476
23823
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
24477
23824
|
};
|
|
@@ -24489,6 +23836,8 @@ export interface usersComponents {
|
|
|
24489
23836
|
attempts: {
|
|
24490
23837
|
scheduleInstruction: usersComponents["schemas"]["InvoiceRetryScheduleInstruction"];
|
|
24491
23838
|
amountAdjustmentInstruction?: usersComponents["schemas"]["InvoiceRetryAmountAdjustmentInstruction"];
|
|
23839
|
+
/** Whether to use backup payment instruments on invoice payment retry or not. */
|
|
23840
|
+
tryBackupInstruments: boolean;
|
|
24492
23841
|
}[];
|
|
24493
23842
|
/** The policy on the attempt finishes. */
|
|
24494
23843
|
afterAttemptPolicies: "change-subscription-renewal-time"[];
|
|
@@ -24513,7 +23862,7 @@ export interface usersComponents {
|
|
|
24513
23862
|
/** Time past due reminder event will be triggered. */
|
|
24514
23863
|
dueReminderTime?: usersComponents["schemas"]["ServerTimestamp"] | null;
|
|
24515
23864
|
/** Number of past due reminder events triggered. */
|
|
24516
|
-
dueReminderNumber?: number;
|
|
23865
|
+
dueReminderNumber?: number | null;
|
|
24517
23866
|
/** The links related to resource. */
|
|
24518
23867
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
24519
23868
|
Partial<usersComponents["schemas"]["CustomerLink"]> &
|
|
@@ -25028,6 +24377,9 @@ export interface usersComponents {
|
|
|
25028
24377
|
| "account-password-reset-requested"
|
|
25029
24378
|
| "account-verification-requested"
|
|
25030
24379
|
| "aml-list-possibly-matched"
|
|
24380
|
+
| "application-instance-disabled"
|
|
24381
|
+
| "application-instance-enabled"
|
|
24382
|
+
| "balance-transaction-settled"
|
|
25031
24383
|
| "customer-created"
|
|
25032
24384
|
| "customer-one-time-password-requested"
|
|
25033
24385
|
| "dispute-created"
|
|
@@ -25042,10 +24394,11 @@ export interface usersComponents {
|
|
|
25042
24394
|
| "invoice-issued"
|
|
25043
24395
|
| "invoice-paid"
|
|
25044
24396
|
| "invoice-partially-paid"
|
|
25045
|
-
| "invoice-refunded"
|
|
25046
24397
|
| "invoice-partially-refunded"
|
|
25047
24398
|
| "invoice-past-due"
|
|
25048
24399
|
| "invoice-past-due-reminder"
|
|
24400
|
+
| "invoice-refunded"
|
|
24401
|
+
| "invoice-revenue-recognized"
|
|
25049
24402
|
| "invoice-tax-calculation-failed"
|
|
25050
24403
|
| "kyc-document-accepted"
|
|
25051
24404
|
| "kyc-document-modified"
|
|
@@ -25062,23 +24415,21 @@ export interface usersComponents {
|
|
|
25062
24415
|
| "risk-score-changed"
|
|
25063
24416
|
| "subscription-activated"
|
|
25064
24417
|
| "subscription-canceled"
|
|
25065
|
-
| "subscription-downgraded"
|
|
25066
24418
|
| "subscription-created"
|
|
24419
|
+
| "subscription-downgraded"
|
|
25067
24420
|
| "subscription-modified"
|
|
25068
24421
|
| "subscription-reactivated"
|
|
25069
24422
|
| "subscription-renewal-reminder"
|
|
25070
24423
|
| "subscription-renewed"
|
|
25071
24424
|
| "subscription-trial-converted"
|
|
25072
|
-
| "subscription-trial-end-reminder"
|
|
25073
24425
|
| "subscription-trial-end-changed"
|
|
24426
|
+
| "subscription-trial-end-reminder"
|
|
25074
24427
|
| "subscription-upgraded"
|
|
25075
24428
|
| "transaction-amount-discrepancy-found"
|
|
25076
24429
|
| "transaction-declined"
|
|
25077
24430
|
| "transaction-discrepancy-found"
|
|
25078
24431
|
| "transaction-process-requested"
|
|
25079
|
-
| "transaction-processed"
|
|
25080
|
-
| "application-instance-enabled"
|
|
25081
|
-
| "application-instance-disabled";
|
|
24432
|
+
| "transaction-processed";
|
|
25082
24433
|
/** The email notification event. */
|
|
25083
24434
|
EmailNotification: {
|
|
25084
24435
|
eventType?: usersComponents["schemas"]["EventType"];
|
|
@@ -25114,8 +24465,12 @@ export interface usersComponents {
|
|
|
25114
24465
|
| "adjust-ready-to-pay"
|
|
25115
24466
|
| "blocklist"
|
|
25116
24467
|
| "cancel-scheduled-payments"
|
|
25117
|
-
| "create-
|
|
25118
|
-
| "create-
|
|
24468
|
+
| "create-intuit-quickbooks-invoice"
|
|
24469
|
+
| "create-intuit-quickbooks-payment"
|
|
24470
|
+
| "create-intuit-quickbooks-refund-receipt"
|
|
24471
|
+
| "create-intuit-quickbooks-revenue-recognition-entry"
|
|
24472
|
+
| "create-keap-infusionsoft-order"
|
|
24473
|
+
| "create-keap-infusionsoft-payment"
|
|
25119
24474
|
| "create-taxjar-transaction"
|
|
25120
24475
|
| "decline-transaction"
|
|
25121
24476
|
| "display-message"
|
|
@@ -25133,7 +24488,9 @@ export interface usersComponents {
|
|
|
25133
24488
|
| "send-email"
|
|
25134
24489
|
| "stop-subscriptions"
|
|
25135
24490
|
| "tag-or-untag-customer"
|
|
25136
|
-
| "trigger-webhook"
|
|
24491
|
+
| "trigger-webhook"
|
|
24492
|
+
| "update-intuit-quickbooks-invoice"
|
|
24493
|
+
| "void-intuit-quickbooks-invoice";
|
|
25137
24494
|
status?: usersComponents["schemas"]["OnOff"];
|
|
25138
24495
|
};
|
|
25139
24496
|
"add-risk-score": usersComponents["schemas"]["RuleAction"] & {
|
|
@@ -25342,6 +24699,81 @@ export interface usersComponents {
|
|
|
25342
24699
|
ttl: number;
|
|
25343
24700
|
};
|
|
25344
24701
|
"cancel-scheduled-payments": usersComponents["schemas"]["RuleAction"];
|
|
24702
|
+
QuickbooksTemplate: {
|
|
24703
|
+
/** The line item name. */
|
|
24704
|
+
itemName: string;
|
|
24705
|
+
/** The line item description. */
|
|
24706
|
+
itemDescription: string;
|
|
24707
|
+
/** The line item SKU. */
|
|
24708
|
+
itemSku: string;
|
|
24709
|
+
/** The item line description. */
|
|
24710
|
+
itemLineDescription: string;
|
|
24711
|
+
/** The tax item name. Used when `taxesAccount` is set. */
|
|
24712
|
+
taxName: string;
|
|
24713
|
+
/** The tax item description. */
|
|
24714
|
+
taxDescription: string;
|
|
24715
|
+
/** The tax item SKU. */
|
|
24716
|
+
taxSku: string;
|
|
24717
|
+
/** The tax line description. Used when `taxesAccount` is set. */
|
|
24718
|
+
taxLineDescription: string;
|
|
24719
|
+
};
|
|
24720
|
+
/** Update an Intuit Quickbooks invoice. */
|
|
24721
|
+
"update-intuit-quickbooks-invoice": usersComponents["schemas"]["RuleAction"] & {
|
|
24722
|
+
/** The unearned revenue Quickbooks account ID. */
|
|
24723
|
+
unearnedRevenueAccount: string;
|
|
24724
|
+
/** The taxes Quickbooks account ID. If supplied taxes will be represented as separate line items instead of integrated tax field. */
|
|
24725
|
+
taxesAccount?: string | null;
|
|
24726
|
+
/** The discounts Quickbooks account ID. If not set `unearnedRevenueAccount` will be used for discounts. */
|
|
24727
|
+
discountsAccount?: string | null;
|
|
24728
|
+
/** The Quickbooks department ID. */
|
|
24729
|
+
department?: string | null;
|
|
24730
|
+
template?: usersComponents["schemas"]["QuickbooksTemplate"];
|
|
24731
|
+
/** OAuth2 credential identifier string. */
|
|
24732
|
+
credentialHash: string;
|
|
24733
|
+
};
|
|
24734
|
+
/** Create an Intuit Quickbooks invoice. */
|
|
24735
|
+
"create-intuit-quickbooks-invoice": usersComponents["schemas"]["update-intuit-quickbooks-invoice"] & {
|
|
24736
|
+
/**
|
|
24737
|
+
* The customer display name in the Quickbooks. Same names will be mapped to a single Quickbooks customer.
|
|
24738
|
+
*
|
|
24739
|
+
* Event placeholders could be used as follows:
|
|
24740
|
+
* - Organization name: `{{ invoice.customer.priamryAddress.organization }}`;
|
|
24741
|
+
* - Full customer name: `{{ invoice.customer.firstName }} {{ invoice.customer.lastName }}`;
|
|
24742
|
+
* - Customer ID: `{{ invoice.customer.id }}`.
|
|
24743
|
+
*/
|
|
24744
|
+
customerDisplayName: string;
|
|
24745
|
+
};
|
|
24746
|
+
/** Create an Intuit Quickbooks payment. */
|
|
24747
|
+
"create-intuit-quickbooks-payment": usersComponents["schemas"]["RuleAction"] & {
|
|
24748
|
+
/** The deposit Quickbooks account ID. */
|
|
24749
|
+
depositAccount: string;
|
|
24750
|
+
/** OAuth2 credential identifier string. */
|
|
24751
|
+
credentialHash: string;
|
|
24752
|
+
};
|
|
24753
|
+
/** Create an Intuit Quickbooks refund receipt. */
|
|
24754
|
+
"create-intuit-quickbooks-refund-receipt": usersComponents["schemas"]["RuleAction"] & {
|
|
24755
|
+
/** The deposit Quickbooks account ID. */
|
|
24756
|
+
depositAccount: string;
|
|
24757
|
+
/** The Quickbooks department ID. */
|
|
24758
|
+
department?: string | null;
|
|
24759
|
+
/** OAuth2 credential identifier string. */
|
|
24760
|
+
credentialHash: string;
|
|
24761
|
+
};
|
|
24762
|
+
/** Create an Intuit Quickbooks revenue recognition entry. */
|
|
24763
|
+
"create-intuit-quickbooks-revenue-recognition-entry": usersComponents["schemas"]["RuleAction"] & {
|
|
24764
|
+
/** The debit Quickbooks account ID. */
|
|
24765
|
+
debitAccount: string;
|
|
24766
|
+
/** The credit Quickbooks account ID. */
|
|
24767
|
+
creditAccount: string;
|
|
24768
|
+
/**
|
|
24769
|
+
* The Quickbooks revenue recognition entry description.
|
|
24770
|
+
*
|
|
24771
|
+
* For example, `Revenue recognition for invoice #{{ invoice.id }} item #{{ item.id }} – {{ item.description }}`.
|
|
24772
|
+
*/
|
|
24773
|
+
description: string;
|
|
24774
|
+
/** OAuth2 credential identifier string. */
|
|
24775
|
+
credentialHash: string;
|
|
24776
|
+
};
|
|
25345
24777
|
/** Create a Keap Infusionsoft order along with a contact. */
|
|
25346
24778
|
"create-infusionsoft-order": usersComponents["schemas"]["RuleAction"] & {
|
|
25347
24779
|
/** The list of contact attributes that will be used during Keap Infusionsoft creation process. */
|
|
@@ -25499,6 +24931,8 @@ export interface usersComponents {
|
|
|
25499
24931
|
attempts: {
|
|
25500
24932
|
scheduleInstruction: usersComponents["schemas"]["InvoiceRetryScheduleInstruction"];
|
|
25501
24933
|
amountAdjustmentInstruction?: usersComponents["schemas"]["InvoiceRetryAmountAdjustmentInstruction"];
|
|
24934
|
+
/** Whether to use backup payment instruments on invoice payment retry or not. */
|
|
24935
|
+
tryBackupInstruments: boolean;
|
|
25502
24936
|
}[];
|
|
25503
24937
|
/** The policy on the attempt finishes. */
|
|
25504
24938
|
afterAttemptPolicies: "change-subscription-renewal-time"[];
|
|
@@ -25622,6 +25056,11 @@ export interface usersComponents {
|
|
|
25622
25056
|
};
|
|
25623
25057
|
"trigger-webhook": usersComponents["schemas"]["RuleAction"] &
|
|
25624
25058
|
usersComponents["schemas"]["Webhook"];
|
|
25059
|
+
/** Void an Intuit Quickbooks invoice. */
|
|
25060
|
+
"void-intuit-quickbooks-invoice": usersComponents["schemas"]["RuleAction"] & {
|
|
25061
|
+
/** OAuth2 credential identifier string. */
|
|
25062
|
+
credentialHash: string;
|
|
25063
|
+
};
|
|
25625
25064
|
/** The rule. */
|
|
25626
25065
|
Bind: {
|
|
25627
25066
|
/**
|
|
@@ -26231,7 +25670,10 @@ export interface usersComponents {
|
|
|
26231
25670
|
GlobalWebhookEventType:
|
|
26232
25671
|
| "aml-list-possibly-matched"
|
|
26233
25672
|
| "application-instance-disabled"
|
|
25673
|
+
| "application-instance-disabled"
|
|
26234
25674
|
| "application-instance-enabled"
|
|
25675
|
+
| "application-instance-enabled"
|
|
25676
|
+
| "balance-transaction-settled"
|
|
26235
25677
|
| "customer-created"
|
|
26236
25678
|
| "customer-merged"
|
|
26237
25679
|
| "customer-one-time-password-requested"
|
|
@@ -26253,11 +25695,12 @@ export interface usersComponents {
|
|
|
26253
25695
|
| "invoice-modified"
|
|
26254
25696
|
| "invoice-paid"
|
|
26255
25697
|
| "invoice-partially-paid"
|
|
26256
|
-
| "invoice-refunded"
|
|
26257
25698
|
| "invoice-partially-refunded"
|
|
26258
25699
|
| "invoice-past-due"
|
|
26259
25700
|
| "invoice-past-due-reminder"
|
|
25701
|
+
| "invoice-refunded"
|
|
26260
25702
|
| "invoice-reissued"
|
|
25703
|
+
| "invoice-revenue-recognized"
|
|
26261
25704
|
| "invoice-tax-calculation-failed"
|
|
26262
25705
|
| "invoice-voided"
|
|
26263
25706
|
| "kyc-document-accepted"
|
|
@@ -26285,9 +25728,9 @@ export interface usersComponents {
|
|
|
26285
25728
|
| "subscription-renewal-reminder"
|
|
26286
25729
|
| "subscription-renewed"
|
|
26287
25730
|
| "subscription-trial-converted"
|
|
25731
|
+
| "subscription-trial-end-changed"
|
|
26288
25732
|
| "subscription-trial-end-reminder"
|
|
26289
25733
|
| "subscription-trial-ended"
|
|
26290
|
-
| "subscription-trial-end-changed"
|
|
26291
25734
|
| "subscription-upgraded"
|
|
26292
25735
|
| "transaction-amount-discrepancy-found"
|
|
26293
25736
|
| "transaction-declined"
|
|
@@ -26296,9 +25739,7 @@ export interface usersComponents {
|
|
|
26296
25739
|
| "transaction-processed"
|
|
26297
25740
|
| "transaction-reconciled"
|
|
26298
25741
|
| "transaction-timeout-resolved"
|
|
26299
|
-
| "waiting-gateway-transaction-completed"
|
|
26300
|
-
| "application-instance-enabled"
|
|
26301
|
-
| "application-instance-disabled";
|
|
25742
|
+
| "waiting-gateway-transaction-completed";
|
|
26302
25743
|
GlobalWebhook: {
|
|
26303
25744
|
/** The webhook identifier string. */
|
|
26304
25745
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
@@ -26607,6 +26048,22 @@ export interface usersComponents {
|
|
|
26607
26048
|
/** The links related to resource. */
|
|
26608
26049
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
26609
26050
|
};
|
|
26051
|
+
/** Website settings. */
|
|
26052
|
+
WebsiteSettings: {
|
|
26053
|
+
/** Payment form settings. */
|
|
26054
|
+
paymentForm?: {
|
|
26055
|
+
/**
|
|
26056
|
+
* Hosted payment form
|
|
26057
|
+
* [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
|
|
26058
|
+
*/
|
|
26059
|
+
css?: string;
|
|
26060
|
+
/**
|
|
26061
|
+
* Hosted payment form
|
|
26062
|
+
* [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
|
|
26063
|
+
*/
|
|
26064
|
+
theme?: { [key: string]: string };
|
|
26065
|
+
};
|
|
26066
|
+
};
|
|
26610
26067
|
Website: {
|
|
26611
26068
|
/** The website identifier string. */
|
|
26612
26069
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
@@ -26623,6 +26080,7 @@ export interface usersComponents {
|
|
|
26623
26080
|
/** Website updated time. */
|
|
26624
26081
|
updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
26625
26082
|
customFields?: usersComponents["schemas"]["ResourceCustomFields"];
|
|
26083
|
+
settings?: usersComponents["schemas"]["WebsiteSettings"];
|
|
26626
26084
|
/** Organization ID. */
|
|
26627
26085
|
organizationId?: usersComponents["schemas"]["ResourceId"];
|
|
26628
26086
|
/** The links related to resource. */
|
|
@@ -26794,6 +26252,7 @@ export interface usersComponents {
|
|
|
26794
26252
|
/** The currency used for reports. It can only be set upon organization creation. */
|
|
26795
26253
|
reportCurrency: string;
|
|
26796
26254
|
questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
|
|
26255
|
+
settings?: usersComponents["schemas"]["OrganizationSettings"];
|
|
26797
26256
|
};
|
|
26798
26257
|
};
|
|
26799
26258
|
};
|
|
@@ -26822,6 +26281,7 @@ export interface usersComponents {
|
|
|
26822
26281
|
/** Invoice will use this time zone to display time otherwise UTC will be used. Example "America/New_York". */
|
|
26823
26282
|
invoiceTimeZone?: string;
|
|
26824
26283
|
questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
|
|
26284
|
+
settings?: usersComponents["schemas"]["OrganizationSettings"];
|
|
26825
26285
|
};
|
|
26826
26286
|
};
|
|
26827
26287
|
};
|
|
@@ -28353,6 +27813,24 @@ export interface operations {
|
|
|
28353
27813
|
/** The token identifier string. */
|
|
28354
27814
|
hash: usersComponents["parameters"]["hash"];
|
|
28355
27815
|
};
|
|
27816
|
+
query: {
|
|
27817
|
+
/** The collection items limit. */
|
|
27818
|
+
limit?: usersComponents["parameters"]["collectionLimit"];
|
|
27819
|
+
/** The collection items offset. */
|
|
27820
|
+
offset?: usersComponents["parameters"]["collectionOffset"];
|
|
27821
|
+
/**
|
|
27822
|
+
* The collection items filter requires a special format.
|
|
27823
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
27824
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
27825
|
+
*/
|
|
27826
|
+
filter?: usersComponents["parameters"]["collectionFilter"];
|
|
27827
|
+
/** The partial search of the text fields. */
|
|
27828
|
+
q?: usersComponents["parameters"]["collectionQuery"];
|
|
27829
|
+
/** Limit the returned fields to the list specified, separated by comma. Note that id is always returned. */
|
|
27830
|
+
fields?: usersComponents["parameters"]["collectionFields"];
|
|
27831
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
27832
|
+
sort?: usersComponents["parameters"]["collectionSort"];
|
|
27833
|
+
};
|
|
28356
27834
|
};
|
|
28357
27835
|
responses: {
|
|
28358
27836
|
/** A list of root items available for specified credential was retrieved. successfully. */
|
|
@@ -32054,7 +31532,7 @@ export interface operations {
|
|
|
32054
31532
|
};
|
|
32055
31533
|
};
|
|
32056
31534
|
responses: {
|
|
32057
|
-
/** Password was
|
|
31535
|
+
/** Password was reset successfully. */
|
|
32058
31536
|
201: {
|
|
32059
31537
|
content: {
|
|
32060
31538
|
"application/json": usersComponents["schemas"]["User"];
|
|
@@ -34080,9 +33558,11 @@ export interface storefrontComponents {
|
|
|
34080
33558
|
/** The invoice's shipping amount. */
|
|
34081
33559
|
amount: number;
|
|
34082
33560
|
};
|
|
34083
|
-
/** Rebilly-based shipping which is calculated by shipping
|
|
33561
|
+
/** Rebilly-based shipping which is calculated by shipping rates. */
|
|
34084
33562
|
rebilly: storefrontComponents["schemas"]["Shipping"] & {
|
|
34085
|
-
/** The
|
|
33563
|
+
/** The shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
33564
|
+
rateId?: storefrontComponents["schemas"]["ResourceId"] | null;
|
|
33565
|
+
/** The invoice's shipping amount which is calculated from [Shipping Rates](#tag/Shipping-Rates). */
|
|
34086
33566
|
amount?: number;
|
|
34087
33567
|
};
|
|
34088
33568
|
/** Invoice taxes. */
|
|
@@ -34850,7 +34330,11 @@ export interface storefrontComponents {
|
|
|
34850
34330
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
34851
34331
|
/** Linked file object id. */
|
|
34852
34332
|
fileId?: storefrontComponents["schemas"]["ResourceId"];
|
|
34853
|
-
/**
|
|
34333
|
+
/**
|
|
34334
|
+
* Linked file object id's.
|
|
34335
|
+
*
|
|
34336
|
+
* Files uploaded for identity-proof must have following corresponding tags attached `['kyc', 'id-front']`, `['kyc', 'id-back']`, `['kyc', 'face-proof']` in order to be properly recognized as identity-proof files.
|
|
34337
|
+
*/
|
|
34854
34338
|
fileIds?: storefrontComponents["schemas"]["ResourceId"][];
|
|
34855
34339
|
/** Document type submitted for validation, only identity-proof type is analyzed in an automated manner. */
|
|
34856
34340
|
documentType: storefrontComponents["schemas"]["KycDocumentTypes"];
|
|
@@ -34880,16 +34364,27 @@ export interface storefrontComponents {
|
|
|
34880
34364
|
subtypes?: storefrontComponents["schemas"]["KycDocumentSubtypes"][];
|
|
34881
34365
|
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
34882
34366
|
maxAttempts: number;
|
|
34367
|
+
/** If `true` uploading matching face photo (selfie) is required. */
|
|
34368
|
+
faceProofRequired?: boolean;
|
|
34883
34369
|
}[];
|
|
34884
34370
|
/** Status of the request. */
|
|
34885
34371
|
status?: "unfulfilled" | "pending" | "rejected" | "fulfilled" | "expired";
|
|
34886
|
-
/**
|
|
34372
|
+
/**
|
|
34373
|
+
* The URL to redirect the customer when an upload is completed.
|
|
34374
|
+
* When the customer is redirected, Rebilly will append an `info` query parameter which may have one of the following values (example: `https://example.com?info=success`):
|
|
34375
|
+
*
|
|
34376
|
+
* - **back** - The customer clicked the `back to website` link;
|
|
34377
|
+
* - **token_expired** - The customer's token expired;
|
|
34378
|
+
* - **success** - The customer uploaded docs that were successfully analyzed;
|
|
34379
|
+
* - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
|
|
34380
|
+
* - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
|
|
34381
|
+
*/
|
|
34887
34382
|
redirectUrl?: string;
|
|
34888
|
-
/** Expiration date
|
|
34383
|
+
/** Expiration date-time. Default value is one hour in the future. */
|
|
34889
34384
|
expirationTime?: string;
|
|
34890
|
-
/** Creation date
|
|
34385
|
+
/** Creation date-time. */
|
|
34891
34386
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
34892
|
-
/** Latest update date
|
|
34387
|
+
/** Latest update date-time. */
|
|
34893
34388
|
updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
34894
34389
|
};
|
|
34895
34390
|
KycDocumentsLink: storefrontComponents["schemas"]["Link"] & {
|
|
@@ -35350,6 +34845,8 @@ export interface storefrontComponents {
|
|
|
35350
34845
|
bankName?: string;
|
|
35351
34846
|
/** The billing address. */
|
|
35352
34847
|
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
34848
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
34849
|
+
useAsBackup: boolean;
|
|
35353
34850
|
/** Payment instrument created time. */
|
|
35354
34851
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
35355
34852
|
/** Payment instrument updated time. */
|
|
@@ -35382,6 +34879,8 @@ export interface storefrontComponents {
|
|
|
35382
34879
|
last4?: string;
|
|
35383
34880
|
/** Bank account status. */
|
|
35384
34881
|
status?: "active" | "deactivated";
|
|
34882
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
34883
|
+
useAsBackup: boolean;
|
|
35385
34884
|
/** Bank account created time. */
|
|
35386
34885
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
35387
34886
|
/** Bank account updated time. */
|
|
@@ -35402,6 +34901,8 @@ export interface storefrontComponents {
|
|
|
35402
34901
|
username?: string;
|
|
35403
34902
|
/** PayPal account status. */
|
|
35404
34903
|
status?: "inactive" | "active" | "deactivated";
|
|
34904
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
34905
|
+
useAsBackup: boolean;
|
|
35405
34906
|
/** PayPal account created time. */
|
|
35406
34907
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
35407
34908
|
/** PayPal account updated time. */
|
|
@@ -35726,6 +35227,8 @@ export interface storefrontComponents {
|
|
|
35726
35227
|
billingAddress: storefrontComponents["schemas"]["ContactObject"];
|
|
35727
35228
|
/** The payment instrument status. */
|
|
35728
35229
|
status?: "active" | "deactivated";
|
|
35230
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
35231
|
+
useAsBackup: boolean;
|
|
35729
35232
|
/** The payment instrument created time. */
|
|
35730
35233
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
35731
35234
|
/** The payment instrument updated time. */
|
|
@@ -35806,6 +35309,8 @@ export interface storefrontComponents {
|
|
|
35806
35309
|
billingAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
|
|
35807
35310
|
/** The delivery address. */
|
|
35808
35311
|
deliveryAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
|
|
35312
|
+
/** The shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
35313
|
+
shippingRateId?: storefrontComponents["schemas"]["ResourceId"];
|
|
35809
35314
|
/** The payment instruction to be used for purchasing. */
|
|
35810
35315
|
paymentInstruction: storefrontComponents["schemas"]["PaymentInstruction"];
|
|
35811
35316
|
/** The list of coupons applied to the order. */
|
|
@@ -35823,6 +35328,17 @@ export interface storefrontComponents {
|
|
|
35823
35328
|
*/
|
|
35824
35329
|
redirectUrl?: string | null;
|
|
35825
35330
|
};
|
|
35331
|
+
ShippingOption: {
|
|
35332
|
+
/** The shipping rate identifier string. */
|
|
35333
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
35334
|
+
/** The shipping rate name. */
|
|
35335
|
+
name: string;
|
|
35336
|
+
/** The shipping rate description. */
|
|
35337
|
+
descriptions?: string;
|
|
35338
|
+
/** The shipping rate price - 0 is a valid value (for free). */
|
|
35339
|
+
price: number;
|
|
35340
|
+
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
35341
|
+
};
|
|
35826
35342
|
CommonOrderPreview: {
|
|
35827
35343
|
/** The website identifier string. */
|
|
35828
35344
|
websiteId: storefrontComponents["schemas"]["ResourceId"];
|
|
@@ -35856,6 +35372,8 @@ export interface storefrontComponents {
|
|
|
35856
35372
|
/** The item product identifier string. */
|
|
35857
35373
|
productId?: storefrontComponents["schemas"]["ResourceId"];
|
|
35858
35374
|
}[];
|
|
35375
|
+
/** Available shipping rates. */
|
|
35376
|
+
shippingRates?: storefrontComponents["schemas"]["ShippingOption"][];
|
|
35859
35377
|
/** Taxes applied to this purchase. */
|
|
35860
35378
|
taxes?: {
|
|
35861
35379
|
/** Tax amount. */
|
|
@@ -35883,6 +35401,10 @@ export interface storefrontComponents {
|
|
|
35883
35401
|
/** The purchase's total amount. */
|
|
35884
35402
|
total?: number;
|
|
35885
35403
|
};
|
|
35404
|
+
StorefrontOrderPreview: storefrontComponents["schemas"]["CommonOrderPreview"] & {
|
|
35405
|
+
/** The shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
35406
|
+
shippingRateId?: storefrontComponents["schemas"]["ResourceId"];
|
|
35407
|
+
};
|
|
35886
35408
|
ReadyToPayAmount: {
|
|
35887
35409
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
35888
35410
|
/** The amount. */
|
|
@@ -35908,10 +35430,15 @@ export interface storefrontComponents {
|
|
|
35908
35430
|
};
|
|
35909
35431
|
/** The feature name. */
|
|
35910
35432
|
ApplePayFeatureName: "Apple Pay";
|
|
35433
|
+
/** The ISO 3166 alpha-2 country code. */
|
|
35434
|
+
Country: string;
|
|
35435
|
+
/** The ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your payment service provider (PSP) to determine the appropriate country code. */
|
|
35436
|
+
DigitalWalletCountry: storefrontComponents["schemas"]["Country"];
|
|
35911
35437
|
ApplePayFeature: {
|
|
35912
35438
|
name?: storefrontComponents["schemas"]["ApplePayFeatureName"];
|
|
35913
35439
|
/** A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name. */
|
|
35914
35440
|
displayName?: string;
|
|
35441
|
+
country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
|
|
35915
35442
|
};
|
|
35916
35443
|
/** The feature name. */
|
|
35917
35444
|
GooglePayFeatureName: "Google Pay";
|
|
@@ -35921,6 +35448,7 @@ export interface storefrontComponents {
|
|
|
35921
35448
|
merchantName?: string;
|
|
35922
35449
|
/** The merchant origin in Google Pay. The fully qualified domain name. */
|
|
35923
35450
|
merchantOrigin?: string;
|
|
35451
|
+
country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
|
|
35924
35452
|
};
|
|
35925
35453
|
/**
|
|
35926
35454
|
* For the method to be applicable any of the following filters should match.
|
|
@@ -35986,6 +35514,22 @@ export interface storefrontComponents {
|
|
|
35986
35514
|
Partial<storefrontComponents["schemas"]["ReadyToPayAchMethod"]> &
|
|
35987
35515
|
Partial<storefrontComponents["schemas"]["ReadyToPayGenericMethod"]> &
|
|
35988
35516
|
Partial<storefrontComponents["schemas"]["ReadyToPayPayPalMethod"]>)[];
|
|
35517
|
+
/** Website settings. */
|
|
35518
|
+
WebsiteSettings: {
|
|
35519
|
+
/** Payment form settings. */
|
|
35520
|
+
paymentForm?: {
|
|
35521
|
+
/**
|
|
35522
|
+
* Hosted payment form
|
|
35523
|
+
* [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
|
|
35524
|
+
*/
|
|
35525
|
+
css?: string;
|
|
35526
|
+
/**
|
|
35527
|
+
* Hosted payment form
|
|
35528
|
+
* [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
|
|
35529
|
+
*/
|
|
35530
|
+
theme?: { [key: string]: string };
|
|
35531
|
+
};
|
|
35532
|
+
};
|
|
35989
35533
|
OrganizationLink: storefrontComponents["schemas"]["Link"] & {
|
|
35990
35534
|
/** The link type. */
|
|
35991
35535
|
rel: "organization";
|
|
@@ -36006,6 +35550,7 @@ export interface storefrontComponents {
|
|
|
36006
35550
|
/** Website updated time. */
|
|
36007
35551
|
updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
36008
35552
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
35553
|
+
settings?: storefrontComponents["schemas"]["WebsiteSettings"];
|
|
36009
35554
|
/** Organization ID. */
|
|
36010
35555
|
organizationId?: storefrontComponents["schemas"]["ResourceId"];
|
|
36011
35556
|
/** The links related to resource. */
|
|
@@ -37330,7 +36875,7 @@ export interface operations {
|
|
|
37330
36875
|
/** Purchase preview was retrieved. */
|
|
37331
36876
|
200: {
|
|
37332
36877
|
content: {
|
|
37333
|
-
"application/json": storefrontComponents["schemas"]["
|
|
36878
|
+
"application/json": storefrontComponents["schemas"]["StorefrontOrderPreview"];
|
|
37334
36879
|
};
|
|
37335
36880
|
};
|
|
37336
36881
|
401: storefrontComponents["responses"]["Unauthorized"];
|
|
@@ -37339,7 +36884,7 @@ export interface operations {
|
|
|
37339
36884
|
};
|
|
37340
36885
|
requestBody: {
|
|
37341
36886
|
content: {
|
|
37342
|
-
"application/json": storefrontComponents["schemas"]["
|
|
36887
|
+
"application/json": storefrontComponents["schemas"]["StorefrontOrderPreview"];
|
|
37343
36888
|
};
|
|
37344
36889
|
};
|
|
37345
36890
|
};
|
|
@@ -37950,7 +37495,7 @@ declare module "resources/credential-hashes-resource" {
|
|
|
37950
37495
|
hash: any;
|
|
37951
37496
|
data: any;
|
|
37952
37497
|
}): any;
|
|
37953
|
-
getOAuth2CredentialItems({ hash }: rebilly.GetOauth2CredentialHashItemCollectionRequest): rebilly.GetOauth2CredentialHashItemCollectionResponsePromise;
|
|
37498
|
+
getOAuth2CredentialItems({ hash, limit, offset, filter, q, fields, sort, }: rebilly.GetOauth2CredentialHashItemCollectionRequest): rebilly.GetOauth2CredentialHashItemCollectionResponsePromise;
|
|
37954
37499
|
getAllPlaidCredentials({ filter, limit, offset, sort, q, }?: rebilly.GetPlaidCredentialCollectionRequest): rebilly.GetPlaidCredentialCollectionResponsePromise;
|
|
37955
37500
|
createPlaidCredential({ data }: {
|
|
37956
37501
|
data: any;
|
|
@@ -38605,19 +38150,6 @@ declare module "resources/invoices-resource" {
|
|
|
38605
38150
|
id: any;
|
|
38606
38151
|
data: any;
|
|
38607
38152
|
}): any;
|
|
38608
|
-
getAllTimelineMessages({ id, limit, offset, filter, sort, q, }: rebilly.GetInvoiceTimelineCollectionRequest): rebilly.GetInvoiceTimelineCollectionResponsePromise;
|
|
38609
|
-
createTimelineComment({ id, data }: {
|
|
38610
|
-
id: any;
|
|
38611
|
-
data: any;
|
|
38612
|
-
}): any;
|
|
38613
|
-
getTimelineMessage({ id, messageId }: {
|
|
38614
|
-
id: any;
|
|
38615
|
-
messageId: any;
|
|
38616
|
-
}): rebilly.GetInvoiceTimelineResponsePromise;
|
|
38617
|
-
deleteTimelineMessage({ id, messageId }: {
|
|
38618
|
-
id: any;
|
|
38619
|
-
messageId: any;
|
|
38620
|
-
}): any;
|
|
38621
38153
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
38622
38154
|
limit?: any;
|
|
38623
38155
|
offset?: any;
|
|
@@ -38961,24 +38493,6 @@ declare module "resources/shipping-rates-resource" {
|
|
|
38961
38493
|
}): any;
|
|
38962
38494
|
};
|
|
38963
38495
|
}
|
|
38964
|
-
declare module "resources/shipping-zones-resource" {
|
|
38965
|
-
export default function ShippingZonesResource({ apiHandler }: {
|
|
38966
|
-
apiHandler: any;
|
|
38967
|
-
}): {
|
|
38968
|
-
getAll({ limit, offset, filter, sort, q, }?: rebilly.GetShippingZoneCollectionRequest): rebilly.GetShippingZoneCollectionResponsePromise;
|
|
38969
|
-
create({ id, data }: rebilly.CreateShippingZoneRequest): rebilly.PostShippingZoneResponsePromise;
|
|
38970
|
-
get({ id }: {
|
|
38971
|
-
id: any;
|
|
38972
|
-
}): rebilly.GetShippingZoneResponsePromise;
|
|
38973
|
-
update({ id, data }: {
|
|
38974
|
-
id: any;
|
|
38975
|
-
data: any;
|
|
38976
|
-
}): rebilly.PutShippingZoneResponsePromise;
|
|
38977
|
-
delete({ id }: {
|
|
38978
|
-
id: any;
|
|
38979
|
-
}): any;
|
|
38980
|
-
};
|
|
38981
|
-
}
|
|
38982
38496
|
declare module "resources/status-resource" {
|
|
38983
38497
|
export default function StatusResource({ apiHandler }: {
|
|
38984
38498
|
apiHandler: any;
|
|
@@ -38998,6 +38512,10 @@ declare module "resources/subscription-cancellations-resource" {
|
|
|
38998
38512
|
delete({ id }: {
|
|
38999
38513
|
id: any;
|
|
39000
38514
|
}): any;
|
|
38515
|
+
patch({ id, data }: {
|
|
38516
|
+
id: any;
|
|
38517
|
+
data: any;
|
|
38518
|
+
}): any;
|
|
39001
38519
|
};
|
|
39002
38520
|
}
|
|
39003
38521
|
declare module "resources/subscription-reactivations-resource" {
|
|
@@ -39048,19 +38566,6 @@ declare module "resources/subscriptions-resource" {
|
|
|
39048
38566
|
invoiceId: any;
|
|
39049
38567
|
data: any;
|
|
39050
38568
|
}): any;
|
|
39051
|
-
getAllTimelineMessages({ id, limit, offset, filter, sort, q, }: rebilly.GetSubscriptionTimelineCollectionRequest): rebilly.GetSubscriptionTimelineCollectionResponsePromise;
|
|
39052
|
-
createTimelineComment({ id, data }: {
|
|
39053
|
-
id: any;
|
|
39054
|
-
data: any;
|
|
39055
|
-
}): any;
|
|
39056
|
-
getTimelineMessage({ id, messageId }: {
|
|
39057
|
-
id: any;
|
|
39058
|
-
messageId: any;
|
|
39059
|
-
}): rebilly.GetSubscriptionTimelineResponsePromise;
|
|
39060
|
-
deleteTimelineMessage({ id, messageId }: {
|
|
39061
|
-
id: any;
|
|
39062
|
-
messageId: any;
|
|
39063
|
-
}): any;
|
|
39064
38569
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
39065
38570
|
limit?: any;
|
|
39066
38571
|
offset?: any;
|
|
@@ -39176,19 +38681,6 @@ declare module "resources/transactions-resource" {
|
|
|
39176
38681
|
id: any;
|
|
39177
38682
|
data: any;
|
|
39178
38683
|
}): any;
|
|
39179
|
-
getAllTimelineMessages({ id, limit, offset, filter }: rebilly.GetTransactionTimelineCollectionRequest): rebilly.GetTransactionTimelineCollectionResponsePromise;
|
|
39180
|
-
createTimelineComment({ id, data }: {
|
|
39181
|
-
id: any;
|
|
39182
|
-
data: any;
|
|
39183
|
-
}): any;
|
|
39184
|
-
getTimelineMessage({ id, messageId }: {
|
|
39185
|
-
id: any;
|
|
39186
|
-
messageId: any;
|
|
39187
|
-
}): rebilly.GetTransactionTimelineResponsePromise;
|
|
39188
|
-
deleteTimelineMessage({ id, messageId }: {
|
|
39189
|
-
id: any;
|
|
39190
|
-
messageId: any;
|
|
39191
|
-
}): any;
|
|
39192
38684
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
39193
38685
|
limit?: any;
|
|
39194
38686
|
offset?: any;
|
|
@@ -39520,7 +39012,7 @@ declare module "resources/api-instance" {
|
|
|
39520
39012
|
hash: any;
|
|
39521
39013
|
data: any;
|
|
39522
39014
|
}): any;
|
|
39523
|
-
getOAuth2CredentialItems({ hash }: rebilly.GetOauth2CredentialHashItemCollectionRequest): rebilly.GetOauth2CredentialHashItemCollectionResponsePromise;
|
|
39015
|
+
getOAuth2CredentialItems({ hash, limit, offset, filter, q, fields, sort, }: rebilly.GetOauth2CredentialHashItemCollectionRequest): rebilly.GetOauth2CredentialHashItemCollectionResponsePromise;
|
|
39524
39016
|
getAllPlaidCredentials({ filter, limit, offset, sort, q, }?: {
|
|
39525
39017
|
filter?: string;
|
|
39526
39018
|
limit?: number;
|
|
@@ -40208,19 +39700,6 @@ declare module "resources/api-instance" {
|
|
|
40208
39700
|
id: any;
|
|
40209
39701
|
data: any;
|
|
40210
39702
|
}): any;
|
|
40211
|
-
getAllTimelineMessages({ id, limit, offset, filter, sort, q, }: rebilly.GetInvoiceTimelineCollectionRequest): rebilly.GetInvoiceTimelineCollectionResponsePromise;
|
|
40212
|
-
createTimelineComment({ id, data }: {
|
|
40213
|
-
id: any;
|
|
40214
|
-
data: any;
|
|
40215
|
-
}): any;
|
|
40216
|
-
getTimelineMessage({ id, messageId }: {
|
|
40217
|
-
id: any;
|
|
40218
|
-
messageId: any;
|
|
40219
|
-
}): rebilly.GetInvoiceTimelineResponsePromise;
|
|
40220
|
-
deleteTimelineMessage({ id, messageId }: {
|
|
40221
|
-
id: any;
|
|
40222
|
-
messageId: any;
|
|
40223
|
-
}): any;
|
|
40224
39703
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
40225
39704
|
limit?: any;
|
|
40226
39705
|
offset?: any;
|
|
@@ -40554,26 +40033,6 @@ declare module "resources/api-instance" {
|
|
|
40554
40033
|
id: any;
|
|
40555
40034
|
}): any;
|
|
40556
40035
|
};
|
|
40557
|
-
shippingZones: {
|
|
40558
|
-
getAll({ limit, offset, filter, sort, q, }?: {
|
|
40559
|
-
limit?: number;
|
|
40560
|
-
offset?: number;
|
|
40561
|
-
filter?: string;
|
|
40562
|
-
sort?: string[];
|
|
40563
|
-
q?: string;
|
|
40564
|
-
}): rebilly.GetShippingZoneCollectionResponsePromise;
|
|
40565
|
-
create({ id, data }: rebilly.CreateShippingZoneRequest): rebilly.PostShippingZoneResponsePromise;
|
|
40566
|
-
get({ id }: {
|
|
40567
|
-
id: any;
|
|
40568
|
-
}): rebilly.GetShippingZoneResponsePromise;
|
|
40569
|
-
update({ id, data }: {
|
|
40570
|
-
id: any;
|
|
40571
|
-
data: any;
|
|
40572
|
-
}): rebilly.PutShippingZoneResponsePromise;
|
|
40573
|
-
delete({ id }: {
|
|
40574
|
-
id: any;
|
|
40575
|
-
}): any;
|
|
40576
|
-
};
|
|
40577
40036
|
status: {
|
|
40578
40037
|
get(): rebilly.GetStatusResponsePromise;
|
|
40579
40038
|
};
|
|
@@ -40591,6 +40050,10 @@ declare module "resources/api-instance" {
|
|
|
40591
40050
|
delete({ id }: {
|
|
40592
40051
|
id: any;
|
|
40593
40052
|
}): any;
|
|
40053
|
+
patch({ id, data }: {
|
|
40054
|
+
id: any;
|
|
40055
|
+
data: any;
|
|
40056
|
+
}): any;
|
|
40594
40057
|
};
|
|
40595
40058
|
subscriptionReactivations: {
|
|
40596
40059
|
getAll({ limit, offset, filter, sort }?: {
|
|
@@ -40645,19 +40108,6 @@ declare module "resources/api-instance" {
|
|
|
40645
40108
|
invoiceId: any;
|
|
40646
40109
|
data: any;
|
|
40647
40110
|
}): any;
|
|
40648
|
-
getAllTimelineMessages({ id, limit, offset, filter, sort, q, }: rebilly.GetSubscriptionTimelineCollectionRequest): rebilly.GetSubscriptionTimelineCollectionResponsePromise;
|
|
40649
|
-
createTimelineComment({ id, data }: {
|
|
40650
|
-
id: any;
|
|
40651
|
-
data: any;
|
|
40652
|
-
}): any;
|
|
40653
|
-
getTimelineMessage({ id, messageId }: {
|
|
40654
|
-
id: any;
|
|
40655
|
-
messageId: any;
|
|
40656
|
-
}): rebilly.GetSubscriptionTimelineResponsePromise;
|
|
40657
|
-
deleteTimelineMessage({ id, messageId }: {
|
|
40658
|
-
id: any;
|
|
40659
|
-
messageId: any;
|
|
40660
|
-
}): any;
|
|
40661
40111
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
40662
40112
|
limit?: any;
|
|
40663
40113
|
offset?: any;
|
|
@@ -40792,19 +40242,6 @@ declare module "resources/api-instance" {
|
|
|
40792
40242
|
id: any;
|
|
40793
40243
|
data: any;
|
|
40794
40244
|
}): any;
|
|
40795
|
-
getAllTimelineMessages({ id, limit, offset, filter }: rebilly.GetTransactionTimelineCollectionRequest): rebilly.GetTransactionTimelineCollectionResponsePromise;
|
|
40796
|
-
createTimelineComment({ id, data }: {
|
|
40797
|
-
id: any;
|
|
40798
|
-
data: any;
|
|
40799
|
-
}): any;
|
|
40800
|
-
getTimelineMessage({ id, messageId }: {
|
|
40801
|
-
id: any;
|
|
40802
|
-
messageId: any;
|
|
40803
|
-
}): rebilly.GetTransactionTimelineResponsePromise;
|
|
40804
|
-
deleteTimelineMessage({ id, messageId }: {
|
|
40805
|
-
id: any;
|
|
40806
|
-
messageId: any;
|
|
40807
|
-
}): any;
|
|
40808
40245
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
40809
40246
|
limit?: any;
|
|
40810
40247
|
offset?: any;
|