@gofynd/fdk-client-javascript 1.4.8 → 1.4.10-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.
@@ -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 `{}`
@@ -74,47 +34,6 @@ declare class Billing {
74
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/).
75
35
  */
76
36
  createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
77
- /**
78
- * @param {BillingPlatformValidator.CreditTransactionParam} arg - Arg object
79
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
80
- * @param {import("../PlatformAPIClient").Options} - Options
81
- * @returns {Promise<BillingPlatformModel.CreditTransactionResponse>} -
82
- * Success response
83
- * @name creditTransaction
84
- * @summary: Credit Transaction
85
- * @description: Credit Transaction - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/creditTransaction/).
86
- */
87
- creditTransaction({ uniqueId, productSuite, type, pageSize, pageNo, startDate, endDate, searchType, searchValue, requestHeaders, }?: BillingPlatformValidator.CreditTransactionParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreditTransactionResponse>;
88
- /**
89
- * @param {BillingPlatformValidator.CurrentAppLimitParam} arg - Arg object
90
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
91
- * @param {import("../PlatformAPIClient").Options} - Options
92
- * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
93
- * @name currentAppLimit
94
- * @summary: Obtain feature limit configurations.
95
- * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/currentAppLimit/).
96
- */
97
- currentAppLimit({ productSuite, type, requestHeaders }?: BillingPlatformValidator.CurrentAppLimitParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
98
- /**
99
- * @param {BillingPlatformValidator.CurrentLimitParam} arg - Arg object
100
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
101
- * @param {import("../PlatformAPIClient").Options} - Options
102
- * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
103
- * @name currentLimit
104
- * @summary: Obtain feature limit configurations.
105
- * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/currentLimit/).
106
- */
107
- currentLimit({ productSuite, type, requestHeaders }?: BillingPlatformValidator.CurrentLimitParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
108
- /**
109
- * @param {BillingPlatformValidator.GetBankListParam} arg - Arg object
110
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
111
- * @param {import("../PlatformAPIClient").Options} - Options
112
- * @returns {Promise<string>} - Success response
113
- * @name getBankList
114
- * @summary: Get Bank List
115
- * @description: Get Bank List - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getBankList/).
116
- */
117
- getBankList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
118
37
  /**
119
38
  * @param {BillingPlatformValidator.GetChargeDetailsParam} arg - Arg object
120
39
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -125,77 +44,6 @@ declare class Billing {
125
44
  * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
126
45
  */
127
46
  getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ChargeDetails>;
128
- /**
129
- * @param {BillingPlatformValidator.GetCustomerDetailParam} arg - Arg object
130
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
131
- * @param {import("../PlatformAPIClient").Options} - Options
132
- * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
133
- * @name getCustomerDetail
134
- * @summary: Fetch customer details.
135
- * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
136
- */
137
- getCustomerDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
138
- /**
139
- * @param {BillingPlatformValidator.GetEnterprisePlansParam} arg - Arg object
140
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
141
- * @param {import("../PlatformAPIClient").Options} - Options
142
- * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
143
- * @name getEnterprisePlans
144
- * @summary: Retrieve enterprise-level plans.
145
- * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
146
- */
147
- getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
148
- /**
149
- * @param {BillingPlatformValidator.GetInvoiceByIdParam} arg - Arg object
150
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
151
- * @param {import("../PlatformAPIClient").Options} - Options
152
- * @returns {Promise<BillingPlatformModel.InvoiceData>} - Success response
153
- * @name getInvoiceById
154
- * @summary: Get a specific invoice.
155
- * @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/).
156
- */
157
- getInvoiceById({ invoiceId, requestHeaders }?: BillingPlatformValidator.GetInvoiceByIdParam, { responseHeaders }?: object): Promise<BillingPlatformModel.InvoiceData>;
158
- /**
159
- * @param {BillingPlatformValidator.GetInvoicesParam} arg - Arg object
160
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
161
- * @param {import("../PlatformAPIClient").Options} - Options
162
- * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
163
- * @name getInvoices
164
- * @summary: Retrieve invoices.
165
- * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
166
- */
167
- getInvoices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoices>;
168
- /**
169
- * @param {BillingPlatformValidator.GetPaymentOptionsParam} arg - Arg object
170
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
171
- * @param {import("../PlatformAPIClient").Options} - Options
172
- * @returns {Promise<BillingPlatformModel.GetPaymentOptions>} - Success response
173
- * @name getPaymentOptions
174
- * @summary: API to get payment options
175
- * @description: API to get payment options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getPaymentOptions/).
176
- */
177
- getPaymentOptions({ transactionId, requestHeaders }?: BillingPlatformValidator.GetPaymentOptionsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.GetPaymentOptions>;
178
- /**
179
- * @param {BillingPlatformValidator.GetPaymentTransactionParam} arg - Arg object
180
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
181
- * @param {import("../PlatformAPIClient").Options} - Options
182
- * @returns {Promise<BillingPlatformModel.PaymentTransactionDetails>} -
183
- * Success response
184
- * @name getPaymentTransaction
185
- * @summary: API to get payment transaction details
186
- * @description: API to get payment transaction details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getPaymentTransaction/).
187
- */
188
- getPaymentTransaction({ transactionId, requestHeaders }?: BillingPlatformValidator.GetPaymentTransactionParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentTransactionDetails>;
189
- /**
190
- * @param {BillingPlatformValidator.GetSubscriptionParam} arg - Arg object
191
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
192
- * @param {import("../PlatformAPIClient").Options} - Options
193
- * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
194
- * @name getSubscription
195
- * @summary: Retrieve subscription details.
196
- * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
197
- */
198
- getSubscription({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionStatus>;
199
47
  /**
200
48
  * @param {BillingPlatformValidator.GetSubscriptionChargeParam} arg - Arg object
201
49
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -206,256 +54,6 @@ declare class Billing {
206
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/).
207
55
  */
208
56
  getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
209
- /**
210
- * @param {BillingPlatformValidator.GetentityDetailParam} arg - Arg object
211
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
212
- * @param {import("../PlatformAPIClient").Options} - Options
213
- * @returns {Promise<BillingPlatformModel.EntityDetail[]>} - Success response
214
- * @name getentityDetail
215
- * @summary: Generic api to get the entity detail
216
- * @description: Generic api to get the entity detail - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getentityDetail/).
217
- */
218
- getentityDetail({ entityName, channel, entityId, component, componentName, requestHeaders, }?: BillingPlatformValidator.GetentityDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntityDetail[]>;
219
- /**
220
- * @param {BillingPlatformValidator.GlobalSettingsParam} arg - Arg object
221
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
222
- * @param {import("../PlatformAPIClient").Options} - Options
223
- * @returns {Promise<BillingPlatformModel.GlobalSettings>} - Success response
224
- * @name globalSettings
225
- * @summary: API to get global settings details
226
- * @description: API to get global settings details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/globalSettings/).
227
- */
228
- globalSettings({ pageNo, pageSize, query, requestHeaders }?: BillingPlatformValidator.GlobalSettingsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.GlobalSettings>;
229
- /**
230
- * @param {BillingPlatformValidator.MethodDefaultParam} arg - Arg object
231
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
232
- * @param {import("../PlatformAPIClient").Options} - Options
233
- * @returns {Promise<BillingPlatformModel.Message>} - Success response
234
- * @name methodDefault
235
- * @summary: Method Default
236
- * @description: Method Default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/methodDefault/).
237
- */
238
- methodDefault({ body, requestHeaders }?: BillingPlatformValidator.MethodDefaultParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Message>;
239
- /**
240
- * @param {BillingPlatformValidator.PaymentCollectParam} arg - Arg object
241
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
242
- * @param {import("../PlatformAPIClient").Options} - Options
243
- * @returns {Promise<BillingPlatformModel.PaymentCollectRes>} - Success response
244
- * @name paymentCollect
245
- * @summary: Payment Collect
246
- * @description: Payment Collect - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentCollect/).
247
- */
248
- paymentCollect({ body, requestHeaders }?: BillingPlatformValidator.PaymentCollectParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentCollectRes>;
249
- /**
250
- * @param {BillingPlatformValidator.PaymentInitiateParam} arg - Arg object
251
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
252
- * @param {import("../PlatformAPIClient").Options} - Options
253
- * @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
254
- * @name paymentInitiate
255
- * @summary: Initiate Payment
256
- * @description: Initiate Payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentInitiate/).
257
- */
258
- paymentInitiate({ body, requestHeaders }?: BillingPlatformValidator.PaymentInitiateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscribePlanRes>;
259
- /**
260
- * @param {BillingPlatformValidator.PaymentOptionsParam} arg - Arg object
261
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
262
- * @param {import("../PlatformAPIClient").Options} - Options
263
- * @returns {Promise<BillingPlatformModel.PaymentOptions>} - Success response
264
- * @name paymentOptions
265
- * @summary: API to get payment details of requested payment options
266
- * @description: API to get payment details of requested payment options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentOptions/).
267
- */
268
- paymentOptions({ code, requestHeaders }?: BillingPlatformValidator.PaymentOptionsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentOptions>;
269
- /**
270
- * @param {BillingPlatformValidator.PaymentStatusParam} arg - Arg object
271
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
272
- * @param {import("../PlatformAPIClient").Options} - Options
273
- * @returns {Promise<BillingPlatformModel.PaymentStatusResponse>} - Success response
274
- * @name paymentStatus
275
- * @summary: Credit Transaction
276
- * @description: Credit Transaction - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/paymentStatus/).
277
- */
278
- paymentStatus({ orderId, requestHeaders }?: BillingPlatformValidator.PaymentStatusParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PaymentStatusResponse>;
279
- /**
280
- * @param {BillingPlatformValidator.PlanDowngradeParam} arg - Arg object
281
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
282
- * @param {import("../PlatformAPIClient").Options} - Options
283
- * @returns {Promise<BillingPlatformModel.PostDowngradeRes>} - Success response
284
- * @name planDowngrade
285
- * @summary: Plan change downgrade
286
- * @description: Plan change downgrade - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planDowngrade/).
287
- */
288
- planDowngrade({ body, requestHeaders }?: BillingPlatformValidator.PlanDowngradeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PostDowngradeRes>;
289
- /**
290
- * @param {BillingPlatformValidator.PlanDowngradeGetParam} arg - Arg object
291
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
292
- * @param {import("../PlatformAPIClient").Options} - Options
293
- * @returns {Promise<BillingPlatformModel.DowngradeRes>} - Success response
294
- * @name planDowngradeGet
295
- * @summary: Get plan change downgrade
296
- * @description: Get plan change downgrade - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planDowngradeGet/).
297
- */
298
- planDowngradeGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.DowngradeRes>;
299
- /**
300
- * @param {BillingPlatformValidator.PlanStatusUpdateParam} arg - Arg object
301
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
302
- * @param {import("../PlatformAPIClient").Options} - Options
303
- * @returns {Promise<BillingPlatformModel.Plan>} - Success response
304
- * @name planStatusUpdate
305
- * @summary: Update subscription plan status.
306
- * @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
307
- */
308
- planStatusUpdate({ body, requestHeaders }?: BillingPlatformValidator.PlanStatusUpdateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan>;
309
- /**
310
- * @param {BillingPlatformValidator.SetupIntentParam} arg - Arg object
311
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
312
- * @param {import("../PlatformAPIClient").Options} - Options
313
- * @returns {Promise<BillingPlatformModel.SetupIntentRes>} - Success response
314
- * @name setupIntent
315
- * @summary: Setup Intent
316
- * @description: Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/setupIntent/).
317
- */
318
- setupIntent({ body, requestHeaders }?: BillingPlatformValidator.SetupIntentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SetupIntentRes>;
319
- /**
320
- * @param {BillingPlatformValidator.SetupMandateParam} arg - Arg object
321
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
322
- * @param {import("../PlatformAPIClient").Options} - Options
323
- * @returns {Promise<BillingPlatformModel.Message>} - Success response
324
- * @name setupMandate
325
- * @summary: Setup Mandate
326
- * @description: Setup Mandate - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/setupMandate/).
327
- */
328
- setupMandate({ body, requestHeaders }?: BillingPlatformValidator.SetupMandateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Message>;
329
- /**
330
- * @param {BillingPlatformValidator.SetupPaymentParam} arg - Arg object
331
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
332
- * @param {import("../PlatformAPIClient").Options} - Options
333
- * @returns {Promise<BillingPlatformModel.SetupPayment>} - Success response
334
- * @name setupPayment
335
- * @summary: Setup Payment
336
- * @description: Setup Payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/setupPayment/).
337
- */
338
- setupPayment({ body, requestHeaders }?: BillingPlatformValidator.SetupPaymentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SetupPayment>;
339
- /**
340
- * @param {BillingPlatformValidator.SubscriptionConfigsParam} arg - Arg object
341
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
342
- * @param {import("../PlatformAPIClient").Options} - Options
343
- * @returns {Promise<BillingPlatformModel.ConfigRes>} - Success response
344
- * @name subscriptionConfigs
345
- * @summary: API to get subscription config details
346
- * @description: API to get subscription config details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionConfigs/).
347
- */
348
- subscriptionConfigs({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.ConfigRes>;
349
- /**
350
- * @param {BillingPlatformValidator.SubscriptionMethodsParam} arg - Arg object
351
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
352
- * @param {import("../PlatformAPIClient").Options} - Options
353
- * @returns {Promise<BillingPlatformModel.SubscriptionMethods>} - Success response
354
- * @name subscriptionMethods
355
- * @summary: API to get subscription methods
356
- * @description: API to get subscription methods. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionMethods/).
357
- */
358
- subscriptionMethods({ uniqueExternalId, requestHeaders }?: BillingPlatformValidator.SubscriptionMethodsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionMethods>;
359
- /**
360
- * @param {BillingPlatformValidator.SubscriptionMethodsDeleteParam} arg - Arg object
361
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
362
- * @param {import("../PlatformAPIClient").Options} - Options
363
- * @returns {Promise<BillingPlatformModel.ResourceNotFound>} - Success response
364
- * @name subscriptionMethodsDelete
365
- * @summary: API to get subscription methods
366
- * @description: API to get subscription methods. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionMethodsDelete/).
367
- */
368
- subscriptionMethodsDelete({ uniqueExternalId, paymentMethodId, requestHeaders }?: BillingPlatformValidator.SubscriptionMethodsDeleteParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ResourceNotFound>;
369
- /**
370
- * @param {BillingPlatformValidator.SubscriptionPlanChangeParam} arg - Arg object
371
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
372
- * @param {import("../PlatformAPIClient").Options} - Options
373
- * @returns {Promise<BillingPlatformModel.PlanChangeDetails>} - Success response
374
- * @name subscriptionPlanChange
375
- * @summary: API to get plan change details of subscription
376
- * @description: API to get plan change details of subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionPlanChange/).
377
- */
378
- subscriptionPlanChange({ productSuite, coupon, uniqueId, platform, planId, requestHeaders }?: BillingPlatformValidator.SubscriptionPlanChangeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.PlanChangeDetails>;
379
- /**
380
- * @param {BillingPlatformValidator.SubscriptionRenewParam} arg - Arg object
381
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
382
- * @param {import("../PlatformAPIClient").Options} - Options
383
- * @returns {Promise<BillingPlatformModel.SubscriptionRenewRes>} - Success response
384
- * @name subscriptionRenew
385
- * @summary: Subscription Renew
386
- * @description: Subscription Renew - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscriptionRenew/).
387
- */
388
- subscriptionRenew({ body, requestHeaders }?: BillingPlatformValidator.SubscriptionRenewParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionRenewRes>;
389
- /**
390
- * @param {BillingPlatformValidator.TopupCancelCreditParam} arg - Arg object
391
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
392
- * @param {import("../PlatformAPIClient").Options} - Options
393
- * @returns {Promise<BillingPlatformModel.CancelTopupRes>} - Success response
394
- * @name topupCancelCredit
395
- * @summary: Cancel Topup
396
- * @description: Cancel Topup - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/topupCancelCredit/).
397
- */
398
- topupCancelCredit({ body, requestHeaders }?: BillingPlatformValidator.TopupCancelCreditParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelTopupRes>;
399
- /**
400
- * @param {BillingPlatformValidator.TopupCreditParam} arg - Arg object
401
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
402
- * @param {import("../PlatformAPIClient").Options} - Options
403
- * @returns {Promise<BillingPlatformModel.TopupRes>} - Success response
404
- * @name topupCredit
405
- * @summary: Topup
406
- * @description: Topup - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/topupCredit/).
407
- */
408
- topupCredit({ body, requestHeaders }?: BillingPlatformValidator.TopupCreditParam, { responseHeaders }?: object): Promise<BillingPlatformModel.TopupRes>;
409
- /**
410
- * @param {BillingPlatformValidator.UpdateConsentParam} arg - Arg object
411
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
412
- * @param {import("../PlatformAPIClient").Options} - Options
413
- * @returns {Promise<BillingPlatformModel.StatusMessage>} - Success response
414
- * @name updateConsent
415
- * @summary: Update Consent
416
- * @description: Update Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/updateConsent/).
417
- */
418
- updateConsent({ subscriberId, requestHeaders }?: BillingPlatformValidator.UpdateConsentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.StatusMessage>;
419
- /**
420
- * @param {BillingPlatformValidator.UpdateSetupIntentParam} arg - Arg object
421
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
422
- * @param {import("../PlatformAPIClient").Options} - Options
423
- * @returns {Promise<BillingPlatformModel.StatusMessage>} - Success response
424
- * @name updateSetupIntent
425
- * @summary: Setup Intent
426
- * @description: Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/updateSetupIntent/).
427
- */
428
- updateSetupIntent({ body, requestHeaders }?: BillingPlatformValidator.UpdateSetupIntentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.StatusMessage>;
429
- /**
430
- * @param {BillingPlatformValidator.UpgradePlanParam} arg - Arg object
431
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
432
- * @param {import("../PlatformAPIClient").Options} - Options
433
- * @returns {Promise<BillingPlatformModel.ResourceNotFound>} - Success response
434
- * @name upgradePlan
435
- * @summary: Post Methods
436
- * @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/).
437
- */
438
- upgradePlan({ body, requestHeaders }?: BillingPlatformValidator.UpgradePlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ResourceNotFound>;
439
- /**
440
- * @param {BillingPlatformValidator.UpsertCustomerDetailParam} arg - Arg object
441
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
442
- * @param {import("../PlatformAPIClient").Options} - Options
443
- * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
444
- * @name upsertCustomerDetail
445
- * @summary: Update or insert customer details.
446
- * @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/).
447
- */
448
- upsertCustomerDetail({ body, requestHeaders }?: BillingPlatformValidator.UpsertCustomerDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
449
- /**
450
- * @param {BillingPlatformValidator.VerifyPaymentParam} arg - Arg object
451
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
452
- * @param {import("../PlatformAPIClient").Options} - Options
453
- * @returns {Promise<BillingPlatformModel.VerifyPaymentRes>} - Success response
454
- * @name verifyPayment
455
- * @summary: API to verify subscription payment
456
- * @description: API to verify subscription payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/verifyPayment/).
457
- */
458
- verifyPayment({ body, requestHeaders }?: BillingPlatformValidator.VerifyPaymentParam, { responseHeaders }?: object): Promise<BillingPlatformModel.VerifyPaymentRes>;
459
57
  }
460
58
  import BillingPlatformValidator = require("./BillingPlatformValidator");
461
59
  import BillingPlatformModel = require("./BillingPlatformModel");