rebilly-js-sdk 47.6.0 → 47.7.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/dist/rebilly-js-sdk.d.ts +2743 -702
- package/dist/rebilly-js-sdk.es.js +171 -183
- package/dist/rebilly-js-sdk.umd.js +4 -4
- package/package.json +1 -1
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -1768,6 +1768,145 @@ declare module rebilly {
|
|
|
1768
1768
|
type StorefrontGetWebsiteResponse = operations['StorefrontGetWebsite']['responses']['200']['content']['application/json']
|
|
1769
1769
|
type StorefrontGetWebsiteResponsePromise = Promise<{fields: StorefrontGetWebsiteResponse}>
|
|
1770
1770
|
|
|
1771
|
+
type GetCustomerSummaryMetricReportRequest = { customerId : String }
|
|
1772
|
+
|
|
1773
|
+
type GetCustomerSummaryMetricReportResponse = operations['GetCustomerSummaryMetricReport']['responses']['200']['content']['application/json']
|
|
1774
|
+
type GetCustomerSummaryMetricReportResponsePromise = Promise<{fields: GetCustomerSummaryMetricReportResponse}>
|
|
1775
|
+
|
|
1776
|
+
type GetDataExportCollectionRequest = operations['GetDataExportCollection']['parameters']["query"] & (operations['GetDataExportCollection']['parameters'] extends {path: {}} ? operations['GetDataExportCollection']['parameters']["path"] : {})
|
|
1777
|
+
|
|
1778
|
+
type GetDataExportCollectionResponse = operations['GetDataExportCollection']['responses']['200']['content']['application/json'][0]
|
|
1779
|
+
type GetDataExportCollectionResponsePromise = Promise<{ items: {fields: GetDataExportCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1780
|
+
type PostDataExportRequest = operations['PostDataExport']['requestBody']['content']['application/json']
|
|
1781
|
+
type CreateDataExportRequest = { id: String, data: PostDataExportRequest, expand?: String }
|
|
1782
|
+
type PostDataExportResponse = operations['PostDataExport']['responses']['201']['content']['application/json']
|
|
1783
|
+
type PostDataExportResponsePromise = Promise<{fields: PostDataExportResponse}>
|
|
1784
|
+
|
|
1785
|
+
type GetDataExportRequest = operations['GetDataExport']['parameters'] & { id : String }
|
|
1786
|
+
|
|
1787
|
+
type GetDataExportResponse = operations['GetDataExport']['responses']['200']['content']['application/json']
|
|
1788
|
+
type GetDataExportResponsePromise = Promise<{fields: GetDataExportResponse}>
|
|
1789
|
+
type PutDataExportRequest = operations['PutDataExport']['requestBody']['content']['application/json']
|
|
1790
|
+
type PutDataExportResponse = operations['PutDataExport']['responses']['201']['content']['application/json']
|
|
1791
|
+
type PutDataExportResponsePromise = Promise<{fields: PutDataExportResponse}>
|
|
1792
|
+
type DeleteDataExportResponse = operations['DeleteDataExport']['responses']['204']
|
|
1793
|
+
type DeleteDataExportResponsePromise = Promise<{fields: DeleteDataExportResponse}>
|
|
1794
|
+
|
|
1795
|
+
type GetHistogramTransactionReportRequest = operations['GetHistogramTransactionReport']['parameters']
|
|
1796
|
+
|
|
1797
|
+
type GetHistogramTransactionReportResponse = operations['GetHistogramTransactionReport']['responses']['200']['content']['application/json']
|
|
1798
|
+
type GetHistogramTransactionReportResponsePromise = Promise<{fields: GetHistogramTransactionReportResponse}>
|
|
1799
|
+
|
|
1800
|
+
type GetApiLogSummaryReportRequest = operations['GetApiLogSummaryReport']['parameters']
|
|
1801
|
+
|
|
1802
|
+
type GetApiLogSummaryReportResponse = operations['GetApiLogSummaryReport']['responses']['200']['content']['application/json']
|
|
1803
|
+
type GetApiLogSummaryReportResponsePromise = Promise<{fields: GetApiLogSummaryReportResponse}>
|
|
1804
|
+
|
|
1805
|
+
type GetCumulativeSubscriptionReportRequest = operations['GetCumulativeSubscriptionReport']['parameters']
|
|
1806
|
+
|
|
1807
|
+
type GetCumulativeSubscriptionReportResponse = operations['GetCumulativeSubscriptionReport']['responses']['200']['content']['application/json']
|
|
1808
|
+
type GetCumulativeSubscriptionReportResponsePromise = Promise<{fields: GetCumulativeSubscriptionReportResponse}>
|
|
1809
|
+
|
|
1810
|
+
type GetDashboardReportRequest = operations['GetDashboardReport']['parameters']
|
|
1811
|
+
|
|
1812
|
+
type GetDashboardReportResponse = operations['GetDashboardReport']['responses']['200']['content']['application/json']
|
|
1813
|
+
type GetDashboardReportResponsePromise = Promise<{fields: GetDashboardReportResponse}>
|
|
1814
|
+
|
|
1815
|
+
type GetDccMarkupReportRequest = operations['GetDccMarkupReport']['parameters']
|
|
1816
|
+
|
|
1817
|
+
type GetDccMarkupReportResponse = operations['GetDccMarkupReport']['responses']['200']['content']['application/json']
|
|
1818
|
+
type GetDccMarkupReportResponsePromise = Promise<{fields: GetDccMarkupReportResponse}>
|
|
1819
|
+
|
|
1820
|
+
type GetDisputeReportRequest = operations['GetDisputeReport']['parameters']
|
|
1821
|
+
|
|
1822
|
+
type GetDisputeReportResponse = operations['GetDisputeReport']['responses']['200']['content']['application/json']
|
|
1823
|
+
type GetDisputeReportResponsePromise = Promise<{fields: GetDisputeReportResponse}>
|
|
1824
|
+
|
|
1825
|
+
type GetTriggeredEventReportRequest = operations['GetTriggeredEventReport']['parameters']
|
|
1826
|
+
|
|
1827
|
+
type GetTriggeredEventReportResponse = operations['GetTriggeredEventReport']['responses']['200']['content']['application/json']
|
|
1828
|
+
type GetTriggeredEventReportResponsePromise = Promise<{fields: GetTriggeredEventReportResponse}>
|
|
1829
|
+
|
|
1830
|
+
type GetTriggeredEventRuleReportRequest = operations['GetTriggeredEventRuleReport']['parameters'] & { eventType : String }
|
|
1831
|
+
|
|
1832
|
+
type GetTriggeredEventRuleReportResponse = operations['GetTriggeredEventRuleReport']['responses']['200']['content']['application/json']
|
|
1833
|
+
type GetTriggeredEventRuleReportResponsePromise = Promise<{fields: GetTriggeredEventRuleReportResponse}>
|
|
1834
|
+
|
|
1835
|
+
type GetFutureRenewalReportRequest = operations['GetFutureRenewalReport']['parameters']
|
|
1836
|
+
|
|
1837
|
+
type GetFutureRenewalReportResponse = operations['GetFutureRenewalReport']['responses']['200']['content']['application/json']
|
|
1838
|
+
type GetFutureRenewalReportResponsePromise = Promise<{fields: GetFutureRenewalReportResponse}>
|
|
1839
|
+
|
|
1840
|
+
type GetKycAcceptanceSummaryReportRequest = operations['GetKycAcceptanceSummaryReport']['parameters']
|
|
1841
|
+
|
|
1842
|
+
type GetKycAcceptanceSummaryReportResponse = operations['GetKycAcceptanceSummaryReport']['responses']['200']['content']['application/json']
|
|
1843
|
+
type GetKycAcceptanceSummaryReportResponsePromise = Promise<{fields: GetKycAcceptanceSummaryReportResponse}>
|
|
1844
|
+
|
|
1845
|
+
type GetKycRejectionSummaryReportRequest = operations['GetKycRejectionSummaryReport']['parameters']
|
|
1846
|
+
|
|
1847
|
+
type GetKycRejectionSummaryReportResponse = operations['GetKycRejectionSummaryReport']['responses']['200']['content']['application/json']
|
|
1848
|
+
type GetKycRejectionSummaryReportResponsePromise = Promise<{fields: GetKycRejectionSummaryReportResponse}>
|
|
1849
|
+
|
|
1850
|
+
type GetKycRequestSummaryReportRequest = operations['GetKycRequestSummaryReport']['parameters']
|
|
1851
|
+
|
|
1852
|
+
type GetKycRequestSummaryReportResponse = operations['GetKycRequestSummaryReport']['responses']['200']['content']['application/json']
|
|
1853
|
+
type GetKycRequestSummaryReportResponsePromise = Promise<{fields: GetKycRequestSummaryReportResponse}>
|
|
1854
|
+
|
|
1855
|
+
type GetMonthlyRecurringRevenueReportRequest = operations['GetMonthlyRecurringRevenueReport']['parameters']
|
|
1856
|
+
|
|
1857
|
+
type GetMonthlyRecurringRevenueReportResponse = operations['GetMonthlyRecurringRevenueReport']['responses']['200']['content']['application/json']
|
|
1858
|
+
type GetMonthlyRecurringRevenueReportResponsePromise = Promise<{fields: GetMonthlyRecurringRevenueReportResponse}>
|
|
1859
|
+
|
|
1860
|
+
type GetRenewalSaleReportRequest = operations['GetRenewalSaleReport']['parameters']
|
|
1861
|
+
|
|
1862
|
+
type GetRenewalSaleReportResponse = operations['GetRenewalSaleReport']['responses']['200']['content']['application/json']
|
|
1863
|
+
type GetRenewalSaleReportResponsePromise = Promise<{fields: GetRenewalSaleReportResponse}>
|
|
1864
|
+
|
|
1865
|
+
type GetRetentionPercentageReportRequest = operations['GetRetentionPercentageReport']['parameters']
|
|
1866
|
+
|
|
1867
|
+
type GetRetentionPercentageReportResponse = operations['GetRetentionPercentageReport']['responses']['200']['content']['application/json']
|
|
1868
|
+
type GetRetentionPercentageReportResponsePromise = Promise<{fields: GetRetentionPercentageReportResponse}>
|
|
1869
|
+
|
|
1870
|
+
type GetRetentionValueReportRequest = operations['GetRetentionValueReport']['parameters']
|
|
1871
|
+
|
|
1872
|
+
type GetRetentionValueReportResponse = operations['GetRetentionValueReport']['responses']['200']['content']['application/json']
|
|
1873
|
+
type GetRetentionValueReportResponsePromise = Promise<{fields: GetRetentionValueReportResponse}>
|
|
1874
|
+
|
|
1875
|
+
type GetRevenueWaterfallReportRequest = operations['GetRevenueWaterfallReport']['parameters']
|
|
1876
|
+
|
|
1877
|
+
type GetRevenueWaterfallReportResponse = operations['GetRevenueWaterfallReport']['responses']['200']['content']['application/json']
|
|
1878
|
+
type GetRevenueWaterfallReportResponsePromise = Promise<{fields: GetRevenueWaterfallReportResponse}>
|
|
1879
|
+
|
|
1880
|
+
type GetSubscriptionCancellationReportRequest = operations['GetSubscriptionCancellationReport']['parameters']
|
|
1881
|
+
|
|
1882
|
+
type GetSubscriptionCancellationReportResponse = operations['GetSubscriptionCancellationReport']['responses']['200']['content']['application/json']
|
|
1883
|
+
type GetSubscriptionCancellationReportResponsePromise = Promise<{fields: GetSubscriptionCancellationReportResponse}>
|
|
1884
|
+
|
|
1885
|
+
type GetSubscriptionRenewalReportRequest = operations['GetSubscriptionRenewalReport']['parameters']
|
|
1886
|
+
|
|
1887
|
+
type GetSubscriptionRenewalReportResponse = operations['GetSubscriptionRenewalReport']['responses']['200']['content']['application/json']
|
|
1888
|
+
type GetSubscriptionRenewalReportResponsePromise = Promise<{fields: GetSubscriptionRenewalReportResponse}>
|
|
1889
|
+
|
|
1890
|
+
type GetTimeSeriesTransactionReportRequest = operations['GetTimeSeriesTransactionReport']['parameters']
|
|
1891
|
+
|
|
1892
|
+
type GetTimeSeriesTransactionReportResponse = operations['GetTimeSeriesTransactionReport']['responses']['200']['content']['application/json']
|
|
1893
|
+
type GetTimeSeriesTransactionReportResponsePromise = Promise<{fields: GetTimeSeriesTransactionReportResponse}>
|
|
1894
|
+
|
|
1895
|
+
type GetTransactionTimeDisputeReportRequest = operations['GetTransactionTimeDisputeReport']['parameters']
|
|
1896
|
+
|
|
1897
|
+
type GetTransactionTimeDisputeReportResponse = operations['GetTransactionTimeDisputeReport']['responses']['200']['content']['application/json']
|
|
1898
|
+
type GetTransactionTimeDisputeReportResponsePromise = Promise<{fields: GetTransactionTimeDisputeReportResponse}>
|
|
1899
|
+
|
|
1900
|
+
type GetTransactionReportRequest = operations['GetTransactionReport']['parameters']
|
|
1901
|
+
|
|
1902
|
+
type GetTransactionReportResponse = operations['GetTransactionReport']['responses']['200']['content']['application/json']
|
|
1903
|
+
type GetTransactionReportResponsePromise = Promise<{fields: GetTransactionReportResponse}>
|
|
1904
|
+
|
|
1905
|
+
type GetSubscriptionSummaryMetricReportRequest = { subscriptionId : String }
|
|
1906
|
+
|
|
1907
|
+
type GetSubscriptionSummaryMetricReportResponse = operations['GetSubscriptionSummaryMetricReport']['responses']['200']['content']['application/json']
|
|
1908
|
+
type GetSubscriptionSummaryMetricReportResponsePromise = Promise<{fields: GetSubscriptionSummaryMetricReportResponse}>
|
|
1909
|
+
|
|
1771
1910
|
|
|
1772
1911
|
|
|
1773
1912
|
type Expandable <T> = (Partial<T> & { expand?: String })
|
|
@@ -3527,7 +3666,7 @@ export interface coreComponents {
|
|
|
3527
3666
|
Error: coreComponents["schemas"]["Problem"] & {
|
|
3528
3667
|
error?: string;
|
|
3529
3668
|
};
|
|
3530
|
-
|
|
3669
|
+
CustomerCredential: {
|
|
3531
3670
|
/** The credential identifier string. */
|
|
3532
3671
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
3533
3672
|
/** Credential's username. */
|
|
@@ -5028,78 +5167,6 @@ export interface coreComponents {
|
|
|
5028
5167
|
};
|
|
5029
5168
|
/** eMerchantPay 3DS Server. */
|
|
5030
5169
|
eMerchantPay3dsServer: coreComponents["schemas"]["eMerchantPay3dsServers"];
|
|
5031
|
-
/** ThreeDSecureIO3dsServer. */
|
|
5032
|
-
ThreeDSecureIO3dsServer: coreComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"] &
|
|
5033
|
-
coreComponents["schemas"]["TestProcessor3dsServers"] &
|
|
5034
|
-
coreComponents["schemas"]["EMS3dsServers"] & {
|
|
5035
|
-
/** Visa acquirer merchant ID (MID). */
|
|
5036
|
-
acquirerMerchantIdVisa: string;
|
|
5037
|
-
/** Mastercard acquirer merchant ID (MID). */
|
|
5038
|
-
acquirerMerchantIdMastercard: string;
|
|
5039
|
-
/** Merchant Name. */
|
|
5040
|
-
merchantName: string;
|
|
5041
|
-
/** Visa Acquirer BIN. */
|
|
5042
|
-
merchantAcquirerBinVisa: string;
|
|
5043
|
-
/** Mastercard Acquirer BIN. */
|
|
5044
|
-
merchantAcquirerBinMastercard: string;
|
|
5045
|
-
/** Merchant Country ISO Alpha-2 Code. */
|
|
5046
|
-
merchantCountry: string;
|
|
5047
|
-
/** Merchant URL. */
|
|
5048
|
-
merchantUrl: string;
|
|
5049
|
-
/**
|
|
5050
|
-
* Value determines if requests can use version 1 of 3DS.
|
|
5051
|
-
* In case both v1 and v2 are enabled it will prefer v2.
|
|
5052
|
-
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
5053
|
-
*/
|
|
5054
|
-
v1?: boolean;
|
|
5055
|
-
/**
|
|
5056
|
-
* Value determines if requests will attempt version 2 of 3DS.
|
|
5057
|
-
* In case both v1 and v2 are enabled it will prefer v2.
|
|
5058
|
-
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
5059
|
-
*/
|
|
5060
|
-
v2?: boolean;
|
|
5061
|
-
/**
|
|
5062
|
-
* 01 - Goods/Service Purchase
|
|
5063
|
-
* 03 - Check Acceptance
|
|
5064
|
-
* 10 - Account Funding
|
|
5065
|
-
* 11 - Quasi-Cash Transaction
|
|
5066
|
-
* 28 - Prepaid Activation and Load
|
|
5067
|
-
*
|
|
5068
|
-
* Identifies the type of transaction being authenticated.
|
|
5069
|
-
*/
|
|
5070
|
-
transactionType?: "01" | "03" | "10" | "11" | "28";
|
|
5071
|
-
/** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
|
|
5072
|
-
declineNotEnrolled: boolean;
|
|
5073
|
-
/** Use 3DS for merchant initiated transactions. */
|
|
5074
|
-
use3dsForMerchantInitiated: boolean;
|
|
5075
|
-
/**
|
|
5076
|
-
* 01 - Recurring transaction
|
|
5077
|
-
* 02 - Instalment transaction
|
|
5078
|
-
* 03 - Add card
|
|
5079
|
-
* 04 - Maintain card information
|
|
5080
|
-
* 05 - Account verification
|
|
5081
|
-
* 06 - Split/delayed shipment
|
|
5082
|
-
* 07 - Top-up
|
|
5083
|
-
* 08 - Mail Order
|
|
5084
|
-
* 09 - Telephone Order
|
|
5085
|
-
* 10 - Whitelist status check
|
|
5086
|
-
* 11 - Other payment
|
|
5087
|
-
*
|
|
5088
|
-
* Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
|
|
5089
|
-
*/
|
|
5090
|
-
threeRIInd?:
|
|
5091
|
-
| "01"
|
|
5092
|
-
| "02"
|
|
5093
|
-
| "03"
|
|
5094
|
-
| "04"
|
|
5095
|
-
| "05"
|
|
5096
|
-
| "06"
|
|
5097
|
-
| "07"
|
|
5098
|
-
| "08"
|
|
5099
|
-
| "09"
|
|
5100
|
-
| "10"
|
|
5101
|
-
| "11";
|
|
5102
|
-
};
|
|
5103
5170
|
/** The Merchant plug-in Name. */
|
|
5104
5171
|
ThreeDSecureServerName:
|
|
5105
5172
|
| "Payvision3dsServer"
|
|
@@ -5118,19 +5185,76 @@ export interface coreComponents {
|
|
|
5118
5185
|
| "Piastrix3dsServer"
|
|
5119
5186
|
| "NGenius3dsServer"
|
|
5120
5187
|
| "Stripe3dsServer";
|
|
5121
|
-
/**
|
|
5122
|
-
|
|
5123
|
-
name: "ThreeDSecureIO3dsServer";
|
|
5124
|
-
};
|
|
5125
|
-
/** TestProcessor3dsServers 3DS Servers. */
|
|
5126
|
-
TestProcessor3dsServers: {
|
|
5127
|
-
name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
|
|
5128
|
-
};
|
|
5129
|
-
/** TestProcessor Integrated. */
|
|
5130
|
-
TestProcessor3dsServer: coreComponents["schemas"]["TestProcessor3dsServers"];
|
|
5131
|
-
/** EMS 3DS Servers. */
|
|
5132
|
-
EMS3dsServers: {
|
|
5188
|
+
/** ThreeDSecureIO3dsServer. */
|
|
5189
|
+
ThreeDSecureIO3dsServer: {
|
|
5133
5190
|
name: "ThreeDSecureIO3dsServer";
|
|
5191
|
+
/** Visa acquirer merchant ID (MID). */
|
|
5192
|
+
acquirerMerchantIdVisa: string;
|
|
5193
|
+
/** Mastercard acquirer merchant ID (MID). */
|
|
5194
|
+
acquirerMerchantIdMastercard: string;
|
|
5195
|
+
/** Merchant Name. */
|
|
5196
|
+
merchantName: string;
|
|
5197
|
+
/** Visa Acquirer BIN. */
|
|
5198
|
+
merchantAcquirerBinVisa: string;
|
|
5199
|
+
/** Mastercard Acquirer BIN. */
|
|
5200
|
+
merchantAcquirerBinMastercard: string;
|
|
5201
|
+
/** Merchant Country ISO Alpha-2 Code. */
|
|
5202
|
+
merchantCountry: string;
|
|
5203
|
+
/** Merchant URL. */
|
|
5204
|
+
merchantUrl: string;
|
|
5205
|
+
/**
|
|
5206
|
+
* Value determines if requests can use version 1 of 3DS.
|
|
5207
|
+
* In case both v1 and v2 are enabled it will prefer v2.
|
|
5208
|
+
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
5209
|
+
*/
|
|
5210
|
+
v1?: boolean;
|
|
5211
|
+
/**
|
|
5212
|
+
* Value determines if requests will attempt version 2 of 3DS.
|
|
5213
|
+
* In case both v1 and v2 are enabled it will prefer v2.
|
|
5214
|
+
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
5215
|
+
*/
|
|
5216
|
+
v2?: boolean;
|
|
5217
|
+
/**
|
|
5218
|
+
* 01 - Goods/Service Purchase
|
|
5219
|
+
* 03 - Check Acceptance
|
|
5220
|
+
* 10 - Account Funding
|
|
5221
|
+
* 11 - Quasi-Cash Transaction
|
|
5222
|
+
* 28 - Prepaid Activation and Load
|
|
5223
|
+
*
|
|
5224
|
+
* Identifies the type of transaction being authenticated.
|
|
5225
|
+
*/
|
|
5226
|
+
transactionType?: "01" | "03" | "10" | "11" | "28";
|
|
5227
|
+
/** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
|
|
5228
|
+
declineNotEnrolled: boolean;
|
|
5229
|
+
/** Use 3DS for merchant initiated transactions. */
|
|
5230
|
+
use3dsForMerchantInitiated: boolean;
|
|
5231
|
+
/**
|
|
5232
|
+
* 01 - Recurring transaction
|
|
5233
|
+
* 02 - Instalment transaction
|
|
5234
|
+
* 03 - Add card
|
|
5235
|
+
* 04 - Maintain card information
|
|
5236
|
+
* 05 - Account verification
|
|
5237
|
+
* 06 - Split/delayed shipment
|
|
5238
|
+
* 07 - Top-up
|
|
5239
|
+
* 08 - Mail Order
|
|
5240
|
+
* 09 - Telephone Order
|
|
5241
|
+
* 10 - Whitelist status check
|
|
5242
|
+
* 11 - Other payment
|
|
5243
|
+
*
|
|
5244
|
+
* Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
|
|
5245
|
+
*/
|
|
5246
|
+
threeRIInd?:
|
|
5247
|
+
| "01"
|
|
5248
|
+
| "02"
|
|
5249
|
+
| "03"
|
|
5250
|
+
| "04"
|
|
5251
|
+
| "05"
|
|
5252
|
+
| "06"
|
|
5253
|
+
| "07"
|
|
5254
|
+
| "08"
|
|
5255
|
+
| "09"
|
|
5256
|
+
| "10"
|
|
5257
|
+
| "11";
|
|
5134
5258
|
};
|
|
5135
5259
|
/** GET 3DS Servers. */
|
|
5136
5260
|
GET3dsServers: {
|
|
@@ -5309,6 +5433,8 @@ export interface coreComponents {
|
|
|
5309
5433
|
settings?: {
|
|
5310
5434
|
/** Use One Touch AstroPay API. */
|
|
5311
5435
|
oneTouchApi: boolean;
|
|
5436
|
+
/** Use One Touch AstroPay SDK. */
|
|
5437
|
+
useOneTouchSdk: boolean;
|
|
5312
5438
|
/** Displayed merchant name for AstroPay One Touch. */
|
|
5313
5439
|
merchantName?: string;
|
|
5314
5440
|
/** Displayed merchant logo for AstroPay One Touch. */
|
|
@@ -5874,6 +6000,10 @@ export interface coreComponents {
|
|
|
5874
6000
|
ssl_pin: string;
|
|
5875
6001
|
};
|
|
5876
6002
|
};
|
|
6003
|
+
/** EMS 3DS Servers. */
|
|
6004
|
+
EMS3dsServers: {
|
|
6005
|
+
name: "ThreeDSecureIO3dsServer";
|
|
6006
|
+
};
|
|
5877
6007
|
/** EMS e-Commerce (XML) API config. */
|
|
5878
6008
|
EMS: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5879
6009
|
/** EMS settings object. */
|
|
@@ -6975,8 +7105,6 @@ export interface coreComponents {
|
|
|
6975
7105
|
merchantCode: string;
|
|
6976
7106
|
/** Redsys Gateway secret code. */
|
|
6977
7107
|
secretCode: string;
|
|
6978
|
-
/** Redsys Gateway merchant sha256 code. Required for Bizum payments. */
|
|
6979
|
-
sha256SecretCode?: string;
|
|
6980
7108
|
};
|
|
6981
7109
|
};
|
|
6982
7110
|
/** Rotessa config. */
|
|
@@ -7303,6 +7431,12 @@ export interface coreComponents {
|
|
|
7303
7431
|
transactionDescription?: string;
|
|
7304
7432
|
};
|
|
7305
7433
|
};
|
|
7434
|
+
/** TestProcessor3dsServers 3DS Servers. */
|
|
7435
|
+
TestProcessor3dsServers: {
|
|
7436
|
+
name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
|
|
7437
|
+
};
|
|
7438
|
+
/** TestProcessor Integrated. */
|
|
7439
|
+
TestProcessor3dsServer: coreComponents["schemas"]["TestProcessor3dsServers"];
|
|
7306
7440
|
/** TestProcessor Gateway config. */
|
|
7307
7441
|
TestProcessor: coreComponents["schemas"]["GatewayAccount"] & {
|
|
7308
7442
|
threeDSecureServer?: coreComponents["schemas"]["TestProcessor3dsServers"];
|
|
@@ -7491,6 +7625,10 @@ export interface coreComponents {
|
|
|
7491
7625
|
};
|
|
7492
7626
|
threeDSecureServer?: coreComponents["schemas"]["Wirecard3dsServers"];
|
|
7493
7627
|
};
|
|
7628
|
+
/** WorldlineAtosFrankfurt 3DS Servers. */
|
|
7629
|
+
WorldlineAtosFrankfurt3dsServers: {
|
|
7630
|
+
name: "ThreeDSecureIO3dsServer";
|
|
7631
|
+
};
|
|
7494
7632
|
/** WorldlineAtosFrankfurt Gateway config. */
|
|
7495
7633
|
WorldlineAtosFrankfurt: coreComponents["schemas"]["GatewayAccount"] & {
|
|
7496
7634
|
threeDSecureServer?: coreComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"];
|
|
@@ -7862,12 +8000,12 @@ export interface coreComponents {
|
|
|
7862
8000
|
calculator: "manual" | "rebilly";
|
|
7863
8001
|
};
|
|
7864
8002
|
/** Manually set shipping amount. */
|
|
7865
|
-
|
|
8003
|
+
ManualShipping: coreComponents["schemas"]["Shipping"] & {
|
|
7866
8004
|
/** Shipping amount. */
|
|
7867
8005
|
amount: number;
|
|
7868
8006
|
};
|
|
7869
8007
|
/** Rebilly-based shipping which is calculated by shipping rates. */
|
|
7870
|
-
|
|
8008
|
+
RebillyShipping: coreComponents["schemas"]["Shipping"] & {
|
|
7871
8009
|
/** Shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
7872
8010
|
rateId?: coreComponents["schemas"]["ResourceId"] | null;
|
|
7873
8011
|
/** Shipping amount which is calculated from [Shipping rates](https://api-reference.rebilly.com/tag/Shipping-rates). */
|
|
@@ -7889,7 +8027,7 @@ export interface coreComponents {
|
|
|
7889
8027
|
rate?: number | null;
|
|
7890
8028
|
};
|
|
7891
8029
|
/** Manually set tax items. */
|
|
7892
|
-
|
|
8030
|
+
manual: coreComponents["schemas"]["InvoiceTax"] & {
|
|
7893
8031
|
/** Taxes applied to this invoice. */
|
|
7894
8032
|
items: coreComponents["schemas"]["InvoiceTaxItem"][];
|
|
7895
8033
|
};
|
|
@@ -8490,6 +8628,18 @@ export interface coreComponents {
|
|
|
8490
8628
|
identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
8491
8629
|
addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
8492
8630
|
};
|
|
8631
|
+
TaxLocation: {
|
|
8632
|
+
/** The tax location street address. */
|
|
8633
|
+
address?: string;
|
|
8634
|
+
/** The tax location city. */
|
|
8635
|
+
city: string;
|
|
8636
|
+
/** The tax location region (state). */
|
|
8637
|
+
region?: string;
|
|
8638
|
+
/** The tax location country ISO Alpha-2 code. */
|
|
8639
|
+
country: string;
|
|
8640
|
+
/** The tax location postal code. */
|
|
8641
|
+
postalCode: string;
|
|
8642
|
+
};
|
|
8493
8643
|
OrganizationSettings: {
|
|
8494
8644
|
/** The settings for tax calculation. */
|
|
8495
8645
|
defaultTaxCalculator?: {
|
|
@@ -8499,6 +8649,11 @@ export interface coreComponents {
|
|
|
8499
8649
|
rate?: number | null;
|
|
8500
8650
|
};
|
|
8501
8651
|
kyc?: coreComponents["schemas"]["KycSettings"];
|
|
8652
|
+
/**
|
|
8653
|
+
* Additional organization addresses where a merchant may wish to collect taxes using the `taxjar` tax calculator.
|
|
8654
|
+
* Available only for US-based organizations.
|
|
8655
|
+
*/
|
|
8656
|
+
taxLocations?: coreComponents["schemas"]["TaxLocation"][];
|
|
8502
8657
|
};
|
|
8503
8658
|
Organization: {
|
|
8504
8659
|
/** The organization identifier string. */
|
|
@@ -10477,7 +10632,9 @@ export interface coreComponents {
|
|
|
10477
10632
|
PaymentInstruction:
|
|
10478
10633
|
| coreComponents["schemas"]["PaymentToken"]
|
|
10479
10634
|
| coreComponents["schemas"]["PaymentInstrument-3"]
|
|
10480
|
-
| coreComponents["schemas"]["PaymentMethods"]
|
|
10635
|
+
| coreComponents["schemas"]["PaymentMethods"]
|
|
10636
|
+
| coreComponents["schemas"]["PaymentCardCreatePlain"]
|
|
10637
|
+
| coreComponents["schemas"]["BankAccountCreatePlain"];
|
|
10481
10638
|
CommonTransactionRequest: {
|
|
10482
10639
|
/** The website identifier string. */
|
|
10483
10640
|
websiteId: coreComponents["schemas"]["ResourceId"];
|
|
@@ -10521,7 +10678,7 @@ export interface coreComponents {
|
|
|
10521
10678
|
* To `capture` use the `sale` type. If any existing `authorize` transactions are eligible, then they will be captured and the `sale` will be converted to a `capture` type.
|
|
10522
10679
|
* The `setup` type will set up the payment instrument by following the `setupInstruction` in the selected gateway account. If the instruction is to `do-nothing`, a transaction with result `approved` of type `setup` will be returned.
|
|
10523
10680
|
*/
|
|
10524
|
-
type?: "
|
|
10681
|
+
type?: "sale" | "authorize" | "setup";
|
|
10525
10682
|
limits?: coreComponents["schemas"]["TransactionLimitAmount"];
|
|
10526
10683
|
} & coreComponents["schemas"]["CommonTransactionRequest"];
|
|
10527
10684
|
PayoutRequest: coreComponents["schemas"]["CommonTransactionRequest"];
|
|
@@ -10774,7 +10931,6 @@ export interface coreComponents {
|
|
|
10774
10931
|
| "invoice-past-due-reminder"
|
|
10775
10932
|
| "invoice-refunded"
|
|
10776
10933
|
| "invoice-reissued"
|
|
10777
|
-
| "invoice-revenue-recognized"
|
|
10778
10934
|
| "invoice-tax-calculation-failed"
|
|
10779
10935
|
| "invoice-voided"
|
|
10780
10936
|
| "kyc-document-accepted"
|
|
@@ -11027,12 +11183,6 @@ export interface coreComponents {
|
|
|
11027
11183
|
"application/json": coreComponents["schemas"]["Coupon"];
|
|
11028
11184
|
};
|
|
11029
11185
|
};
|
|
11030
|
-
/** Credential resource. */
|
|
11031
|
-
Credential: {
|
|
11032
|
-
content: {
|
|
11033
|
-
"application/json": coreComponents["schemas"]["Credential"];
|
|
11034
|
-
};
|
|
11035
|
-
};
|
|
11036
11186
|
/** Customer resource. */
|
|
11037
11187
|
Customer: {
|
|
11038
11188
|
content: {
|
|
@@ -12057,7 +12207,7 @@ export interface operations {
|
|
|
12057
12207
|
200: {
|
|
12058
12208
|
headers: {};
|
|
12059
12209
|
content: {
|
|
12060
|
-
"application/json": coreComponents["schemas"]["
|
|
12210
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"][];
|
|
12061
12211
|
};
|
|
12062
12212
|
};
|
|
12063
12213
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -12070,14 +12220,19 @@ export interface operations {
|
|
|
12070
12220
|
/** Credential was created. */
|
|
12071
12221
|
201: {
|
|
12072
12222
|
content: {
|
|
12073
|
-
"application/json": coreComponents["schemas"]["
|
|
12223
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"];
|
|
12074
12224
|
};
|
|
12075
12225
|
};
|
|
12076
12226
|
401: coreComponents["responses"]["Unauthorized"];
|
|
12077
12227
|
403: coreComponents["responses"]["Forbidden"];
|
|
12078
12228
|
422: coreComponents["responses"]["ValidationError"];
|
|
12079
12229
|
};
|
|
12080
|
-
|
|
12230
|
+
/** Credential resource. */
|
|
12231
|
+
requestBody: {
|
|
12232
|
+
content: {
|
|
12233
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"];
|
|
12234
|
+
};
|
|
12235
|
+
};
|
|
12081
12236
|
};
|
|
12082
12237
|
/** Retrieve a credential with specified identifier string. */
|
|
12083
12238
|
GetCredential: {
|
|
@@ -12091,7 +12246,7 @@ export interface operations {
|
|
|
12091
12246
|
/** Credential was retrieved successfully. */
|
|
12092
12247
|
200: {
|
|
12093
12248
|
content: {
|
|
12094
|
-
"application/json": coreComponents["schemas"]["
|
|
12249
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"];
|
|
12095
12250
|
};
|
|
12096
12251
|
};
|
|
12097
12252
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -12111,13 +12266,13 @@ export interface operations {
|
|
|
12111
12266
|
/** Credential was updated. */
|
|
12112
12267
|
200: {
|
|
12113
12268
|
content: {
|
|
12114
|
-
"application/json": coreComponents["schemas"]["
|
|
12269
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"];
|
|
12115
12270
|
};
|
|
12116
12271
|
};
|
|
12117
12272
|
/** Credential was created. */
|
|
12118
12273
|
201: {
|
|
12119
12274
|
content: {
|
|
12120
|
-
"application/json": coreComponents["schemas"]["
|
|
12275
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"];
|
|
12121
12276
|
};
|
|
12122
12277
|
};
|
|
12123
12278
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -12125,7 +12280,12 @@ export interface operations {
|
|
|
12125
12280
|
404: coreComponents["responses"]["NotFound"];
|
|
12126
12281
|
422: coreComponents["responses"]["ValidationError"];
|
|
12127
12282
|
};
|
|
12128
|
-
|
|
12283
|
+
/** Credential resource. */
|
|
12284
|
+
requestBody: {
|
|
12285
|
+
content: {
|
|
12286
|
+
"application/json": coreComponents["schemas"]["CustomerCredential"];
|
|
12287
|
+
};
|
|
12288
|
+
};
|
|
12129
12289
|
};
|
|
12130
12290
|
/** Delete a credential with predefined identifier string. */
|
|
12131
12291
|
DeleteCredential: {
|
|
@@ -18749,78 +18909,6 @@ export interface usersComponents {
|
|
|
18749
18909
|
};
|
|
18750
18910
|
/** eMerchantPay 3DS Server. */
|
|
18751
18911
|
eMerchantPay3dsServer: usersComponents["schemas"]["eMerchantPay3dsServers"];
|
|
18752
|
-
/** ThreeDSecureIO3dsServer. */
|
|
18753
|
-
ThreeDSecureIO3dsServer: usersComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"] &
|
|
18754
|
-
usersComponents["schemas"]["TestProcessor3dsServers"] &
|
|
18755
|
-
usersComponents["schemas"]["EMS3dsServers"] & {
|
|
18756
|
-
/** Visa acquirer merchant ID (MID). */
|
|
18757
|
-
acquirerMerchantIdVisa: string;
|
|
18758
|
-
/** Mastercard acquirer merchant ID (MID). */
|
|
18759
|
-
acquirerMerchantIdMastercard: string;
|
|
18760
|
-
/** Merchant Name. */
|
|
18761
|
-
merchantName: string;
|
|
18762
|
-
/** Visa Acquirer BIN. */
|
|
18763
|
-
merchantAcquirerBinVisa: string;
|
|
18764
|
-
/** Mastercard Acquirer BIN. */
|
|
18765
|
-
merchantAcquirerBinMastercard: string;
|
|
18766
|
-
/** Merchant Country ISO Alpha-2 Code. */
|
|
18767
|
-
merchantCountry: string;
|
|
18768
|
-
/** Merchant URL. */
|
|
18769
|
-
merchantUrl: string;
|
|
18770
|
-
/**
|
|
18771
|
-
* Value determines if requests can use version 1 of 3DS.
|
|
18772
|
-
* In case both v1 and v2 are enabled it will prefer v2.
|
|
18773
|
-
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
18774
|
-
*/
|
|
18775
|
-
v1?: boolean;
|
|
18776
|
-
/**
|
|
18777
|
-
* Value determines if requests will attempt version 2 of 3DS.
|
|
18778
|
-
* In case both v1 and v2 are enabled it will prefer v2.
|
|
18779
|
-
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
18780
|
-
*/
|
|
18781
|
-
v2?: boolean;
|
|
18782
|
-
/**
|
|
18783
|
-
* 01 - Goods/Service Purchase
|
|
18784
|
-
* 03 - Check Acceptance
|
|
18785
|
-
* 10 - Account Funding
|
|
18786
|
-
* 11 - Quasi-Cash Transaction
|
|
18787
|
-
* 28 - Prepaid Activation and Load
|
|
18788
|
-
*
|
|
18789
|
-
* Identifies the type of transaction being authenticated.
|
|
18790
|
-
*/
|
|
18791
|
-
transactionType?: "01" | "03" | "10" | "11" | "28";
|
|
18792
|
-
/** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
|
|
18793
|
-
declineNotEnrolled: boolean;
|
|
18794
|
-
/** Use 3DS for merchant initiated transactions. */
|
|
18795
|
-
use3dsForMerchantInitiated: boolean;
|
|
18796
|
-
/**
|
|
18797
|
-
* 01 - Recurring transaction
|
|
18798
|
-
* 02 - Instalment transaction
|
|
18799
|
-
* 03 - Add card
|
|
18800
|
-
* 04 - Maintain card information
|
|
18801
|
-
* 05 - Account verification
|
|
18802
|
-
* 06 - Split/delayed shipment
|
|
18803
|
-
* 07 - Top-up
|
|
18804
|
-
* 08 - Mail Order
|
|
18805
|
-
* 09 - Telephone Order
|
|
18806
|
-
* 10 - Whitelist status check
|
|
18807
|
-
* 11 - Other payment
|
|
18808
|
-
*
|
|
18809
|
-
* Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
|
|
18810
|
-
*/
|
|
18811
|
-
threeRIInd?:
|
|
18812
|
-
| "01"
|
|
18813
|
-
| "02"
|
|
18814
|
-
| "03"
|
|
18815
|
-
| "04"
|
|
18816
|
-
| "05"
|
|
18817
|
-
| "06"
|
|
18818
|
-
| "07"
|
|
18819
|
-
| "08"
|
|
18820
|
-
| "09"
|
|
18821
|
-
| "10"
|
|
18822
|
-
| "11";
|
|
18823
|
-
};
|
|
18824
18912
|
/** The Merchant plug-in Name. */
|
|
18825
18913
|
ThreeDSecureServerName:
|
|
18826
18914
|
| "Payvision3dsServer"
|
|
@@ -18839,19 +18927,76 @@ export interface usersComponents {
|
|
|
18839
18927
|
| "Piastrix3dsServer"
|
|
18840
18928
|
| "NGenius3dsServer"
|
|
18841
18929
|
| "Stripe3dsServer";
|
|
18842
|
-
/**
|
|
18843
|
-
|
|
18844
|
-
name: "ThreeDSecureIO3dsServer";
|
|
18845
|
-
};
|
|
18846
|
-
/** TestProcessor3dsServers 3DS Servers. */
|
|
18847
|
-
TestProcessor3dsServers: {
|
|
18848
|
-
name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
|
|
18849
|
-
};
|
|
18850
|
-
/** TestProcessor Integrated. */
|
|
18851
|
-
TestProcessor3dsServer: usersComponents["schemas"]["TestProcessor3dsServers"];
|
|
18852
|
-
/** EMS 3DS Servers. */
|
|
18853
|
-
EMS3dsServers: {
|
|
18930
|
+
/** ThreeDSecureIO3dsServer. */
|
|
18931
|
+
ThreeDSecureIO3dsServer: {
|
|
18854
18932
|
name: "ThreeDSecureIO3dsServer";
|
|
18933
|
+
/** Visa acquirer merchant ID (MID). */
|
|
18934
|
+
acquirerMerchantIdVisa: string;
|
|
18935
|
+
/** Mastercard acquirer merchant ID (MID). */
|
|
18936
|
+
acquirerMerchantIdMastercard: string;
|
|
18937
|
+
/** Merchant Name. */
|
|
18938
|
+
merchantName: string;
|
|
18939
|
+
/** Visa Acquirer BIN. */
|
|
18940
|
+
merchantAcquirerBinVisa: string;
|
|
18941
|
+
/** Mastercard Acquirer BIN. */
|
|
18942
|
+
merchantAcquirerBinMastercard: string;
|
|
18943
|
+
/** Merchant Country ISO Alpha-2 Code. */
|
|
18944
|
+
merchantCountry: string;
|
|
18945
|
+
/** Merchant URL. */
|
|
18946
|
+
merchantUrl: string;
|
|
18947
|
+
/**
|
|
18948
|
+
* Value determines if requests can use version 1 of 3DS.
|
|
18949
|
+
* In case both v1 and v2 are enabled it will prefer v2.
|
|
18950
|
+
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
18951
|
+
*/
|
|
18952
|
+
v1?: boolean;
|
|
18953
|
+
/**
|
|
18954
|
+
* Value determines if requests will attempt version 2 of 3DS.
|
|
18955
|
+
* In case both v1 and v2 are enabled it will prefer v2.
|
|
18956
|
+
* If v2 is not supported for the issuer, it will coalesce to v1.
|
|
18957
|
+
*/
|
|
18958
|
+
v2?: boolean;
|
|
18959
|
+
/**
|
|
18960
|
+
* 01 - Goods/Service Purchase
|
|
18961
|
+
* 03 - Check Acceptance
|
|
18962
|
+
* 10 - Account Funding
|
|
18963
|
+
* 11 - Quasi-Cash Transaction
|
|
18964
|
+
* 28 - Prepaid Activation and Load
|
|
18965
|
+
*
|
|
18966
|
+
* Identifies the type of transaction being authenticated.
|
|
18967
|
+
*/
|
|
18968
|
+
transactionType?: "01" | "03" | "10" | "11" | "28";
|
|
18969
|
+
/** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
|
|
18970
|
+
declineNotEnrolled: boolean;
|
|
18971
|
+
/** Use 3DS for merchant initiated transactions. */
|
|
18972
|
+
use3dsForMerchantInitiated: boolean;
|
|
18973
|
+
/**
|
|
18974
|
+
* 01 - Recurring transaction
|
|
18975
|
+
* 02 - Instalment transaction
|
|
18976
|
+
* 03 - Add card
|
|
18977
|
+
* 04 - Maintain card information
|
|
18978
|
+
* 05 - Account verification
|
|
18979
|
+
* 06 - Split/delayed shipment
|
|
18980
|
+
* 07 - Top-up
|
|
18981
|
+
* 08 - Mail Order
|
|
18982
|
+
* 09 - Telephone Order
|
|
18983
|
+
* 10 - Whitelist status check
|
|
18984
|
+
* 11 - Other payment
|
|
18985
|
+
*
|
|
18986
|
+
* Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
|
|
18987
|
+
*/
|
|
18988
|
+
threeRIInd?:
|
|
18989
|
+
| "01"
|
|
18990
|
+
| "02"
|
|
18991
|
+
| "03"
|
|
18992
|
+
| "04"
|
|
18993
|
+
| "05"
|
|
18994
|
+
| "06"
|
|
18995
|
+
| "07"
|
|
18996
|
+
| "08"
|
|
18997
|
+
| "09"
|
|
18998
|
+
| "10"
|
|
18999
|
+
| "11";
|
|
18855
19000
|
};
|
|
18856
19001
|
/** GET 3DS Servers. */
|
|
18857
19002
|
GET3dsServers: {
|
|
@@ -19030,6 +19175,8 @@ export interface usersComponents {
|
|
|
19030
19175
|
settings?: {
|
|
19031
19176
|
/** Use One Touch AstroPay API. */
|
|
19032
19177
|
oneTouchApi: boolean;
|
|
19178
|
+
/** Use One Touch AstroPay SDK. */
|
|
19179
|
+
useOneTouchSdk: boolean;
|
|
19033
19180
|
/** Displayed merchant name for AstroPay One Touch. */
|
|
19034
19181
|
merchantName?: string;
|
|
19035
19182
|
/** Displayed merchant logo for AstroPay One Touch. */
|
|
@@ -19595,6 +19742,10 @@ export interface usersComponents {
|
|
|
19595
19742
|
ssl_pin: string;
|
|
19596
19743
|
};
|
|
19597
19744
|
};
|
|
19745
|
+
/** EMS 3DS Servers. */
|
|
19746
|
+
EMS3dsServers: {
|
|
19747
|
+
name: "ThreeDSecureIO3dsServer";
|
|
19748
|
+
};
|
|
19598
19749
|
/** EMS e-Commerce (XML) API config. */
|
|
19599
19750
|
EMS: usersComponents["schemas"]["GatewayAccount"] & {
|
|
19600
19751
|
/** EMS settings object. */
|
|
@@ -20696,8 +20847,6 @@ export interface usersComponents {
|
|
|
20696
20847
|
merchantCode: string;
|
|
20697
20848
|
/** Redsys Gateway secret code. */
|
|
20698
20849
|
secretCode: string;
|
|
20699
|
-
/** Redsys Gateway merchant sha256 code. Required for Bizum payments. */
|
|
20700
|
-
sha256SecretCode?: string;
|
|
20701
20850
|
};
|
|
20702
20851
|
};
|
|
20703
20852
|
/** Rotessa config. */
|
|
@@ -21024,6 +21173,12 @@ export interface usersComponents {
|
|
|
21024
21173
|
transactionDescription?: string;
|
|
21025
21174
|
};
|
|
21026
21175
|
};
|
|
21176
|
+
/** TestProcessor3dsServers 3DS Servers. */
|
|
21177
|
+
TestProcessor3dsServers: {
|
|
21178
|
+
name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
|
|
21179
|
+
};
|
|
21180
|
+
/** TestProcessor Integrated. */
|
|
21181
|
+
TestProcessor3dsServer: usersComponents["schemas"]["TestProcessor3dsServers"];
|
|
21027
21182
|
/** TestProcessor Gateway config. */
|
|
21028
21183
|
TestProcessor: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21029
21184
|
threeDSecureServer?: usersComponents["schemas"]["TestProcessor3dsServers"];
|
|
@@ -21212,6 +21367,10 @@ export interface usersComponents {
|
|
|
21212
21367
|
};
|
|
21213
21368
|
threeDSecureServer?: usersComponents["schemas"]["Wirecard3dsServers"];
|
|
21214
21369
|
};
|
|
21370
|
+
/** WorldlineAtosFrankfurt 3DS Servers. */
|
|
21371
|
+
WorldlineAtosFrankfurt3dsServers: {
|
|
21372
|
+
name: "ThreeDSecureIO3dsServer";
|
|
21373
|
+
};
|
|
21215
21374
|
/** WorldlineAtosFrankfurt Gateway config. */
|
|
21216
21375
|
WorldlineAtosFrankfurt: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21217
21376
|
threeDSecureServer?: usersComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"];
|
|
@@ -21583,12 +21742,12 @@ export interface usersComponents {
|
|
|
21583
21742
|
calculator: "manual" | "rebilly";
|
|
21584
21743
|
};
|
|
21585
21744
|
/** Manually set shipping amount. */
|
|
21586
|
-
|
|
21745
|
+
ManualShipping: usersComponents["schemas"]["Shipping"] & {
|
|
21587
21746
|
/** Shipping amount. */
|
|
21588
21747
|
amount: number;
|
|
21589
21748
|
};
|
|
21590
21749
|
/** Rebilly-based shipping which is calculated by shipping rates. */
|
|
21591
|
-
|
|
21750
|
+
RebillyShipping: usersComponents["schemas"]["Shipping"] & {
|
|
21592
21751
|
/** Shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
21593
21752
|
rateId?: usersComponents["schemas"]["ResourceId"] | null;
|
|
21594
21753
|
/** Shipping amount which is calculated from [Shipping rates](https://api-reference.rebilly.com/tag/Shipping-rates). */
|
|
@@ -21610,7 +21769,7 @@ export interface usersComponents {
|
|
|
21610
21769
|
rate?: number | null;
|
|
21611
21770
|
};
|
|
21612
21771
|
/** Manually set tax items. */
|
|
21613
|
-
|
|
21772
|
+
manual: usersComponents["schemas"]["InvoiceTax"] & {
|
|
21614
21773
|
/** Taxes applied to this invoice. */
|
|
21615
21774
|
items: usersComponents["schemas"]["InvoiceTaxItem"][];
|
|
21616
21775
|
};
|
|
@@ -22211,6 +22370,18 @@ export interface usersComponents {
|
|
|
22211
22370
|
identityProof?: usersComponents["schemas"]["KycSettingsIdentity"];
|
|
22212
22371
|
addressProof?: usersComponents["schemas"]["KycSettingsAddress"];
|
|
22213
22372
|
};
|
|
22373
|
+
TaxLocation: {
|
|
22374
|
+
/** The tax location street address. */
|
|
22375
|
+
address?: string;
|
|
22376
|
+
/** The tax location city. */
|
|
22377
|
+
city: string;
|
|
22378
|
+
/** The tax location region (state). */
|
|
22379
|
+
region?: string;
|
|
22380
|
+
/** The tax location country ISO Alpha-2 code. */
|
|
22381
|
+
country: string;
|
|
22382
|
+
/** The tax location postal code. */
|
|
22383
|
+
postalCode: string;
|
|
22384
|
+
};
|
|
22214
22385
|
OrganizationSettings: {
|
|
22215
22386
|
/** The settings for tax calculation. */
|
|
22216
22387
|
defaultTaxCalculator?: {
|
|
@@ -22220,6 +22391,11 @@ export interface usersComponents {
|
|
|
22220
22391
|
rate?: number | null;
|
|
22221
22392
|
};
|
|
22222
22393
|
kyc?: usersComponents["schemas"]["KycSettings"];
|
|
22394
|
+
/**
|
|
22395
|
+
* Additional organization addresses where a merchant may wish to collect taxes using the `taxjar` tax calculator.
|
|
22396
|
+
* Available only for US-based organizations.
|
|
22397
|
+
*/
|
|
22398
|
+
taxLocations?: usersComponents["schemas"]["TaxLocation"][];
|
|
22223
22399
|
};
|
|
22224
22400
|
Organization: {
|
|
22225
22401
|
/** The organization identifier string. */
|
|
@@ -22432,11 +22608,11 @@ export interface usersComponents {
|
|
|
22432
22608
|
ApplicationInstanceEmbed: {
|
|
22433
22609
|
applicationInstance?: usersComponents["schemas"]["ApplicationInstance"];
|
|
22434
22610
|
};
|
|
22435
|
-
|
|
22611
|
+
UserApplication: usersComponents["schemas"]["Application"] & {
|
|
22436
22612
|
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
22437
22613
|
_embedded?: Partial<usersComponents["schemas"]["ApplicationInstanceEmbed"]>[];
|
|
22438
22614
|
};
|
|
22439
|
-
|
|
22615
|
+
OwnerApplicationInstance: usersComponents["schemas"]["ApplicationInstance"] & {
|
|
22440
22616
|
/** The merchant identifier string. */
|
|
22441
22617
|
organizationId?: usersComponents["schemas"]["ResourceId"];
|
|
22442
22618
|
/** The session's token used to authenticate as the merchant. */
|
|
@@ -22913,14 +23089,14 @@ export interface usersComponents {
|
|
|
22913
23089
|
/** If `inactive`, the checkout form url will result in a 404. */
|
|
22914
23090
|
status: "active" | "inactive";
|
|
22915
23091
|
};
|
|
22916
|
-
|
|
23092
|
+
Credential: {
|
|
22917
23093
|
hash?: usersComponents["schemas"]["ResourceId"];
|
|
22918
23094
|
/** The credential status. */
|
|
22919
23095
|
status?: "active" | "deactivated";
|
|
22920
23096
|
/** The time when the credential was deactivated. */
|
|
22921
23097
|
deactivationTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
22922
23098
|
};
|
|
22923
|
-
SESCredential: usersComponents["schemas"]["Credential
|
|
23099
|
+
SESCredential: usersComponents["schemas"]["Credential"] & {
|
|
22924
23100
|
/** The AWS access key ID. */
|
|
22925
23101
|
key: string;
|
|
22926
23102
|
/** The AWS secret access key. */
|
|
@@ -22950,7 +23126,7 @@ export interface usersComponents {
|
|
|
22950
23126
|
usersComponents["schemas"]["UserPasswordAuthorization"];
|
|
22951
23127
|
plain: usersComponents["schemas"]["SmtpAuthorization"] &
|
|
22952
23128
|
usersComponents["schemas"]["UserPasswordAuthorization"];
|
|
22953
|
-
SmtpCredential: usersComponents["schemas"]["Credential
|
|
23129
|
+
SmtpCredential: usersComponents["schemas"]["Credential"] & {
|
|
22954
23130
|
/** The host name. */
|
|
22955
23131
|
host: string;
|
|
22956
23132
|
/** The port value. */
|
|
@@ -22961,7 +23137,7 @@ export interface usersComponents {
|
|
|
22961
23137
|
/** The links related to resource. */
|
|
22962
23138
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
22963
23139
|
};
|
|
22964
|
-
MailgunCredential: usersComponents["schemas"]["Credential
|
|
23140
|
+
MailgunCredential: usersComponents["schemas"]["Credential"] & {
|
|
22965
23141
|
hash?: usersComponents["schemas"]["ResourceId"];
|
|
22966
23142
|
/** The from email address. */
|
|
22967
23143
|
emailFrom: string;
|
|
@@ -22973,7 +23149,7 @@ export interface usersComponents {
|
|
|
22973
23149
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
22974
23150
|
};
|
|
22975
23151
|
OAuth2CredentialService: "google-sheets";
|
|
22976
|
-
OAuth2Credential: usersComponents["schemas"]["Credential
|
|
23152
|
+
OAuth2Credential: usersComponents["schemas"]["Credential"] & {
|
|
22977
23153
|
/** The name of service that the OAuth2 credential belongs to. */
|
|
22978
23154
|
service: usersComponents["schemas"]["OAuth2CredentialService"];
|
|
22979
23155
|
/** The OAuth2 code provided by the authentication server. */
|
|
@@ -22993,7 +23169,7 @@ export interface usersComponents {
|
|
|
22993
23169
|
/** The google spreadsheet name. */
|
|
22994
23170
|
name?: string;
|
|
22995
23171
|
};
|
|
22996
|
-
PlaidCredential: usersComponents["schemas"]["Credential
|
|
23172
|
+
PlaidCredential: usersComponents["schemas"]["Credential"] & {
|
|
22997
23173
|
/**
|
|
22998
23174
|
* The website assigned to this Plaid account.
|
|
22999
23175
|
* If not set, credentials will be used for any website.
|
|
@@ -23011,13 +23187,13 @@ export interface usersComponents {
|
|
|
23011
23187
|
/** The links related to resource. */
|
|
23012
23188
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23013
23189
|
};
|
|
23014
|
-
PostmarkCredential: usersComponents["schemas"]["Credential
|
|
23190
|
+
PostmarkCredential: usersComponents["schemas"]["Credential"] & {
|
|
23015
23191
|
/** The Postmark server API token. */
|
|
23016
23192
|
serverApiToken: string;
|
|
23017
23193
|
/** The links related to resource. */
|
|
23018
23194
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23019
23195
|
};
|
|
23020
|
-
SendGridCredential: usersComponents["schemas"]["Credential
|
|
23196
|
+
SendGridCredential: usersComponents["schemas"]["Credential"] & {
|
|
23021
23197
|
/** The SendGrid api key. */
|
|
23022
23198
|
apiKey: string;
|
|
23023
23199
|
/** The links related to resource. */
|
|
@@ -23042,12 +23218,12 @@ export interface usersComponents {
|
|
|
23042
23218
|
token: string;
|
|
23043
23219
|
tokenSecret: string;
|
|
23044
23220
|
};
|
|
23045
|
-
WebhookCredential: usersComponents["schemas"]["Credential
|
|
23221
|
+
WebhookCredential: usersComponents["schemas"]["Credential"] & {
|
|
23046
23222
|
/** The host name. */
|
|
23047
23223
|
host: string;
|
|
23048
23224
|
auth?: usersComponents["schemas"]["WebhookAuthorization"];
|
|
23049
23225
|
};
|
|
23050
|
-
ExperianCredential: usersComponents["schemas"]["Credential
|
|
23226
|
+
ExperianCredential: usersComponents["schemas"]["Credential"] & {
|
|
23051
23227
|
/** Username on the Experian side. */
|
|
23052
23228
|
username: string;
|
|
23053
23229
|
/** Password on the Experian side. */
|
|
@@ -23059,7 +23235,7 @@ export interface usersComponents {
|
|
|
23059
23235
|
/** The links related to resource. */
|
|
23060
23236
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23061
23237
|
};
|
|
23062
|
-
TaxJarCredential: usersComponents["schemas"]["Credential
|
|
23238
|
+
TaxJarCredential: usersComponents["schemas"]["Credential"] & {
|
|
23063
23239
|
/** TaxJar API token. */
|
|
23064
23240
|
apiToken: string;
|
|
23065
23241
|
/** The links related to resource. */
|
|
@@ -24275,7 +24451,6 @@ export interface usersComponents {
|
|
|
24275
24451
|
| "invoice-past-due-reminder"
|
|
24276
24452
|
| "invoice-refunded"
|
|
24277
24453
|
| "invoice-reissued"
|
|
24278
|
-
| "invoice-revenue-recognized"
|
|
24279
24454
|
| "invoice-tax-calculation-failed"
|
|
24280
24455
|
| "invoice-voided"
|
|
24281
24456
|
| "kyc-document-accepted"
|
|
@@ -24916,7 +25091,7 @@ export interface usersComponents {
|
|
|
24916
25091
|
eventType?: "application-instance-enabled";
|
|
24917
25092
|
_embedded?: {
|
|
24918
25093
|
application?: usersComponents["schemas"]["Application"];
|
|
24919
|
-
applicationInstance?: usersComponents["schemas"]["
|
|
25094
|
+
applicationInstance?: usersComponents["schemas"]["OwnerApplicationInstance"];
|
|
24920
25095
|
};
|
|
24921
25096
|
/** The links related to resource. */
|
|
24922
25097
|
_links?: (Partial<usersComponents["schemas"]["ApplicationLink"]> &
|
|
@@ -25098,7 +25273,7 @@ export interface operations {
|
|
|
25098
25273
|
200: {
|
|
25099
25274
|
headers: {};
|
|
25100
25275
|
content: {
|
|
25101
|
-
"application/json": usersComponents["schemas"]["
|
|
25276
|
+
"application/json": usersComponents["schemas"]["UserApplication"][];
|
|
25102
25277
|
};
|
|
25103
25278
|
};
|
|
25104
25279
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -25138,7 +25313,7 @@ export interface operations {
|
|
|
25138
25313
|
200: {
|
|
25139
25314
|
headers: {};
|
|
25140
25315
|
content: {
|
|
25141
|
-
"application/json": usersComponents["schemas"]["
|
|
25316
|
+
"application/json": usersComponents["schemas"]["UserApplication"];
|
|
25142
25317
|
};
|
|
25143
25318
|
};
|
|
25144
25319
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -25158,7 +25333,7 @@ export interface operations {
|
|
|
25158
25333
|
200: {
|
|
25159
25334
|
headers: {};
|
|
25160
25335
|
content: {
|
|
25161
|
-
"application/json": usersComponents["schemas"]["
|
|
25336
|
+
"application/json": usersComponents["schemas"]["OwnerApplicationInstance"][];
|
|
25162
25337
|
};
|
|
25163
25338
|
};
|
|
25164
25339
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -25180,7 +25355,7 @@ export interface operations {
|
|
|
25180
25355
|
200: {
|
|
25181
25356
|
headers: {};
|
|
25182
25357
|
content: {
|
|
25183
|
-
"application/json": usersComponents["schemas"]["
|
|
25358
|
+
"application/json": usersComponents["schemas"]["OwnerApplicationInstance"];
|
|
25184
25359
|
};
|
|
25185
25360
|
};
|
|
25186
25361
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -30673,12 +30848,12 @@ export interface storefrontComponents {
|
|
|
30673
30848
|
calculator: "manual" | "rebilly";
|
|
30674
30849
|
};
|
|
30675
30850
|
/** Manually set shipping amount. */
|
|
30676
|
-
|
|
30851
|
+
ManualShipping: storefrontComponents["schemas"]["Shipping"] & {
|
|
30677
30852
|
/** Shipping amount. */
|
|
30678
30853
|
amount: number;
|
|
30679
30854
|
};
|
|
30680
30855
|
/** Rebilly-based shipping which is calculated by shipping rates. */
|
|
30681
|
-
|
|
30856
|
+
RebillyShipping: storefrontComponents["schemas"]["Shipping"] & {
|
|
30682
30857
|
/** Shipping rate ID. If unset the cheapest applicable shipping rate is chosen. */
|
|
30683
30858
|
rateId?: storefrontComponents["schemas"]["ResourceId"] | null;
|
|
30684
30859
|
/** Shipping amount which is calculated from [Shipping rates](https://api-reference.rebilly.com/tag/Shipping-rates). */
|
|
@@ -30700,7 +30875,7 @@ export interface storefrontComponents {
|
|
|
30700
30875
|
rate?: number | null;
|
|
30701
30876
|
};
|
|
30702
30877
|
/** Manually set tax items. */
|
|
30703
|
-
|
|
30878
|
+
manual: storefrontComponents["schemas"]["InvoiceTax"] & {
|
|
30704
30879
|
/** Taxes applied to this invoice. */
|
|
30705
30880
|
items: storefrontComponents["schemas"]["InvoiceTaxItem"][];
|
|
30706
30881
|
};
|
|
@@ -31601,6 +31776,76 @@ export interface storefrontComponents {
|
|
|
31601
31776
|
updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
31602
31777
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
31603
31778
|
};
|
|
31779
|
+
PaymentCardCreatePlain: {
|
|
31780
|
+
/** The method of payment instrument. */
|
|
31781
|
+
method: "payment-card";
|
|
31782
|
+
/** The Customer's ID. */
|
|
31783
|
+
customerId: storefrontComponents["schemas"]["ResourceId"];
|
|
31784
|
+
/** The card PAN (Primary Account Number). */
|
|
31785
|
+
pan: string;
|
|
31786
|
+
/** Card's expiration year. */
|
|
31787
|
+
expYear: number;
|
|
31788
|
+
/** Card's expiration month. */
|
|
31789
|
+
expMonth: number;
|
|
31790
|
+
/** Card's cvv (card verification value). */
|
|
31791
|
+
cvv?: string;
|
|
31792
|
+
/** The billing address. */
|
|
31793
|
+
billingAddress: storefrontComponents["schemas"]["ContactObject"];
|
|
31794
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
31795
|
+
riskMetadata?: storefrontComponents["schemas"]["RiskMetadata"];
|
|
31796
|
+
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
31797
|
+
useAsBackup: boolean;
|
|
31798
|
+
};
|
|
31799
|
+
/** BBAN type object. */
|
|
31800
|
+
BBANType: {
|
|
31801
|
+
/** The method of payment instrument. */
|
|
31802
|
+
method: "ach";
|
|
31803
|
+
/** Customer's ID. */
|
|
31804
|
+
customerId: storefrontComponents["schemas"]["ResourceId"];
|
|
31805
|
+
/**
|
|
31806
|
+
* Bank's Account Number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).
|
|
31807
|
+
* This is the object for the BBAN.
|
|
31808
|
+
*/
|
|
31809
|
+
accountNumberType: "IBAN" | "BBAN";
|
|
31810
|
+
/** Bank's account number. */
|
|
31811
|
+
accountNumber: string;
|
|
31812
|
+
/** Bank's routing number. */
|
|
31813
|
+
routingNumber: string;
|
|
31814
|
+
/** Bank's account type. */
|
|
31815
|
+
accountType: "checking" | "savings" | "other";
|
|
31816
|
+
/** Bank's name. */
|
|
31817
|
+
bankName?: string;
|
|
31818
|
+
/** Bank Identifier Code. */
|
|
31819
|
+
bic?: string;
|
|
31820
|
+
/** The billing address. */
|
|
31821
|
+
billingAddress: storefrontComponents["schemas"]["ContactObject"];
|
|
31822
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
31823
|
+
riskMetadata?: storefrontComponents["schemas"]["RiskMetadata"];
|
|
31824
|
+
};
|
|
31825
|
+
/** IBAN type object. */
|
|
31826
|
+
IBANType: {
|
|
31827
|
+
/** The method of payment instrument. */
|
|
31828
|
+
method: "ach";
|
|
31829
|
+
/** Customer's ID. */
|
|
31830
|
+
customerId: storefrontComponents["schemas"]["ResourceId"];
|
|
31831
|
+
/**
|
|
31832
|
+
* Bank's Account Number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).
|
|
31833
|
+
* This is the object for the IBAN.
|
|
31834
|
+
*/
|
|
31835
|
+
accountNumberType: "IBAN" | "BBAN";
|
|
31836
|
+
/** Bank's account number. Detailed information about all ISO 13616-compliant national IBAN formats is available in the [SWIFT IBAN Registry](https://www.swift.com/standards/data-standards/iban). */
|
|
31837
|
+
accountNumber: string;
|
|
31838
|
+
/** Bank's name. */
|
|
31839
|
+
bankName?: string;
|
|
31840
|
+
/** Bank Identifier Code. */
|
|
31841
|
+
bic?: string;
|
|
31842
|
+
/** The billing address. */
|
|
31843
|
+
billingAddress: storefrontComponents["schemas"]["ContactObject"];
|
|
31844
|
+
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
31845
|
+
riskMetadata?: storefrontComponents["schemas"]["RiskMetadata"];
|
|
31846
|
+
};
|
|
31847
|
+
BankAccountCreatePlain: Partial<storefrontComponents["schemas"]["BBANType"]> &
|
|
31848
|
+
Partial<storefrontComponents["schemas"]["IBANType"]>;
|
|
31604
31849
|
ReadyToPayAmount: {
|
|
31605
31850
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
31606
31851
|
/** The amount. */
|
|
@@ -31921,7 +32166,9 @@ export interface storefrontComponents {
|
|
|
31921
32166
|
PaymentInstruction:
|
|
31922
32167
|
| storefrontComponents["schemas"]["PaymentToken"]
|
|
31923
32168
|
| storefrontComponents["schemas"]["PaymentInstrument-3"]
|
|
31924
|
-
| storefrontComponents["schemas"]["PaymentMethods"]
|
|
32169
|
+
| storefrontComponents["schemas"]["PaymentMethods"]
|
|
32170
|
+
| storefrontComponents["schemas"]["PaymentCardCreatePlain"]
|
|
32171
|
+
| storefrontComponents["schemas"]["BankAccountCreatePlain"];
|
|
31925
32172
|
CommonBillingPortal: {
|
|
31926
32173
|
/** The billing portal identifier string. */
|
|
31927
32174
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
@@ -32265,7 +32512,7 @@ export interface storefrontComponents {
|
|
|
32265
32512
|
documents?: storefrontComponents["schemas"]["StorefrontKycDocument"][];
|
|
32266
32513
|
};
|
|
32267
32514
|
};
|
|
32268
|
-
|
|
32515
|
+
StorefrontCustomerJWT: {
|
|
32269
32516
|
/** The session ID. */
|
|
32270
32517
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
32271
32518
|
/** The session's token used for authentication. */
|
|
@@ -32907,7 +33154,7 @@ export interface operations {
|
|
|
32907
33154
|
/** Account logged in. */
|
|
32908
33155
|
201: {
|
|
32909
33156
|
content: {
|
|
32910
|
-
"application/json": storefrontComponents["schemas"]["
|
|
33157
|
+
"application/json": storefrontComponents["schemas"]["StorefrontCustomerJWT"];
|
|
32911
33158
|
};
|
|
32912
33159
|
};
|
|
32913
33160
|
401: storefrontComponents["responses"]["Unauthorized"];
|
|
@@ -33507,256 +33754,2132 @@ export interface operations {
|
|
|
33507
33754
|
};
|
|
33508
33755
|
};
|
|
33509
33756
|
}
|
|
33757
|
+
/**
|
|
33758
|
+
* This file was auto-generated by openapi-typescript.
|
|
33759
|
+
* Do not make direct changes to the file.
|
|
33760
|
+
*/
|
|
33510
33761
|
|
|
33511
|
-
|
|
33512
|
-
|
|
33513
|
-
|
|
33514
|
-
|
|
33515
|
-
|
|
33516
|
-
|
|
33517
|
-
|
|
33518
|
-
|
|
33519
|
-
|
|
33520
|
-
constructor({ id, created }?: {
|
|
33521
|
-
id?: any;
|
|
33522
|
-
created?: any;
|
|
33523
|
-
});
|
|
33524
|
-
id: CachedRequestId;
|
|
33525
|
-
created: number;
|
|
33526
|
-
cancelSource: import("axios").CancelTokenSource;
|
|
33527
|
-
cancel: any;
|
|
33528
|
-
cancelToken: any;
|
|
33529
|
-
}
|
|
33530
|
-
export type CachedRequestId = string;
|
|
33531
|
-
}
|
|
33532
|
-
declare module "requests-cache" {
|
|
33533
|
-
var _default: RequestsCache;
|
|
33534
|
-
export default _default;
|
|
33535
|
-
class RequestsCache {
|
|
33536
|
-
requests: any;
|
|
33537
|
-
getAll(): any[];
|
|
33538
|
-
getById(id: any): CachedRequest | undefined;
|
|
33539
|
-
deleteById(id: any): any;
|
|
33540
|
-
save(): {
|
|
33541
|
-
id: any;
|
|
33542
|
-
cancelToken: any;
|
|
33543
|
-
};
|
|
33544
|
-
}
|
|
33545
|
-
import CachedRequest from "cached-request";
|
|
33546
|
-
}
|
|
33547
|
-
declare module "cancellation" {
|
|
33548
|
-
export class Cancellation {
|
|
33549
|
-
static cancelById: (id: string, reason?: string) => void;
|
|
33550
|
-
static cancelAll: (reason?: string) => any;
|
|
33551
|
-
}
|
|
33552
|
-
namespace _default {
|
|
33553
|
-
const cancelAll: (reason?: string) => any;
|
|
33554
|
-
}
|
|
33555
|
-
export default _default;
|
|
33556
|
-
}
|
|
33557
|
-
declare module "member" {
|
|
33558
|
-
export default class Member {
|
|
33559
|
-
constructor({ data, status, statusText, headers }: {
|
|
33560
|
-
data: any;
|
|
33561
|
-
status: any;
|
|
33562
|
-
statusText: any;
|
|
33563
|
-
headers: any;
|
|
33564
|
-
}, config?: {});
|
|
33565
|
-
response: any;
|
|
33566
|
-
fields: any;
|
|
33567
|
-
config: any;
|
|
33568
|
-
getJSON(): any;
|
|
33569
|
-
}
|
|
33570
|
-
}
|
|
33571
|
-
declare module "pagination-headers" {
|
|
33572
|
-
export default paginationHeaders;
|
|
33573
|
-
namespace paginationHeaders {
|
|
33574
|
-
const limit: string;
|
|
33575
|
-
const offset: string;
|
|
33576
|
-
const total: string;
|
|
33577
|
-
}
|
|
33578
|
-
}
|
|
33579
|
-
declare module "collection" {
|
|
33580
|
-
export default class Collection {
|
|
33581
|
-
constructor({ data, status, statusText, headers }: {
|
|
33582
|
-
data: any;
|
|
33583
|
-
status: any;
|
|
33584
|
-
statusText: any;
|
|
33585
|
-
headers: any;
|
|
33586
|
-
}, config?: {});
|
|
33587
|
-
limit: number | null;
|
|
33588
|
-
offset: number | null;
|
|
33589
|
-
total: number | null;
|
|
33590
|
-
response: any;
|
|
33591
|
-
items: Array<Member>;
|
|
33592
|
-
config: any;
|
|
33593
|
-
getJSON(): any;
|
|
33594
|
-
}
|
|
33595
|
-
import Member from "member";
|
|
33596
|
-
}
|
|
33597
|
-
declare module "file" {
|
|
33598
|
-
export default class File {
|
|
33599
|
-
constructor({ data, status, statusText, headers }: {
|
|
33600
|
-
data: any;
|
|
33601
|
-
status: any;
|
|
33602
|
-
statusText: any;
|
|
33603
|
-
headers: any;
|
|
33604
|
-
}, config?: {});
|
|
33605
|
-
response: {
|
|
33606
|
-
status: any;
|
|
33607
|
-
statusText: any;
|
|
33608
|
-
headers: any;
|
|
33609
|
-
};
|
|
33610
|
-
data: any;
|
|
33611
|
-
config: {};
|
|
33612
|
-
}
|
|
33613
|
-
}
|
|
33614
|
-
declare module "errors/rebilly-error" {
|
|
33615
|
-
export default class RebillyError extends Error {
|
|
33616
|
-
constructor({ error, name }: {
|
|
33617
|
-
error: any;
|
|
33618
|
-
name?: any;
|
|
33619
|
-
});
|
|
33620
|
-
response: any;
|
|
33621
|
-
request: any;
|
|
33622
|
-
config: any;
|
|
33623
|
-
status: any;
|
|
33624
|
-
statusText: any;
|
|
33625
|
-
details: any;
|
|
33626
|
-
invalidFields: any;
|
|
33627
|
-
}
|
|
33628
|
-
}
|
|
33629
|
-
declare module "errors/errors" {
|
|
33630
|
-
export default Errors;
|
|
33631
|
-
namespace Errors {
|
|
33632
|
-
export { RebillyError };
|
|
33633
|
-
export { RebillyRequestError };
|
|
33634
|
-
export { RebillyValidationError };
|
|
33635
|
-
export { RebillyNotFoundError };
|
|
33636
|
-
export { RebillyConflictError };
|
|
33637
|
-
export { RebillyForbiddenError };
|
|
33638
|
-
export { RebillyMethodNotAllowedError };
|
|
33639
|
-
export { RebillyTimeoutError };
|
|
33640
|
-
export { RebillyCanceledError };
|
|
33641
|
-
}
|
|
33642
|
-
import RebillyError from "errors/rebilly-error";
|
|
33643
|
-
class RebillyRequestError extends RebillyError {
|
|
33644
|
-
constructor(error: any);
|
|
33645
|
-
}
|
|
33646
|
-
class RebillyValidationError extends RebillyError {
|
|
33647
|
-
constructor(error: any);
|
|
33648
|
-
}
|
|
33649
|
-
class RebillyNotFoundError extends RebillyError {
|
|
33650
|
-
constructor(error: any);
|
|
33651
|
-
}
|
|
33652
|
-
class RebillyConflictError extends RebillyError {
|
|
33653
|
-
constructor(error: any);
|
|
33654
|
-
}
|
|
33655
|
-
class RebillyForbiddenError extends RebillyError {
|
|
33656
|
-
constructor(error: any);
|
|
33657
|
-
}
|
|
33658
|
-
class RebillyMethodNotAllowedError extends RebillyError {
|
|
33659
|
-
constructor(error: any);
|
|
33660
|
-
}
|
|
33661
|
-
class RebillyTimeoutError extends RebillyError {
|
|
33662
|
-
constructor(error: any);
|
|
33663
|
-
}
|
|
33664
|
-
class RebillyCanceledError extends RebillyError {
|
|
33665
|
-
constructor(error: any);
|
|
33666
|
-
}
|
|
33667
|
-
}
|
|
33668
|
-
declare module "create-api-handler" {
|
|
33669
|
-
export default function createApiHandler({ options }: {
|
|
33670
|
-
options: any;
|
|
33671
|
-
}): {
|
|
33672
|
-
addRequestInterceptor: ({ thenDelegate, catchDelegate }: {
|
|
33673
|
-
thenDelegate: Function;
|
|
33674
|
-
catchDelegate: Function;
|
|
33675
|
-
}) => number;
|
|
33676
|
-
removeRequestInterceptor: (interceptor: number) => void;
|
|
33677
|
-
addResponseInterceptor: ({ thenDelegate, catchDelegate }: {
|
|
33678
|
-
thenDelegate: Function;
|
|
33679
|
-
catchDelegate: Function;
|
|
33680
|
-
}) => number;
|
|
33681
|
-
removeResponseInterceptor: (interceptor: number) => void;
|
|
33682
|
-
setTimeout: (timeout: any) => void;
|
|
33683
|
-
setProxyAgent: ({ host, port, auth }: {
|
|
33684
|
-
host: string;
|
|
33685
|
-
port: number;
|
|
33686
|
-
auth: {
|
|
33687
|
-
username: string;
|
|
33688
|
-
password: string;
|
|
33689
|
-
};
|
|
33690
|
-
}) => void;
|
|
33691
|
-
setSessionToken: (token?: any) => void;
|
|
33692
|
-
setPublishableKey: (key?: any) => void;
|
|
33693
|
-
setEndpoints: ({ live, sandbox }: {
|
|
33694
|
-
live: string;
|
|
33695
|
-
sandbox: string;
|
|
33696
|
-
}) => void;
|
|
33697
|
-
getCancellationToken: any;
|
|
33698
|
-
get: (url: string, params?: any) => Member;
|
|
33699
|
-
getAll: (url: string, params: any) => Collection;
|
|
33700
|
-
post: (url: string, data: any, options?: any) => Member;
|
|
33701
|
-
put: (url: string, data: any, params?: {}) => Member;
|
|
33702
|
-
patch: (url: string, data: any) => Member;
|
|
33703
|
-
delete: (url: string) => null | any;
|
|
33704
|
-
create: (url: string, id: string, data: any, params?: {}) => Member;
|
|
33762
|
+
export interface reportsPaths {
|
|
33763
|
+
"/customers/{customerId}/summary-metrics": {
|
|
33764
|
+
/** Retrieve customer lifetime summary metrics. */
|
|
33765
|
+
get: operations["GetCustomerSummaryMetricReport"];
|
|
33766
|
+
parameters: {
|
|
33767
|
+
path: {
|
|
33768
|
+
/** Customer's ID. */
|
|
33769
|
+
customerId: string;
|
|
33770
|
+
};
|
|
33705
33771
|
};
|
|
33706
|
-
|
|
33707
|
-
|
|
33708
|
-
|
|
33709
|
-
|
|
33710
|
-
export
|
|
33711
|
-
|
|
33712
|
-
|
|
33713
|
-
}
|
|
33714
|
-
|
|
33715
|
-
|
|
33716
|
-
|
|
33717
|
-
|
|
33718
|
-
|
|
33719
|
-
|
|
33720
|
-
|
|
33721
|
-
|
|
33722
|
-
|
|
33723
|
-
|
|
33724
|
-
|
|
33725
|
-
signIn({ data }: {
|
|
33726
|
-
data: any;
|
|
33727
|
-
}): any;
|
|
33728
|
-
signUp({ data }: {
|
|
33729
|
-
data: any;
|
|
33730
|
-
}): any;
|
|
33772
|
+
};
|
|
33773
|
+
"/data-exports": {
|
|
33774
|
+
/** Retrieve a list of data export requests. */
|
|
33775
|
+
get: operations["GetDataExportCollection"];
|
|
33776
|
+
/** Request a data export of selected resource. */
|
|
33777
|
+
post: operations["PostDataExport"];
|
|
33778
|
+
};
|
|
33779
|
+
"/data-exports/{id}": {
|
|
33780
|
+
/** Retrieve a data export request. */
|
|
33781
|
+
get: operations["GetDataExport"];
|
|
33782
|
+
/** A data export may be changed as long as it is still pending. */
|
|
33783
|
+
put: operations["PutDataExport"];
|
|
33784
|
+
/** Delete an existing data export. */
|
|
33785
|
+
delete: operations["DeleteDataExport"];
|
|
33786
|
+
parameters: {
|
|
33787
|
+
path: {
|
|
33788
|
+
/** The resource identifier string. */
|
|
33789
|
+
id: reportsComponents["parameters"]["resourceId"];
|
|
33790
|
+
};
|
|
33731
33791
|
};
|
|
33732
|
-
}
|
|
33733
|
-
|
|
33734
|
-
|
|
33735
|
-
|
|
33736
|
-
|
|
33737
|
-
|
|
33738
|
-
|
|
33739
|
-
|
|
33740
|
-
|
|
33741
|
-
|
|
33742
|
-
|
|
33792
|
+
};
|
|
33793
|
+
"/histograms/transactions": {
|
|
33794
|
+
/** Get Transaction histogram report data. */
|
|
33795
|
+
get: operations["GetHistogramTransactionReport"];
|
|
33796
|
+
};
|
|
33797
|
+
"/reports/api-log-summary": {
|
|
33798
|
+
/** Retrieve a API Log Summary Report. */
|
|
33799
|
+
get: operations["GetApiLogSummaryReport"];
|
|
33800
|
+
};
|
|
33801
|
+
"/reports/cumulative-subscriptions": {
|
|
33802
|
+
/** Retrieve a cumulative subscriptions report. */
|
|
33803
|
+
get: operations["GetCumulativeSubscriptionReport"];
|
|
33804
|
+
};
|
|
33805
|
+
"/reports/dashboard": {
|
|
33806
|
+
/** Retrieve dashboard data. */
|
|
33807
|
+
get: operations["GetDashboardReport"];
|
|
33808
|
+
};
|
|
33809
|
+
"/reports/dcc-markup": {
|
|
33810
|
+
/** Retrieve a DCC markup report. */
|
|
33811
|
+
get: operations["GetDccMarkupReport"];
|
|
33812
|
+
};
|
|
33813
|
+
"/reports/disputes": {
|
|
33814
|
+
/** Retrieve a disputes report. */
|
|
33815
|
+
get: operations["GetDisputeReport"];
|
|
33816
|
+
};
|
|
33817
|
+
"/reports/events-triggered": {
|
|
33818
|
+
/** Retrieve a events triggered summary report. */
|
|
33819
|
+
get: operations["GetTriggeredEventReport"];
|
|
33820
|
+
};
|
|
33821
|
+
"/reports/events-triggered/{eventType}/rules": {
|
|
33822
|
+
/** Retrieve a rules matched summary report by events triggered. */
|
|
33823
|
+
get: operations["GetTriggeredEventRuleReport"];
|
|
33824
|
+
parameters: {
|
|
33825
|
+
path: {
|
|
33826
|
+
/** The system event type. */
|
|
33827
|
+
eventType: reportsComponents["schemas"]["EventType"];
|
|
33828
|
+
};
|
|
33743
33829
|
};
|
|
33744
|
-
}
|
|
33745
|
-
|
|
33746
|
-
|
|
33747
|
-
|
|
33748
|
-
|
|
33749
|
-
|
|
33750
|
-
|
|
33751
|
-
|
|
33752
|
-
|
|
33753
|
-
|
|
33754
|
-
|
|
33755
|
-
|
|
33756
|
-
|
|
33757
|
-
|
|
33758
|
-
|
|
33759
|
-
|
|
33830
|
+
};
|
|
33831
|
+
"/reports/future-renewals": {
|
|
33832
|
+
/** Retrieve a future renewals report. */
|
|
33833
|
+
get: operations["GetFutureRenewalReport"];
|
|
33834
|
+
};
|
|
33835
|
+
"/reports/kyc-acceptance-summary": {
|
|
33836
|
+
/** Retrieve a KYC acceptance summary report. */
|
|
33837
|
+
get: operations["GetKycAcceptanceSummaryReport"];
|
|
33838
|
+
};
|
|
33839
|
+
"/reports/kyc-rejection-summary": {
|
|
33840
|
+
/** Retrieve a KYC rejection report by type and by rejection reasons. */
|
|
33841
|
+
get: operations["GetKycRejectionSummaryReport"];
|
|
33842
|
+
};
|
|
33843
|
+
"/reports/kyc-request-summary": {
|
|
33844
|
+
/** Retrieve a KYC request report by type and by rejection reasons. */
|
|
33845
|
+
get: operations["GetKycRequestSummaryReport"];
|
|
33846
|
+
};
|
|
33847
|
+
"/reports/monthly-recurring-revenue": {
|
|
33848
|
+
/** Retrieve a monthly recurring revenue report. */
|
|
33849
|
+
get: operations["GetMonthlyRecurringRevenueReport"];
|
|
33850
|
+
};
|
|
33851
|
+
"/reports/renewal-sales": {
|
|
33852
|
+
/** Retrieve a renewal sales report. */
|
|
33853
|
+
get: operations["GetRenewalSaleReport"];
|
|
33854
|
+
};
|
|
33855
|
+
"/reports/retention-percentage": {
|
|
33856
|
+
/** Retrieve a retention percentage report. */
|
|
33857
|
+
get: operations["GetRetentionPercentageReport"];
|
|
33858
|
+
};
|
|
33859
|
+
"/reports/retention-value": {
|
|
33860
|
+
/**
|
|
33861
|
+
* The retention value report shows the count of new customers.
|
|
33862
|
+
* per aggregation bucket and the corresponding per customer value over time.
|
|
33863
|
+
*/
|
|
33864
|
+
get: operations["GetRetentionValueReport"];
|
|
33865
|
+
};
|
|
33866
|
+
"/reports/revenue-waterfall": {
|
|
33867
|
+
/** Retrieve a revenue waterfall report. */
|
|
33868
|
+
get: operations["GetRevenueWaterfallReport"];
|
|
33869
|
+
};
|
|
33870
|
+
"/reports/subscription-cancellation": {
|
|
33871
|
+
/** Retrieve transactions with their plan data. */
|
|
33872
|
+
get: operations["GetSubscriptionCancellationReport"];
|
|
33873
|
+
};
|
|
33874
|
+
"/reports/subscription-renewal": {
|
|
33875
|
+
/** Retrieve a subscription renewal report. */
|
|
33876
|
+
get: operations["GetSubscriptionRenewalReport"];
|
|
33877
|
+
};
|
|
33878
|
+
"/reports/time-series-transaction": {
|
|
33879
|
+
/** Retrieve a transactions report aggregated by time periods. */
|
|
33880
|
+
get: operations["GetTimeSeriesTransactionReport"];
|
|
33881
|
+
};
|
|
33882
|
+
"/reports/transactions-time-dispute": {
|
|
33883
|
+
/** Retrieve a dispute delays in days report, how much time between a. transaction and a dispute. */
|
|
33884
|
+
get: operations["GetTransactionTimeDisputeReport"];
|
|
33885
|
+
};
|
|
33886
|
+
"/reports/transactions": {
|
|
33887
|
+
/** Retrieve a transactions report. */
|
|
33888
|
+
get: operations["GetTransactionReport"];
|
|
33889
|
+
};
|
|
33890
|
+
"/subscriptions/{subscriptionId}/summary-metrics": {
|
|
33891
|
+
/** Retrieve subscription order summary metrics. */
|
|
33892
|
+
get: operations["GetSubscriptionSummaryMetricReport"];
|
|
33893
|
+
parameters: {
|
|
33894
|
+
path: {
|
|
33895
|
+
/** Order's ID. */
|
|
33896
|
+
subscriptionId: string;
|
|
33897
|
+
};
|
|
33898
|
+
};
|
|
33899
|
+
};
|
|
33900
|
+
}
|
|
33901
|
+
|
|
33902
|
+
export interface reportsComponents {
|
|
33903
|
+
schemas: {
|
|
33904
|
+
Link: {
|
|
33905
|
+
/** The link URL. */
|
|
33906
|
+
href: string;
|
|
33907
|
+
};
|
|
33908
|
+
/** The resource ID. Defaults to UUID v4. */
|
|
33909
|
+
ResourceId: string;
|
|
33910
|
+
/** Read-only timestamp, automatically assigned on back-end. */
|
|
33911
|
+
ServerTimestamp: string;
|
|
33912
|
+
/** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
|
|
33913
|
+
BaseProblem: {
|
|
33914
|
+
/** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
|
|
33915
|
+
type?: string;
|
|
33916
|
+
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
33917
|
+
title?: string;
|
|
33918
|
+
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
33919
|
+
detail?: string;
|
|
33920
|
+
/** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
|
|
33921
|
+
instance?: string;
|
|
33922
|
+
} & { [key: string]: any };
|
|
33923
|
+
Unauthorized: { [key: string]: any } & {
|
|
33924
|
+
/** The HTTP status code. */
|
|
33925
|
+
status?: number;
|
|
33926
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
33927
|
+
Forbidden: { [key: string]: any } & {
|
|
33928
|
+
/** The HTTP status code. */
|
|
33929
|
+
status?: number;
|
|
33930
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
33931
|
+
ValidationError: { [key: string]: any } & {
|
|
33932
|
+
/** The HTTP status code. */
|
|
33933
|
+
status?: number;
|
|
33934
|
+
} & reportsComponents["schemas"]["BaseProblem"] & {
|
|
33935
|
+
invalidFields?: {
|
|
33936
|
+
/** The field name. Dot notation is used for nested object field names. */
|
|
33937
|
+
field?: string;
|
|
33938
|
+
message?: string;
|
|
33939
|
+
}[];
|
|
33940
|
+
};
|
|
33941
|
+
NotFound: {
|
|
33942
|
+
/** The HTTP status code. */
|
|
33943
|
+
status?: number;
|
|
33944
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
33945
|
+
/** ISO 4217 alphabetic currency code. */
|
|
33946
|
+
CurrencyCode: string;
|
|
33947
|
+
KycDocumentTypes:
|
|
33948
|
+
| "identity-proof"
|
|
33949
|
+
| "address-proof"
|
|
33950
|
+
| "funds-proof"
|
|
33951
|
+
| "purchase-proof"
|
|
33952
|
+
| "credit-file-proof";
|
|
33953
|
+
KycDocumentRejectionReasonTypes:
|
|
33954
|
+
| "document-unreadable"
|
|
33955
|
+
| "document-expired"
|
|
33956
|
+
| "document-not-matching"
|
|
33957
|
+
| "underage-person"
|
|
33958
|
+
| "third-party-or-mismatch"
|
|
33959
|
+
| "expiration-date-missing"
|
|
33960
|
+
| "issue-date-missing"
|
|
33961
|
+
| "dob-mismatch"
|
|
33962
|
+
| "name-mismatch"
|
|
33963
|
+
| "other";
|
|
33964
|
+
/** Rebilly event type. */
|
|
33965
|
+
EventType:
|
|
33966
|
+
| "account-password-reset-requested"
|
|
33967
|
+
| "account-verification-requested"
|
|
33968
|
+
| "aml-list-possibly-matched"
|
|
33969
|
+
| "application-instance-disabled"
|
|
33970
|
+
| "application-instance-enabled"
|
|
33971
|
+
| "balance-transaction-settled"
|
|
33972
|
+
| "customer-created"
|
|
33973
|
+
| "customer-one-time-password-requested"
|
|
33974
|
+
| "dispute-created"
|
|
33975
|
+
| "dispute-modified"
|
|
33976
|
+
| "experian-check-performed"
|
|
33977
|
+
| "gateway-account-downtime-ended"
|
|
33978
|
+
| "gateway-account-downtime-started"
|
|
33979
|
+
| "gateway-account-limit-reached"
|
|
33980
|
+
| "gateway-account-onboarding-completed"
|
|
33981
|
+
| "gateway-account-onboarding-failed"
|
|
33982
|
+
| "gateway-account-requested"
|
|
33983
|
+
| "invoice-issued"
|
|
33984
|
+
| "invoice-paid"
|
|
33985
|
+
| "invoice-partially-paid"
|
|
33986
|
+
| "invoice-partially-refunded"
|
|
33987
|
+
| "invoice-past-due"
|
|
33988
|
+
| "invoice-past-due-reminder"
|
|
33989
|
+
| "invoice-refunded"
|
|
33990
|
+
| "invoice-revenue-recognized"
|
|
33991
|
+
| "invoice-tax-calculation-failed"
|
|
33992
|
+
| "kyc-document-accepted"
|
|
33993
|
+
| "kyc-document-modified"
|
|
33994
|
+
| "kyc-document-rejected"
|
|
33995
|
+
| "kyc-request-fulfilled"
|
|
33996
|
+
| "nsf-response-received"
|
|
33997
|
+
| "order-completed"
|
|
33998
|
+
| "payment-card-created"
|
|
33999
|
+
| "payment-card-expiration-reminder"
|
|
34000
|
+
| "payment-card-expired"
|
|
34001
|
+
| "ready-to-pay-requested"
|
|
34002
|
+
| "renewal-invoice-issued"
|
|
34003
|
+
| "renewal-invoice-payment-canceled"
|
|
34004
|
+
| "renewal-invoice-payment-declined"
|
|
34005
|
+
| "risk-score-changed"
|
|
34006
|
+
| "subscription-activated"
|
|
34007
|
+
| "subscription-canceled"
|
|
34008
|
+
| "subscription-created"
|
|
34009
|
+
| "subscription-downgraded"
|
|
34010
|
+
| "subscription-modified"
|
|
34011
|
+
| "subscription-paused"
|
|
34012
|
+
| "subscription-pause-created"
|
|
34013
|
+
| "subscription-pause-modified"
|
|
34014
|
+
| "subscription-pause-revoked"
|
|
34015
|
+
| "subscription-reactivated"
|
|
34016
|
+
| "subscription-renewal-reminder"
|
|
34017
|
+
| "subscription-renewed"
|
|
34018
|
+
| "subscription-resumed"
|
|
34019
|
+
| "subscription-trial-converted"
|
|
34020
|
+
| "subscription-trial-end-changed"
|
|
34021
|
+
| "subscription-trial-end-reminder"
|
|
34022
|
+
| "subscription-upgraded"
|
|
34023
|
+
| "transaction-amount-discrepancy-found"
|
|
34024
|
+
| "transaction-declined"
|
|
34025
|
+
| "transaction-discrepancy-found"
|
|
34026
|
+
| "transaction-process-requested"
|
|
34027
|
+
| "transaction-processed";
|
|
34028
|
+
LinkSelf: reportsComponents["schemas"]["Link"] & {
|
|
34029
|
+
/** The link type. */
|
|
34030
|
+
rel: "self";
|
|
34031
|
+
};
|
|
34032
|
+
LinkUser: reportsComponents["schemas"]["Link"] & {
|
|
34033
|
+
/** The link type. */
|
|
34034
|
+
rel: "user";
|
|
34035
|
+
};
|
|
34036
|
+
CustomerInformation: {
|
|
34037
|
+
/** Currency (three letter ISO 4217 alpha code). For example, USD, EUR. */
|
|
34038
|
+
currency?: string;
|
|
34039
|
+
/** Sum of all refunded transactions. */
|
|
34040
|
+
refundsAmount?: number;
|
|
34041
|
+
/** Sum of overall sales and captures that were approved. */
|
|
34042
|
+
revenueAmount?: number;
|
|
34043
|
+
/** Sum of all disputed transactions. */
|
|
34044
|
+
disputesAmount?: number;
|
|
34045
|
+
};
|
|
34046
|
+
DataExport: {
|
|
34047
|
+
/** The export identifier string. */
|
|
34048
|
+
id?: reportsComponents["schemas"]["ResourceId"];
|
|
34049
|
+
/** Export name. */
|
|
34050
|
+
name: string;
|
|
34051
|
+
/** The type of resource being exported (e.g. transactions). */
|
|
34052
|
+
resource:
|
|
34053
|
+
| "transactions"
|
|
34054
|
+
| "customers"
|
|
34055
|
+
| "subscriptions"
|
|
34056
|
+
| "invoices"
|
|
34057
|
+
| "invoiceItems";
|
|
34058
|
+
/** Export result format. */
|
|
34059
|
+
format: "csv" | "json" | "json-api" | "xml" | "pdf";
|
|
34060
|
+
/** Export request arguments that can be passed to filter and/or sort the result set. See the [arguments guide](https://docs-reconciliation.rebilly.com/getting-started/arguments) for more options and examples. */
|
|
34061
|
+
arguments?: {
|
|
34062
|
+
/** The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. */
|
|
34063
|
+
filter?: string;
|
|
34064
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
34065
|
+
sort?: string;
|
|
34066
|
+
/** The partial search of the text fields. */
|
|
34067
|
+
q?: string;
|
|
34068
|
+
};
|
|
34069
|
+
/** The date range (can be in relative formats). If omitted, all time will be included. See the [Date Range guide](https://docs-reconciliation.rebilly.com/getting-started/date-range) for more options and examples. */
|
|
34070
|
+
dateRange?: {
|
|
34071
|
+
/** Any valid datetime arguments including [relative datetime arguments](http://php.net/manual/en/datetime.formats.php). */
|
|
34072
|
+
start: string;
|
|
34073
|
+
/** Any valid datetime arguments including [relative datetime arguments](http://php.net/manual/en/datetime.formats.php). */
|
|
34074
|
+
end: string;
|
|
34075
|
+
/** The field to apply date range to. */
|
|
34076
|
+
field?: string;
|
|
34077
|
+
};
|
|
34078
|
+
/** List of emails to be notified when export is completed. */
|
|
34079
|
+
emailNotification?: string[];
|
|
34080
|
+
/** List of fields to include in the export. See supporting documentation for more info. If omitted, default fields will be included. */
|
|
34081
|
+
fields?: string[];
|
|
34082
|
+
/** Exports can reoccur according to your own schedule. */
|
|
34083
|
+
recurring?: {
|
|
34084
|
+
/** RRule RFC 5545 formatted string used for recurring exports. */
|
|
34085
|
+
instruction: string;
|
|
34086
|
+
/** The date and time when the first recurring scheduled export will occur. Defaults to now. */
|
|
34087
|
+
start?: string;
|
|
34088
|
+
};
|
|
34089
|
+
/** The ID of the User who requested the data export. */
|
|
34090
|
+
userId?: string;
|
|
34091
|
+
/** The number of records in the export (excluding the header row). */
|
|
34092
|
+
recordCount?: number;
|
|
34093
|
+
/** The date and time this data export is scheduled to generate a file. */
|
|
34094
|
+
scheduledTime?: reportsComponents["schemas"]["ServerTimestamp"];
|
|
34095
|
+
/** The time the data export was requested. */
|
|
34096
|
+
createdTime?: reportsComponents["schemas"]["ServerTimestamp"];
|
|
34097
|
+
/** Data export updated time. */
|
|
34098
|
+
updatedTime?: reportsComponents["schemas"]["ServerTimestamp"];
|
|
34099
|
+
/** Status of export request. */
|
|
34100
|
+
status?: "pending" | "queued" | "processing" | "completed";
|
|
34101
|
+
/** The links related to resource. */
|
|
34102
|
+
_links?: (Partial<reportsComponents["schemas"]["LinkSelf"]> &
|
|
34103
|
+
Partial<reportsComponents["schemas"]["LinkUser"]> &
|
|
34104
|
+
Partial<reportsComponents["schemas"]["LinkFileDownload"]> &
|
|
34105
|
+
Partial<reportsComponents["schemas"]["LinkSignedLink"]>)[];
|
|
34106
|
+
};
|
|
34107
|
+
/** Customers resource type to export. */
|
|
34108
|
+
customers: reportsComponents["schemas"]["DataExport"] & {
|
|
34109
|
+
dateRange?: {
|
|
34110
|
+
field: string;
|
|
34111
|
+
};
|
|
34112
|
+
};
|
|
34113
|
+
/** Orders resource type to export. */
|
|
34114
|
+
subscriptions: reportsComponents["schemas"]["DataExport"] & {
|
|
34115
|
+
dateRange?: {
|
|
34116
|
+
field: string;
|
|
34117
|
+
};
|
|
34118
|
+
};
|
|
34119
|
+
/** Transactions resource type to export. */
|
|
34120
|
+
transactions: reportsComponents["schemas"]["DataExport"] & {
|
|
34121
|
+
dateRange?: {
|
|
34122
|
+
field: string;
|
|
34123
|
+
};
|
|
34124
|
+
};
|
|
34125
|
+
/** Invoices resource type to export. */
|
|
34126
|
+
invoices: reportsComponents["schemas"]["DataExport"] & {
|
|
34127
|
+
dateRange?: {
|
|
34128
|
+
field: string;
|
|
34129
|
+
};
|
|
34130
|
+
};
|
|
34131
|
+
/** Invoice items resource type to export. */
|
|
34132
|
+
invoiceItems: reportsComponents["schemas"]["DataExport"] & {
|
|
34133
|
+
dateRange?: {
|
|
34134
|
+
field: string;
|
|
34135
|
+
};
|
|
34136
|
+
};
|
|
34137
|
+
LinkFileDownload: reportsComponents["schemas"]["Link"] & {
|
|
34138
|
+
/** The link type. */
|
|
34139
|
+
rel: "download";
|
|
34140
|
+
};
|
|
34141
|
+
LinkSignedLink: reportsComponents["schemas"]["Link"] & {
|
|
34142
|
+
/** The link type. */
|
|
34143
|
+
rel: "signedLink";
|
|
34144
|
+
};
|
|
34145
|
+
HistogramData: {
|
|
34146
|
+
data?: {
|
|
34147
|
+
/** Entry date-time. */
|
|
34148
|
+
date?: string;
|
|
34149
|
+
/** Entry value. */
|
|
34150
|
+
value?: number;
|
|
34151
|
+
}[];
|
|
34152
|
+
};
|
|
34153
|
+
APILogSummary: {
|
|
34154
|
+
data?: {
|
|
34155
|
+
/** Route string pattern. */
|
|
34156
|
+
route?: string;
|
|
34157
|
+
/** Total count of requests. */
|
|
34158
|
+
total?: number;
|
|
34159
|
+
/** Count of GET requests. */
|
|
34160
|
+
get?: number;
|
|
34161
|
+
/** Count of POST requests. */
|
|
34162
|
+
post?: number;
|
|
34163
|
+
/** Count of PUT requests. */
|
|
34164
|
+
put?: number;
|
|
34165
|
+
/** Count of PATCH requests. */
|
|
34166
|
+
patch?: number;
|
|
34167
|
+
/** Count of DELETE requests. */
|
|
34168
|
+
delete?: number;
|
|
34169
|
+
/** Count of HEAD requests. */
|
|
34170
|
+
head?: number;
|
|
34171
|
+
/** Count of OPTIONS requests. */
|
|
34172
|
+
options?: number;
|
|
34173
|
+
}[];
|
|
34174
|
+
};
|
|
34175
|
+
CumulativeSubscriptions: {
|
|
34176
|
+
data?: {
|
|
34177
|
+
/** Date in format YYYY-MM (monthly aggregation) or YYYY-MM-DD (daily aggregation). */
|
|
34178
|
+
aggregationValue?: string;
|
|
34179
|
+
/** Number of new subscriptions within the aggregation. */
|
|
34180
|
+
newCount?: number;
|
|
34181
|
+
/** Number of canceled subscriptions within the aggregation. */
|
|
34182
|
+
canceledCount?: number;
|
|
34183
|
+
/**
|
|
34184
|
+
* Number of cumulative subscriptions from the previous aggregation +
|
|
34185
|
+
* number of new subscriptions - number of canceled subscriptions within the aggregation.
|
|
34186
|
+
*/
|
|
34187
|
+
cumulativeCount?: number;
|
|
34188
|
+
}[];
|
|
34189
|
+
};
|
|
34190
|
+
DashboardResponse: {
|
|
34191
|
+
/** Metric type. */
|
|
34192
|
+
metric?:
|
|
34193
|
+
| "approvalRate"
|
|
34194
|
+
| "salesCount"
|
|
34195
|
+
| "salesValue"
|
|
34196
|
+
| "refundsValue"
|
|
34197
|
+
| "chargebacksCount"
|
|
34198
|
+
| "chargebacksValue"
|
|
34199
|
+
| "transactionsCount"
|
|
34200
|
+
| "redeemedCouponsCount"
|
|
34201
|
+
| "newLeadsCount"
|
|
34202
|
+
| "newCustomersCount"
|
|
34203
|
+
| "appliedCouponsCount"
|
|
34204
|
+
| "trialConversionsCount"
|
|
34205
|
+
| "trialConversionsRate"
|
|
34206
|
+
| "renewalSuccessRate"
|
|
34207
|
+
| "renewalsCount"
|
|
34208
|
+
| "newTrialsCount"
|
|
34209
|
+
| "reactivationsCount"
|
|
34210
|
+
| "successfulRetriesCount"
|
|
34211
|
+
| "invoicedRevenue"
|
|
34212
|
+
| "churnCount"
|
|
34213
|
+
| "churnRate"
|
|
34214
|
+
| "cancellationsCount"
|
|
34215
|
+
| "cancellationsRate"
|
|
34216
|
+
| "activeSubscriptionsCount"
|
|
34217
|
+
| "newSubscriptionsCount"
|
|
34218
|
+
| "upgradesCount"
|
|
34219
|
+
| "downgradesCount"
|
|
34220
|
+
| "monthlyRecurringRevenue";
|
|
34221
|
+
/** Metric name to display. */
|
|
34222
|
+
humanName?: string;
|
|
34223
|
+
/** True when the higher value means a better performance thus positive for a merchant, false otherwise. */
|
|
34224
|
+
increaseIsGood?: boolean;
|
|
34225
|
+
segments?: {
|
|
34226
|
+
/** Segment name. */
|
|
34227
|
+
name?: string;
|
|
34228
|
+
/** Segment value for the given date range. */
|
|
34229
|
+
value?: number;
|
|
34230
|
+
/** Segment value for the previous date range (relative to the given date range). */
|
|
34231
|
+
previousValue?: number;
|
|
34232
|
+
/** Human readable segment value (formatted with a currency sign). */
|
|
34233
|
+
humanValue?: string;
|
|
34234
|
+
/** Ratio of current value per previous value null is infinity. */
|
|
34235
|
+
changeRatio?: number;
|
|
34236
|
+
/** Human readable change ratio (formatted percentage with a "%" sign), null is infinity. */
|
|
34237
|
+
humanChangeRatio?: string;
|
|
34238
|
+
timeseries?: {
|
|
34239
|
+
/** Entry date-time. */
|
|
34240
|
+
date?: string;
|
|
34241
|
+
/** Entry value. */
|
|
34242
|
+
value?: number;
|
|
34243
|
+
}[];
|
|
34244
|
+
}[];
|
|
34245
|
+
}[];
|
|
34246
|
+
DccMarkup: {
|
|
34247
|
+
data?: {
|
|
34248
|
+
/** Value by which the report provides aggregated data. The date values are displayed as following: Day: YYYY-MM-DD; Month: YYYY-MM. */
|
|
34249
|
+
aggregationValue?: string;
|
|
34250
|
+
/** Number of selected offers in the aggregation. */
|
|
34251
|
+
selectedCount?: number;
|
|
34252
|
+
/** Amount of selected offers in the aggregation. */
|
|
34253
|
+
selectedSum?: number;
|
|
34254
|
+
/** Number of rejected offers in the aggregation. */
|
|
34255
|
+
rejectedCount?: number;
|
|
34256
|
+
/** Amount of rejected offers in the aggregation. */
|
|
34257
|
+
rejectedSum?: number;
|
|
34258
|
+
/** Number of offers in the aggregation which weren't selected nor rejected. */
|
|
34259
|
+
unknownCount?: number;
|
|
34260
|
+
/** Amount of offers in the aggregation which weren't selected nor rejected. */
|
|
34261
|
+
unknownSum?: number;
|
|
34262
|
+
}[];
|
|
34263
|
+
};
|
|
34264
|
+
ReportDisputes: {
|
|
34265
|
+
data?: {
|
|
34266
|
+
/**
|
|
34267
|
+
* Selected aggregation field value (defined by query). It can be, for example, website or country.
|
|
34268
|
+
* You define it in aggregationField param in query.
|
|
34269
|
+
*/
|
|
34270
|
+
aggregationValue?: string;
|
|
34271
|
+
/** Disputes count on Visa. */
|
|
34272
|
+
countVisa?: number;
|
|
34273
|
+
/** Disputes count / Settled transactions count. */
|
|
34274
|
+
ratioCountVisa?: number;
|
|
34275
|
+
/** Disputes amount / Settled transactions amount. */
|
|
34276
|
+
ratioAmountVisa?: number;
|
|
34277
|
+
/** Disputes count on Mastercard. */
|
|
34278
|
+
countMastercard?: number;
|
|
34279
|
+
/** Disputes count / Settled transactions count. */
|
|
34280
|
+
ratioCountMastercard?: number;
|
|
34281
|
+
/** Disputes amount / Settled transactions amount. */
|
|
34282
|
+
ratioAmountMastercard?: number;
|
|
34283
|
+
}[];
|
|
34284
|
+
};
|
|
34285
|
+
ReportEventsTriggeredSummary: {
|
|
34286
|
+
data?: {
|
|
34287
|
+
/** System event name. */
|
|
34288
|
+
eventName?:
|
|
34289
|
+
| "dispute-created"
|
|
34290
|
+
| "gateway-account-requested"
|
|
34291
|
+
| "transaction-processed"
|
|
34292
|
+
| "subscription-canceled"
|
|
34293
|
+
| "subscription-renewed"
|
|
34294
|
+
| "payment-card-expired"
|
|
34295
|
+
| "payment-declined"
|
|
34296
|
+
| "transaction-process-requested"
|
|
34297
|
+
| "risk-score-changed";
|
|
34298
|
+
/** Count of event triggered. */
|
|
34299
|
+
count?: number;
|
|
34300
|
+
}[];
|
|
34301
|
+
};
|
|
34302
|
+
ReportRulesMatchedSummary: {
|
|
34303
|
+
data?: {
|
|
34304
|
+
/** Rule matched name. */
|
|
34305
|
+
rule?: string;
|
|
34306
|
+
/** Count of matched rule. */
|
|
34307
|
+
count?: number;
|
|
34308
|
+
/** Transaction approval rate by rule. */
|
|
34309
|
+
approvalRate?: number;
|
|
34310
|
+
}[];
|
|
34311
|
+
};
|
|
34312
|
+
FutureRenewals: {
|
|
34313
|
+
data?: {
|
|
34314
|
+
/** Date in format YYYY-MM. */
|
|
34315
|
+
date?: string;
|
|
34316
|
+
/** Amount of future renewals in user's reporting currency. */
|
|
34317
|
+
sum?: number;
|
|
34318
|
+
plansCount?: {
|
|
34319
|
+
/** Plan identifier. */
|
|
34320
|
+
planId?: reportsComponents["schemas"]["ResourceId"];
|
|
34321
|
+
/** Amount of plan's future renewals. */
|
|
34322
|
+
count?: number;
|
|
34323
|
+
}[];
|
|
34324
|
+
}[];
|
|
34325
|
+
};
|
|
34326
|
+
ReportKycRejections: {
|
|
34327
|
+
data?: {
|
|
34328
|
+
documentType?: reportsComponents["schemas"]["KycDocumentTypes"];
|
|
34329
|
+
rejectionReasons?: {
|
|
34330
|
+
rejectionReason?: reportsComponents["schemas"]["KycDocumentRejectionReasonTypes"];
|
|
34331
|
+
/** Number of related KYC documents. */
|
|
34332
|
+
count?: number;
|
|
34333
|
+
}[];
|
|
34334
|
+
}[];
|
|
34335
|
+
};
|
|
34336
|
+
KycDocumentRequestStatuses:
|
|
34337
|
+
| "abandoned"
|
|
34338
|
+
| "expired"
|
|
34339
|
+
| "failed"
|
|
34340
|
+
| "fulfilled"
|
|
34341
|
+
| "pending-review";
|
|
34342
|
+
ReportKycRequests: {
|
|
34343
|
+
data?: {
|
|
34344
|
+
rejectionReason?: reportsComponents["schemas"]["KycDocumentRequestStatuses"];
|
|
34345
|
+
/** Number of related KYC requests. */
|
|
34346
|
+
count?: number;
|
|
34347
|
+
}[];
|
|
34348
|
+
};
|
|
34349
|
+
ReportMonthlyRecurringRevenue: {
|
|
34350
|
+
data?: {
|
|
34351
|
+
/** Revenue month. */
|
|
34352
|
+
period?: string;
|
|
34353
|
+
/** Total Monthly Recurring Revenue (MRR) amount. */
|
|
34354
|
+
total?: number;
|
|
34355
|
+
/**
|
|
34356
|
+
* MRR categories are described below.
|
|
34357
|
+
* The difference between current period MRR and previous period MRR is equal to `new + reactivated + expanded - contracted - churned`.
|
|
34358
|
+
*/
|
|
34359
|
+
breakdown?: {
|
|
34360
|
+
/**
|
|
34361
|
+
* MRR of new customers.
|
|
34362
|
+
* Example: A new customer signs up to a $40 per month plan. This is $40 in new MRR.
|
|
34363
|
+
*/
|
|
34364
|
+
new?: number;
|
|
34365
|
+
/**
|
|
34366
|
+
* A previous customer stops being a customer for a period.
|
|
34367
|
+
* The same customer signs up again and purchases a $25 per month plan. This is reactivation MRR of $25.
|
|
34368
|
+
*/
|
|
34369
|
+
reactivation?: number;
|
|
34370
|
+
/**
|
|
34371
|
+
* A customer decides to cancel.
|
|
34372
|
+
* The subscription churns, the customer goes from $80 per month to $0 per month. This is $80 of churned MRR.
|
|
34373
|
+
*/
|
|
34374
|
+
churned?: number;
|
|
34375
|
+
/**
|
|
34376
|
+
* Existing customers who changed items which resulted in a smaller MRR. Contraction MRR is the difference.
|
|
34377
|
+
* Example: A customer at $100 in MRR changes to $80 in MRR. This contraction MRR is $20.
|
|
34378
|
+
*/
|
|
34379
|
+
contraction?: number;
|
|
34380
|
+
/**
|
|
34381
|
+
* Existing customers who changed items which resulted in a bigger MRR.
|
|
34382
|
+
* Example: A customer upgrades from a plan that is $40 per month to a plan that is $100 per month. This is an expansion MRR of $60.
|
|
34383
|
+
*/
|
|
34384
|
+
expansion?: number;
|
|
34385
|
+
};
|
|
34386
|
+
}[];
|
|
34387
|
+
};
|
|
34388
|
+
RenewalSales: {
|
|
34389
|
+
data?: {
|
|
34390
|
+
/** Date in format YYYY-MM. */
|
|
34391
|
+
aggregationValue?: string;
|
|
34392
|
+
/** Amount of new sales. */
|
|
34393
|
+
newSales?: number;
|
|
34394
|
+
/** Amount of new refunds. */
|
|
34395
|
+
newRefunds?: number;
|
|
34396
|
+
/** Amount of renewal sales. */
|
|
34397
|
+
renewalSales?: number;
|
|
34398
|
+
/** Amount of renewal refunds. */
|
|
34399
|
+
renewalRefunds?: number;
|
|
34400
|
+
}[];
|
|
34401
|
+
};
|
|
34402
|
+
ReportRetentionPercentage: {
|
|
34403
|
+
data?: {
|
|
34404
|
+
/**
|
|
34405
|
+
* Value by which the report provides retention periods and percentages.
|
|
34406
|
+
* The date values are displayed as following:
|
|
34407
|
+
* Day: YYYY-MM-DD;
|
|
34408
|
+
* Month: YYYY-MM;
|
|
34409
|
+
* Quarter: YYYY-MM/YYYY-MM;
|
|
34410
|
+
* Year: YYYY.
|
|
34411
|
+
*/
|
|
34412
|
+
aggregationValue?: string;
|
|
34413
|
+
/** Number of subscriptions created within the aggregation. */
|
|
34414
|
+
subscriptionsCount?: number;
|
|
34415
|
+
periods?: {
|
|
34416
|
+
/** Retention period (0 - first, 1 - second etc) since the beginning boundary of the aggregation. */
|
|
34417
|
+
period?: number;
|
|
34418
|
+
/** Ratio % of remaining subscriptions (not canceled) at the moment of retention period to all subscriptions created in the aggregation period. */
|
|
34419
|
+
retentionRatio?: number;
|
|
34420
|
+
/** Number of canceled subscriptions within the given retention period. */
|
|
34421
|
+
canceledSubscriptionsCount?: number;
|
|
34422
|
+
}[];
|
|
34423
|
+
}[];
|
|
34424
|
+
};
|
|
34425
|
+
ReportRetentionValue: {
|
|
34426
|
+
data?: {
|
|
34427
|
+
/**
|
|
34428
|
+
* Value by which the report provides retention periods and values. The date values are displayed as following:
|
|
34429
|
+
* Day: YYYY-MM-DD;
|
|
34430
|
+
* Month: YYYY-MM;
|
|
34431
|
+
* Quarter: YYYY-MM/YYYY-MM;
|
|
34432
|
+
* Year: YYYY.
|
|
34433
|
+
*/
|
|
34434
|
+
aggregationValue?: string;
|
|
34435
|
+
/** Number of customers within the aggregation with their first payment. */
|
|
34436
|
+
customersCount?: number;
|
|
34437
|
+
periods?: {
|
|
34438
|
+
/** Retention period (0 - first, 1 - second etc) since the beginning boundary of the aggregation. */
|
|
34439
|
+
period?: number;
|
|
34440
|
+
/** Summary amount of all transactions for all periods up to the current one divided by the aggregation customers number. */
|
|
34441
|
+
retentionAverage?: number;
|
|
34442
|
+
/** The number of transactions happened in the retention period (e.g. in 3 rebills). */
|
|
34443
|
+
transactionsCount?: number;
|
|
34444
|
+
/** The amount of transactions (income transactions - loss transactions). */
|
|
34445
|
+
transactionsValue?: number;
|
|
34446
|
+
}[];
|
|
34447
|
+
}[];
|
|
34448
|
+
};
|
|
34449
|
+
ReportRevenueWaterfall: {
|
|
34450
|
+
/** Revenue invoice issue month. */
|
|
34451
|
+
issuedMonth?: string;
|
|
34452
|
+
/** The revenue amount booked at issue month. */
|
|
34453
|
+
booked?: number;
|
|
34454
|
+
/** The revenue amount regognized up to `recognizedTo` month. */
|
|
34455
|
+
recognized?: number;
|
|
34456
|
+
/** The revenue amount remaining to be recognized after `recognizedTo` month. */
|
|
34457
|
+
remaining?: number;
|
|
34458
|
+
/** Per month recognized revenue waterfall. */
|
|
34459
|
+
waterfall?: {
|
|
34460
|
+
/** Revenue recognition month. */
|
|
34461
|
+
recognizedMonth?: string;
|
|
34462
|
+
/** The revenue amount recognized at `recognizedMonth`. */
|
|
34463
|
+
amount?: number;
|
|
34464
|
+
}[];
|
|
34465
|
+
}[];
|
|
34466
|
+
SubscriptionCancellationReport: {
|
|
34467
|
+
data?: {
|
|
34468
|
+
/** Aggregation value. */
|
|
34469
|
+
aggregationValue?: string;
|
|
34470
|
+
/** Count of canceled subscriptions. */
|
|
34471
|
+
count?: number;
|
|
34472
|
+
/** Average length of canceled subscription from start to end within the aggregation in seconds. */
|
|
34473
|
+
averageLength?: number;
|
|
34474
|
+
/** Median length of canceled subscription from start to end within the aggregation in seconds. */
|
|
34475
|
+
medianLength?: number;
|
|
34476
|
+
}[];
|
|
34477
|
+
};
|
|
34478
|
+
SubscriptionRenewal: {
|
|
34479
|
+
data?: {
|
|
34480
|
+
/** Plan identifier for which subscriptions are counted. */
|
|
34481
|
+
planId?: reportsComponents["schemas"]["ResourceId"];
|
|
34482
|
+
/** All renewed subscriptions number. */
|
|
34483
|
+
allRenewalCount?: number;
|
|
34484
|
+
/** All dunned subscriptions number. */
|
|
34485
|
+
allDunningCount?: number;
|
|
34486
|
+
/** Abandon subscriptions number. */
|
|
34487
|
+
abandonedCount?: number;
|
|
34488
|
+
/** Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal success rate. */
|
|
34489
|
+
paidRenewalCount?: number;
|
|
34490
|
+
/** Number of paid dunned subscriptions. Divide by allDunningCount to know the dun success rate. */
|
|
34491
|
+
paidDunningCount?: number;
|
|
34492
|
+
/** Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal refund rate. */
|
|
34493
|
+
refundedRenewalCount?: number;
|
|
34494
|
+
/** Number of paid dunned subscriptions. Divide by allDunningCount to know the dun refund rate. */
|
|
34495
|
+
refundedDunningCount?: number;
|
|
34496
|
+
/** Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal chargeback rate. */
|
|
34497
|
+
chargebackRenewalCount?: number;
|
|
34498
|
+
/** Number of paid dunned subscriptions. Divide by allDunningCount to know the dun chargeback rate. */
|
|
34499
|
+
chargebackDunningCount?: number;
|
|
34500
|
+
}[];
|
|
34501
|
+
};
|
|
34502
|
+
TimeSeriesTransaction: {
|
|
34503
|
+
data?: {
|
|
34504
|
+
/** Date in format YYYY-MM-DD. */
|
|
34505
|
+
date?: string;
|
|
34506
|
+
/** Amount or count of all transactions within the aggregation. */
|
|
34507
|
+
total?: number;
|
|
34508
|
+
/** Subaggregates which have appropriate transactions within the range. */
|
|
34509
|
+
subaggregates?: {
|
|
34510
|
+
/** Subaggregate identifier. */
|
|
34511
|
+
subaggregate?: string;
|
|
34512
|
+
/** Amount or count of the subaggregate's transactions within the aggregation. */
|
|
34513
|
+
value?: number;
|
|
34514
|
+
};
|
|
34515
|
+
}[];
|
|
34516
|
+
};
|
|
34517
|
+
ReportDisputeDelays: {
|
|
34518
|
+
data?: {
|
|
34519
|
+
/**
|
|
34520
|
+
* Selected aggregation field value (defined by query). It can be, for example, website or country.
|
|
34521
|
+
* You define it in aggregationField param in query.
|
|
34522
|
+
*/
|
|
34523
|
+
aggregationFieldValue?: string;
|
|
34524
|
+
/** 25th percentile. */
|
|
34525
|
+
"25th"?: number;
|
|
34526
|
+
/** 50th percentile. */
|
|
34527
|
+
"50th"?: number;
|
|
34528
|
+
/** 75th percentile. */
|
|
34529
|
+
"75th"?: number;
|
|
34530
|
+
}[];
|
|
34531
|
+
};
|
|
34532
|
+
ReportTransactions: {
|
|
34533
|
+
data?: {
|
|
34534
|
+
/** Selected aggregation field value. */
|
|
34535
|
+
aggregationFieldValue?: string;
|
|
34536
|
+
/** Approved auth transactions to all transactions percentage. */
|
|
34537
|
+
authApprovedThroughput?: number;
|
|
34538
|
+
/** Approved sale transactions to all transactions percentage. */
|
|
34539
|
+
approvedThroughput?: number;
|
|
34540
|
+
/** Approved auth transactions count. */
|
|
34541
|
+
authApprovalCount?: number;
|
|
34542
|
+
/** Disputed transactions to all approved sale and capture transactions percentage. */
|
|
34543
|
+
disputesRate?: number;
|
|
34544
|
+
/** Disputed transactions to all approved sale and capture transactions count. */
|
|
34545
|
+
disputesCount?: number;
|
|
34546
|
+
/** Sales count. */
|
|
34547
|
+
salesCount?: number;
|
|
34548
|
+
/** Sales value. */
|
|
34549
|
+
salesValue?: number;
|
|
34550
|
+
/** Sales average value. */
|
|
34551
|
+
salesAverage?: number;
|
|
34552
|
+
/** Refunds count. */
|
|
34553
|
+
refundsCount?: number;
|
|
34554
|
+
/** Refunds value. */
|
|
34555
|
+
refundsValue?: number;
|
|
34556
|
+
/** Amount. */
|
|
34557
|
+
amount?: number;
|
|
34558
|
+
/** Transactions count. */
|
|
34559
|
+
count?: number;
|
|
34560
|
+
/** Unapproved transactions count. */
|
|
34561
|
+
unapprovedCount?: number;
|
|
34562
|
+
}[];
|
|
34563
|
+
};
|
|
34564
|
+
SubscriptionSummaryMetrics: {
|
|
34565
|
+
/** Currency (three letter ISO 4217 alpha code). */
|
|
34566
|
+
currency?: string;
|
|
34567
|
+
/** Sum of all issued, past due, or paid invoices. */
|
|
34568
|
+
invoicedAmount?: number;
|
|
34569
|
+
/** Sum of all paid invoices. */
|
|
34570
|
+
collectedAmount?: number;
|
|
34571
|
+
/** Number of issued, past due, or paid invoices. */
|
|
34572
|
+
invoiceCount?: number;
|
|
34573
|
+
};
|
|
34574
|
+
};
|
|
34575
|
+
responses: {
|
|
34576
|
+
/** Unauthorized access, invalid credentials were used. */
|
|
34577
|
+
Unauthorized: {
|
|
34578
|
+
content: {
|
|
34579
|
+
"application/json": reportsComponents["schemas"]["Unauthorized"];
|
|
34580
|
+
};
|
|
34581
|
+
};
|
|
34582
|
+
/** Access forbidden. */
|
|
34583
|
+
Forbidden: {
|
|
34584
|
+
content: {
|
|
34585
|
+
"application/json": reportsComponents["schemas"]["Forbidden"];
|
|
34586
|
+
};
|
|
34587
|
+
};
|
|
34588
|
+
/** Invalid data was sent. */
|
|
34589
|
+
ValidationError: {
|
|
34590
|
+
content: {
|
|
34591
|
+
"application/json": reportsComponents["schemas"]["ValidationError"];
|
|
34592
|
+
};
|
|
34593
|
+
};
|
|
34594
|
+
/** Resource was not found. */
|
|
34595
|
+
NotFound: {
|
|
34596
|
+
content: {
|
|
34597
|
+
"application/json": reportsComponents["schemas"]["NotFound"];
|
|
34598
|
+
};
|
|
34599
|
+
};
|
|
34600
|
+
/** Request was accepted, but no response body is returned. */
|
|
34601
|
+
NoContent: unknown;
|
|
34602
|
+
};
|
|
34603
|
+
parameters: {
|
|
34604
|
+
/** The collection items limit. */
|
|
34605
|
+
collectionLimit: number;
|
|
34606
|
+
/** The collection items offset. */
|
|
34607
|
+
collectionOffset: number;
|
|
34608
|
+
/**
|
|
34609
|
+
* The collection items filter requires a special format.
|
|
34610
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
34611
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
34612
|
+
*/
|
|
34613
|
+
collectionFilter: string;
|
|
34614
|
+
/** The partial search of the text fields. */
|
|
34615
|
+
collectionQuery: string;
|
|
34616
|
+
/**
|
|
34617
|
+
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
34618
|
+
* It accepts a comma-separated list of objects to expand.
|
|
34619
|
+
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
34620
|
+
*/
|
|
34621
|
+
collectionExpand: string;
|
|
34622
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
34623
|
+
collectionSort: string[];
|
|
34624
|
+
/** The resource identifier string. */
|
|
34625
|
+
resourceId: string;
|
|
34626
|
+
/** Criteria parameter for requesting a collection. */
|
|
34627
|
+
collectionCriteria: string;
|
|
34628
|
+
};
|
|
34629
|
+
requestBodies: {
|
|
34630
|
+
/** Data Export Request. */
|
|
34631
|
+
DataExport: {
|
|
34632
|
+
content: {
|
|
34633
|
+
"application/json": reportsComponents["schemas"]["DataExport"];
|
|
34634
|
+
};
|
|
34635
|
+
};
|
|
34636
|
+
};
|
|
34637
|
+
headers: {
|
|
34638
|
+
/** Total items count. */
|
|
34639
|
+
"Pagination-Total"?: number;
|
|
34640
|
+
/** Items per page limit. */
|
|
34641
|
+
"Pagination-Limit"?: number;
|
|
34642
|
+
/** Pagination offset. */
|
|
34643
|
+
"Pagination-Offset"?: number;
|
|
34644
|
+
};
|
|
34645
|
+
}
|
|
34646
|
+
|
|
34647
|
+
export interface operations {
|
|
34648
|
+
/** Retrieve customer lifetime summary metrics. */
|
|
34649
|
+
GetCustomerSummaryMetricReport: {
|
|
34650
|
+
parameters: {
|
|
34651
|
+
path: {
|
|
34652
|
+
/** Customer's ID. */
|
|
34653
|
+
customerId: string;
|
|
34654
|
+
};
|
|
34655
|
+
};
|
|
34656
|
+
responses: {
|
|
34657
|
+
/** Metrics were retrieved successfully. */
|
|
34658
|
+
200: {
|
|
34659
|
+
content: {
|
|
34660
|
+
"application/json": reportsComponents["schemas"]["CustomerInformation"];
|
|
34661
|
+
};
|
|
34662
|
+
};
|
|
34663
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34664
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34665
|
+
};
|
|
34666
|
+
};
|
|
34667
|
+
/** Retrieve a list of data export requests. */
|
|
34668
|
+
GetDataExportCollection: {
|
|
34669
|
+
parameters: {
|
|
34670
|
+
query: {
|
|
34671
|
+
/** The collection items limit. */
|
|
34672
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
34673
|
+
/** The collection items offset. */
|
|
34674
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
34675
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
34676
|
+
sort?: reportsComponents["parameters"]["collectionSort"];
|
|
34677
|
+
/**
|
|
34678
|
+
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
34679
|
+
* It accepts a comma-separated list of objects to expand.
|
|
34680
|
+
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
34681
|
+
*/
|
|
34682
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
34683
|
+
/**
|
|
34684
|
+
* The collection items filter requires a special format.
|
|
34685
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
34686
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
34687
|
+
*/
|
|
34688
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
34689
|
+
/** The partial search of the text fields. */
|
|
34690
|
+
q?: reportsComponents["parameters"]["collectionQuery"];
|
|
34691
|
+
/** Criteria parameter for requesting a collection. */
|
|
34692
|
+
criteria?: reportsComponents["parameters"]["collectionCriteria"];
|
|
34693
|
+
};
|
|
34694
|
+
};
|
|
34695
|
+
responses: {
|
|
34696
|
+
/** A list of data export requests was retrieved successfully. */
|
|
34697
|
+
200: {
|
|
34698
|
+
headers: {};
|
|
34699
|
+
content: {
|
|
34700
|
+
"application/json": reportsComponents["schemas"]["DataExport"][];
|
|
34701
|
+
};
|
|
34702
|
+
};
|
|
34703
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34704
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34705
|
+
404: reportsComponents["responses"]["NotFound"];
|
|
34706
|
+
};
|
|
34707
|
+
};
|
|
34708
|
+
/** Request a data export of selected resource. */
|
|
34709
|
+
PostDataExport: {
|
|
34710
|
+
parameters: {
|
|
34711
|
+
query: {
|
|
34712
|
+
/**
|
|
34713
|
+
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
34714
|
+
* It accepts a comma-separated list of objects to expand.
|
|
34715
|
+
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
34716
|
+
*/
|
|
34717
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
34718
|
+
};
|
|
34719
|
+
};
|
|
34720
|
+
responses: {
|
|
34721
|
+
/** Data export request received. */
|
|
34722
|
+
201: {
|
|
34723
|
+
content: {
|
|
34724
|
+
"application/json": reportsComponents["schemas"]["DataExport"];
|
|
34725
|
+
};
|
|
34726
|
+
};
|
|
34727
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34728
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34729
|
+
422: reportsComponents["responses"]["ValidationError"];
|
|
34730
|
+
};
|
|
34731
|
+
requestBody: reportsComponents["requestBodies"]["DataExport"];
|
|
34732
|
+
};
|
|
34733
|
+
/** Retrieve a data export request. */
|
|
34734
|
+
GetDataExport: {
|
|
34735
|
+
parameters: {
|
|
34736
|
+
path: {
|
|
34737
|
+
/** The resource identifier string. */
|
|
34738
|
+
id: reportsComponents["parameters"]["resourceId"];
|
|
34739
|
+
};
|
|
34740
|
+
query: {
|
|
34741
|
+
/**
|
|
34742
|
+
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
34743
|
+
* It accepts a comma-separated list of objects to expand.
|
|
34744
|
+
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
34745
|
+
*/
|
|
34746
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
34747
|
+
};
|
|
34748
|
+
};
|
|
34749
|
+
responses: {
|
|
34750
|
+
/** Data Export request. */
|
|
34751
|
+
200: {
|
|
34752
|
+
headers: {};
|
|
34753
|
+
content: {
|
|
34754
|
+
"application/json": reportsComponents["schemas"]["DataExport"];
|
|
34755
|
+
};
|
|
34756
|
+
};
|
|
34757
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34758
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34759
|
+
404: reportsComponents["responses"]["NotFound"];
|
|
34760
|
+
};
|
|
34761
|
+
};
|
|
34762
|
+
/** A data export may be changed as long as it is still pending. */
|
|
34763
|
+
PutDataExport: {
|
|
34764
|
+
parameters: {
|
|
34765
|
+
path: {
|
|
34766
|
+
/** The resource identifier string. */
|
|
34767
|
+
id: reportsComponents["parameters"]["resourceId"];
|
|
34768
|
+
};
|
|
34769
|
+
query: {
|
|
34770
|
+
/**
|
|
34771
|
+
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
34772
|
+
* It accepts a comma-separated list of objects to expand.
|
|
34773
|
+
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
34774
|
+
*/
|
|
34775
|
+
expand?: reportsComponents["parameters"]["collectionExpand"];
|
|
34776
|
+
};
|
|
34777
|
+
};
|
|
34778
|
+
responses: {
|
|
34779
|
+
/** Data Export was modified. */
|
|
34780
|
+
200: {
|
|
34781
|
+
content: {
|
|
34782
|
+
"application/json": reportsComponents["schemas"]["DataExport"];
|
|
34783
|
+
};
|
|
34784
|
+
};
|
|
34785
|
+
/** Data Export was updated. */
|
|
34786
|
+
201: {
|
|
34787
|
+
content: {
|
|
34788
|
+
"application/json": reportsComponents["schemas"]["DataExport"];
|
|
34789
|
+
};
|
|
34790
|
+
};
|
|
34791
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34792
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34793
|
+
422: reportsComponents["responses"]["ValidationError"];
|
|
34794
|
+
};
|
|
34795
|
+
requestBody: reportsComponents["requestBodies"]["DataExport"];
|
|
34796
|
+
};
|
|
34797
|
+
/** Delete an existing data export. */
|
|
34798
|
+
DeleteDataExport: {
|
|
34799
|
+
parameters: {
|
|
34800
|
+
path: {
|
|
34801
|
+
/** The resource identifier string. */
|
|
34802
|
+
id: reportsComponents["parameters"]["resourceId"];
|
|
34803
|
+
};
|
|
34804
|
+
};
|
|
34805
|
+
responses: {
|
|
34806
|
+
204: reportsComponents["responses"]["NoContent"];
|
|
34807
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34808
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34809
|
+
404: reportsComponents["responses"]["NotFound"];
|
|
34810
|
+
};
|
|
34811
|
+
};
|
|
34812
|
+
/** Get Transaction histogram report data. */
|
|
34813
|
+
GetHistogramTransactionReport: {
|
|
34814
|
+
parameters: {
|
|
34815
|
+
query: {
|
|
34816
|
+
/** Report start day. */
|
|
34817
|
+
periodStart: string;
|
|
34818
|
+
/** Report end day. */
|
|
34819
|
+
periodEnd: string;
|
|
34820
|
+
/** Report aggregation field. */
|
|
34821
|
+
aggregationField:
|
|
34822
|
+
| "website"
|
|
34823
|
+
| "currency"
|
|
34824
|
+
| "bin"
|
|
34825
|
+
| "rebillNumber"
|
|
34826
|
+
| "transactionResult"
|
|
34827
|
+
| "transactionType"
|
|
34828
|
+
| "gatewayAccount"
|
|
34829
|
+
| "leadsAffiliate"
|
|
34830
|
+
| "leadsCampaign"
|
|
34831
|
+
| "leadsContent"
|
|
34832
|
+
| "leadsMedium"
|
|
34833
|
+
| "leadsSalesAgent"
|
|
34834
|
+
| "leadsSource"
|
|
34835
|
+
| "leadsSubAffiliate"
|
|
34836
|
+
| "leadsTerm";
|
|
34837
|
+
/** Report aggregation period. */
|
|
34838
|
+
aggregationPeriod: "hour" | "day" | "month";
|
|
34839
|
+
/** Report metric. */
|
|
34840
|
+
metric:
|
|
34841
|
+
| "ApprovalThroughput"
|
|
34842
|
+
| "AuthApprovalThroughput"
|
|
34843
|
+
| "AvgSalesPrice"
|
|
34844
|
+
| "Refunds"
|
|
34845
|
+
| "RefundCount"
|
|
34846
|
+
| "Sales"
|
|
34847
|
+
| "SalesCount"
|
|
34848
|
+
| "UnapprovedCount";
|
|
34849
|
+
/**
|
|
34850
|
+
* The collection items filter requires a special format.
|
|
34851
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
34852
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
34853
|
+
*/
|
|
34854
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
34855
|
+
};
|
|
34856
|
+
};
|
|
34857
|
+
responses: {
|
|
34858
|
+
/** Transaction report was retrieved successfully. */
|
|
34859
|
+
200: {
|
|
34860
|
+
content: {
|
|
34861
|
+
"application/json": reportsComponents["schemas"]["HistogramData"];
|
|
34862
|
+
};
|
|
34863
|
+
};
|
|
34864
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34865
|
+
};
|
|
34866
|
+
};
|
|
34867
|
+
/** Retrieve a API Log Summary Report. */
|
|
34868
|
+
GetApiLogSummaryReport: {
|
|
34869
|
+
parameters: {
|
|
34870
|
+
query: {
|
|
34871
|
+
/** Report start date. */
|
|
34872
|
+
periodStart: string;
|
|
34873
|
+
/** Report end date. */
|
|
34874
|
+
periodEnd: string;
|
|
34875
|
+
/** The collection items limit. */
|
|
34876
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
34877
|
+
/** The collection items offset. */
|
|
34878
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
34879
|
+
};
|
|
34880
|
+
};
|
|
34881
|
+
responses: {
|
|
34882
|
+
/** Report was retrieved successfully. */
|
|
34883
|
+
200: {
|
|
34884
|
+
content: {
|
|
34885
|
+
"application/json": reportsComponents["schemas"]["APILogSummary"];
|
|
34886
|
+
};
|
|
34887
|
+
};
|
|
34888
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34889
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34890
|
+
};
|
|
34891
|
+
};
|
|
34892
|
+
/** Retrieve a cumulative subscriptions report. */
|
|
34893
|
+
GetCumulativeSubscriptionReport: {
|
|
34894
|
+
parameters: {
|
|
34895
|
+
query: {
|
|
34896
|
+
/** Report aggregation field. */
|
|
34897
|
+
aggregationField: "day" | "month";
|
|
34898
|
+
/** Report start date. */
|
|
34899
|
+
periodStart: string;
|
|
34900
|
+
/** Report end date. */
|
|
34901
|
+
periodEnd: string;
|
|
34902
|
+
/** The collection items limit. */
|
|
34903
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
34904
|
+
/** The collection items offset. */
|
|
34905
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
34906
|
+
/**
|
|
34907
|
+
* The collection items filter requires a special format.
|
|
34908
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
34909
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
34910
|
+
*/
|
|
34911
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
34912
|
+
};
|
|
34913
|
+
};
|
|
34914
|
+
responses: {
|
|
34915
|
+
/** Report was retrieved successfully. */
|
|
34916
|
+
200: {
|
|
34917
|
+
content: {
|
|
34918
|
+
"application/json": reportsComponents["schemas"]["CumulativeSubscriptions"];
|
|
34919
|
+
};
|
|
34920
|
+
};
|
|
34921
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34922
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34923
|
+
};
|
|
34924
|
+
};
|
|
34925
|
+
/** Retrieve dashboard data. */
|
|
34926
|
+
GetDashboardReport: {
|
|
34927
|
+
parameters: {
|
|
34928
|
+
query: {
|
|
34929
|
+
/** Report start day. */
|
|
34930
|
+
periodStart: string;
|
|
34931
|
+
/** Report end day. */
|
|
34932
|
+
periodEnd: string;
|
|
34933
|
+
/** Comma-separated list of metrics. */
|
|
34934
|
+
metrics?: string;
|
|
34935
|
+
/** Dashboard report segments as a JSON array. */
|
|
34936
|
+
segments?: string;
|
|
34937
|
+
};
|
|
34938
|
+
};
|
|
34939
|
+
responses: {
|
|
34940
|
+
/** Report was retrieved successfully. */
|
|
34941
|
+
200: {
|
|
34942
|
+
content: {
|
|
34943
|
+
"application/json": reportsComponents["schemas"]["DashboardResponse"];
|
|
34944
|
+
};
|
|
34945
|
+
};
|
|
34946
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34947
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34948
|
+
};
|
|
34949
|
+
};
|
|
34950
|
+
/** Retrieve a DCC markup report. */
|
|
34951
|
+
GetDccMarkupReport: {
|
|
34952
|
+
parameters: {
|
|
34953
|
+
query: {
|
|
34954
|
+
/** Report aggregation field. */
|
|
34955
|
+
aggregationField:
|
|
34956
|
+
| "day"
|
|
34957
|
+
| "month"
|
|
34958
|
+
| "bin"
|
|
34959
|
+
| "country"
|
|
34960
|
+
| "baseCurrency"
|
|
34961
|
+
| "quoteCurrency";
|
|
34962
|
+
/** Report start date. */
|
|
34963
|
+
periodStart: string;
|
|
34964
|
+
/** Report end date. */
|
|
34965
|
+
periodEnd: string;
|
|
34966
|
+
/** The collection items limit. */
|
|
34967
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
34968
|
+
/** The collection items offset. */
|
|
34969
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
34970
|
+
/**
|
|
34971
|
+
* The collection items filter requires a special format.
|
|
34972
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
34973
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
34974
|
+
*/
|
|
34975
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
34976
|
+
};
|
|
34977
|
+
};
|
|
34978
|
+
responses: {
|
|
34979
|
+
/** Report was retrieved successfully. */
|
|
34980
|
+
200: {
|
|
34981
|
+
headers: {};
|
|
34982
|
+
content: {
|
|
34983
|
+
"application/json": reportsComponents["schemas"]["DccMarkup"];
|
|
34984
|
+
};
|
|
34985
|
+
};
|
|
34986
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
34987
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
34988
|
+
};
|
|
34989
|
+
};
|
|
34990
|
+
/** Retrieve a disputes report. */
|
|
34991
|
+
GetDisputeReport: {
|
|
34992
|
+
parameters: {
|
|
34993
|
+
query: {
|
|
34994
|
+
/** Report will be aggregated by this field. */
|
|
34995
|
+
aggregationField:
|
|
34996
|
+
| "website"
|
|
34997
|
+
| "gatewayAcquirer"
|
|
34998
|
+
| "currency"
|
|
34999
|
+
| "bin"
|
|
35000
|
+
| "country"
|
|
35001
|
+
| "rebillNumber"
|
|
35002
|
+
| "retryNumber"
|
|
35003
|
+
| "gatewayAccount"
|
|
35004
|
+
| "transactionAmount";
|
|
35005
|
+
/** Report month in format YYYY-MM. */
|
|
35006
|
+
periodMonth: string;
|
|
35007
|
+
/** The collection items limit. */
|
|
35008
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35009
|
+
/** The collection items offset. */
|
|
35010
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35011
|
+
/**
|
|
35012
|
+
* The collection items filter requires a special format.
|
|
35013
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
35014
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
35015
|
+
*/
|
|
35016
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
35017
|
+
};
|
|
35018
|
+
};
|
|
35019
|
+
responses: {
|
|
35020
|
+
/** Report was retrieved successfully. */
|
|
35021
|
+
200: {
|
|
35022
|
+
headers: {};
|
|
35023
|
+
content: {
|
|
35024
|
+
"application/json": reportsComponents["schemas"]["ReportDisputes"];
|
|
35025
|
+
};
|
|
35026
|
+
};
|
|
35027
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35028
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35029
|
+
};
|
|
35030
|
+
};
|
|
35031
|
+
/** Retrieve a events triggered summary report. */
|
|
35032
|
+
GetTriggeredEventReport: {
|
|
35033
|
+
parameters: {
|
|
35034
|
+
query: {
|
|
35035
|
+
/** Report start date. */
|
|
35036
|
+
periodStart: string;
|
|
35037
|
+
/** Report end date. */
|
|
35038
|
+
periodEnd: string;
|
|
35039
|
+
/** The collection items limit. */
|
|
35040
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35041
|
+
/** The collection items offset. */
|
|
35042
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35043
|
+
};
|
|
35044
|
+
};
|
|
35045
|
+
responses: {
|
|
35046
|
+
/** Report was retrieved successfully. */
|
|
35047
|
+
200: {
|
|
35048
|
+
headers: {};
|
|
35049
|
+
content: {
|
|
35050
|
+
"application/json": reportsComponents["schemas"]["ReportEventsTriggeredSummary"];
|
|
35051
|
+
};
|
|
35052
|
+
};
|
|
35053
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35054
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35055
|
+
};
|
|
35056
|
+
};
|
|
35057
|
+
/** Retrieve a rules matched summary report by events triggered. */
|
|
35058
|
+
GetTriggeredEventRuleReport: {
|
|
35059
|
+
parameters: {
|
|
35060
|
+
path: {
|
|
35061
|
+
/** The system event type. */
|
|
35062
|
+
eventType: reportsComponents["schemas"]["EventType"];
|
|
35063
|
+
};
|
|
35064
|
+
query: {
|
|
35065
|
+
/** Report start date. */
|
|
35066
|
+
periodStart: string;
|
|
35067
|
+
/** Report end date. */
|
|
35068
|
+
periodEnd: string;
|
|
35069
|
+
/** The collection items limit. */
|
|
35070
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35071
|
+
/** The collection items offset. */
|
|
35072
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35073
|
+
};
|
|
35074
|
+
};
|
|
35075
|
+
responses: {
|
|
35076
|
+
/** Report was retrieved successfully. */
|
|
35077
|
+
200: {
|
|
35078
|
+
headers: {};
|
|
35079
|
+
content: {
|
|
35080
|
+
"application/json": reportsComponents["schemas"]["ReportRulesMatchedSummary"];
|
|
35081
|
+
};
|
|
35082
|
+
};
|
|
35083
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35084
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35085
|
+
};
|
|
35086
|
+
};
|
|
35087
|
+
/** Retrieve a future renewals report. */
|
|
35088
|
+
GetFutureRenewalReport: {
|
|
35089
|
+
parameters: {
|
|
35090
|
+
query: {
|
|
35091
|
+
/** Report start date. It should be in the future. */
|
|
35092
|
+
periodStart: string;
|
|
35093
|
+
/** Report end date. */
|
|
35094
|
+
periodEnd: string;
|
|
35095
|
+
/** The collection items limit. */
|
|
35096
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35097
|
+
/** The collection items offset. */
|
|
35098
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35099
|
+
};
|
|
35100
|
+
};
|
|
35101
|
+
responses: {
|
|
35102
|
+
/** Report was retrieved successfully. */
|
|
35103
|
+
200: {
|
|
35104
|
+
headers: {};
|
|
35105
|
+
content: {
|
|
35106
|
+
"application/json": reportsComponents["schemas"]["FutureRenewals"];
|
|
35107
|
+
};
|
|
35108
|
+
};
|
|
35109
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35110
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35111
|
+
};
|
|
35112
|
+
};
|
|
35113
|
+
/** Retrieve a KYC acceptance summary report. */
|
|
35114
|
+
GetKycAcceptanceSummaryReport: {
|
|
35115
|
+
parameters: {
|
|
35116
|
+
query: {
|
|
35117
|
+
/** Report start date. */
|
|
35118
|
+
periodStart: string;
|
|
35119
|
+
/** Report end date. */
|
|
35120
|
+
periodEnd: string;
|
|
35121
|
+
};
|
|
35122
|
+
};
|
|
35123
|
+
responses: {
|
|
35124
|
+
/** Report was retrieved successfully. */
|
|
35125
|
+
200: {
|
|
35126
|
+
content: {
|
|
35127
|
+
"application/json": {
|
|
35128
|
+
data?: {
|
|
35129
|
+
documentType?: {
|
|
35130
|
+
[key: string]: any;
|
|
35131
|
+
} & reportsComponents["schemas"]["KycDocumentTypes"];
|
|
35132
|
+
/** Statistics for each status. */
|
|
35133
|
+
statusStatistics?: {
|
|
35134
|
+
/** Statistics for `accepted` status. */
|
|
35135
|
+
accepted?: {
|
|
35136
|
+
/** Total amount of accepted documents. */
|
|
35137
|
+
total?: number;
|
|
35138
|
+
/** Amount of documents that have been accepted automatically. */
|
|
35139
|
+
automatically?: number;
|
|
35140
|
+
/** Amount of documents that have been accepted by reviewer. */
|
|
35141
|
+
manually?: number;
|
|
35142
|
+
/** Amount of documents that have been rejected automatically and then accepted by reviewer. */
|
|
35143
|
+
afterAutoRejected?: number;
|
|
35144
|
+
};
|
|
35145
|
+
/** Statistics for `rejected` status. */
|
|
35146
|
+
rejected?: {
|
|
35147
|
+
/** Total amount of rejected documents. */
|
|
35148
|
+
total?: number;
|
|
35149
|
+
/** Amount of documents that have been rejected automatically. */
|
|
35150
|
+
automatically?: number;
|
|
35151
|
+
/** Amount of documents that have been rejected by reviewer. */
|
|
35152
|
+
manually?: number;
|
|
35153
|
+
/** Amount of documents that have been accepted automatically and then rejected by reviewer. */
|
|
35154
|
+
afterAutoAccepted?: number;
|
|
35155
|
+
};
|
|
35156
|
+
/** Statistics for `pending` status. */
|
|
35157
|
+
pending?: {
|
|
35158
|
+
/** Total amount of pending documents. */
|
|
35159
|
+
total?: number;
|
|
35160
|
+
};
|
|
35161
|
+
/** Statistics for `archived` status. */
|
|
35162
|
+
archived?: {
|
|
35163
|
+
/** Total amount of archived documents. */
|
|
35164
|
+
total?: number;
|
|
35165
|
+
};
|
|
35166
|
+
};
|
|
35167
|
+
/** Total documents amount. */
|
|
35168
|
+
total?: number;
|
|
35169
|
+
/**
|
|
35170
|
+
* Percent of automatically accepted and rejected documents that remain in the same status after review.
|
|
35171
|
+
* Calculated by the formula: `(nonarchived total - accepted auto rejected - rejected auto accepted)/nonarchived total`.
|
|
35172
|
+
*/
|
|
35173
|
+
accuracyRate?: number;
|
|
35174
|
+
/** Percent of accepted documents out of the total number of KYC documents. Calculated by accepted total divided by the total of nonarchived documents. */
|
|
35175
|
+
acceptanceRate?: number;
|
|
35176
|
+
/** Median duration in minutes between review and created time for manually reviewed documents. */
|
|
35177
|
+
manualReviewTime?: number;
|
|
35178
|
+
}[];
|
|
35179
|
+
};
|
|
35180
|
+
};
|
|
35181
|
+
};
|
|
35182
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35183
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35184
|
+
};
|
|
35185
|
+
};
|
|
35186
|
+
/** Retrieve a KYC rejection report by type and by rejection reasons. */
|
|
35187
|
+
GetKycRejectionSummaryReport: {
|
|
35188
|
+
parameters: {
|
|
35189
|
+
query: {
|
|
35190
|
+
/** Report start date. */
|
|
35191
|
+
periodStart: string;
|
|
35192
|
+
/** Report end date. */
|
|
35193
|
+
periodEnd: string;
|
|
35194
|
+
};
|
|
35195
|
+
};
|
|
35196
|
+
responses: {
|
|
35197
|
+
/** Report was retrieved successfully. */
|
|
35198
|
+
200: {
|
|
35199
|
+
headers: {};
|
|
35200
|
+
content: {
|
|
35201
|
+
"application/json": reportsComponents["schemas"]["ReportKycRejections"];
|
|
35202
|
+
};
|
|
35203
|
+
};
|
|
35204
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35205
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35206
|
+
};
|
|
35207
|
+
};
|
|
35208
|
+
/** Retrieve a KYC request report by type and by rejection reasons. */
|
|
35209
|
+
GetKycRequestSummaryReport: {
|
|
35210
|
+
parameters: {
|
|
35211
|
+
query: {
|
|
35212
|
+
/** Report start date. */
|
|
35213
|
+
periodStart: string;
|
|
35214
|
+
/** Report end date. */
|
|
35215
|
+
periodEnd: string;
|
|
35216
|
+
};
|
|
35217
|
+
};
|
|
35218
|
+
responses: {
|
|
35219
|
+
/** Report successfully retrieved. */
|
|
35220
|
+
200: {
|
|
35221
|
+
headers: {};
|
|
35222
|
+
content: {
|
|
35223
|
+
"application/json": reportsComponents["schemas"]["ReportKycRequests"];
|
|
35224
|
+
};
|
|
35225
|
+
};
|
|
35226
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35227
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35228
|
+
};
|
|
35229
|
+
};
|
|
35230
|
+
/** Retrieve a monthly recurring revenue report. */
|
|
35231
|
+
GetMonthlyRecurringRevenueReport: {
|
|
35232
|
+
parameters: {
|
|
35233
|
+
query: {
|
|
35234
|
+
/** Revenue currency. */
|
|
35235
|
+
currency: reportsComponents["schemas"]["CurrencyCode"];
|
|
35236
|
+
/** Report start date. */
|
|
35237
|
+
periodStart: string;
|
|
35238
|
+
/** Report end date. */
|
|
35239
|
+
periodEnd: string;
|
|
35240
|
+
/** The collection items limit. */
|
|
35241
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35242
|
+
/** The collection items offset. */
|
|
35243
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35244
|
+
};
|
|
35245
|
+
};
|
|
35246
|
+
responses: {
|
|
35247
|
+
/** Report was retrieved successfully. */
|
|
35248
|
+
200: {
|
|
35249
|
+
headers: {};
|
|
35250
|
+
content: {
|
|
35251
|
+
"application/json": reportsComponents["schemas"]["ReportMonthlyRecurringRevenue"];
|
|
35252
|
+
};
|
|
35253
|
+
};
|
|
35254
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35255
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35256
|
+
};
|
|
35257
|
+
};
|
|
35258
|
+
/** Retrieve a renewal sales report. */
|
|
35259
|
+
GetRenewalSaleReport: {
|
|
35260
|
+
parameters: {
|
|
35261
|
+
query: {
|
|
35262
|
+
/** Report start date. */
|
|
35263
|
+
periodStart: string;
|
|
35264
|
+
/** Report end date. */
|
|
35265
|
+
periodEnd: string;
|
|
35266
|
+
/** The collection items limit. */
|
|
35267
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35268
|
+
/** The collection items offset. */
|
|
35269
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35270
|
+
};
|
|
35271
|
+
};
|
|
35272
|
+
responses: {
|
|
35273
|
+
/** Report was retrieved successfully. */
|
|
35274
|
+
200: {
|
|
35275
|
+
headers: {};
|
|
35276
|
+
content: {
|
|
35277
|
+
"application/json": reportsComponents["schemas"]["RenewalSales"];
|
|
35278
|
+
};
|
|
35279
|
+
};
|
|
35280
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35281
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35282
|
+
};
|
|
35283
|
+
};
|
|
35284
|
+
/** Retrieve a retention percentage report. */
|
|
35285
|
+
GetRetentionPercentageReport: {
|
|
35286
|
+
parameters: {
|
|
35287
|
+
query: {
|
|
35288
|
+
/** Report aggregation field. */
|
|
35289
|
+
aggregationField: "day" | "month" | "quarter" | "year";
|
|
35290
|
+
/** Report aggregation period. */
|
|
35291
|
+
aggregationPeriod: "day" | "month" | "quarter" | "year" | "cycle";
|
|
35292
|
+
/** If to include switched subscriptions. */
|
|
35293
|
+
includeSwitchedSubscriptions?: "true" | "false";
|
|
35294
|
+
/** Report start date. */
|
|
35295
|
+
periodStart: string;
|
|
35296
|
+
/** Report end date. */
|
|
35297
|
+
periodEnd: string;
|
|
35298
|
+
/** The collection items limit. */
|
|
35299
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35300
|
+
/** The collection items offset. */
|
|
35301
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35302
|
+
/**
|
|
35303
|
+
* The collection items filter requires a special format.
|
|
35304
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
35305
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
35306
|
+
*/
|
|
35307
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
35308
|
+
/** Criteria parameter for requesting a collection. */
|
|
35309
|
+
criteria?: reportsComponents["parameters"]["collectionCriteria"];
|
|
35310
|
+
};
|
|
35311
|
+
};
|
|
35312
|
+
responses: {
|
|
35313
|
+
/** Report was retrieved successfully. */
|
|
35314
|
+
200: {
|
|
35315
|
+
headers: {};
|
|
35316
|
+
content: {
|
|
35317
|
+
"application/json": reportsComponents["schemas"]["ReportRetentionPercentage"];
|
|
35318
|
+
};
|
|
35319
|
+
};
|
|
35320
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35321
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35322
|
+
};
|
|
35323
|
+
};
|
|
35324
|
+
/**
|
|
35325
|
+
* The retention value report shows the count of new customers.
|
|
35326
|
+
* per aggregation bucket and the corresponding per customer value over time.
|
|
35327
|
+
*/
|
|
35328
|
+
GetRetentionValueReport: {
|
|
35329
|
+
parameters: {
|
|
35330
|
+
query: {
|
|
35331
|
+
/** Report aggregation field. */
|
|
35332
|
+
aggregationField:
|
|
35333
|
+
| "day"
|
|
35334
|
+
| "month"
|
|
35335
|
+
| "quarter"
|
|
35336
|
+
| "year"
|
|
35337
|
+
| "leadsSource"
|
|
35338
|
+
| "leadsMedium"
|
|
35339
|
+
| "leadsCampaign"
|
|
35340
|
+
| "leadsContent"
|
|
35341
|
+
| "leadsTerm"
|
|
35342
|
+
| "leadsAffiliate"
|
|
35343
|
+
| "leadsSubAffiliate"
|
|
35344
|
+
| "leadsSalesAgent";
|
|
35345
|
+
/** Report aggregation period. */
|
|
35346
|
+
aggregationPeriod: "day" | "month" | "quarter" | "year";
|
|
35347
|
+
/** If to include refunds. */
|
|
35348
|
+
includeRefunds?: "true" | "false";
|
|
35349
|
+
/** If to include disputes. */
|
|
35350
|
+
includeDisputes?: "true" | "false";
|
|
35351
|
+
/** Report start date. */
|
|
35352
|
+
periodStart: string;
|
|
35353
|
+
/** Report end date. */
|
|
35354
|
+
periodEnd: string;
|
|
35355
|
+
/** The collection items limit. */
|
|
35356
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35357
|
+
/** The collection items offset. */
|
|
35358
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35359
|
+
/**
|
|
35360
|
+
* The collection items filter requires a special format.
|
|
35361
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
35362
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
35363
|
+
*/
|
|
35364
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
35365
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
35366
|
+
sort?: reportsComponents["parameters"]["collectionSort"];
|
|
35367
|
+
/** Criteria parameter for requesting a collection. */
|
|
35368
|
+
criteria?: reportsComponents["parameters"]["collectionCriteria"];
|
|
35369
|
+
};
|
|
35370
|
+
};
|
|
35371
|
+
responses: {
|
|
35372
|
+
/** Report was retrieved successfully. */
|
|
35373
|
+
200: {
|
|
35374
|
+
headers: {};
|
|
35375
|
+
content: {
|
|
35376
|
+
"application/json": reportsComponents["schemas"]["ReportRetentionValue"];
|
|
35377
|
+
};
|
|
35378
|
+
};
|
|
35379
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35380
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35381
|
+
};
|
|
35382
|
+
};
|
|
35383
|
+
/** Retrieve a revenue waterfall report. */
|
|
35384
|
+
GetRevenueWaterfallReport: {
|
|
35385
|
+
parameters: {
|
|
35386
|
+
query: {
|
|
35387
|
+
/** Revenue currency. */
|
|
35388
|
+
currency: reportsComponents["schemas"]["CurrencyCode"];
|
|
35389
|
+
/** Revenue invoice issued from month. */
|
|
35390
|
+
issuedFrom: string;
|
|
35391
|
+
/** Revenue invoice issued to month. */
|
|
35392
|
+
issuedTo: string;
|
|
35393
|
+
/** Revenue recognized up to month. */
|
|
35394
|
+
recognizedTo: string;
|
|
35395
|
+
};
|
|
35396
|
+
};
|
|
35397
|
+
responses: {
|
|
35398
|
+
/** Report was retrieved successfully. */
|
|
35399
|
+
200: {
|
|
35400
|
+
content: {
|
|
35401
|
+
"application/json": reportsComponents["schemas"]["ReportRevenueWaterfall"];
|
|
35402
|
+
};
|
|
35403
|
+
};
|
|
35404
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35405
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35406
|
+
};
|
|
35407
|
+
};
|
|
35408
|
+
/** Retrieve transactions with their plan data. */
|
|
35409
|
+
GetSubscriptionCancellationReport: {
|
|
35410
|
+
parameters: {
|
|
35411
|
+
query: {
|
|
35412
|
+
/** Report start date. */
|
|
35413
|
+
periodStart: string;
|
|
35414
|
+
/** Report end date. */
|
|
35415
|
+
periodEnd: string;
|
|
35416
|
+
/** Report aggregation field. */
|
|
35417
|
+
aggregationField:
|
|
35418
|
+
| "planId"
|
|
35419
|
+
| "websiteId"
|
|
35420
|
+
| "canceledBy"
|
|
35421
|
+
| "cancelCategory"
|
|
35422
|
+
| "leadSource.source"
|
|
35423
|
+
| "leadSource.medium"
|
|
35424
|
+
| "leadSource.campaign"
|
|
35425
|
+
| "leadSource.content"
|
|
35426
|
+
| "leadSource.term"
|
|
35427
|
+
| "leadSource.affiliate"
|
|
35428
|
+
| "leadSource.subAffiliate"
|
|
35429
|
+
| "leadSource.salesAgent";
|
|
35430
|
+
/** The collection items limit. */
|
|
35431
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35432
|
+
/** The collection items offset. */
|
|
35433
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35434
|
+
/**
|
|
35435
|
+
* The collection items filter requires a special format.
|
|
35436
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
35437
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
35438
|
+
*/
|
|
35439
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
35440
|
+
};
|
|
35441
|
+
};
|
|
35442
|
+
responses: {
|
|
35443
|
+
/** Report was retrieved successfully. */
|
|
35444
|
+
200: {
|
|
35445
|
+
headers: {};
|
|
35446
|
+
content: {
|
|
35447
|
+
"application/json": reportsComponents["schemas"]["SubscriptionCancellationReport"];
|
|
35448
|
+
};
|
|
35449
|
+
};
|
|
35450
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35451
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35452
|
+
};
|
|
35453
|
+
};
|
|
35454
|
+
/** Retrieve a subscription renewal report. */
|
|
35455
|
+
GetSubscriptionRenewalReport: {
|
|
35456
|
+
parameters: {
|
|
35457
|
+
query: {
|
|
35458
|
+
/** Report start date. */
|
|
35459
|
+
periodStart: string;
|
|
35460
|
+
/** Report end date. */
|
|
35461
|
+
periodEnd: string;
|
|
35462
|
+
/** The collection items limit. */
|
|
35463
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35464
|
+
/** The collection items offset. */
|
|
35465
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35466
|
+
};
|
|
35467
|
+
};
|
|
35468
|
+
responses: {
|
|
35469
|
+
/** Report was retrieved successfully. */
|
|
35470
|
+
200: {
|
|
35471
|
+
headers: {};
|
|
35472
|
+
content: {
|
|
35473
|
+
"application/json": reportsComponents["schemas"]["SubscriptionRenewal"];
|
|
35474
|
+
};
|
|
35475
|
+
};
|
|
35476
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35477
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35478
|
+
};
|
|
35479
|
+
};
|
|
35480
|
+
/** Retrieve a transactions report aggregated by time periods. */
|
|
35481
|
+
GetTimeSeriesTransactionReport: {
|
|
35482
|
+
parameters: {
|
|
35483
|
+
query: {
|
|
35484
|
+
/** Report aggregation type. */
|
|
35485
|
+
type: "count" | "amount" | "approval-rate" | "incomplete-rate";
|
|
35486
|
+
/** Report subaggregate. */
|
|
35487
|
+
subaggregate:
|
|
35488
|
+
| "website"
|
|
35489
|
+
| "gateway-account"
|
|
35490
|
+
| "currency"
|
|
35491
|
+
| "plan"
|
|
35492
|
+
| "leads.source"
|
|
35493
|
+
| "leads.medium"
|
|
35494
|
+
| "leads.campaign"
|
|
35495
|
+
| "leads.content"
|
|
35496
|
+
| "leads.term"
|
|
35497
|
+
| "leads.affiliate"
|
|
35498
|
+
| "leads.subaffiliate"
|
|
35499
|
+
| "leads.sales-agent";
|
|
35500
|
+
/** Report start date. */
|
|
35501
|
+
periodStart: string;
|
|
35502
|
+
/** Report end date. */
|
|
35503
|
+
periodEnd: string;
|
|
35504
|
+
};
|
|
35505
|
+
};
|
|
35506
|
+
responses: {
|
|
35507
|
+
/** Report was retrieved successfully. */
|
|
35508
|
+
200: {
|
|
35509
|
+
headers: {};
|
|
35510
|
+
content: {
|
|
35511
|
+
"application/json": reportsComponents["schemas"]["TimeSeriesTransaction"];
|
|
35512
|
+
};
|
|
35513
|
+
};
|
|
35514
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35515
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35516
|
+
};
|
|
35517
|
+
};
|
|
35518
|
+
/** Retrieve a dispute delays in days report, how much time between a. transaction and a dispute. */
|
|
35519
|
+
GetTransactionTimeDisputeReport: {
|
|
35520
|
+
parameters: {
|
|
35521
|
+
query: {
|
|
35522
|
+
/** Report will be aggregated by this field. */
|
|
35523
|
+
aggregationField:
|
|
35524
|
+
| "website"
|
|
35525
|
+
| "processor"
|
|
35526
|
+
| "currency"
|
|
35527
|
+
| "bin"
|
|
35528
|
+
| "country"
|
|
35529
|
+
| "rebillNumber"
|
|
35530
|
+
| "retryNumber"
|
|
35531
|
+
| "gatewayAccount"
|
|
35532
|
+
| "transactionAmount";
|
|
35533
|
+
/** Report start date. */
|
|
35534
|
+
periodStart: string;
|
|
35535
|
+
/** Report end date. */
|
|
35536
|
+
periodEnd: string;
|
|
35537
|
+
/** The collection items limit. */
|
|
35538
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35539
|
+
/** The collection items offset. */
|
|
35540
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35541
|
+
/**
|
|
35542
|
+
* The collection items filter requires a special format.
|
|
35543
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
35544
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
35545
|
+
*/
|
|
35546
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
35547
|
+
};
|
|
35548
|
+
};
|
|
35549
|
+
responses: {
|
|
35550
|
+
/** Report was retrieved successfully. */
|
|
35551
|
+
200: {
|
|
35552
|
+
headers: {};
|
|
35553
|
+
content: {
|
|
35554
|
+
"application/json": reportsComponents["schemas"]["ReportDisputeDelays"];
|
|
35555
|
+
};
|
|
35556
|
+
};
|
|
35557
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35558
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35559
|
+
};
|
|
35560
|
+
};
|
|
35561
|
+
/** Retrieve a transactions report. */
|
|
35562
|
+
GetTransactionReport: {
|
|
35563
|
+
parameters: {
|
|
35564
|
+
query: {
|
|
35565
|
+
/** Report start day. */
|
|
35566
|
+
periodStart: string;
|
|
35567
|
+
/** Report end day. */
|
|
35568
|
+
periodEnd: string;
|
|
35569
|
+
/** Report aggregation field. */
|
|
35570
|
+
aggregationField:
|
|
35571
|
+
| "website"
|
|
35572
|
+
| "currency"
|
|
35573
|
+
| "bin"
|
|
35574
|
+
| "rebillNumber"
|
|
35575
|
+
| "transactionResult"
|
|
35576
|
+
| "transactionType"
|
|
35577
|
+
| "gatewayAccount"
|
|
35578
|
+
| "gateway"
|
|
35579
|
+
| "retryNumber"
|
|
35580
|
+
| "plan"
|
|
35581
|
+
| "leadSource.source"
|
|
35582
|
+
| "leadSource.medium"
|
|
35583
|
+
| "leadSource.campaign"
|
|
35584
|
+
| "leadSource.content"
|
|
35585
|
+
| "leadSource.term"
|
|
35586
|
+
| "leadSource.affiliate"
|
|
35587
|
+
| "leadSource.subAffiliate"
|
|
35588
|
+
| "leadSource.salesAgent";
|
|
35589
|
+
/** The collection items limit. */
|
|
35590
|
+
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
35591
|
+
/** The collection items offset. */
|
|
35592
|
+
offset?: reportsComponents["parameters"]["collectionOffset"];
|
|
35593
|
+
/**
|
|
35594
|
+
* The collection items filter requires a special format.
|
|
35595
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
35596
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
35597
|
+
*/
|
|
35598
|
+
filter?: reportsComponents["parameters"]["collectionFilter"];
|
|
35599
|
+
};
|
|
35600
|
+
};
|
|
35601
|
+
responses: {
|
|
35602
|
+
/** Report was retrieved successfully. */
|
|
35603
|
+
200: {
|
|
35604
|
+
headers: {};
|
|
35605
|
+
content: {
|
|
35606
|
+
"application/json": reportsComponents["schemas"]["ReportTransactions"];
|
|
35607
|
+
};
|
|
35608
|
+
};
|
|
35609
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35610
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35611
|
+
};
|
|
35612
|
+
};
|
|
35613
|
+
/** Retrieve subscription order summary metrics. */
|
|
35614
|
+
GetSubscriptionSummaryMetricReport: {
|
|
35615
|
+
parameters: {
|
|
35616
|
+
path: {
|
|
35617
|
+
/** Order's ID. */
|
|
35618
|
+
subscriptionId: string;
|
|
35619
|
+
};
|
|
35620
|
+
};
|
|
35621
|
+
responses: {
|
|
35622
|
+
/** Metrics were retrieved successfully. */
|
|
35623
|
+
200: {
|
|
35624
|
+
content: {
|
|
35625
|
+
"application/json": reportsComponents["schemas"]["SubscriptionSummaryMetrics"];
|
|
35626
|
+
};
|
|
35627
|
+
};
|
|
35628
|
+
401: reportsComponents["responses"]["Unauthorized"];
|
|
35629
|
+
403: reportsComponents["responses"]["Forbidden"];
|
|
35630
|
+
};
|
|
35631
|
+
};
|
|
35632
|
+
}
|
|
35633
|
+
|
|
35634
|
+
}
|
|
35635
|
+
|
|
35636
|
+
declare module "deep-freeze" {
|
|
35637
|
+
export default function deepFreeze(obj: any, { exclude }?: {
|
|
35638
|
+
exclude: any[];
|
|
35639
|
+
}): any;
|
|
35640
|
+
}
|
|
35641
|
+
declare module "cached-request" {
|
|
35642
|
+
export default class CachedRequest {
|
|
35643
|
+
constructor({ id, created }?: {
|
|
35644
|
+
id?: any;
|
|
35645
|
+
created?: any;
|
|
35646
|
+
});
|
|
35647
|
+
id: CachedRequestId;
|
|
35648
|
+
created: number;
|
|
35649
|
+
cancelSource: import("axios").CancelTokenSource;
|
|
35650
|
+
cancel: any;
|
|
35651
|
+
cancelToken: any;
|
|
35652
|
+
}
|
|
35653
|
+
export type CachedRequestId = string;
|
|
35654
|
+
}
|
|
35655
|
+
declare module "requests-cache" {
|
|
35656
|
+
var _default: RequestsCache;
|
|
35657
|
+
export default _default;
|
|
35658
|
+
class RequestsCache {
|
|
35659
|
+
requests: any;
|
|
35660
|
+
getAll(): any[];
|
|
35661
|
+
getById(id: any): CachedRequest | undefined;
|
|
35662
|
+
deleteById(id: any): any;
|
|
35663
|
+
save(): {
|
|
35664
|
+
id: any;
|
|
35665
|
+
cancelToken: any;
|
|
35666
|
+
};
|
|
35667
|
+
}
|
|
35668
|
+
import CachedRequest from "cached-request";
|
|
35669
|
+
}
|
|
35670
|
+
declare module "cancellation" {
|
|
35671
|
+
export class Cancellation {
|
|
35672
|
+
static cancelById: (id: string, reason?: string) => void;
|
|
35673
|
+
static cancelAll: (reason?: string) => any;
|
|
35674
|
+
}
|
|
35675
|
+
namespace _default {
|
|
35676
|
+
const cancelAll: (reason?: string) => any;
|
|
35677
|
+
}
|
|
35678
|
+
export default _default;
|
|
35679
|
+
}
|
|
35680
|
+
declare module "member" {
|
|
35681
|
+
export default class Member {
|
|
35682
|
+
constructor({ data, status, statusText, headers }: {
|
|
35683
|
+
data: any;
|
|
35684
|
+
status: any;
|
|
35685
|
+
statusText: any;
|
|
35686
|
+
headers: any;
|
|
35687
|
+
}, config?: {});
|
|
35688
|
+
response: any;
|
|
35689
|
+
fields: any;
|
|
35690
|
+
config: any;
|
|
35691
|
+
getJSON(): any;
|
|
35692
|
+
}
|
|
35693
|
+
}
|
|
35694
|
+
declare module "pagination-headers" {
|
|
35695
|
+
export default paginationHeaders;
|
|
35696
|
+
namespace paginationHeaders {
|
|
35697
|
+
const limit: string;
|
|
35698
|
+
const offset: string;
|
|
35699
|
+
const total: string;
|
|
35700
|
+
}
|
|
35701
|
+
}
|
|
35702
|
+
declare module "collection" {
|
|
35703
|
+
export default class Collection {
|
|
35704
|
+
constructor({ data, status, statusText, headers }: {
|
|
35705
|
+
data: any;
|
|
35706
|
+
status: any;
|
|
35707
|
+
statusText: any;
|
|
35708
|
+
headers: any;
|
|
35709
|
+
}, config?: {});
|
|
35710
|
+
limit: number | null;
|
|
35711
|
+
offset: number | null;
|
|
35712
|
+
total: number | null;
|
|
35713
|
+
response: any;
|
|
35714
|
+
items: Array<Member>;
|
|
35715
|
+
config: any;
|
|
35716
|
+
getJSON(): any;
|
|
35717
|
+
}
|
|
35718
|
+
import Member from "member";
|
|
35719
|
+
}
|
|
35720
|
+
declare module "file" {
|
|
35721
|
+
export default class File {
|
|
35722
|
+
constructor({ data, status, statusText, headers }: {
|
|
35723
|
+
data: any;
|
|
35724
|
+
status: any;
|
|
35725
|
+
statusText: any;
|
|
35726
|
+
headers: any;
|
|
35727
|
+
}, config?: {});
|
|
35728
|
+
response: {
|
|
35729
|
+
status: any;
|
|
35730
|
+
statusText: any;
|
|
35731
|
+
headers: any;
|
|
35732
|
+
};
|
|
35733
|
+
data: any;
|
|
35734
|
+
config: {};
|
|
35735
|
+
}
|
|
35736
|
+
}
|
|
35737
|
+
declare module "errors/rebilly-error" {
|
|
35738
|
+
export default class RebillyError extends Error {
|
|
35739
|
+
constructor({ error, name }: {
|
|
35740
|
+
error: any;
|
|
35741
|
+
name?: any;
|
|
35742
|
+
});
|
|
35743
|
+
response: any;
|
|
35744
|
+
request: any;
|
|
35745
|
+
config: any;
|
|
35746
|
+
status: any;
|
|
35747
|
+
statusText: any;
|
|
35748
|
+
details: any;
|
|
35749
|
+
invalidFields: any;
|
|
35750
|
+
}
|
|
35751
|
+
}
|
|
35752
|
+
declare module "errors/errors" {
|
|
35753
|
+
export default Errors;
|
|
35754
|
+
namespace Errors {
|
|
35755
|
+
export { RebillyError };
|
|
35756
|
+
export { RebillyRequestError };
|
|
35757
|
+
export { RebillyValidationError };
|
|
35758
|
+
export { RebillyNotFoundError };
|
|
35759
|
+
export { RebillyConflictError };
|
|
35760
|
+
export { RebillyForbiddenError };
|
|
35761
|
+
export { RebillyMethodNotAllowedError };
|
|
35762
|
+
export { RebillyTimeoutError };
|
|
35763
|
+
export { RebillyCanceledError };
|
|
35764
|
+
}
|
|
35765
|
+
import RebillyError from "errors/rebilly-error";
|
|
35766
|
+
class RebillyRequestError extends RebillyError {
|
|
35767
|
+
constructor(error: any);
|
|
35768
|
+
}
|
|
35769
|
+
class RebillyValidationError extends RebillyError {
|
|
35770
|
+
constructor(error: any);
|
|
35771
|
+
}
|
|
35772
|
+
class RebillyNotFoundError extends RebillyError {
|
|
35773
|
+
constructor(error: any);
|
|
35774
|
+
}
|
|
35775
|
+
class RebillyConflictError extends RebillyError {
|
|
35776
|
+
constructor(error: any);
|
|
35777
|
+
}
|
|
35778
|
+
class RebillyForbiddenError extends RebillyError {
|
|
35779
|
+
constructor(error: any);
|
|
35780
|
+
}
|
|
35781
|
+
class RebillyMethodNotAllowedError extends RebillyError {
|
|
35782
|
+
constructor(error: any);
|
|
35783
|
+
}
|
|
35784
|
+
class RebillyTimeoutError extends RebillyError {
|
|
35785
|
+
constructor(error: any);
|
|
35786
|
+
}
|
|
35787
|
+
class RebillyCanceledError extends RebillyError {
|
|
35788
|
+
constructor(error: any);
|
|
35789
|
+
}
|
|
35790
|
+
}
|
|
35791
|
+
declare module "create-api-handler" {
|
|
35792
|
+
export default function createApiHandler({ options }: {
|
|
35793
|
+
options: any;
|
|
35794
|
+
}): {
|
|
35795
|
+
addRequestInterceptor: ({ thenDelegate, catchDelegate }: {
|
|
35796
|
+
thenDelegate: Function;
|
|
35797
|
+
catchDelegate: Function;
|
|
35798
|
+
}) => number;
|
|
35799
|
+
removeRequestInterceptor: (interceptor: number) => void;
|
|
35800
|
+
addResponseInterceptor: ({ thenDelegate, catchDelegate }: {
|
|
35801
|
+
thenDelegate: Function;
|
|
35802
|
+
catchDelegate: Function;
|
|
35803
|
+
}) => number;
|
|
35804
|
+
removeResponseInterceptor: (interceptor: number) => void;
|
|
35805
|
+
setTimeout: (timeout: any) => void;
|
|
35806
|
+
setProxyAgent: ({ host, port, auth }: {
|
|
35807
|
+
host: string;
|
|
35808
|
+
port: number;
|
|
35809
|
+
auth: {
|
|
35810
|
+
username: string;
|
|
35811
|
+
password: string;
|
|
35812
|
+
};
|
|
35813
|
+
}) => void;
|
|
35814
|
+
setSessionToken: (token?: any) => void;
|
|
35815
|
+
setPublishableKey: (key?: any) => void;
|
|
35816
|
+
setEndpoints: ({ live, sandbox }: {
|
|
35817
|
+
live: string;
|
|
35818
|
+
sandbox: string;
|
|
35819
|
+
}) => void;
|
|
35820
|
+
getCancellationToken: any;
|
|
35821
|
+
get: (url: string, params?: any) => Member;
|
|
35822
|
+
getAll: (url: string, params: any) => Collection;
|
|
35823
|
+
post: (url: string, data: any, options?: any) => Member;
|
|
35824
|
+
put: (url: string, data: any, params?: {}) => Member;
|
|
35825
|
+
patch: (url: string, data: any) => Member;
|
|
35826
|
+
delete: (url: string) => null | any;
|
|
35827
|
+
create: (url: string, id: string, data: any, params?: {}) => Member;
|
|
35828
|
+
};
|
|
35829
|
+
export namespace interceptorTypes {
|
|
35830
|
+
const request: string;
|
|
35831
|
+
const response: string;
|
|
35832
|
+
}
|
|
35833
|
+
export function isInterceptorType(type: any): boolean;
|
|
35834
|
+
import Member from "member";
|
|
35835
|
+
import Collection from "collection";
|
|
35836
|
+
}
|
|
35837
|
+
declare module "resources/account-resource" {
|
|
35838
|
+
export default function AccountResource({ apiHandler }: {
|
|
35839
|
+
apiHandler: any;
|
|
35840
|
+
}): {
|
|
35841
|
+
activate({ token }: {
|
|
35842
|
+
token: any;
|
|
35843
|
+
}): any;
|
|
35844
|
+
forgotPassword({ data }: {
|
|
35845
|
+
data: any;
|
|
35846
|
+
}): any;
|
|
35847
|
+
logout(): any;
|
|
35848
|
+
signIn({ data }: {
|
|
35849
|
+
data: any;
|
|
35850
|
+
}): any;
|
|
35851
|
+
signUp({ data }: {
|
|
35852
|
+
data: any;
|
|
35853
|
+
}): any;
|
|
35854
|
+
};
|
|
35855
|
+
}
|
|
35856
|
+
declare module "resources/aml-resource" {
|
|
35857
|
+
export default function AmlResource({ apiHandler }: {
|
|
35858
|
+
apiHandler: any;
|
|
35859
|
+
}): {
|
|
35860
|
+
getAll({ firstName, lastName, dob, country }: {
|
|
35861
|
+
firstName: any;
|
|
35862
|
+
lastName: any;
|
|
35863
|
+
dob?: any;
|
|
35864
|
+
country?: any;
|
|
35865
|
+
}): rebilly.GetAmlEntryResponsePromise;
|
|
35866
|
+
};
|
|
35867
|
+
}
|
|
35868
|
+
declare module "resources/api-keys-resource" {
|
|
35869
|
+
export default function ApiKeysResource({ apiHandler }: {
|
|
35870
|
+
apiHandler: any;
|
|
35871
|
+
}): {
|
|
35872
|
+
getAll({ limit, offset, sort }?: rebilly.GetApiKeyCollectionRequest): rebilly.GetApiKeyCollectionResponsePromise;
|
|
35873
|
+
create({ id, data }: rebilly.CreateApiKeyRequest): rebilly.PostApiKeyResponsePromise;
|
|
35874
|
+
get({ id }: {
|
|
35875
|
+
id: any;
|
|
35876
|
+
}): rebilly.GetApiKeyResponsePromise;
|
|
35877
|
+
update({ id, data }: {
|
|
35878
|
+
id: any;
|
|
35879
|
+
data: any;
|
|
35880
|
+
}): rebilly.PutApiKeyResponsePromise;
|
|
35881
|
+
delete({ id }: {
|
|
35882
|
+
id: any;
|
|
33760
35883
|
}): any;
|
|
33761
35884
|
};
|
|
33762
35885
|
}
|
|
@@ -36976,37 +39099,26 @@ declare module "resources/experimental/customers-resource" {
|
|
|
36976
39099
|
export default function CustomersResource({ apiHandler }: {
|
|
36977
39100
|
apiHandler: any;
|
|
36978
39101
|
}): {
|
|
36979
|
-
getCustomerLifetimeSummaryMetrics({ customerId }
|
|
36980
|
-
customerId
|
|
36981
|
-
}):
|
|
39102
|
+
getCustomerLifetimeSummaryMetrics({ customerId }: {
|
|
39103
|
+
customerId: any;
|
|
39104
|
+
}): rebilly.GetCustomerSummaryMetricReportResponsePromise;
|
|
36982
39105
|
};
|
|
36983
39106
|
}
|
|
36984
39107
|
declare module "resources/experimental/data-exports-resource" {
|
|
36985
39108
|
export default function DataExportsResource({ apiHandler }: {
|
|
36986
39109
|
apiHandler: any;
|
|
36987
39110
|
}): {
|
|
36988
|
-
getAll({ limit, offset, sort, expand, filter, q, criteria }?:
|
|
36989
|
-
|
|
36990
|
-
offset?: any;
|
|
36991
|
-
sort?: any;
|
|
36992
|
-
expand?: any;
|
|
36993
|
-
filter?: any;
|
|
36994
|
-
q?: any;
|
|
36995
|
-
criteria?: any;
|
|
36996
|
-
}): any;
|
|
39111
|
+
getAll({ limit, offset, sort, expand, filter, q, criteria, }?: rebilly.GetDataExportCollectionRequest): rebilly.GetDataExportCollectionResponsePromise;
|
|
39112
|
+
queue({ id, data, expand }: rebilly.CreateDataExportRequest): rebilly.PostDataExportResponsePromise;
|
|
36997
39113
|
get({ id, expand }: {
|
|
36998
39114
|
id: any;
|
|
36999
39115
|
expand?: any;
|
|
37000
|
-
}):
|
|
37001
|
-
queue({ data, expand }: {
|
|
37002
|
-
data: any;
|
|
37003
|
-
expand?: any;
|
|
37004
|
-
}): any;
|
|
39116
|
+
}): rebilly.GetDataExportResponsePromise;
|
|
37005
39117
|
update({ id, data, expand }: {
|
|
37006
39118
|
id: any;
|
|
37007
39119
|
data: any;
|
|
37008
39120
|
expand?: any;
|
|
37009
|
-
}):
|
|
39121
|
+
}): rebilly.PutDataExportResponsePromise;
|
|
37010
39122
|
delete({ id }: {
|
|
37011
39123
|
id: any;
|
|
37012
39124
|
}): any;
|
|
@@ -37016,208 +39128,174 @@ declare module "resources/experimental/histograms-resource" {
|
|
|
37016
39128
|
export default function HistogramsResource({ apiHandler }: {
|
|
37017
39129
|
apiHandler: any;
|
|
37018
39130
|
}): {
|
|
37019
|
-
getTransactionHistogramReport({ periodStart, periodEnd, aggregationField, aggregationPeriod, metric, filter,
|
|
37020
|
-
periodStart
|
|
37021
|
-
periodEnd
|
|
37022
|
-
aggregationField
|
|
37023
|
-
aggregationPeriod
|
|
37024
|
-
metric
|
|
39131
|
+
getTransactionHistogramReport({ periodStart, periodEnd, aggregationField, aggregationPeriod, metric, filter, }: {
|
|
39132
|
+
periodStart: any;
|
|
39133
|
+
periodEnd: any;
|
|
39134
|
+
aggregationField: any;
|
|
39135
|
+
aggregationPeriod: any;
|
|
39136
|
+
metric: any;
|
|
37025
39137
|
filter?: any;
|
|
37026
|
-
|
|
37027
|
-
}): any;
|
|
39138
|
+
}): rebilly.GetHistogramTransactionReportResponsePromise;
|
|
37028
39139
|
};
|
|
37029
39140
|
}
|
|
37030
39141
|
declare module "resources/experimental/reports-resource" {
|
|
37031
39142
|
export default function ReportsResource({ apiHandler }: {
|
|
37032
39143
|
apiHandler: any;
|
|
37033
39144
|
}): {
|
|
37034
|
-
getApiLogSummary({
|
|
37035
|
-
aggregationField: any;
|
|
39145
|
+
getApiLogSummary({ periodStart, periodEnd, limit, offset }: {
|
|
37036
39146
|
periodStart: any;
|
|
37037
39147
|
periodEnd: any;
|
|
37038
39148
|
limit?: any;
|
|
37039
39149
|
offset?: any;
|
|
37040
|
-
|
|
37041
|
-
}
|
|
37042
|
-
getCumulativeSubscriptions({ aggregationField, periodStart, periodEnd, limit, offset, filter, criteria, tz }?: {
|
|
39150
|
+
}): rebilly.GetApiLogSummaryReportResponsePromise;
|
|
39151
|
+
getCumulativeSubscriptions({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
|
|
37043
39152
|
aggregationField: any;
|
|
37044
39153
|
periodStart: any;
|
|
37045
39154
|
periodEnd: any;
|
|
37046
39155
|
limit?: any;
|
|
37047
39156
|
offset?: any;
|
|
37048
39157
|
filter?: any;
|
|
37049
|
-
|
|
37050
|
-
|
|
37051
|
-
|
|
37052
|
-
|
|
37053
|
-
periodStart?: any;
|
|
37054
|
-
periodEnd?: any;
|
|
37055
|
-
tz?: any;
|
|
39158
|
+
}): rebilly.GetCumulativeSubscriptionReportResponsePromise;
|
|
39159
|
+
getDashboardMetrics({ periodStart, periodEnd, metrics, segments, }: {
|
|
39160
|
+
periodStart: any;
|
|
39161
|
+
periodEnd: any;
|
|
37056
39162
|
metrics?: any;
|
|
37057
|
-
segments?:
|
|
37058
|
-
}):
|
|
37059
|
-
getDccMarkup({ aggregationField, periodStart, periodEnd, limit, offset, filter,
|
|
39163
|
+
segments?: any;
|
|
39164
|
+
}): rebilly.GetDashboardReportResponsePromise;
|
|
39165
|
+
getDccMarkup({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
|
|
37060
39166
|
aggregationField: any;
|
|
37061
39167
|
periodStart: any;
|
|
37062
39168
|
periodEnd: any;
|
|
37063
39169
|
limit?: any;
|
|
37064
39170
|
offset?: any;
|
|
37065
39171
|
filter?: any;
|
|
37066
|
-
|
|
37067
|
-
}
|
|
37068
|
-
getDisputes({ aggregationField, periodMonth, limit, offset, filter, tz }?: {
|
|
39172
|
+
}): rebilly.GetDccMarkupReportResponsePromise;
|
|
39173
|
+
getDisputes({ aggregationField, periodMonth, limit, offset, filter, }: {
|
|
37069
39174
|
aggregationField: any;
|
|
37070
39175
|
periodMonth: any;
|
|
37071
39176
|
limit?: any;
|
|
37072
39177
|
offset?: any;
|
|
37073
39178
|
filter?: any;
|
|
37074
|
-
|
|
37075
|
-
}
|
|
37076
|
-
getEventsTriggeredSummary({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
39179
|
+
}): rebilly.GetDisputeReportResponsePromise;
|
|
39180
|
+
getEventsTriggeredSummary({ periodStart, periodEnd, limit, offset, }: {
|
|
37077
39181
|
periodStart: any;
|
|
37078
39182
|
periodEnd: any;
|
|
37079
39183
|
limit?: any;
|
|
37080
39184
|
offset?: any;
|
|
37081
|
-
|
|
37082
|
-
}
|
|
37083
|
-
|
|
39185
|
+
}): rebilly.GetTriggeredEventReportResponsePromise;
|
|
39186
|
+
getTriggeredEventRuleReport({ eventType, periodStart, periodEnd, limit, offset, }: {
|
|
39187
|
+
eventType: any;
|
|
37084
39188
|
periodStart: any;
|
|
37085
39189
|
periodEnd: any;
|
|
37086
39190
|
limit?: any;
|
|
37087
39191
|
offset?: any;
|
|
37088
|
-
|
|
37089
|
-
}
|
|
37090
|
-
getKycAcceptanceSummary({ periodStart, periodEnd }?: {
|
|
39192
|
+
}): rebilly.GetTriggeredEventRuleReportResponsePromise;
|
|
39193
|
+
getFutureRenewals({ periodStart, periodEnd, limit, offset }: {
|
|
37091
39194
|
periodStart: any;
|
|
37092
39195
|
periodEnd: any;
|
|
37093
|
-
|
|
37094
|
-
|
|
39196
|
+
limit?: any;
|
|
39197
|
+
offset?: any;
|
|
39198
|
+
}): rebilly.GetFutureRenewalReportResponsePromise;
|
|
39199
|
+
getKycAcceptanceSummary({ periodStart, periodEnd }: {
|
|
37095
39200
|
periodStart: any;
|
|
37096
39201
|
periodEnd: any;
|
|
37097
|
-
}):
|
|
37098
|
-
|
|
39202
|
+
}): rebilly.GetKycAcceptanceSummaryReportResponsePromise;
|
|
39203
|
+
getKycRejectionSummary({ periodStart, periodEnd }: {
|
|
37099
39204
|
periodStart: any;
|
|
37100
39205
|
periodEnd: any;
|
|
37101
|
-
}):
|
|
37102
|
-
|
|
39206
|
+
}): rebilly.GetKycRejectionSummaryReportResponsePromise;
|
|
39207
|
+
getKycRequestSummary({ periodStart, periodEnd }: {
|
|
37103
39208
|
periodStart: any;
|
|
37104
39209
|
periodEnd: any;
|
|
39210
|
+
}): rebilly.GetKycRequestSummaryReportResponsePromise;
|
|
39211
|
+
getMonthlyRecurringRevenue({ currency, periodStart, periodEnd, limit, offset, }: {
|
|
37105
39212
|
currency: any;
|
|
37106
|
-
limit?: any;
|
|
37107
|
-
offset?: any;
|
|
37108
|
-
tz?: any;
|
|
37109
|
-
}): any;
|
|
37110
|
-
getRulesMatchedSummary({ eventType, periodStart, periodEnd, limit, offset, tz }?: {
|
|
37111
|
-
eventType: any;
|
|
37112
39213
|
periodStart: any;
|
|
37113
39214
|
periodEnd: any;
|
|
37114
39215
|
limit?: any;
|
|
37115
39216
|
offset?: any;
|
|
37116
|
-
|
|
37117
|
-
}
|
|
37118
|
-
getRenewalSales({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
39217
|
+
}): rebilly.GetMonthlyRecurringRevenueReportResponsePromise;
|
|
39218
|
+
getRenewalSales({ periodStart, periodEnd, limit, offset }: {
|
|
37119
39219
|
periodStart: any;
|
|
37120
39220
|
periodEnd: any;
|
|
37121
39221
|
limit?: any;
|
|
37122
39222
|
offset?: any;
|
|
37123
|
-
|
|
37124
|
-
}
|
|
37125
|
-
getRetentionPercentage({ aggregationField, aggregationPeriod, periodStart, periodEnd, includeSwitchedSubscriptions, limit, offset, filter, criteria, tz }?: {
|
|
39223
|
+
}): rebilly.GetRenewalSaleReportResponsePromise;
|
|
39224
|
+
getRetentionPercentage({ aggregationField, aggregationPeriod, includeSwitchedSubscriptions, periodStart, periodEnd, limit, offset, filter, criteria, }: {
|
|
37126
39225
|
aggregationField: any;
|
|
37127
39226
|
aggregationPeriod: any;
|
|
39227
|
+
includeSwitchedSubscriptions?: any;
|
|
37128
39228
|
periodStart: any;
|
|
37129
39229
|
periodEnd: any;
|
|
37130
|
-
includeSwitchedSubscriptions?: any;
|
|
37131
39230
|
limit?: any;
|
|
37132
39231
|
offset?: any;
|
|
37133
39232
|
filter?: any;
|
|
37134
39233
|
criteria?: any;
|
|
37135
|
-
|
|
37136
|
-
}
|
|
37137
|
-
getRetentionValue({ aggregationField, aggregationPeriod, periodStart, periodEnd, includeRefunds, includeDisputes, limit, offset, sort, filter, criteria, tz }?: {
|
|
39234
|
+
}): rebilly.GetRetentionPercentageReportResponsePromise;
|
|
39235
|
+
getRetentionValue({ aggregationField, aggregationPeriod, includeRefunds, includeDisputes, periodStart, periodEnd, limit, offset, filter, sort, criteria, }: {
|
|
37138
39236
|
aggregationField: any;
|
|
37139
39237
|
aggregationPeriod: any;
|
|
37140
|
-
periodStart: any;
|
|
37141
|
-
periodEnd: any;
|
|
37142
39238
|
includeRefunds?: any;
|
|
37143
39239
|
includeDisputes?: any;
|
|
39240
|
+
periodStart: any;
|
|
39241
|
+
periodEnd: any;
|
|
37144
39242
|
limit?: any;
|
|
37145
39243
|
offset?: any;
|
|
37146
|
-
sort?: any;
|
|
37147
39244
|
filter?: any;
|
|
39245
|
+
sort?: any;
|
|
37148
39246
|
criteria?: any;
|
|
37149
|
-
|
|
37150
|
-
}
|
|
37151
|
-
getRevenueWaterfall({ currency, issuedFrom, issuedTo, recognizedTo, limit, offset, tz }: {
|
|
39247
|
+
}): rebilly.GetRetentionValueReportResponsePromise;
|
|
39248
|
+
getRevenueWaterfall({ currency, issuedFrom, issuedTo, recognizedTo }: {
|
|
37152
39249
|
currency: any;
|
|
37153
39250
|
issuedFrom: any;
|
|
37154
39251
|
issuedTo: any;
|
|
37155
39252
|
recognizedTo: any;
|
|
37156
|
-
|
|
37157
|
-
|
|
37158
|
-
tz?: any;
|
|
37159
|
-
}): any;
|
|
37160
|
-
getSubscriptionCancellation({ aggregationField, periodStart, periodEnd, limit, offset, filter, criteria, tz }?: {
|
|
37161
|
-
aggregationField: any;
|
|
39253
|
+
}): rebilly.GetRevenueWaterfallReportResponsePromise;
|
|
39254
|
+
getSubscriptionCancellation({ periodStart, periodEnd, aggregationField, limit, offset, filter, }: {
|
|
37162
39255
|
periodStart: any;
|
|
37163
39256
|
periodEnd: any;
|
|
39257
|
+
aggregationField: any;
|
|
37164
39258
|
limit?: any;
|
|
37165
39259
|
offset?: any;
|
|
37166
39260
|
filter?: any;
|
|
37167
|
-
|
|
37168
|
-
|
|
37169
|
-
}): any;
|
|
37170
|
-
getSubscriptionRenewalList({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
37171
|
-
periodStart: any;
|
|
37172
|
-
periodEnd: any;
|
|
37173
|
-
limit?: any;
|
|
37174
|
-
offset?: any;
|
|
37175
|
-
tz?: any;
|
|
37176
|
-
}): any;
|
|
37177
|
-
getSubscriptionRenewal({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
39261
|
+
}): rebilly.GetSubscriptionCancellationReportResponsePromise;
|
|
39262
|
+
getSubscriptionRenewal({ periodStart, periodEnd, limit, offset, }: {
|
|
37178
39263
|
periodStart: any;
|
|
37179
39264
|
periodEnd: any;
|
|
37180
39265
|
limit?: any;
|
|
37181
39266
|
offset?: any;
|
|
37182
|
-
|
|
37183
|
-
}
|
|
37184
|
-
getTimeSeriesTransaction({ periodStart, periodEnd, type, subaggregate, limit, offset }?: {
|
|
37185
|
-
periodStart: any;
|
|
37186
|
-
periodEnd: any;
|
|
39267
|
+
}): rebilly.GetSubscriptionRenewalReportResponsePromise;
|
|
39268
|
+
getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd }: {
|
|
37187
39269
|
type: any;
|
|
37188
39270
|
subaggregate: any;
|
|
37189
|
-
|
|
37190
|
-
|
|
37191
|
-
}):
|
|
37192
|
-
getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter,
|
|
39271
|
+
periodStart: any;
|
|
39272
|
+
periodEnd: any;
|
|
39273
|
+
}): rebilly.GetTimeSeriesTransactionReportResponsePromise;
|
|
39274
|
+
getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
|
|
37193
39275
|
aggregationField: any;
|
|
37194
39276
|
periodStart: any;
|
|
37195
39277
|
periodEnd: any;
|
|
37196
39278
|
limit?: any;
|
|
37197
39279
|
offset?: any;
|
|
37198
39280
|
filter?: any;
|
|
37199
|
-
|
|
37200
|
-
|
|
37201
|
-
}): any;
|
|
37202
|
-
getTransactions({ aggregationField, periodStart, periodEnd, limit, offset, filter, criteria, tz }?: {
|
|
37203
|
-
aggregationField: any;
|
|
39281
|
+
}): rebilly.GetTransactionTimeDisputeReportResponsePromise;
|
|
39282
|
+
getTransactions({ periodStart, periodEnd, aggregationField, limit, offset, filter, }: {
|
|
37204
39283
|
periodStart: any;
|
|
37205
39284
|
periodEnd: any;
|
|
39285
|
+
aggregationField: any;
|
|
37206
39286
|
limit?: any;
|
|
37207
39287
|
offset?: any;
|
|
37208
39288
|
filter?: any;
|
|
37209
|
-
|
|
37210
|
-
tz?: any;
|
|
37211
|
-
}): any;
|
|
39289
|
+
}): rebilly.GetTransactionReportResponsePromise;
|
|
37212
39290
|
};
|
|
37213
39291
|
}
|
|
37214
39292
|
declare module "resources/experimental/subscriptions-resource" {
|
|
37215
39293
|
export default function SubscriptionsResource({ apiHandler }: {
|
|
37216
39294
|
apiHandler: any;
|
|
37217
39295
|
}): {
|
|
37218
|
-
getSubscriptionSummaryMetrics({ subscriptionId }
|
|
37219
|
-
subscriptionId
|
|
37220
|
-
}):
|
|
39296
|
+
getSubscriptionSummaryMetrics({ subscriptionId }: {
|
|
39297
|
+
subscriptionId: any;
|
|
39298
|
+
}): rebilly.GetSubscriptionSummaryMetricReportResponsePromise;
|
|
37221
39299
|
};
|
|
37222
39300
|
}
|
|
37223
39301
|
declare module "resources/experimental/timelines-resource" {
|
|
@@ -37256,232 +39334,195 @@ declare module "resources/experimental/experimental-resources" {
|
|
|
37256
39334
|
apiHandler: any;
|
|
37257
39335
|
});
|
|
37258
39336
|
customers: {
|
|
37259
|
-
getCustomerLifetimeSummaryMetrics({ customerId }
|
|
37260
|
-
customerId
|
|
37261
|
-
}):
|
|
39337
|
+
getCustomerLifetimeSummaryMetrics({ customerId }: {
|
|
39338
|
+
customerId: any;
|
|
39339
|
+
}): rebilly.GetCustomerSummaryMetricReportResponsePromise;
|
|
37262
39340
|
};
|
|
37263
39341
|
dataExports: {
|
|
37264
|
-
getAll({ limit, offset, sort, expand, filter, q, criteria }?: {
|
|
37265
|
-
limit?:
|
|
37266
|
-
offset?:
|
|
37267
|
-
sort?:
|
|
37268
|
-
expand?:
|
|
37269
|
-
filter?:
|
|
37270
|
-
q?:
|
|
37271
|
-
criteria?:
|
|
37272
|
-
}):
|
|
39342
|
+
getAll({ limit, offset, sort, expand, filter, q, criteria, }?: {
|
|
39343
|
+
limit?: number;
|
|
39344
|
+
offset?: number;
|
|
39345
|
+
sort?: string[];
|
|
39346
|
+
expand?: string;
|
|
39347
|
+
filter?: string;
|
|
39348
|
+
q?: string;
|
|
39349
|
+
criteria?: string;
|
|
39350
|
+
}): rebilly.GetDataExportCollectionResponsePromise;
|
|
39351
|
+
queue({ id, data, expand }: rebilly.CreateDataExportRequest): rebilly.PostDataExportResponsePromise;
|
|
37273
39352
|
get({ id, expand }: {
|
|
37274
39353
|
id: any;
|
|
37275
39354
|
expand?: any;
|
|
37276
|
-
}):
|
|
37277
|
-
queue({ data, expand }: {
|
|
37278
|
-
data: any;
|
|
37279
|
-
expand?: any;
|
|
37280
|
-
}): any;
|
|
39355
|
+
}): rebilly.GetDataExportResponsePromise;
|
|
37281
39356
|
update({ id, data, expand }: {
|
|
37282
39357
|
id: any;
|
|
37283
39358
|
data: any;
|
|
37284
39359
|
expand?: any;
|
|
37285
|
-
}):
|
|
39360
|
+
}): rebilly.PutDataExportResponsePromise;
|
|
37286
39361
|
delete({ id }: {
|
|
37287
39362
|
id: any;
|
|
37288
39363
|
}): any;
|
|
37289
39364
|
};
|
|
37290
39365
|
histograms: {
|
|
37291
|
-
getTransactionHistogramReport({ periodStart, periodEnd, aggregationField, aggregationPeriod, metric, filter,
|
|
37292
|
-
periodStart
|
|
37293
|
-
periodEnd
|
|
37294
|
-
aggregationField
|
|
37295
|
-
aggregationPeriod
|
|
37296
|
-
metric
|
|
39366
|
+
getTransactionHistogramReport({ periodStart, periodEnd, aggregationField, aggregationPeriod, metric, filter, }: {
|
|
39367
|
+
periodStart: any;
|
|
39368
|
+
periodEnd: any;
|
|
39369
|
+
aggregationField: any;
|
|
39370
|
+
aggregationPeriod: any;
|
|
39371
|
+
metric: any;
|
|
37297
39372
|
filter?: any;
|
|
37298
|
-
|
|
37299
|
-
}): any;
|
|
39373
|
+
}): rebilly.GetHistogramTransactionReportResponsePromise;
|
|
37300
39374
|
};
|
|
37301
39375
|
reports: {
|
|
37302
|
-
getApiLogSummary({
|
|
37303
|
-
aggregationField: any;
|
|
39376
|
+
getApiLogSummary({ periodStart, periodEnd, limit, offset }: {
|
|
37304
39377
|
periodStart: any;
|
|
37305
39378
|
periodEnd: any;
|
|
37306
39379
|
limit?: any;
|
|
37307
39380
|
offset?: any;
|
|
37308
|
-
|
|
37309
|
-
}
|
|
37310
|
-
getCumulativeSubscriptions({ aggregationField, periodStart, periodEnd, limit, offset, filter, criteria, tz }?: {
|
|
39381
|
+
}): rebilly.GetApiLogSummaryReportResponsePromise;
|
|
39382
|
+
getCumulativeSubscriptions({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
|
|
37311
39383
|
aggregationField: any;
|
|
37312
39384
|
periodStart: any;
|
|
37313
39385
|
periodEnd: any;
|
|
37314
39386
|
limit?: any;
|
|
37315
39387
|
offset?: any;
|
|
37316
39388
|
filter?: any;
|
|
37317
|
-
|
|
37318
|
-
|
|
37319
|
-
|
|
37320
|
-
|
|
37321
|
-
periodStart?: any;
|
|
37322
|
-
periodEnd?: any;
|
|
37323
|
-
tz?: any;
|
|
39389
|
+
}): rebilly.GetCumulativeSubscriptionReportResponsePromise;
|
|
39390
|
+
getDashboardMetrics({ periodStart, periodEnd, metrics, segments, }: {
|
|
39391
|
+
periodStart: any;
|
|
39392
|
+
periodEnd: any;
|
|
37324
39393
|
metrics?: any;
|
|
37325
|
-
segments?:
|
|
37326
|
-
}):
|
|
37327
|
-
getDccMarkup({ aggregationField, periodStart, periodEnd, limit, offset, filter,
|
|
39394
|
+
segments?: any;
|
|
39395
|
+
}): rebilly.GetDashboardReportResponsePromise;
|
|
39396
|
+
getDccMarkup({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
|
|
37328
39397
|
aggregationField: any;
|
|
37329
39398
|
periodStart: any;
|
|
37330
39399
|
periodEnd: any;
|
|
37331
39400
|
limit?: any;
|
|
37332
39401
|
offset?: any;
|
|
37333
39402
|
filter?: any;
|
|
37334
|
-
|
|
37335
|
-
}
|
|
37336
|
-
getDisputes({ aggregationField, periodMonth, limit, offset, filter, tz }?: {
|
|
39403
|
+
}): rebilly.GetDccMarkupReportResponsePromise;
|
|
39404
|
+
getDisputes({ aggregationField, periodMonth, limit, offset, filter, }: {
|
|
37337
39405
|
aggregationField: any;
|
|
37338
39406
|
periodMonth: any;
|
|
37339
39407
|
limit?: any;
|
|
37340
39408
|
offset?: any;
|
|
37341
39409
|
filter?: any;
|
|
37342
|
-
|
|
37343
|
-
}
|
|
37344
|
-
getEventsTriggeredSummary({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
39410
|
+
}): rebilly.GetDisputeReportResponsePromise;
|
|
39411
|
+
getEventsTriggeredSummary({ periodStart, periodEnd, limit, offset, }: {
|
|
37345
39412
|
periodStart: any;
|
|
37346
39413
|
periodEnd: any;
|
|
37347
39414
|
limit?: any;
|
|
37348
39415
|
offset?: any;
|
|
37349
|
-
|
|
37350
|
-
}
|
|
37351
|
-
|
|
39416
|
+
}): rebilly.GetTriggeredEventReportResponsePromise;
|
|
39417
|
+
getTriggeredEventRuleReport({ eventType, periodStart, periodEnd, limit, offset, }: {
|
|
39418
|
+
eventType: any;
|
|
37352
39419
|
periodStart: any;
|
|
37353
39420
|
periodEnd: any;
|
|
37354
39421
|
limit?: any;
|
|
37355
39422
|
offset?: any;
|
|
37356
|
-
|
|
37357
|
-
}
|
|
37358
|
-
getKycAcceptanceSummary({ periodStart, periodEnd }?: {
|
|
39423
|
+
}): rebilly.GetTriggeredEventRuleReportResponsePromise;
|
|
39424
|
+
getFutureRenewals({ periodStart, periodEnd, limit, offset }: {
|
|
37359
39425
|
periodStart: any;
|
|
37360
39426
|
periodEnd: any;
|
|
37361
|
-
|
|
37362
|
-
|
|
39427
|
+
limit?: any;
|
|
39428
|
+
offset?: any;
|
|
39429
|
+
}): rebilly.GetFutureRenewalReportResponsePromise;
|
|
39430
|
+
getKycAcceptanceSummary({ periodStart, periodEnd }: {
|
|
37363
39431
|
periodStart: any;
|
|
37364
39432
|
periodEnd: any;
|
|
37365
|
-
}):
|
|
37366
|
-
|
|
39433
|
+
}): rebilly.GetKycAcceptanceSummaryReportResponsePromise;
|
|
39434
|
+
getKycRejectionSummary({ periodStart, periodEnd }: {
|
|
37367
39435
|
periodStart: any;
|
|
37368
39436
|
periodEnd: any;
|
|
37369
|
-
}):
|
|
37370
|
-
|
|
39437
|
+
}): rebilly.GetKycRejectionSummaryReportResponsePromise;
|
|
39438
|
+
getKycRequestSummary({ periodStart, periodEnd }: {
|
|
37371
39439
|
periodStart: any;
|
|
37372
39440
|
periodEnd: any;
|
|
39441
|
+
}): rebilly.GetKycRequestSummaryReportResponsePromise;
|
|
39442
|
+
getMonthlyRecurringRevenue({ currency, periodStart, periodEnd, limit, offset, }: {
|
|
37373
39443
|
currency: any;
|
|
37374
|
-
limit?: any;
|
|
37375
|
-
offset?: any;
|
|
37376
|
-
tz?: any;
|
|
37377
|
-
}): any;
|
|
37378
|
-
getRulesMatchedSummary({ eventType, periodStart, periodEnd, limit, offset, tz }?: {
|
|
37379
|
-
eventType: any;
|
|
37380
39444
|
periodStart: any;
|
|
37381
39445
|
periodEnd: any;
|
|
37382
39446
|
limit?: any;
|
|
37383
39447
|
offset?: any;
|
|
37384
|
-
|
|
37385
|
-
}
|
|
37386
|
-
getRenewalSales({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
39448
|
+
}): rebilly.GetMonthlyRecurringRevenueReportResponsePromise;
|
|
39449
|
+
getRenewalSales({ periodStart, periodEnd, limit, offset }: {
|
|
37387
39450
|
periodStart: any;
|
|
37388
39451
|
periodEnd: any;
|
|
37389
39452
|
limit?: any;
|
|
37390
39453
|
offset?: any;
|
|
37391
|
-
|
|
37392
|
-
}
|
|
37393
|
-
getRetentionPercentage({ aggregationField, aggregationPeriod, periodStart, periodEnd, includeSwitchedSubscriptions, limit, offset, filter, criteria, tz }?: {
|
|
39454
|
+
}): rebilly.GetRenewalSaleReportResponsePromise;
|
|
39455
|
+
getRetentionPercentage({ aggregationField, aggregationPeriod, includeSwitchedSubscriptions, periodStart, periodEnd, limit, offset, filter, criteria, }: {
|
|
37394
39456
|
aggregationField: any;
|
|
37395
39457
|
aggregationPeriod: any;
|
|
39458
|
+
includeSwitchedSubscriptions?: any;
|
|
37396
39459
|
periodStart: any;
|
|
37397
39460
|
periodEnd: any;
|
|
37398
|
-
includeSwitchedSubscriptions?: any;
|
|
37399
39461
|
limit?: any;
|
|
37400
39462
|
offset?: any;
|
|
37401
39463
|
filter?: any;
|
|
37402
39464
|
criteria?: any;
|
|
37403
|
-
|
|
37404
|
-
}
|
|
37405
|
-
getRetentionValue({ aggregationField, aggregationPeriod, periodStart, periodEnd, includeRefunds, includeDisputes, limit, offset, sort, filter, criteria, tz }?: {
|
|
39465
|
+
}): rebilly.GetRetentionPercentageReportResponsePromise;
|
|
39466
|
+
getRetentionValue({ aggregationField, aggregationPeriod, includeRefunds, includeDisputes, periodStart, periodEnd, limit, offset, filter, sort, criteria, }: {
|
|
37406
39467
|
aggregationField: any;
|
|
37407
39468
|
aggregationPeriod: any;
|
|
37408
|
-
periodStart: any;
|
|
37409
|
-
periodEnd: any;
|
|
37410
39469
|
includeRefunds?: any;
|
|
37411
39470
|
includeDisputes?: any;
|
|
39471
|
+
periodStart: any;
|
|
39472
|
+
periodEnd: any;
|
|
37412
39473
|
limit?: any;
|
|
37413
39474
|
offset?: any;
|
|
37414
|
-
sort?: any;
|
|
37415
39475
|
filter?: any;
|
|
39476
|
+
sort?: any;
|
|
37416
39477
|
criteria?: any;
|
|
37417
|
-
|
|
37418
|
-
}
|
|
37419
|
-
getRevenueWaterfall({ currency, issuedFrom, issuedTo, recognizedTo, limit, offset, tz }: {
|
|
39478
|
+
}): rebilly.GetRetentionValueReportResponsePromise;
|
|
39479
|
+
getRevenueWaterfall({ currency, issuedFrom, issuedTo, recognizedTo }: {
|
|
37420
39480
|
currency: any;
|
|
37421
39481
|
issuedFrom: any;
|
|
37422
39482
|
issuedTo: any;
|
|
37423
39483
|
recognizedTo: any;
|
|
37424
|
-
|
|
37425
|
-
|
|
37426
|
-
tz?: any;
|
|
37427
|
-
}): any;
|
|
37428
|
-
getSubscriptionCancellation({ aggregationField, periodStart, periodEnd, limit, offset, filter, criteria, tz }?: {
|
|
37429
|
-
aggregationField: any;
|
|
39484
|
+
}): rebilly.GetRevenueWaterfallReportResponsePromise;
|
|
39485
|
+
getSubscriptionCancellation({ periodStart, periodEnd, aggregationField, limit, offset, filter, }: {
|
|
37430
39486
|
periodStart: any;
|
|
37431
39487
|
periodEnd: any;
|
|
39488
|
+
aggregationField: any;
|
|
37432
39489
|
limit?: any;
|
|
37433
39490
|
offset?: any;
|
|
37434
39491
|
filter?: any;
|
|
37435
|
-
|
|
37436
|
-
|
|
37437
|
-
}): any;
|
|
37438
|
-
getSubscriptionRenewalList({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
37439
|
-
periodStart: any;
|
|
37440
|
-
periodEnd: any;
|
|
37441
|
-
limit?: any;
|
|
37442
|
-
offset?: any;
|
|
37443
|
-
tz?: any;
|
|
37444
|
-
}): any;
|
|
37445
|
-
getSubscriptionRenewal({ periodStart, periodEnd, limit, offset, tz }?: {
|
|
39492
|
+
}): rebilly.GetSubscriptionCancellationReportResponsePromise;
|
|
39493
|
+
getSubscriptionRenewal({ periodStart, periodEnd, limit, offset, }: {
|
|
37446
39494
|
periodStart: any;
|
|
37447
39495
|
periodEnd: any;
|
|
37448
39496
|
limit?: any;
|
|
37449
39497
|
offset?: any;
|
|
37450
|
-
|
|
37451
|
-
}
|
|
37452
|
-
getTimeSeriesTransaction({ periodStart, periodEnd, type, subaggregate, limit, offset }?: {
|
|
37453
|
-
periodStart: any;
|
|
37454
|
-
periodEnd: any;
|
|
39498
|
+
}): rebilly.GetSubscriptionRenewalReportResponsePromise;
|
|
39499
|
+
getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd }: {
|
|
37455
39500
|
type: any;
|
|
37456
39501
|
subaggregate: any;
|
|
37457
|
-
|
|
37458
|
-
|
|
37459
|
-
}):
|
|
37460
|
-
getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter,
|
|
39502
|
+
periodStart: any;
|
|
39503
|
+
periodEnd: any;
|
|
39504
|
+
}): rebilly.GetTimeSeriesTransactionReportResponsePromise;
|
|
39505
|
+
getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
|
|
37461
39506
|
aggregationField: any;
|
|
37462
39507
|
periodStart: any;
|
|
37463
39508
|
periodEnd: any;
|
|
37464
39509
|
limit?: any;
|
|
37465
39510
|
offset?: any;
|
|
37466
39511
|
filter?: any;
|
|
37467
|
-
|
|
37468
|
-
|
|
37469
|
-
}): any;
|
|
37470
|
-
getTransactions({ aggregationField, periodStart, periodEnd, limit, offset, filter, criteria, tz }?: {
|
|
37471
|
-
aggregationField: any;
|
|
39512
|
+
}): rebilly.GetTransactionTimeDisputeReportResponsePromise;
|
|
39513
|
+
getTransactions({ periodStart, periodEnd, aggregationField, limit, offset, filter, }: {
|
|
37472
39514
|
periodStart: any;
|
|
37473
39515
|
periodEnd: any;
|
|
39516
|
+
aggregationField: any;
|
|
37474
39517
|
limit?: any;
|
|
37475
39518
|
offset?: any;
|
|
37476
39519
|
filter?: any;
|
|
37477
|
-
|
|
37478
|
-
tz?: any;
|
|
37479
|
-
}): any;
|
|
39520
|
+
}): rebilly.GetTransactionReportResponsePromise;
|
|
37480
39521
|
};
|
|
37481
39522
|
subscriptions: {
|
|
37482
|
-
getSubscriptionSummaryMetrics({ subscriptionId }
|
|
37483
|
-
subscriptionId
|
|
37484
|
-
}):
|
|
39523
|
+
getSubscriptionSummaryMetrics({ subscriptionId }: {
|
|
39524
|
+
subscriptionId: any;
|
|
39525
|
+
}): rebilly.GetSubscriptionSummaryMetricReportResponsePromise;
|
|
37485
39526
|
};
|
|
37486
39527
|
timelines: {
|
|
37487
39528
|
getActivityFeed({ eventTypes, limit, offset }: {
|