@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +14 -14
  4. package/sdk/application/Cart/CartApplicationClient.js +14 -14
  5. package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
  6. package/sdk/application/Content/ContentApplicationClient.js +53 -0
  7. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  8. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  9. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -0
  10. package/sdk/application/Logistic/LogisticApplicationClient.js +136 -0
  11. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -12
  12. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -12
  13. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +46 -33
  14. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +41 -25
  15. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -4
  16. package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
  17. package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
  18. package/sdk/platform/Billing/BillingPlatformModel.d.ts +417 -3811
  19. package/sdk/platform/Billing/BillingPlatformModel.js +292 -2544
  20. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
  21. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
  22. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -34
  23. package/sdk/platform/Cart/CartPlatformApplicationClient.js +34 -34
  24. package/sdk/platform/Cart/CartPlatformModel.d.ts +363 -29
  25. package/sdk/platform/Cart/CartPlatformModel.js +203 -31
  26. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +57 -57
  27. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +220 -200
  28. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +121 -91
  29. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +58 -46
  30. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
  31. package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
  32. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +22 -228
  33. package/sdk/platform/Catalog/CatalogPlatformModel.js +12 -163
  34. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
  35. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
  36. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +4 -8
  37. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +10 -14
  38. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +94 -30
  39. package/sdk/platform/Communication/CommunicationPlatformModel.js +110 -32
  40. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +33 -1
  41. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +62 -0
  42. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +11 -0
  43. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +5 -0
  44. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +12 -2
  45. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -1
  46. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +6 -4
  47. package/sdk/platform/Content/ContentPlatformApplicationClient.js +12 -10
  48. package/sdk/platform/Content/ContentPlatformModel.d.ts +42 -12
  49. package/sdk/platform/Content/ContentPlatformModel.js +43 -13
  50. package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
  51. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  52. package/sdk/platform/Order/OrderPlatformClient.d.ts +21 -21
  53. package/sdk/platform/Order/OrderPlatformClient.js +21 -21
  54. package/sdk/platform/Order/OrderPlatformModel.d.ts +1010 -80
  55. package/sdk/platform/Order/OrderPlatformModel.js +665 -70
  56. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +31 -4
  57. package/sdk/platform/Payment/PaymentPlatformModel.js +11 -4
  58. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +1 -1
  59. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -0
  60. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +14 -0
  61. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +6 -0
  62. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +24 -0
  63. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
  64. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +194 -23
  65. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +116 -22
  66. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +23 -1
  67. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +16 -0
  68. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
  69. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  70. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +10 -12
  71. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +45 -49
  72. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -10
  73. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +12 -12
  74. package/sdk/public/PublicClient.d.ts +0 -2
  75. package/sdk/public/PublicClient.js +0 -4
  76. package/sdk/public/index.d.ts +0 -1
  77. package/sdk/public/index.js +0 -2
  78. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
  79. package/sdk/public/Billing/BillingPublicClient.js +0 -397
  80. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
  81. package/sdk/public/Billing/BillingPublicModel.js +0 -560
  82. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
  83. package/sdk/public/Billing/BillingPublicValidator.js +0 -50
@@ -2,16 +2,6 @@ export = Billing;
2
2
  declare class Billing {
3
3
  constructor(config: any);
4
4
  config: any;
5
- /**
6
- * @param {BillingPlatformValidator.ActivateSubscriptionPlanParam} arg - Arg object
7
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
- * @param {import("../PlatformAPIClient").Options} - Options
9
- * @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
10
- * @name activateSubscriptionPlan
11
- * @summary: Activate a subscription plan.
12
- * @description: Activate a specific subscription plan for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/activateSubscriptionPlan/).
13
- */
14
- activateSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.ActivateSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionActivateRes>;
15
5
  /**
16
6
  * @param {BillingPlatformValidator.CancelSubscriptionChargeParam} arg - Arg object
17
7
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -22,36 +12,6 @@ declare class Billing {
22
12
  * @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
23
13
  */
24
14
  cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
25
- /**
26
- * @param {BillingPlatformValidator.CancelSubscriptionPlanParam} arg - Arg object
27
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
28
- * @param {import("../PlatformAPIClient").Options} - Options
29
- * @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
30
- * @name cancelSubscriptionPlan
31
- * @summary: Cancel a subscription plan.
32
- * @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
33
- */
34
- cancelSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelSubscriptionRes>;
35
- /**
36
- * @param {BillingPlatformValidator.ChangePlanParam} arg - Arg object
37
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
38
- * @param {import("../PlatformAPIClient").Options} - Options
39
- * @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
40
- * @name changePlan
41
- * @summary: Upgrade plan.
42
- * @description: Admin user can modify the subscription plan for an seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/changePlan/).
43
- */
44
- changePlan({ body, requestHeaders }?: BillingPlatformValidator.ChangePlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionActivateRes>;
45
- /**
46
- * @param {BillingPlatformValidator.CheckCouponValidityParam} arg - Arg object
47
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
48
- * @param {import("../PlatformAPIClient").Options} - Options
49
- * @returns {Promise<BillingPlatformModel.CheckValidityResponse>} - Success response
50
- * @name checkCouponValidity
51
- * @summary: Verify coupon validity.
52
- * @description: Checks whether a coupon code is valid for discounts while billing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/checkCouponValidity/).
53
- */
54
- checkCouponValidity({ plan, couponCode, requestHeaders }?: BillingPlatformValidator.CheckCouponValidityParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CheckValidityResponse>;
55
15
  /**
56
16
  * @param {BillingPlatformValidator.CreateOneTimeChargeParam} arg - Arg object
57
17
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -64,36 +24,16 @@ declare class Billing {
64
24
  */
65
25
  createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponse>;
66
26
  /**
67
- * @param {BillingPlatformValidator.CreditTransactionParam} arg - Arg object
27
+ * @param {BillingPlatformValidator.CreateSubscriptionChargeParam} arg - Arg object
68
28
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
69
29
  * @param {import("../PlatformAPIClient").Options} - Options
70
- * @returns {Promise<BillingPlatformModel.CreditTransactionResponse>} -
30
+ * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
71
31
  * Success response
72
- * @name creditTransaction
73
- * @summary: Credit Transaction
74
- * @description: Credit Transaction - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/creditTransaction/).
75
- */
76
- creditTransaction({ uniqueId, productSuite, type, pageSize, pageNo, startDate, endDate, searchType, searchValue, requestHeaders, }?: BillingPlatformValidator.CreditTransactionParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreditTransactionResponse>;
77
- /**
78
- * @param {BillingPlatformValidator.CurrentAppLimitParam} arg - Arg object
79
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
80
- * @param {import("../PlatformAPIClient").Options} - Options
81
- * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
82
- * @name currentAppLimit
83
- * @summary: Obtain feature limit configurations.
84
- * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/currentAppLimit/).
32
+ * @name createSubscriptionCharge
33
+ * @summary: Initiate subscription billing
34
+ * @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
85
35
  */
86
- currentAppLimit({ productSuite, type, requestHeaders }?: BillingPlatformValidator.CurrentAppLimitParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
87
- /**
88
- * @param {BillingPlatformValidator.GetBankListParam} arg - Arg object
89
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
90
- * @param {import("../PlatformAPIClient").Options} - Options
91
- * @returns {Promise<string>} - Success response
92
- * @name getBankList
93
- * @summary: Get Bank List
94
- * @description: Get Bank List - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getBankList/).
95
- */
96
- getBankList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
36
+ createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
97
37
  /**
98
38
  * @param {BillingPlatformValidator.GetChargeDetailsParam} arg - Arg object
99
39
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -104,87 +44,6 @@ declare class Billing {
104
44
  * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
105
45
  */
106
46
  getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ChargeDetails>;
107
- /**
108
- * @param {BillingPlatformValidator.GetCustomerDetailParam} arg - Arg object
109
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
110
- * @param {import("../PlatformAPIClient").Options} - Options
111
- * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
112
- * @name getCustomerDetail
113
- * @summary: Fetch customer details.
114
- * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
115
- */
116
- getCustomerDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
117
- /**
118
- * @param {BillingPlatformValidator.GetEnterprisePlansParam} arg - Arg object
119
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
120
- * @param {import("../PlatformAPIClient").Options} - Options
121
- * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
122
- * @name getEnterprisePlans
123
- * @summary: Retrieve enterprise-level plans.
124
- * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
125
- */
126
- getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
127
- /**
128
- * @param {BillingPlatformValidator.GetFeatureLimitConfigParam} arg - Arg object
129
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
130
- * @param {import("../PlatformAPIClient").Options} - Options
131
- * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
132
- * @name getFeatureLimitConfig
133
- * @summary: Obtain feature limit configurations.
134
- * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
135
- */
136
- getFeatureLimitConfig({ productSuite, type, requestHeaders }?: BillingPlatformValidator.GetFeatureLimitConfigParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
137
- /**
138
- * @param {BillingPlatformValidator.GetInvoiceByIdParam} arg - Arg object
139
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
140
- * @param {import("../PlatformAPIClient").Options} - Options
141
- * @returns {Promise<BillingPlatformModel.InvoiceData>} - Success response
142
- * @name getInvoiceById
143
- * @summary: Get a specific invoice.
144
- * @description: Retrieve a particular invoice's details by providing its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoiceById/).
145
- */
146
- getInvoiceById({ invoiceId, requestHeaders }?: BillingPlatformValidator.GetInvoiceByIdParam, { responseHeaders }?: object): Promise<BillingPlatformModel.InvoiceData>;
147
- /**
148
- * @param {BillingPlatformValidator.GetInvoicesParam} arg - Arg object
149
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
150
- * @param {import("../PlatformAPIClient").Options} - Options
151
- * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
152
- * @name getInvoices
153
- * @summary: Retrieve invoices.
154
- * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
155
- */
156
- getInvoices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoices>;
157
- /**
158
- * @param {BillingPlatformValidator.GetPaymentOptionsParam} arg - Arg object
159
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
160
- * @param {import("../PlatformAPIClient").Options} - Options
161
- * @returns {Promise<BillingPlatformModel.GetPaymentOptions>} - Success response
162
- * @name getPaymentOptions
163
- * @summary: API to get payment options
164
- * @description: API to get payment options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getPaymentOptions/).
165
- */
166
- getPaymentOptions({ transactionId, requestHeaders }?: BillingPlatformValidator.GetPaymentOptionsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.GetPaymentOptions>;
167
- /**
168
- * @param {BillingPlatformValidator.GetPaymentTransactionParam} arg - Arg object
169
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
170
- * @param {import("../PlatformAPIClient").Options} - Options
171
- * @returns {Promise<BillingPlatformModel.PaymentTransactionDetails>} -
172
- * Success response
173
- * @name getPaymentTransaction
174
- * @summary: API to get payment transaction details
175
- * @description: API to get payment transaction details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getPaymentTransaction/).
176
- */
177
- getPaymentTransaction({ transactionId, requestHeaders }?: BillingPlatformValidator.GetPaymentTransactionParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentTransactionDetails>;
178
- /**
179
- * @param {BillingPlatformValidator.GetSubscriptionParam} arg - Arg object
180
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
181
- * @param {import("../PlatformAPIClient").Options} - Options
182
- * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
183
- * @name getSubscription
184
- * @summary: Retrieve subscription details.
185
- * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
186
- */
187
- getSubscription({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionStatus>;
188
47
  /**
189
48
  * @param {BillingPlatformValidator.GetSubscriptionChargeParam} arg - Arg object
190
49
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -195,256 +54,6 @@ declare class Billing {
195
54
  * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
196
55
  */
197
56
  getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
198
- /**
199
- * @param {BillingPlatformValidator.GetentityDetailParam} arg - Arg object
200
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
201
- * @param {import("../PlatformAPIClient").Options} - Options
202
- * @returns {Promise<BillingPlatformModel.EntityDetail[]>} - Success response
203
- * @name getentityDetail
204
- * @summary: Generic api to get the entity detail
205
- * @description: Generic api to get the entity detail - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getentityDetail/).
206
- */
207
- getentityDetail({ entityName, channel, entityId, component, componentName, requestHeaders, }?: BillingPlatformValidator.GetentityDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntityDetail[]>;
208
- /**
209
- * @param {BillingPlatformValidator.GlobalSettingsParam} arg - Arg object
210
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
211
- * @param {import("../PlatformAPIClient").Options} - Options
212
- * @returns {Promise<BillingPlatformModel.GlobalSettings>} - Success response
213
- * @name globalSettings
214
- * @summary: API to get global settings details
215
- * @description: API to get global settings details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/globalSettings/).
216
- */
217
- globalSettings({ pageNo, pageSize, query, requestHeaders }?: BillingPlatformValidator.GlobalSettingsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.GlobalSettings>;
218
- /**
219
- * @param {BillingPlatformValidator.MethodDefaultParam} arg - Arg object
220
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
221
- * @param {import("../PlatformAPIClient").Options} - Options
222
- * @returns {Promise<BillingPlatformModel.Message>} - Success response
223
- * @name methodDefault
224
- * @summary: Method Default
225
- * @description: Method Default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/methodDefault/).
226
- */
227
- methodDefault({ body, requestHeaders }?: BillingPlatformValidator.MethodDefaultParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Message>;
228
- /**
229
- * @param {BillingPlatformValidator.PaymentCollectParam} arg - Arg object
230
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
231
- * @param {import("../PlatformAPIClient").Options} - Options
232
- * @returns {Promise<BillingPlatformModel.PaymentCollectRes>} - Success response
233
- * @name paymentCollect
234
- * @summary: Payment Collect
235
- * @description: Payment Collect - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentCollect/).
236
- */
237
- paymentCollect({ body, requestHeaders }?: BillingPlatformValidator.PaymentCollectParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentCollectRes>;
238
- /**
239
- * @param {BillingPlatformValidator.PaymentInitiateParam} arg - Arg object
240
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
241
- * @param {import("../PlatformAPIClient").Options} - Options
242
- * @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
243
- * @name paymentInitiate
244
- * @summary: Initiate Payment
245
- * @description: Initiate Payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentInitiate/).
246
- */
247
- paymentInitiate({ body, requestHeaders }?: BillingPlatformValidator.PaymentInitiateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscribePlanRes>;
248
- /**
249
- * @param {BillingPlatformValidator.PaymentOptionsParam} arg - Arg object
250
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
251
- * @param {import("../PlatformAPIClient").Options} - Options
252
- * @returns {Promise<BillingPlatformModel.PaymentOptions>} - Success response
253
- * @name paymentOptions
254
- * @summary: API to get payment details of requested payment options
255
- * @description: API to get payment details of requested payment options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentOptions/).
256
- */
257
- paymentOptions({ code, requestHeaders }?: BillingPlatformValidator.PaymentOptionsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentOptions>;
258
- /**
259
- * @param {BillingPlatformValidator.PaymentStatusParam} arg - Arg object
260
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
261
- * @param {import("../PlatformAPIClient").Options} - Options
262
- * @returns {Promise<BillingPlatformModel.PaymentStatusResponse>} - Success response
263
- * @name paymentStatus
264
- * @summary: Credit Transaction
265
- * @description: Credit Transaction - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentStatus/).
266
- */
267
- paymentStatus({ orderId, requestHeaders }?: BillingPlatformValidator.PaymentStatusParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentStatusResponse>;
268
- /**
269
- * @param {BillingPlatformValidator.PlanDowngradeParam} arg - Arg object
270
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
271
- * @param {import("../PlatformAPIClient").Options} - Options
272
- * @returns {Promise<BillingPlatformModel.PostDowngradeRes>} - Success response
273
- * @name planDowngrade
274
- * @summary: Plan change downgrade
275
- * @description: Plan change downgrade - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planDowngrade/).
276
- */
277
- planDowngrade({ body, requestHeaders }?: BillingPlatformValidator.PlanDowngradeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PostDowngradeRes>;
278
- /**
279
- * @param {BillingPlatformValidator.PlanDowngradeGetParam} arg - Arg object
280
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
281
- * @param {import("../PlatformAPIClient").Options} - Options
282
- * @returns {Promise<BillingPlatformModel.DowngradeRes>} - Success response
283
- * @name planDowngradeGet
284
- * @summary: Get plan change downgrade
285
- * @description: Get plan change downgrade - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planDowngradeGet/).
286
- */
287
- planDowngradeGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.DowngradeRes>;
288
- /**
289
- * @param {BillingPlatformValidator.PlanStatusUpdateParam} arg - Arg object
290
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
291
- * @param {import("../PlatformAPIClient").Options} - Options
292
- * @returns {Promise<BillingPlatformModel.Plan>} - Success response
293
- * @name planStatusUpdate
294
- * @summary: Update subscription plan status.
295
- * @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
296
- */
297
- planStatusUpdate({ body, requestHeaders }?: BillingPlatformValidator.PlanStatusUpdateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan>;
298
- /**
299
- * @param {BillingPlatformValidator.SetupIntentParam} arg - Arg object
300
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
301
- * @param {import("../PlatformAPIClient").Options} - Options
302
- * @returns {Promise<BillingPlatformModel.SetupIntentRes>} - Success response
303
- * @name setupIntent
304
- * @summary: Setup Intent
305
- * @description: Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/setupIntent/).
306
- */
307
- setupIntent({ body, requestHeaders }?: BillingPlatformValidator.SetupIntentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SetupIntentRes>;
308
- /**
309
- * @param {BillingPlatformValidator.SetupMandateParam} arg - Arg object
310
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
311
- * @param {import("../PlatformAPIClient").Options} - Options
312
- * @returns {Promise<BillingPlatformModel.Message>} - Success response
313
- * @name setupMandate
314
- * @summary: Setup Mandate
315
- * @description: Setup Mandate - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/setupMandate/).
316
- */
317
- setupMandate({ body, requestHeaders }?: BillingPlatformValidator.SetupMandateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Message>;
318
- /**
319
- * @param {BillingPlatformValidator.SetupPaymentParam} arg - Arg object
320
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
321
- * @param {import("../PlatformAPIClient").Options} - Options
322
- * @returns {Promise<BillingPlatformModel.SetupPayment>} - Success response
323
- * @name setupPayment
324
- * @summary: Setup Payment
325
- * @description: Setup Payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/setupPayment/).
326
- */
327
- setupPayment({ body, requestHeaders }?: BillingPlatformValidator.SetupPaymentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SetupPayment>;
328
- /**
329
- * @param {BillingPlatformValidator.SubscriptionConfigsParam} arg - Arg object
330
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
331
- * @param {import("../PlatformAPIClient").Options} - Options
332
- * @returns {Promise<BillingPlatformModel.ConfigRes>} - Success response
333
- * @name subscriptionConfigs
334
- * @summary: API to get subscription config details
335
- * @description: API to get subscription config details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionConfigs/).
336
- */
337
- subscriptionConfigs({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.ConfigRes>;
338
- /**
339
- * @param {BillingPlatformValidator.SubscriptionMethodsParam} arg - Arg object
340
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
341
- * @param {import("../PlatformAPIClient").Options} - Options
342
- * @returns {Promise<BillingPlatformModel.SubscriptionMethods>} - Success response
343
- * @name subscriptionMethods
344
- * @summary: API to get subscription methods
345
- * @description: API to get subscription methods. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionMethods/).
346
- */
347
- subscriptionMethods({ uniqueExternalId, requestHeaders }?: BillingPlatformValidator.SubscriptionMethodsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionMethods>;
348
- /**
349
- * @param {BillingPlatformValidator.SubscriptionMethodsDeleteParam} arg - Arg object
350
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
351
- * @param {import("../PlatformAPIClient").Options} - Options
352
- * @returns {Promise<BillingPlatformModel.ResourceNotFound>} - Success response
353
- * @name subscriptionMethodsDelete
354
- * @summary: API to get subscription methods
355
- * @description: API to get subscription methods. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionMethodsDelete/).
356
- */
357
- subscriptionMethodsDelete({ uniqueExternalId, paymentMethodId, requestHeaders }?: BillingPlatformValidator.SubscriptionMethodsDeleteParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ResourceNotFound>;
358
- /**
359
- * @param {BillingPlatformValidator.SubscriptionPlanChangeParam} arg - Arg object
360
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
361
- * @param {import("../PlatformAPIClient").Options} - Options
362
- * @returns {Promise<BillingPlatformModel.PlanChangeDetails>} - Success response
363
- * @name subscriptionPlanChange
364
- * @summary: API to get plan change details of subscription
365
- * @description: API to get plan change details of subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionPlanChange/).
366
- */
367
- subscriptionPlanChange({ productSuite, coupon, uniqueId, platform, planId, requestHeaders }?: BillingPlatformValidator.SubscriptionPlanChangeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PlanChangeDetails>;
368
- /**
369
- * @param {BillingPlatformValidator.SubscriptionRenewParam} arg - Arg object
370
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
371
- * @param {import("../PlatformAPIClient").Options} - Options
372
- * @returns {Promise<BillingPlatformModel.SubscriptionRenewRes>} - Success response
373
- * @name subscriptionRenew
374
- * @summary: Subscription Renew
375
- * @description: Subscription Renew - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionRenew/).
376
- */
377
- subscriptionRenew({ body, requestHeaders }?: BillingPlatformValidator.SubscriptionRenewParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionRenewRes>;
378
- /**
379
- * @param {BillingPlatformValidator.TopupCancelCreditParam} arg - Arg object
380
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
381
- * @param {import("../PlatformAPIClient").Options} - Options
382
- * @returns {Promise<BillingPlatformModel.CancelTopupRes>} - Success response
383
- * @name topupCancelCredit
384
- * @summary: Cancel Topup
385
- * @description: Cancel Topup - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/topupCancelCredit/).
386
- */
387
- topupCancelCredit({ body, requestHeaders }?: BillingPlatformValidator.TopupCancelCreditParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelTopupRes>;
388
- /**
389
- * @param {BillingPlatformValidator.TopupCreditParam} arg - Arg object
390
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
391
- * @param {import("../PlatformAPIClient").Options} - Options
392
- * @returns {Promise<BillingPlatformModel.TopupRes>} - Success response
393
- * @name topupCredit
394
- * @summary: Topup
395
- * @description: Topup - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/topupCredit/).
396
- */
397
- topupCredit({ body, requestHeaders }?: BillingPlatformValidator.TopupCreditParam, { responseHeaders }?: object): Promise<BillingPlatformModel.TopupRes>;
398
- /**
399
- * @param {BillingPlatformValidator.UpdateConsentParam} arg - Arg object
400
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
401
- * @param {import("../PlatformAPIClient").Options} - Options
402
- * @returns {Promise<BillingPlatformModel.StatusMessage>} - Success response
403
- * @name updateConsent
404
- * @summary: Update Consent
405
- * @description: Update Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/updateConsent/).
406
- */
407
- updateConsent({ subscriberId, requestHeaders }?: BillingPlatformValidator.UpdateConsentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.StatusMessage>;
408
- /**
409
- * @param {BillingPlatformValidator.UpdateSetupIntentParam} arg - Arg object
410
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
411
- * @param {import("../PlatformAPIClient").Options} - Options
412
- * @returns {Promise<BillingPlatformModel.StatusMessage>} - Success response
413
- * @name updateSetupIntent
414
- * @summary: Setup Intent
415
- * @description: Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/updateSetupIntent/).
416
- */
417
- updateSetupIntent({ body, requestHeaders }?: BillingPlatformValidator.UpdateSetupIntentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.StatusMessage>;
418
- /**
419
- * @param {BillingPlatformValidator.UpgradePlanParam} arg - Arg object
420
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
421
- * @param {import("../PlatformAPIClient").Options} - Options
422
- * @returns {Promise<BillingPlatformModel.ResourceNotFound>} - Success response
423
- * @name upgradePlan
424
- * @summary: Post Methods
425
- * @description: Admin user can modify the subscription plan for an seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upgradePlan/).
426
- */
427
- upgradePlan({ body, requestHeaders }?: BillingPlatformValidator.UpgradePlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ResourceNotFound>;
428
- /**
429
- * @param {BillingPlatformValidator.UpsertCustomerDetailParam} arg - Arg object
430
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
431
- * @param {import("../PlatformAPIClient").Options} - Options
432
- * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
433
- * @name upsertCustomerDetail
434
- * @summary: Update or insert customer details.
435
- * @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
436
- */
437
- upsertCustomerDetail({ body, requestHeaders }?: BillingPlatformValidator.UpsertCustomerDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
438
- /**
439
- * @param {BillingPlatformValidator.VerifyPaymentParam} arg - Arg object
440
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
441
- * @param {import("../PlatformAPIClient").Options} - Options
442
- * @returns {Promise<BillingPlatformModel.VerifyPaymentRes>} - Success response
443
- * @name verifyPayment
444
- * @summary: API to verify subscription payment
445
- * @description: API to verify subscription payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/verifyPayment/).
446
- */
447
- verifyPayment({ body, requestHeaders }?: BillingPlatformValidator.VerifyPaymentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.VerifyPaymentRes>;
448
57
  }
449
58
  import BillingPlatformValidator = require("./BillingPlatformValidator");
450
59
  import BillingPlatformModel = require("./BillingPlatformModel");