@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6

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 (155) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -2
  3. package/sdk/application/ApplicationClient.js +20 -0
  4. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  5. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  6. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  7. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  8. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  9. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  10. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  11. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  12. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  13. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  15. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  16. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  17. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  19. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  20. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  21. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  22. package/sdk/application/Lead/LeadApplicationModel.js +1 -1
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  26. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  27. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  28. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  30. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  31. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  32. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  33. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  34. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  35. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  36. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  37. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  38. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  39. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  40. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  41. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
  42. package/sdk/application/Share/ShareApplicationModel.js +0 -4
  43. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  44. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  45. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  46. package/sdk/application/User/UserApplicationClient.js +64 -64
  47. package/sdk/common/Clickstream.d.ts +1 -0
  48. package/sdk/common/Clickstream.js +246 -0
  49. package/sdk/common/Utility.js +1 -4
  50. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  51. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  52. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  53. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  54. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  55. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  56. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  57. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  58. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  59. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  60. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  61. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  62. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  63. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  64. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  65. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  66. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  67. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  68. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  69. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  70. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  71. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  72. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  73. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  74. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  75. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  76. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  77. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  78. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  79. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  80. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  81. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  82. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  83. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  84. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  85. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  86. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  87. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  88. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  89. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  90. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  91. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  92. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  93. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  94. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  95. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
  96. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
  97. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
  98. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
  99. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  100. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  101. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
  102. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
  103. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  104. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  105. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  106. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  107. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  108. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  109. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  110. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  111. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  112. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  113. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  114. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  115. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  116. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  117. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  118. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  119. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  120. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  121. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  122. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  123. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  124. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  125. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  126. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  127. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  128. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
  131. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
  132. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  133. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  134. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  135. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  136. package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
  137. package/sdk/platform/Share/SharePlatformModel.js +0 -4
  138. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  139. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  140. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  141. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  142. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  143. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  144. package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
  145. package/sdk/platform/User/UserPlatformModel.js +4 -4
  146. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  147. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  148. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  149. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  150. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  151. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  152. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  153. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  154. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  155. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -8,8 +8,8 @@ declare class Billing {
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
9
  * @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
10
10
  * @name activateSubscriptionPlan
11
- * @summary: Activate subscription
12
- * @description: It will activate subscription plan for customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/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
13
  */
14
14
  activateSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.ActivateSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionActivateRes>;
15
15
  /**
@@ -18,8 +18,8 @@ declare class Billing {
18
18
  * @param {import("../PlatformAPIClient").Options} - Options
19
19
  * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
20
20
  * @name cancelSubscriptionCharge
21
- * @summary: Cancel subscription charge
22
- * @description: Cancel subscription and attached charges. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
21
+ * @summary: Cancel a subscription charge.
22
+ * @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
23
23
  */
24
24
  cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
25
25
  /**
@@ -28,8 +28,8 @@ declare class Billing {
28
28
  * @param {import("../PlatformAPIClient").Options} - Options
29
29
  * @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
30
30
  * @name cancelSubscriptionPlan
31
- * @summary: Cancel subscription
32
- * @description: It will cancel current active subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/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
33
  */
34
34
  cancelSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelSubscriptionRes>;
35
35
  /**
@@ -38,8 +38,8 @@ declare class Billing {
38
38
  * @param {import("../PlatformAPIClient").Options} - Options
39
39
  * @returns {Promise<BillingPlatformModel.CheckValidityResponse>} - Success response
40
40
  * @name checkCouponValidity
41
- * @summary: Check coupon validity
42
- * @description: Check coupon validity. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/checkCouponValidity/).
41
+ * @summary: Verify coupon validity.
42
+ * @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/).
43
43
  */
44
44
  checkCouponValidity({ plan, couponCode, requestHeaders }?: BillingPlatformValidator.CheckCouponValidityParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CheckValidityResponse>;
45
45
  /**
@@ -49,8 +49,8 @@ declare class Billing {
49
49
  * @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
50
50
  * Success response
51
51
  * @name createOneTimeCharge
52
- * @summary: Create one time subscription charge
53
- * @description: Register one time subscription charge for a seller of your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
52
+ * @summary: Generate a one-time charge.
53
+ * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
54
54
  */
55
55
  createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponse>;
56
56
  /**
@@ -60,8 +60,8 @@ declare class Billing {
60
60
  * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
61
61
  * Success response
62
62
  * @name createSubscriptionCharge
63
- * @summary: Create subscription charge
64
- * @description: Register subscription charge for a seller of your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
63
+ * @summary: Initiate subscription billing.
64
+ * @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/).
65
65
  */
66
66
  createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
67
67
  /**
@@ -70,8 +70,8 @@ declare class Billing {
70
70
  * @param {import("../PlatformAPIClient").Options} - Options
71
71
  * @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - Success response
72
72
  * @name getChargeDetails
73
- * @summary: Get subscription charge details
74
- * @description: Get created subscription charge details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
73
+ * @summary: Obtain charge details.
74
+ * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
75
75
  */
76
76
  getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.OneTimeChargeEntity>;
77
77
  /**
@@ -80,8 +80,8 @@ declare class Billing {
80
80
  * @param {import("../PlatformAPIClient").Options} - Options
81
81
  * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
82
82
  * @name getCustomerDetail
83
- * @summary: Get subscription customer detail
84
- * @description: Get subscription customer detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
83
+ * @summary: Fetch customer details.
84
+ * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
85
85
  */
86
86
  getCustomerDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
87
87
  /**
@@ -90,9 +90,8 @@ declare class Billing {
90
90
  * @param {import("../PlatformAPIClient").Options} - Options
91
91
  * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
92
92
  * @name getEnterprisePlans
93
- * @summary: Get Enterprise Plans
94
- * @description: Get Enterprise Plans.
95
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
93
+ * @summary: Retrieve enterprise-level plans.
94
+ * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
96
95
  */
97
96
  getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
98
97
  /**
@@ -101,8 +100,8 @@ declare class Billing {
101
100
  * @param {import("../PlatformAPIClient").Options} - Options
102
101
  * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
103
102
  * @name getFeatureLimitConfig
104
- * @summary: Get subscription subscription limits
105
- * @description: Get subscription subscription limits. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
103
+ * @summary: Obtain feature limit configurations.
104
+ * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
106
105
  */
107
106
  getFeatureLimitConfig({ productSuite, type, requestHeaders }?: BillingPlatformValidator.GetFeatureLimitConfigParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
108
107
  /**
@@ -111,8 +110,8 @@ declare class Billing {
111
110
  * @param {import("../PlatformAPIClient").Options} - Options
112
111
  * @returns {Promise<BillingPlatformModel.Invoice>} - Success response
113
112
  * @name getInvoiceById
114
- * @summary: Get invoice by id
115
- * @description: Get invoice by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoiceById/).
113
+ * @summary: Get a specific invoice.
114
+ * @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/).
116
115
  */
117
116
  getInvoiceById({ invoiceId, requestHeaders }?: BillingPlatformValidator.GetInvoiceByIdParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoice>;
118
117
  /**
@@ -121,8 +120,8 @@ declare class Billing {
121
120
  * @param {import("../PlatformAPIClient").Options} - Options
122
121
  * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
123
122
  * @name getInvoices
124
- * @summary: Get invoices
125
- * @description: Get invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
123
+ * @summary: Retrieve invoices.
124
+ * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
126
125
  */
127
126
  getInvoices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoices>;
128
127
  /**
@@ -131,9 +130,8 @@ declare class Billing {
131
130
  * @param {import("../PlatformAPIClient").Options} - Options
132
131
  * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
133
132
  * @name getSubscription
134
- * @summary: Get current subscription detail
135
- * @description: If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
136
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
133
+ * @summary: Retrieve subscription details.
134
+ * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
137
135
  */
138
136
  getSubscription({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionStatus>;
139
137
  /**
@@ -142,8 +140,8 @@ declare class Billing {
142
140
  * @param {import("../PlatformAPIClient").Options} - Options
143
141
  * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
144
142
  * @name getSubscriptionCharge
145
- * @summary: Get subscription charge details
146
- * @description: Get created subscription charge details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
143
+ * @summary: Retrieve subscription charge details.
144
+ * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
147
145
  */
148
146
  getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
149
147
  /**
@@ -162,8 +160,8 @@ declare class Billing {
162
160
  * @param {import("../PlatformAPIClient").Options} - Options
163
161
  * @returns {Promise<BillingPlatformModel.Plan>} - Success response
164
162
  * @name planStatusUpdate
165
- * @summary: Update Status of The plan
166
- * @description: It will update the status of the plan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
163
+ * @summary: Update subscription plan status.
164
+ * @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
167
165
  */
168
166
  planStatusUpdate({ body, requestHeaders }?: BillingPlatformValidator.PlanStatusUpdateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan>;
169
167
  /**
@@ -172,8 +170,8 @@ declare class Billing {
172
170
  * @param {import("../PlatformAPIClient").Options} - Options
173
171
  * @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
174
172
  * @name subscripePlan
175
- * @summary: Subscribe plan.
176
- * @description: It will subscribe a plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
173
+ * @summary: Subscribe to a plan.
174
+ * @description: Subscribe to a specific billing plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
177
175
  */
178
176
  subscripePlan({ body, requestHeaders }?: BillingPlatformValidator.SubscripePlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscribePlanRes>;
179
177
  /**
@@ -182,8 +180,8 @@ declare class Billing {
182
180
  * @param {import("../PlatformAPIClient").Options} - Options
183
181
  * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
184
182
  * @name upsertCustomerDetail
185
- * @summary: Upsert subscription customer detail
186
- * @description: Upsert subscription customer detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
183
+ * @summary: Update or insert customer details.
184
+ * @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/).
187
185
  */
188
186
  upsertCustomerDetail({ body, requestHeaders }?: BillingPlatformValidator.UpsertCustomerDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
189
187
  }
@@ -20,8 +20,8 @@ class Billing {
20
20
  * @param {import("../PlatformAPIClient").Options} - Options
21
21
  * @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
22
22
  * @name activateSubscriptionPlan
23
- * @summary: Activate subscription
24
- * @description: It will activate subscription plan for customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/activateSubscriptionPlan/).
23
+ * @summary: Activate a subscription plan.
24
+ * @description: Activate a specific subscription plan for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/activateSubscriptionPlan/).
25
25
  */
26
26
  async activateSubscriptionPlan(
27
27
  { body, requestHeaders } = { requestHeaders: {} },
@@ -101,8 +101,8 @@ class Billing {
101
101
  * @param {import("../PlatformAPIClient").Options} - Options
102
102
  * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
103
103
  * @name cancelSubscriptionCharge
104
- * @summary: Cancel subscription charge
105
- * @description: Cancel subscription and attached charges. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
104
+ * @summary: Cancel a subscription charge.
105
+ * @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
106
106
  */
107
107
  async cancelSubscriptionCharge(
108
108
  { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
@@ -184,8 +184,8 @@ class Billing {
184
184
  * @param {import("../PlatformAPIClient").Options} - Options
185
185
  * @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
186
186
  * @name cancelSubscriptionPlan
187
- * @summary: Cancel subscription
188
- * @description: It will cancel current active subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
187
+ * @summary: Cancel a subscription plan.
188
+ * @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
189
189
  */
190
190
  async cancelSubscriptionPlan(
191
191
  { body, requestHeaders } = { requestHeaders: {} },
@@ -265,8 +265,8 @@ class Billing {
265
265
  * @param {import("../PlatformAPIClient").Options} - Options
266
266
  * @returns {Promise<BillingPlatformModel.CheckValidityResponse>} - Success response
267
267
  * @name checkCouponValidity
268
- * @summary: Check coupon validity
269
- * @description: Check coupon validity. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/checkCouponValidity/).
268
+ * @summary: Verify coupon validity.
269
+ * @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/).
270
270
  */
271
271
  async checkCouponValidity(
272
272
  { plan, couponCode, requestHeaders } = { requestHeaders: {} },
@@ -349,8 +349,8 @@ class Billing {
349
349
  * @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
350
350
  * Success response
351
351
  * @name createOneTimeCharge
352
- * @summary: Create one time subscription charge
353
- * @description: Register one time subscription charge for a seller of your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
352
+ * @summary: Generate a one-time charge.
353
+ * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
354
354
  */
355
355
  async createOneTimeCharge(
356
356
  { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -431,8 +431,8 @@ class Billing {
431
431
  * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
432
432
  * Success response
433
433
  * @name createSubscriptionCharge
434
- * @summary: Create subscription charge
435
- * @description: Register subscription charge for a seller of your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
434
+ * @summary: Initiate subscription billing.
435
+ * @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/).
436
436
  */
437
437
  async createSubscriptionCharge(
438
438
  { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -514,8 +514,8 @@ class Billing {
514
514
  * @param {import("../PlatformAPIClient").Options} - Options
515
515
  * @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - Success response
516
516
  * @name getChargeDetails
517
- * @summary: Get subscription charge details
518
- * @description: Get created subscription charge details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
517
+ * @summary: Obtain charge details.
518
+ * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
519
519
  */
520
520
  async getChargeDetails(
521
521
  { extensionId, chargeId, requestHeaders } = { requestHeaders: {} },
@@ -595,8 +595,8 @@ class Billing {
595
595
  * @param {import("../PlatformAPIClient").Options} - Options
596
596
  * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
597
597
  * @name getCustomerDetail
598
- * @summary: Get subscription customer detail
599
- * @description: Get subscription customer detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
598
+ * @summary: Fetch customer details.
599
+ * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
600
600
  */
601
601
  async getCustomerDetail(
602
602
  { requestHeaders } = { requestHeaders: {} },
@@ -670,9 +670,8 @@ class Billing {
670
670
  * @param {import("../PlatformAPIClient").Options} - Options
671
671
  * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
672
672
  * @name getEnterprisePlans
673
- * @summary: Get Enterprise Plans
674
- * @description: Get Enterprise Plans.
675
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
673
+ * @summary: Retrieve enterprise-level plans.
674
+ * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
676
675
  */
677
676
  async getEnterprisePlans(
678
677
  { requestHeaders } = { requestHeaders: {} },
@@ -743,8 +742,8 @@ class Billing {
743
742
  * @param {import("../PlatformAPIClient").Options} - Options
744
743
  * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
745
744
  * @name getFeatureLimitConfig
746
- * @summary: Get subscription subscription limits
747
- * @description: Get subscription subscription limits. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
745
+ * @summary: Obtain feature limit configurations.
746
+ * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
748
747
  */
749
748
  async getFeatureLimitConfig(
750
749
  { productSuite, type, requestHeaders } = { requestHeaders: {} },
@@ -826,8 +825,8 @@ class Billing {
826
825
  * @param {import("../PlatformAPIClient").Options} - Options
827
826
  * @returns {Promise<BillingPlatformModel.Invoice>} - Success response
828
827
  * @name getInvoiceById
829
- * @summary: Get invoice by id
830
- * @description: Get invoice by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoiceById/).
828
+ * @summary: Get a specific invoice.
829
+ * @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/).
831
830
  */
832
831
  async getInvoiceById(
833
832
  { invoiceId, requestHeaders } = { requestHeaders: {} },
@@ -905,8 +904,8 @@ class Billing {
905
904
  * @param {import("../PlatformAPIClient").Options} - Options
906
905
  * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
907
906
  * @name getInvoices
908
- * @summary: Get invoices
909
- * @description: Get invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
907
+ * @summary: Retrieve invoices.
908
+ * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
910
909
  */
911
910
  async getInvoices(
912
911
  { requestHeaders } = { requestHeaders: {} },
@@ -978,9 +977,8 @@ class Billing {
978
977
  * @param {import("../PlatformAPIClient").Options} - Options
979
978
  * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
980
979
  * @name getSubscription
981
- * @summary: Get current subscription detail
982
- * @description: If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
983
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
980
+ * @summary: Retrieve subscription details.
981
+ * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
984
982
  */
985
983
  async getSubscription(
986
984
  { requestHeaders } = { requestHeaders: {} },
@@ -1054,8 +1052,8 @@ class Billing {
1054
1052
  * @param {import("../PlatformAPIClient").Options} - Options
1055
1053
  * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
1056
1054
  * @name getSubscriptionCharge
1057
- * @summary: Get subscription charge details
1058
- * @description: Get created subscription charge details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
1055
+ * @summary: Retrieve subscription charge details.
1056
+ * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
1059
1057
  */
1060
1058
  async getSubscriptionCharge(
1061
1059
  { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
@@ -1234,8 +1232,8 @@ class Billing {
1234
1232
  * @param {import("../PlatformAPIClient").Options} - Options
1235
1233
  * @returns {Promise<BillingPlatformModel.Plan>} - Success response
1236
1234
  * @name planStatusUpdate
1237
- * @summary: Update Status of The plan
1238
- * @description: It will update the status of the plan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
1235
+ * @summary: Update subscription plan status.
1236
+ * @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
1239
1237
  */
1240
1238
  async planStatusUpdate(
1241
1239
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1313,8 +1311,8 @@ class Billing {
1313
1311
  * @param {import("../PlatformAPIClient").Options} - Options
1314
1312
  * @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
1315
1313
  * @name subscripePlan
1316
- * @summary: Subscribe plan.
1317
- * @description: It will subscribe a plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
1314
+ * @summary: Subscribe to a plan.
1315
+ * @description: Subscribe to a specific billing plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
1318
1316
  */
1319
1317
  async subscripePlan(
1320
1318
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1392,8 +1390,8 @@ class Billing {
1392
1390
  * @param {import("../PlatformAPIClient").Options} - Options
1393
1391
  * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
1394
1392
  * @name upsertCustomerDetail
1395
- * @summary: Upsert subscription customer detail
1396
- * @description: Upsert subscription customer detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
1393
+ * @summary: Update or insert customer details.
1394
+ * @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/).
1397
1395
  */
1398
1396
  async upsertCustomerDetail(
1399
1397
  { body, requestHeaders } = { requestHeaders: {} },