@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.10

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 (265) 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 +1 -1
  5. package/sdk/application/Cart/CartApplicationClient.js +3 -5
  6. package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
  7. package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
  8. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
  9. package/sdk/application/Cart/CartApplicationValidator.js +0 -4
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
  12. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  13. package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
  14. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
  16. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  17. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  18. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  19. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  20. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
  22. package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
  23. package/sdk/application/Content/ContentApplicationClient.js +0 -246
  24. package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
  25. package/sdk/application/Content/ContentApplicationModel.js +565 -817
  26. package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
  27. package/sdk/application/Content/ContentApplicationValidator.js +0 -41
  28. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  29. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  30. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  31. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  32. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
  33. package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
  34. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
  35. package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
  36. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
  37. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
  38. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  39. package/sdk/application/Order/OrderApplicationClient.js +8 -32
  40. package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
  41. package/sdk/application/Order/OrderApplicationModel.js +816 -824
  42. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
  43. package/sdk/application/Order/OrderApplicationValidator.js +0 -8
  44. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
  45. package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
  46. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
  47. package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
  48. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
  49. package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
  50. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
  51. package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
  52. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  53. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  54. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  55. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  56. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  57. package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
  58. package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
  59. package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
  60. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
  62. package/sdk/application/User/UserApplicationClient.d.ts +0 -33
  63. package/sdk/application/User/UserApplicationClient.js +0 -239
  64. package/sdk/application/User/UserApplicationModel.d.ts +753 -768
  65. package/sdk/application/User/UserApplicationModel.js +731 -755
  66. package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
  67. package/sdk/application/User/UserApplicationValidator.js +0 -36
  68. package/sdk/common/Clickstream.d.ts +1 -0
  69. package/sdk/common/Clickstream.js +254 -0
  70. package/sdk/common/Utility.js +1 -4
  71. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
  72. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
  73. package/sdk/partner/PartnerClient.d.ts +0 -6
  74. package/sdk/partner/PartnerClient.js +0 -9
  75. package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
  76. package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
  77. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
  78. package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
  79. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
  80. package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
  81. package/sdk/partner/index.d.ts +0 -3
  82. package/sdk/partner/index.js +0 -6
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  86. package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
  87. package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
  88. package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
  89. package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
  90. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
  91. package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
  92. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
  94. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
  96. package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
  97. package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
  108. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  109. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
  112. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
  114. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
  115. package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  124. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
  125. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
  126. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  127. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  128. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
  129. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
  130. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
  131. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
  132. package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
  133. package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
  145. package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
  147. package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
  150. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  151. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  152. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
  153. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
  154. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
  155. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
  156. package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
  157. package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
  159. package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  161. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  162. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
  163. package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
  164. package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
  165. package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
  166. package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
  167. package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
  168. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  169. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  170. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
  172. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
  174. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  175. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  176. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
  177. package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
  178. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  179. package/sdk/platform/PlatformApplicationClient.js +4 -4
  180. package/sdk/platform/PlatformClient.d.ts +2 -4
  181. package/sdk/platform/PlatformClient.js +4 -8
  182. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  183. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +989 -1588
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +977 -1695
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  195. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  196. package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
  197. package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
  198. package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
  199. package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
  200. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
  201. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
  206. package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
  207. package/sdk/platform/User/UserPlatformModel.js +428 -679
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  214. package/sdk/platform/index.d.ts +1 -1
  215. package/sdk/platform/index.js +2 -2
  216. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  217. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  218. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  219. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  220. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  221. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  222. package/sdk/public/PublicClient.d.ts +0 -4
  223. package/sdk/public/PublicClient.js +0 -8
  224. package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
  225. package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
  226. package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
  227. package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
  228. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
  229. package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
  230. package/sdk/public/index.d.ts +0 -2
  231. package/sdk/public/index.js +0 -4
  232. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
  233. package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
  234. package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
  235. package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
  236. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
  237. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
  238. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
  239. package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
  240. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
  241. package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
  242. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
  243. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
  244. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
  245. package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
  246. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
  247. package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
  248. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
  249. package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
  250. package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
  251. package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
  252. package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
  253. package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
  254. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
  255. package/sdk/public/Billing/BillingPublicClient.js +0 -116
  256. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
  257. package/sdk/public/Billing/BillingPublicModel.js +0 -96
  258. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
  259. package/sdk/public/Billing/BillingPublicValidator.js +0 -19
  260. package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
  261. package/sdk/public/Content/ContentPublicClient.js +0 -114
  262. package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
  263. package/sdk/public/Content/ContentPublicModel.js +0 -60
  264. package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
  265. package/sdk/public/Content/ContentPublicValidator.js +0 -19
@@ -4,68 +4,50 @@ export = BillingPlatformModel;
4
4
  * @property {string} [message] - Failure message.
5
5
  */
6
6
  /**
7
- * @typedef CancelSubscriptionReq
8
- * @property {string} [product_suite]
9
- * @property {string} [subscription_id]
10
- * @property {string} [type]
11
- * @property {string} [unique_id]
12
- */
13
- /**
14
- * @typedef CancelSubscriptionRes
15
- * @property {Subscription} [data]
16
- * @property {boolean} [success]
7
+ * @typedef ResourceNotFound
8
+ * @property {string} [message] - Resource not found with {id}
17
9
  */
18
10
  /**
19
- * @typedef ChargeLineItem
20
- * @property {number} [capped_amount]
21
- * @property {boolean} [is_test]
22
- * @property {Object} [metadata]
23
- * @property {string} name
24
- * @property {EntityChargePrice} price
25
- * @property {string} pricing_type
26
- * @property {EntityChargeRecurring} [recurring]
27
- * @property {string} term
28
- * @property {number} [trial_days]
11
+ * @typedef InternalServerError
12
+ * @property {string} [message] - Internal server Server error
13
+ * @property {string} [code] - Error code
29
14
  */
30
15
  /**
31
16
  * @typedef CheckValidityResponse
32
- * @property {number} [discount_amount]
33
17
  * @property {boolean} [is_valid]
18
+ * @property {number} [discount_amount]
34
19
  */
35
20
  /**
36
- * @typedef CreateOneTimeCharge
37
- * @property {OneTimeChargeItem} charge
38
- * @property {boolean} [is_test]
39
- * @property {string} name
40
- * @property {string} return_url
41
- */
42
- /**
43
- * @typedef CreateOneTimeChargeResponse
44
- * @property {OneTimeChargeEntity} [charge]
45
- * @property {string} [confirm_url]
46
- */
47
- /**
48
- * @typedef CreateSubscriptionCharge
49
- * @property {boolean} [is_test]
50
- * @property {ChargeLineItem[]} line_items
51
- * @property {string} name
52
- * @property {string} return_url
53
- * @property {number} [trial_days]
21
+ * @typedef PlanRecurring
22
+ * @property {string} [interval]
23
+ * @property {number} [interval_count]
54
24
  */
55
25
  /**
56
- * @typedef CreateSubscriptionResponse
57
- * @property {string} [confirm_url]
58
- * @property {EntitySubscription} [subscription]
26
+ * @typedef Plan
27
+ * @property {PlanRecurring} [recurring]
28
+ * @property {boolean} [is_trial_plan]
29
+ * @property {string} [plan_group]
30
+ * @property {string[]} [tag_lines]
31
+ * @property {string} [currency]
32
+ * @property {boolean} [is_active]
33
+ * @property {boolean} [is_visible]
34
+ * @property {number} [trial_period]
35
+ * @property {string[]} [addons]
36
+ * @property {string[]} [tags]
37
+ * @property {string} [type]
38
+ * @property {string} [country]
39
+ * @property {string} [_id]
40
+ * @property {string} [name]
41
+ * @property {string} [description]
42
+ * @property {number} [amount]
43
+ * @property {string} [product_suite_id]
44
+ * @property {string} [created_at]
45
+ * @property {string} [modified_at]
59
46
  */
60
47
  /**
61
- * @typedef CurrentPeriod
62
- * @property {string} [end_date]
48
+ * @typedef SubscriptionTrialPeriod
63
49
  * @property {string} [start_date]
64
- */
65
- /**
66
- * @typedef Details
67
- * @property {Features[]} [features]
68
- * @property {FeeComponents[]} [fee_components]
50
+ * @property {string} [end_date]
69
51
  */
70
52
  /**
71
53
  * @typedef EntityChargePrice
@@ -77,393 +59,366 @@ export = BillingPlatformModel;
77
59
  * @property {string} interval
78
60
  */
79
61
  /**
80
- * @typedef EntityResponse
81
- * @property {Details[]} [items]
82
- * @property {number} [page]
83
- * @property {number} [page_size]
84
- * @property {boolean} [success]
62
+ * @typedef ChargeLineItem
63
+ * @property {string} name
64
+ * @property {string} term
65
+ * @property {string} pricing_type
66
+ * @property {EntityChargePrice} price
67
+ * @property {EntityChargeRecurring} [recurring]
68
+ * @property {number} [capped_amount]
69
+ * @property {number} [trial_days]
70
+ * @property {boolean} [is_test]
71
+ * @property {Object} [metadata]
85
72
  */
86
73
  /**
87
- * @typedef EntitySubscription
74
+ * @typedef CreateSubscriptionCharge
75
+ * @property {string} name
76
+ * @property {number} [trial_days]
77
+ * @property {ChargeLineItem[]} line_items
78
+ * @property {boolean} [is_test]
79
+ * @property {string} return_url
80
+ */
81
+ /**
82
+ * @typedef OneTimeChargeItem
83
+ * @property {string} name
84
+ * @property {string} [term]
85
+ * @property {string} pricing_type
86
+ * @property {EntityChargePrice} price
87
+ * @property {number} [capped_amount]
88
+ * @property {boolean} [is_test]
89
+ * @property {Object} [metadata]
90
+ */
91
+ /**
92
+ * @typedef CreateOneTimeCharge
93
+ * @property {string} name
94
+ * @property {OneTimeChargeItem} charge
95
+ * @property {boolean} [is_test]
96
+ * @property {string} return_url
97
+ */
98
+ /**
99
+ * @typedef CurrentPeriod
100
+ * @property {string} [start_date]
101
+ * @property {string} [end_date]
102
+ */
103
+ /**
104
+ * @typedef SubscriptionCharge
88
105
  * @property {string} [_id]
106
+ * @property {string} [name]
107
+ * @property {string} [term] - Brief description for a charge
108
+ * @property {string} [pricing_type]
109
+ * @property {EntityChargePrice} [price]
110
+ * @property {EntityChargeRecurring} [recurring]
111
+ * @property {number} [capped_amount]
89
112
  * @property {string} [activated_on]
90
113
  * @property {string} [cancelled_on]
91
- * @property {number} [company_id]
92
- * @property {SubscriptionCharge[]} [line_items]
114
+ * @property {string} [billing_date]
115
+ * @property {CurrentPeriod} [current_period]
116
+ * @property {string} [status]
117
+ * @property {boolean} [is_test]
93
118
  * @property {Object} [metadata]
119
+ */
120
+ /**
121
+ * @typedef EntitySubscription
122
+ * @property {string} [_id]
94
123
  * @property {string} [name]
95
124
  * @property {string} [status]
125
+ * @property {number} [company_id]
126
+ * @property {string} [activated_on]
127
+ * @property {string} [cancelled_on]
96
128
  * @property {number} [trial_days]
97
129
  * @property {SubscriptionTrialPeriod} [trial_period]
130
+ * @property {Object} [metadata]
131
+ * @property {SubscriptionCharge[]} [line_items]
98
132
  */
99
133
  /**
100
- * @typedef Features
101
- * @property {string} [description]
102
- * @property {string} [display_text]
103
- * @property {boolean} [enabled]
104
- * @property {string} [group]
134
+ * @typedef OneTimeChargeEntity
135
+ * @property {string} [_id]
105
136
  * @property {string} [name]
106
- * @property {string} [slug]
137
+ * @property {string} [status]
138
+ * @property {string} [activated_on]
139
+ * @property {string} [cancelled_on]
140
+ * @property {Object} [metadata]
141
+ * @property {string} [return_url]
142
+ * @property {boolean} [is_test]
143
+ * @property {string} [pricing_type]
144
+ * @property {string} [subscriber_id]
145
+ * @property {string} [entity_type]
146
+ * @property {string} [entity_id]
147
+ * @property {Object} [meta]
148
+ * @property {EntityChargePrice} [price]
149
+ */
150
+ /**
151
+ * @typedef CreateOneTimeChargeResponse
152
+ * @property {OneTimeChargeEntity} [charge]
153
+ * @property {string} [confirm_url]
107
154
  */
108
155
  /**
109
- * @typedef FeeComponents
110
- * @property {string[]} [brand]
111
- * @property {string} [business_lead]
112
- * @property {Object[]} [channel]
113
- * @property {Object[]} [components]
114
- * @property {string[]} [location]
115
- * @property {Object} [settle_cycle_period]
116
- * @property {string} [settlement_type]
156
+ * @typedef CreateSubscriptionResponse
157
+ * @property {EntitySubscription} [subscription]
158
+ * @property {string} [confirm_url]
117
159
  */
118
160
  /**
119
- * @typedef InternalServerError
120
- * @property {string} [code] - Error code
121
- * @property {string} [message] - Internal server Server error
161
+ * @typedef InvoiceDetailsPeriod
162
+ * @property {string} [start]
163
+ * @property {string} [end]
122
164
  */
123
165
  /**
124
- * @typedef Invoice
125
- * @property {InvoiceDetails} [invoice]
126
- * @property {InvoiceItems[]} [invoice_items]
166
+ * @typedef InvoiceDetailsClient
167
+ * @property {string[]} [address_lines]
168
+ * @property {string} [name]
169
+ * @property {string} [email]
170
+ * @property {string} [phone]
127
171
  */
128
172
  /**
129
- * @typedef InvoiceDetails
173
+ * @typedef InvoiceDetailsStatusTrail
130
174
  * @property {string} [_id]
131
- * @property {number} [attemp]
132
- * @property {boolean} [auto_advance]
175
+ * @property {string} [value]
176
+ * @property {string} [timestamp]
177
+ */
178
+ /**
179
+ * @typedef InvoicePaymentMethod
180
+ * @property {string} [pg_payment_method_id]
181
+ */
182
+ /**
183
+ * @typedef InvoiceDetails
184
+ * @property {InvoiceDetailsPeriod} [period]
133
185
  * @property {InvoiceDetailsClient} [client]
134
- * @property {string} [collection_method]
135
- * @property {string} [created_at]
186
+ * @property {boolean} [auto_advance]
136
187
  * @property {string} [currency]
137
- * @property {string} [current_status]
138
- * @property {string} [hash_identifier]
188
+ * @property {boolean} [paid]
189
+ * @property {number} [attemp]
190
+ * @property {string} [_id]
191
+ * @property {string} [collection_method]
192
+ * @property {string} [subscriber_id]
139
193
  * @property {string} [invoice_url]
140
- * @property {string} [modified_at]
141
- * @property {string} [next_action_time]
142
194
  * @property {string} [number]
143
- * @property {boolean} [paid]
144
- * @property {InvoicePaymentMethod} [payment_method]
145
- * @property {InvoiceDetailsPeriod} [period]
146
195
  * @property {Object} [pg_data]
147
196
  * @property {string} [receipt_number]
148
197
  * @property {string} [statement_descriptor]
198
+ * @property {string} [current_status]
149
199
  * @property {InvoiceDetailsStatusTrail[]} [status_trail]
150
- * @property {string} [subscriber_id]
151
- * @property {string} [subscription]
152
200
  * @property {number} [subtotal]
153
201
  * @property {number} [total]
202
+ * @property {string} [subscription]
203
+ * @property {string} [next_action_time]
204
+ * @property {string} [created_at]
205
+ * @property {string} [modified_at]
206
+ * @property {string} [hash_identifier]
207
+ * @property {InvoicePaymentMethod} [payment_method]
154
208
  */
155
209
  /**
156
- * @typedef InvoiceDetailsClient
157
- * @property {string[]} [address_lines]
158
- * @property {string} [email]
159
- * @property {string} [name]
160
- * @property {string} [phone]
210
+ * @typedef InvoiceItemsPlanRecurring
211
+ * @property {string} [interval]
212
+ * @property {number} [interval_count]
161
213
  */
162
214
  /**
163
- * @typedef InvoiceDetailsPeriod
164
- * @property {string} [end]
165
- * @property {string} [start]
215
+ * @typedef InvoiceItemsPlan
216
+ * @property {InvoiceItemsPlanRecurring} [recurring]
217
+ * @property {boolean} [is_trial_plan]
218
+ * @property {string} [plan_group]
219
+ * @property {string[]} [tag_lines]
220
+ * @property {string} [currency]
221
+ * @property {boolean} [is_active]
222
+ * @property {boolean} [is_visible]
223
+ * @property {number} [trial_period]
224
+ * @property {string[]} [addons]
225
+ * @property {string[]} [tags]
226
+ * @property {string} [type]
227
+ * @property {string} [country]
228
+ * @property {string} [_id]
229
+ * @property {string} [name]
230
+ * @property {string} [description]
231
+ * @property {number} [amount]
232
+ * @property {string} [product_suite_id]
233
+ * @property {string} [created_at]
234
+ * @property {string} [modified_at]
166
235
  */
167
236
  /**
168
- * @typedef InvoiceDetailsStatusTrail
169
- * @property {string} [_id]
170
- * @property {string} [timestamp]
171
- * @property {string} [value]
237
+ * @typedef InvoiceItemsPeriod
238
+ * @property {string} [start]
239
+ * @property {string} [end]
172
240
  */
173
241
  /**
174
242
  * @typedef InvoiceItems
175
243
  * @property {string} [_id]
176
- * @property {number} [amount]
177
- * @property {string} [created_at]
178
244
  * @property {string} [currency]
179
- * @property {string} [description]
180
- * @property {string} [invoice_id]
181
- * @property {string} [modified_at]
182
- * @property {string} [name]
183
- * @property {InvoiceItemsPeriod} [period]
184
245
  * @property {InvoiceItemsPlan} [plan]
246
+ * @property {string} [name]
185
247
  * @property {number} [quantity]
186
- * @property {string} [type]
248
+ * @property {string} [description]
249
+ * @property {InvoiceItemsPeriod} [period]
187
250
  * @property {number} [unit_amount]
251
+ * @property {number} [amount]
252
+ * @property {string} [type]
253
+ * @property {string} [invoice_id]
254
+ * @property {string} [created_at]
255
+ * @property {string} [modified_at]
188
256
  */
189
257
  /**
190
- * @typedef InvoiceItemsPeriod
191
- * @property {string} [end]
192
- * @property {string} [start]
258
+ * @typedef Invoice
259
+ * @property {InvoiceDetails} [invoice]
260
+ * @property {InvoiceItems[]} [invoice_items]
193
261
  */
194
262
  /**
195
- * @typedef InvoiceItemsPlan
196
- * @property {string} [_id]
197
- * @property {string[]} [addons]
198
- * @property {number} [amount]
199
- * @property {string} [country]
200
- * @property {string} [created_at]
201
- * @property {string} [currency]
202
- * @property {string} [description]
203
- * @property {boolean} [is_active]
204
- * @property {boolean} [is_trial_plan]
205
- * @property {boolean} [is_visible]
206
- * @property {string} [modified_at]
263
+ * @typedef InvoicesDataClient
207
264
  * @property {string} [name]
208
- * @property {string} [plan_group]
209
- * @property {string} [product_suite_id]
210
- * @property {InvoiceItemsPlanRecurring} [recurring]
211
- * @property {string[]} [tag_lines]
212
- * @property {string[]} [tags]
213
- * @property {number} [trial_period]
214
- * @property {string} [type]
265
+ * @property {string} [email]
266
+ * @property {string} [phone]
267
+ * @property {string[]} [address_lines]
215
268
  */
216
269
  /**
217
- * @typedef InvoiceItemsPlanRecurring
218
- * @property {string} [interval]
219
- * @property {number} [interval_count]
270
+ * @typedef InvoicesDataPeriod
271
+ * @property {string} [start]
272
+ * @property {string} [end]
220
273
  */
221
274
  /**
222
- * @typedef InvoicePaymentMethod
275
+ * @typedef InvoicesDataPaymentMethod
223
276
  * @property {string} [pg_payment_method_id]
224
277
  */
225
- /**
226
- * @typedef Invoices
227
- * @property {InvoicesData[]} [data]
228
- * @property {number} [end]
229
- * @property {number} [limit]
230
- * @property {number} [page]
231
- * @property {number} [start]
232
- * @property {number} [total]
233
- */
234
278
  /**
235
279
  * @typedef InvoicesData
236
280
  * @property {string} [_id]
237
- * @property {number} [attemp]
238
- * @property {boolean} [auto_advance]
239
281
  * @property {InvoicesDataClient} [client]
240
- * @property {string} [collection_method]
241
- * @property {string} [created_at]
282
+ * @property {boolean} [auto_advance]
242
283
  * @property {string} [currency]
243
- * @property {string} [current_status]
244
- * @property {string} [hash_identifier]
245
- * @property {InvoiceItems[]} [invoice_items]
284
+ * @property {boolean} [paid]
285
+ * @property {number} [attemp]
286
+ * @property {string} [collection_method]
287
+ * @property {string} [subscriber_id]
246
288
  * @property {string} [invoice_url]
247
- * @property {string} [modified_at]
248
- * @property {string} [next_action_time]
249
289
  * @property {string} [number]
250
- * @property {boolean} [paid]
251
- * @property {InvoicesDataPaymentMethod} [payment_method]
252
- * @property {InvoicesDataPeriod} [period]
253
290
  * @property {Object} [pg_data]
291
+ * @property {InvoicesDataPeriod} [period]
254
292
  * @property {string} [receipt_number]
255
293
  * @property {string} [statement_descriptor]
294
+ * @property {string} [current_status]
256
295
  * @property {InvoiceDetailsStatusTrail[]} [status_trail]
257
- * @property {string} [subscriber_id]
258
- * @property {string} [subscription]
259
296
  * @property {number} [subtotal]
260
297
  * @property {number} [total]
298
+ * @property {string} [subscription]
299
+ * @property {string} [next_action_time]
300
+ * @property {string} [created_at]
301
+ * @property {string} [modified_at]
302
+ * @property {string} [hash_identifier]
303
+ * @property {InvoicesDataPaymentMethod} [payment_method]
304
+ * @property {InvoiceItems[]} [invoice_items]
261
305
  */
262
306
  /**
263
- * @typedef InvoicesDataClient
264
- * @property {string[]} [address_lines]
265
- * @property {string} [email]
266
- * @property {string} [name]
267
- * @property {string} [phone]
268
- */
269
- /**
270
- * @typedef InvoicesDataPaymentMethod
271
- * @property {string} [pg_payment_method_id]
307
+ * @typedef Invoices
308
+ * @property {InvoicesData[]} [data]
309
+ * @property {number} [start]
310
+ * @property {number} [end]
311
+ * @property {number} [limit]
312
+ * @property {number} [page]
313
+ * @property {number} [total]
272
314
  */
273
315
  /**
274
- * @typedef InvoicesDataPeriod
275
- * @property {string} [end]
276
- * @property {string} [start]
316
+ * @typedef Phone
317
+ * @property {string} [phone_number]
318
+ * @property {string} [phone_country_code]
277
319
  */
278
320
  /**
279
- * @typedef Meta
280
- * @property {boolean} [is_custom_plan]
281
- * @property {boolean} [is_plan_upgrade]
282
- * @property {boolean} [subscribe]
321
+ * @typedef SubscriptionBillingAddress
322
+ * @property {string} [country]
323
+ * @property {string} [state]
324
+ * @property {string} [city]
325
+ * @property {string} [line1]
326
+ * @property {string} [line2]
327
+ * @property {string} [postal_code]
283
328
  */
284
329
  /**
285
- * @typedef OneTimeChargeEntity
330
+ * @typedef SubscriptionCustomer
331
+ * @property {Phone} [phone]
332
+ * @property {SubscriptionBillingAddress} [billing_address]
286
333
  * @property {string} [_id]
287
- * @property {string} [activated_on]
288
- * @property {string} [cancelled_on]
289
- * @property {string} [entity_id]
290
- * @property {string} [entity_type]
291
- * @property {boolean} [is_test]
292
- * @property {Object} [meta]
293
- * @property {Object} [metadata]
334
+ * @property {string} [unique_id]
335
+ * @property {string} [type]
294
336
  * @property {string} [name]
295
- * @property {EntityChargePrice} [price]
296
- * @property {string} [pricing_type]
297
- * @property {string} [return_url]
298
- * @property {string} [status]
299
- * @property {string} [subscriber_id]
300
- */
301
- /**
302
- * @typedef OneTimeChargeItem
303
- * @property {number} [capped_amount]
304
- * @property {boolean} [is_test]
305
- * @property {Object} [metadata]
306
- * @property {string} name
307
- * @property {EntityChargePrice} price
308
- * @property {string} pricing_type
309
- * @property {string} [term]
310
- */
311
- /**
312
- * @typedef Phone
313
- * @property {string} [phone_country_code]
314
- * @property {string} [phone_number]
315
- */
316
- /**
317
- * @typedef Plan
318
- * @property {string} [_id]
319
- * @property {string[]} [addons]
320
- * @property {number} [amount]
321
- * @property {string} [country]
337
+ * @property {string} [email]
322
338
  * @property {string} [created_at]
323
- * @property {string} [currency]
324
- * @property {string} [description]
325
- * @property {boolean} [is_active]
326
- * @property {boolean} [is_trial_plan]
327
- * @property {boolean} [is_visible]
328
339
  * @property {string} [modified_at]
329
- * @property {string} [name]
330
- * @property {string} [plan_group]
331
- * @property {string} [product_suite_id]
332
- * @property {PlanRecurring} [recurring]
333
- * @property {string[]} [tag_lines]
334
- * @property {string[]} [tags]
335
- * @property {number} [trial_period]
340
+ * @property {Object} [data]
341
+ */
342
+ /**
343
+ * @typedef SubscriptionCustomerCreate
344
+ * @property {Phone} [phone]
345
+ * @property {SubscriptionBillingAddress} [billing_address]
346
+ * @property {string} [unique_id]
336
347
  * @property {string} [type]
348
+ * @property {string} [name]
349
+ * @property {string} [email]
337
350
  */
338
351
  /**
339
- * @typedef PlanRecurring
340
- * @property {string} [interval]
341
- * @property {number} [interval_count]
352
+ * @typedef SubscriptionCurrentPeriod
353
+ * @property {string} [start]
354
+ * @property {string} [end]
342
355
  */
343
356
  /**
344
- * @typedef PlanStatusUpdateReq
345
- * @property {string} [plan_id]
346
- * @property {string} [reason]
347
- * @property {string} [seller_status]
357
+ * @typedef SubscriptionPauseCollection
358
+ * @property {string} [behavior]
359
+ * @property {string} [resume_at]
348
360
  */
349
361
  /**
350
- * @typedef ResourceNotFound
351
- * @property {string} [message] - Resource not found with {id}
362
+ * @typedef SubscriptionTrial
363
+ * @property {string} [start]
364
+ * @property {string} [end]
352
365
  */
353
366
  /**
354
- * @typedef SubscribePlanRes
355
- * @property {string} [current_status]
356
- * @property {Meta} [meta]
357
- * @property {string} [redirect_url]
358
- * @property {string} [transaction_id]
367
+ * @typedef SubscriptionInvoiceSettings
368
+ * @property {boolean} [generation]
369
+ * @property {boolean} [charging]
359
370
  */
360
371
  /**
361
372
  * @typedef Subscription
362
- * @property {string} [_id]
363
- * @property {boolean} [cancel_at_period_end]
364
- * @property {string} [channel_type]
365
- * @property {string} [collection_method]
366
- * @property {string} [created_at]
367
373
  * @property {SubscriptionCurrentPeriod} [current_period]
368
- * @property {string} [current_status]
374
+ * @property {SubscriptionPauseCollection} [pause_collection]
375
+ * @property {SubscriptionTrial} [trial]
369
376
  * @property {SubscriptionInvoiceSettings} [invoice_settings]
370
377
  * @property {boolean} [is_active]
371
- * @property {string} [latest_invoice]
372
- * @property {string} [modified_at]
373
- * @property {SubscriptionPauseCollection} [pause_collection]
374
- * @property {Plan} [plan_data]
378
+ * @property {boolean} [cancel_at_period_end]
379
+ * @property {string} [_id]
380
+ * @property {string} [subscriber_id]
375
381
  * @property {string} [plan_id]
376
382
  * @property {string} [product_suite_id]
377
- * @property {string} [subscriber_id]
378
- * @property {SubscriptionTrial} [trial]
383
+ * @property {Plan} [plan_data]
384
+ * @property {string} [current_status]
385
+ * @property {string} [collection_method]
386
+ * @property {string} [created_at]
387
+ * @property {string} [modified_at]
388
+ * @property {string} [latest_invoice]
389
+ * @property {string} [channel_type]
379
390
  */
380
391
  /**
381
- * @typedef SubscriptionActivateReq
382
- * @property {string} [payment_method]
383
- * @property {string} [plan_id]
384
- * @property {string} [product_suite]
385
- * @property {string} [type]
386
- * @property {string} [unique_id]
392
+ * @typedef SubscriptionStatus
393
+ * @property {boolean} [is_enabled]
394
+ * @property {Subscription} [subscription]
395
+ * @property {InvoicesData} [latest_invoice]
396
+ * @property {Plan} [next_plan]
397
+ * @property {Subscription[]} [current_subscriptions]
398
+ * @property {string} [mandate_amount]
387
399
  */
388
400
  /**
389
- * @typedef SubscriptionActivateRes
390
- * @property {Subscription} [data]
391
- * @property {boolean} [success]
401
+ * @typedef SubscriptionLimitApplication
402
+ * @property {boolean} [enabled]
403
+ * @property {number} [hard_limit]
404
+ * @property {number} [soft_limit]
392
405
  */
393
406
  /**
394
- * @typedef SubscriptionBillingAddress
395
- * @property {string} [city]
396
- * @property {string} [country]
397
- * @property {string} [line1]
398
- * @property {string} [line2]
399
- * @property {string} [postal_code]
400
- * @property {string} [state]
401
- */
402
- /**
403
- * @typedef SubscriptionCharge
404
- * @property {string} [_id]
405
- * @property {string} [activated_on]
406
- * @property {string} [billing_date]
407
- * @property {string} [cancelled_on]
408
- * @property {number} [capped_amount]
409
- * @property {CurrentPeriod} [current_period]
410
- * @property {boolean} [is_test]
411
- * @property {Object} [metadata]
412
- * @property {string} [name]
413
- * @property {EntityChargePrice} [price]
414
- * @property {string} [pricing_type]
415
- * @property {EntityChargeRecurring} [recurring]
416
- * @property {string} [status]
417
- * @property {string} [term] - Brief description for a charge
418
- */
419
- /**
420
- * @typedef SubscriptionCurrentPeriod
421
- * @property {string} [end]
422
- * @property {string} [start]
423
- */
424
- /**
425
- * @typedef SubscriptionCustomer
426
- * @property {string} [_id]
427
- * @property {SubscriptionBillingAddress} [billing_address]
428
- * @property {string} [created_at]
429
- * @property {Object} [data]
430
- * @property {string} [email]
431
- * @property {string} [modified_at]
432
- * @property {string} [name]
433
- * @property {Phone} [phone]
434
- * @property {string} [type]
435
- * @property {string} [unique_id]
436
- */
437
- /**
438
- * @typedef SubscriptionCustomerCreate
439
- * @property {SubscriptionBillingAddress} [billing_address]
440
- * @property {string} [email]
441
- * @property {string} [name]
442
- * @property {Phone} [phone]
443
- * @property {string} [type]
444
- * @property {string} [unique_id]
407
+ * @typedef SubscriptionLimitMarketplace
408
+ * @property {boolean} [enabled]
445
409
  */
446
410
  /**
447
- * @typedef SubscriptionInvoiceSettings
448
- * @property {boolean} [charging]
449
- * @property {boolean} [generation]
411
+ * @typedef SubscriptionLimitOtherPlatform
412
+ * @property {boolean} [enabled]
450
413
  */
451
414
  /**
452
- * @typedef SubscriptionLimit
453
- * @property {SubscriptionLimitApplication} [application]
454
- * @property {SubscriptionLimitExtensions} [extensions]
455
- * @property {SubscriptionLimitIntegrations} [integrations]
456
- * @property {boolean} [is_trial_plan]
457
- * @property {SubscriptionLimitMarketplace} [marketplace]
458
- * @property {SubscriptionLimitOtherPlatform} [other_platform]
459
- * @property {SubscriptionLimitProducts} [products]
460
- * @property {SubscriptionLimitTeam} [team]
415
+ * @typedef SubscriptionLimitTeam
416
+ * @property {number} [limit]
461
417
  */
462
418
  /**
463
- * @typedef SubscriptionLimitApplication
464
- * @property {boolean} [enabled]
465
- * @property {number} [hard_limit]
466
- * @property {number} [soft_limit]
419
+ * @typedef SubscriptionLimitProducts
420
+ * @property {boolean} [bulk]
421
+ * @property {number} [limit]
467
422
  */
468
423
  /**
469
424
  * @typedef SubscriptionLimitExtensions
@@ -476,58 +431,72 @@ export = BillingPlatformModel;
476
431
  * @property {number} [limit]
477
432
  */
478
433
  /**
479
- * @typedef SubscriptionLimitMarketplace
480
- * @property {boolean} [enabled]
434
+ * @typedef SubscriptionLimit
435
+ * @property {SubscriptionLimitApplication} [application]
436
+ * @property {SubscriptionLimitMarketplace} [marketplace]
437
+ * @property {SubscriptionLimitOtherPlatform} [other_platform]
438
+ * @property {SubscriptionLimitTeam} [team]
439
+ * @property {SubscriptionLimitProducts} [products]
440
+ * @property {SubscriptionLimitExtensions} [extensions]
441
+ * @property {SubscriptionLimitIntegrations} [integrations]
442
+ * @property {boolean} [is_trial_plan]
481
443
  */
482
444
  /**
483
- * @typedef SubscriptionLimitOtherPlatform
484
- * @property {boolean} [enabled]
445
+ * @typedef SubscriptionActivateReq
446
+ * @property {string} [unique_id]
447
+ * @property {string} [type]
448
+ * @property {string} [product_suite]
449
+ * @property {string} [plan_id]
450
+ * @property {string} [payment_method]
485
451
  */
486
452
  /**
487
- * @typedef SubscriptionLimitProducts
488
- * @property {boolean} [bulk]
489
- * @property {number} [limit]
453
+ * @typedef SubscriptionActivateRes
454
+ * @property {boolean} [success]
455
+ * @property {Subscription} [data]
490
456
  */
491
457
  /**
492
- * @typedef SubscriptionLimitTeam
493
- * @property {number} [limit]
458
+ * @typedef CancelSubscriptionReq
459
+ * @property {string} [unique_id]
460
+ * @property {string} [type]
461
+ * @property {string} [product_suite]
462
+ * @property {string} [subscription_id]
494
463
  */
495
464
  /**
496
- * @typedef SubscriptionPauseCollection
497
- * @property {string} [behavior]
498
- * @property {string} [resume_at]
465
+ * @typedef CancelSubscriptionRes
466
+ * @property {boolean} [success]
467
+ * @property {Subscription} [data]
499
468
  */
500
469
  /**
501
- * @typedef SubscriptionStatus
502
- * @property {Subscription[]} [current_subscriptions]
503
- * @property {boolean} [is_enabled]
504
- * @property {InvoicesData} [latest_invoice]
505
- * @property {string} [mandate_amount]
506
- * @property {Plan} [next_plan]
507
- * @property {Subscription} [subscription]
470
+ * @typedef PlanStatusUpdateReq
471
+ * @property {string} [plan_id]
472
+ * @property {string} [reason]
473
+ * @property {string} [seller_status]
508
474
  */
509
475
  /**
510
- * @typedef SubscriptionTrial
511
- * @property {string} [end]
512
- * @property {string} [start]
476
+ * @typedef SunscribePlan
477
+ * @property {string} [entity_type]
478
+ * @property {string} [collection_type]
479
+ * @property {string} [plan_id]
480
+ * @property {string} [callback_url]
481
+ * @property {Meta} [meta]
513
482
  */
514
483
  /**
515
- * @typedef SubscriptionTrialPeriod
516
- * @property {string} [end_date]
517
- * @property {string} [start_date]
484
+ * @typedef Meta
485
+ * @property {boolean} [subscribe]
486
+ * @property {boolean} [is_custom_plan]
487
+ * @property {boolean} [is_plan_upgrade]
518
488
  */
519
489
  /**
520
- * @typedef SunscribePlan
521
- * @property {string} [callback_url]
522
- * @property {string} [collection_type]
523
- * @property {string} [entity_type]
490
+ * @typedef SubscribePlanRes
491
+ * @property {string} [redirect_url]
492
+ * @property {string} [transaction_id]
493
+ * @property {string} [current_status]
524
494
  * @property {Meta} [meta]
525
- * @property {string} [plan_id]
526
495
  */
527
496
  declare class BillingPlatformModel {
528
497
  }
529
498
  declare namespace BillingPlatformModel {
530
- export { BadRequest, CancelSubscriptionReq, CancelSubscriptionRes, ChargeLineItem, CheckValidityResponse, CreateOneTimeCharge, CreateOneTimeChargeResponse, CreateSubscriptionCharge, CreateSubscriptionResponse, CurrentPeriod, Details, EntityChargePrice, EntityChargeRecurring, EntityResponse, EntitySubscription, Features, FeeComponents, InternalServerError, Invoice, InvoiceDetails, InvoiceDetailsClient, InvoiceDetailsPeriod, InvoiceDetailsStatusTrail, InvoiceItems, InvoiceItemsPeriod, InvoiceItemsPlan, InvoiceItemsPlanRecurring, InvoicePaymentMethod, Invoices, InvoicesData, InvoicesDataClient, InvoicesDataPaymentMethod, InvoicesDataPeriod, Meta, OneTimeChargeEntity, OneTimeChargeItem, Phone, Plan, PlanRecurring, PlanStatusUpdateReq, ResourceNotFound, SubscribePlanRes, Subscription, SubscriptionActivateReq, SubscriptionActivateRes, SubscriptionBillingAddress, SubscriptionCharge, SubscriptionCurrentPeriod, SubscriptionCustomer, SubscriptionCustomerCreate, SubscriptionInvoiceSettings, SubscriptionLimit, SubscriptionLimitApplication, SubscriptionLimitExtensions, SubscriptionLimitIntegrations, SubscriptionLimitMarketplace, SubscriptionLimitOtherPlatform, SubscriptionLimitProducts, SubscriptionLimitTeam, SubscriptionPauseCollection, SubscriptionStatus, SubscriptionTrial, SubscriptionTrialPeriod, SunscribePlan };
499
+ export { BadRequest, ResourceNotFound, InternalServerError, CheckValidityResponse, PlanRecurring, Plan, SubscriptionTrialPeriod, EntityChargePrice, EntityChargeRecurring, ChargeLineItem, CreateSubscriptionCharge, OneTimeChargeItem, CreateOneTimeCharge, CurrentPeriod, SubscriptionCharge, EntitySubscription, OneTimeChargeEntity, CreateOneTimeChargeResponse, CreateSubscriptionResponse, InvoiceDetailsPeriod, InvoiceDetailsClient, InvoiceDetailsStatusTrail, InvoicePaymentMethod, InvoiceDetails, InvoiceItemsPlanRecurring, InvoiceItemsPlan, InvoiceItemsPeriod, InvoiceItems, Invoice, InvoicesDataClient, InvoicesDataPeriod, InvoicesDataPaymentMethod, InvoicesData, Invoices, Phone, SubscriptionBillingAddress, SubscriptionCustomer, SubscriptionCustomerCreate, SubscriptionCurrentPeriod, SubscriptionPauseCollection, SubscriptionTrial, SubscriptionInvoiceSettings, Subscription, SubscriptionStatus, SubscriptionLimitApplication, SubscriptionLimitMarketplace, SubscriptionLimitOtherPlatform, SubscriptionLimitTeam, SubscriptionLimitProducts, SubscriptionLimitExtensions, SubscriptionLimitIntegrations, SubscriptionLimit, SubscriptionActivateReq, SubscriptionActivateRes, CancelSubscriptionReq, CancelSubscriptionRes, PlanStatusUpdateReq, SunscribePlan, Meta, SubscribePlanRes };
531
500
  }
532
501
  /** @returns {BadRequest} */
533
502
  declare function BadRequest(): BadRequest;
@@ -537,527 +506,457 @@ type BadRequest = {
537
506
  */
538
507
  message?: string;
539
508
  };
540
- /** @returns {CancelSubscriptionReq} */
541
- declare function CancelSubscriptionReq(): CancelSubscriptionReq;
542
- type CancelSubscriptionReq = {
543
- product_suite?: string;
544
- subscription_id?: string;
509
+ /** @returns {ResourceNotFound} */
510
+ declare function ResourceNotFound(): ResourceNotFound;
511
+ type ResourceNotFound = {
512
+ /**
513
+ * - Resource not found with {id}
514
+ */
515
+ message?: string;
516
+ };
517
+ /** @returns {InternalServerError} */
518
+ declare function InternalServerError(): InternalServerError;
519
+ type InternalServerError = {
520
+ /**
521
+ * - Internal server Server error
522
+ */
523
+ message?: string;
524
+ /**
525
+ * - Error code
526
+ */
527
+ code?: string;
528
+ };
529
+ /** @returns {CheckValidityResponse} */
530
+ declare function CheckValidityResponse(): CheckValidityResponse;
531
+ type CheckValidityResponse = {
532
+ is_valid?: boolean;
533
+ discount_amount?: number;
534
+ };
535
+ /** @returns {PlanRecurring} */
536
+ declare function PlanRecurring(): PlanRecurring;
537
+ type PlanRecurring = {
538
+ interval?: string;
539
+ interval_count?: number;
540
+ };
541
+ /** @returns {Plan} */
542
+ declare function Plan(): Plan;
543
+ type Plan = {
544
+ recurring?: PlanRecurring;
545
+ is_trial_plan?: boolean;
546
+ plan_group?: string;
547
+ tag_lines?: string[];
548
+ currency?: string;
549
+ is_active?: boolean;
550
+ is_visible?: boolean;
551
+ trial_period?: number;
552
+ addons?: string[];
553
+ tags?: string[];
545
554
  type?: string;
546
- unique_id?: string;
555
+ country?: string;
556
+ _id?: string;
557
+ name?: string;
558
+ description?: string;
559
+ amount?: number;
560
+ product_suite_id?: string;
561
+ created_at?: string;
562
+ modified_at?: string;
547
563
  };
548
- /** @returns {CancelSubscriptionRes} */
549
- declare function CancelSubscriptionRes(): CancelSubscriptionRes;
550
- type CancelSubscriptionRes = {
551
- data?: Subscription;
552
- success?: boolean;
564
+ /** @returns {SubscriptionTrialPeriod} */
565
+ declare function SubscriptionTrialPeriod(): SubscriptionTrialPeriod;
566
+ type SubscriptionTrialPeriod = {
567
+ start_date?: string;
568
+ end_date?: string;
569
+ };
570
+ /** @returns {EntityChargePrice} */
571
+ declare function EntityChargePrice(): EntityChargePrice;
572
+ type EntityChargePrice = {
573
+ /**
574
+ * - Amount for price. Minimum value 1
575
+ */
576
+ amount: number;
577
+ currency_code: string;
578
+ };
579
+ /** @returns {EntityChargeRecurring} */
580
+ declare function EntityChargeRecurring(): EntityChargeRecurring;
581
+ type EntityChargeRecurring = {
582
+ interval: string;
553
583
  };
554
584
  /** @returns {ChargeLineItem} */
555
585
  declare function ChargeLineItem(): ChargeLineItem;
556
586
  type ChargeLineItem = {
557
- capped_amount?: number;
558
- is_test?: boolean;
559
- metadata?: any;
560
587
  name: string;
561
- price: EntityChargePrice;
588
+ term: string;
562
589
  pricing_type: string;
590
+ price: EntityChargePrice;
563
591
  recurring?: EntityChargeRecurring;
564
- term: string;
592
+ capped_amount?: number;
565
593
  trial_days?: number;
566
- };
567
- /** @returns {CheckValidityResponse} */
568
- declare function CheckValidityResponse(): CheckValidityResponse;
569
- type CheckValidityResponse = {
570
- discount_amount?: number;
571
- is_valid?: boolean;
572
- };
573
- /** @returns {CreateOneTimeCharge} */
574
- declare function CreateOneTimeCharge(): CreateOneTimeCharge;
575
- type CreateOneTimeCharge = {
576
- charge: OneTimeChargeItem;
577
594
  is_test?: boolean;
578
- name: string;
579
- return_url: string;
580
- };
581
- /** @returns {CreateOneTimeChargeResponse} */
582
- declare function CreateOneTimeChargeResponse(): CreateOneTimeChargeResponse;
583
- type CreateOneTimeChargeResponse = {
584
- charge?: OneTimeChargeEntity;
585
- confirm_url?: string;
595
+ metadata?: any;
586
596
  };
587
597
  /** @returns {CreateSubscriptionCharge} */
588
598
  declare function CreateSubscriptionCharge(): CreateSubscriptionCharge;
589
599
  type CreateSubscriptionCharge = {
590
- is_test?: boolean;
591
- line_items: ChargeLineItem[];
592
600
  name: string;
593
- return_url: string;
594
601
  trial_days?: number;
602
+ line_items: ChargeLineItem[];
603
+ is_test?: boolean;
604
+ return_url: string;
595
605
  };
596
- /** @returns {CreateSubscriptionResponse} */
597
- declare function CreateSubscriptionResponse(): CreateSubscriptionResponse;
598
- type CreateSubscriptionResponse = {
599
- confirm_url?: string;
600
- subscription?: EntitySubscription;
606
+ /** @returns {OneTimeChargeItem} */
607
+ declare function OneTimeChargeItem(): OneTimeChargeItem;
608
+ type OneTimeChargeItem = {
609
+ name: string;
610
+ term?: string;
611
+ pricing_type: string;
612
+ price: EntityChargePrice;
613
+ capped_amount?: number;
614
+ is_test?: boolean;
615
+ metadata?: any;
616
+ };
617
+ /** @returns {CreateOneTimeCharge} */
618
+ declare function CreateOneTimeCharge(): CreateOneTimeCharge;
619
+ type CreateOneTimeCharge = {
620
+ name: string;
621
+ charge: OneTimeChargeItem;
622
+ is_test?: boolean;
623
+ return_url: string;
601
624
  };
602
625
  /** @returns {CurrentPeriod} */
603
626
  declare function CurrentPeriod(): CurrentPeriod;
604
627
  type CurrentPeriod = {
605
- end_date?: string;
606
628
  start_date?: string;
629
+ end_date?: string;
607
630
  };
608
- /** @returns {Details} */
609
- declare function Details(): Details;
610
- type Details = {
611
- features?: Features[];
612
- fee_components?: FeeComponents[];
613
- };
614
- /** @returns {EntityChargePrice} */
615
- declare function EntityChargePrice(): EntityChargePrice;
616
- type EntityChargePrice = {
631
+ /** @returns {SubscriptionCharge} */
632
+ declare function SubscriptionCharge(): SubscriptionCharge;
633
+ type SubscriptionCharge = {
634
+ _id?: string;
635
+ name?: string;
617
636
  /**
618
- * - Amount for price. Minimum value 1
637
+ * - Brief description for a charge
619
638
  */
620
- amount: number;
621
- currency_code: string;
622
- };
623
- /** @returns {EntityChargeRecurring} */
624
- declare function EntityChargeRecurring(): EntityChargeRecurring;
625
- type EntityChargeRecurring = {
626
- interval: string;
627
- };
628
- /** @returns {EntityResponse} */
629
- declare function EntityResponse(): EntityResponse;
630
- type EntityResponse = {
631
- items?: Details[];
632
- page?: number;
633
- page_size?: number;
634
- success?: boolean;
639
+ term?: string;
640
+ pricing_type?: string;
641
+ price?: EntityChargePrice;
642
+ recurring?: EntityChargeRecurring;
643
+ capped_amount?: number;
644
+ activated_on?: string;
645
+ cancelled_on?: string;
646
+ billing_date?: string;
647
+ current_period?: CurrentPeriod;
648
+ status?: string;
649
+ is_test?: boolean;
650
+ metadata?: any;
635
651
  };
636
652
  /** @returns {EntitySubscription} */
637
653
  declare function EntitySubscription(): EntitySubscription;
638
654
  type EntitySubscription = {
639
655
  _id?: string;
640
- activated_on?: string;
641
- cancelled_on?: string;
642
- company_id?: number;
643
- line_items?: SubscriptionCharge[];
644
- metadata?: any;
645
656
  name?: string;
646
657
  status?: string;
658
+ company_id?: number;
659
+ activated_on?: string;
660
+ cancelled_on?: string;
647
661
  trial_days?: number;
648
662
  trial_period?: SubscriptionTrialPeriod;
663
+ metadata?: any;
664
+ line_items?: SubscriptionCharge[];
649
665
  };
650
- /** @returns {Features} */
651
- declare function Features(): Features;
652
- type Features = {
653
- description?: string;
654
- display_text?: string;
655
- enabled?: boolean;
656
- group?: string;
666
+ /** @returns {OneTimeChargeEntity} */
667
+ declare function OneTimeChargeEntity(): OneTimeChargeEntity;
668
+ type OneTimeChargeEntity = {
669
+ _id?: string;
657
670
  name?: string;
658
- slug?: string;
671
+ status?: string;
672
+ activated_on?: string;
673
+ cancelled_on?: string;
674
+ metadata?: any;
675
+ return_url?: string;
676
+ is_test?: boolean;
677
+ pricing_type?: string;
678
+ subscriber_id?: string;
679
+ entity_type?: string;
680
+ entity_id?: string;
681
+ meta?: any;
682
+ price?: EntityChargePrice;
659
683
  };
660
- /** @returns {FeeComponents} */
661
- declare function FeeComponents(): FeeComponents;
662
- type FeeComponents = {
663
- brand?: string[];
664
- business_lead?: string;
665
- channel?: any[];
666
- components?: any[];
667
- location?: string[];
668
- settle_cycle_period?: any;
669
- settlement_type?: string;
684
+ /** @returns {CreateOneTimeChargeResponse} */
685
+ declare function CreateOneTimeChargeResponse(): CreateOneTimeChargeResponse;
686
+ type CreateOneTimeChargeResponse = {
687
+ charge?: OneTimeChargeEntity;
688
+ confirm_url?: string;
670
689
  };
671
- /** @returns {InternalServerError} */
672
- declare function InternalServerError(): InternalServerError;
673
- type InternalServerError = {
674
- /**
675
- * - Error code
676
- */
677
- code?: string;
678
- /**
679
- * - Internal server Server error
680
- */
681
- message?: string;
690
+ /** @returns {CreateSubscriptionResponse} */
691
+ declare function CreateSubscriptionResponse(): CreateSubscriptionResponse;
692
+ type CreateSubscriptionResponse = {
693
+ subscription?: EntitySubscription;
694
+ confirm_url?: string;
682
695
  };
683
- /** @returns {Invoice} */
684
- declare function Invoice(): Invoice;
685
- type Invoice = {
686
- invoice?: InvoiceDetails;
687
- invoice_items?: InvoiceItems[];
696
+ /** @returns {InvoiceDetailsPeriod} */
697
+ declare function InvoiceDetailsPeriod(): InvoiceDetailsPeriod;
698
+ type InvoiceDetailsPeriod = {
699
+ start?: string;
700
+ end?: string;
701
+ };
702
+ /** @returns {InvoiceDetailsClient} */
703
+ declare function InvoiceDetailsClient(): InvoiceDetailsClient;
704
+ type InvoiceDetailsClient = {
705
+ address_lines?: string[];
706
+ name?: string;
707
+ email?: string;
708
+ phone?: string;
709
+ };
710
+ /** @returns {InvoiceDetailsStatusTrail} */
711
+ declare function InvoiceDetailsStatusTrail(): InvoiceDetailsStatusTrail;
712
+ type InvoiceDetailsStatusTrail = {
713
+ _id?: string;
714
+ value?: string;
715
+ timestamp?: string;
716
+ };
717
+ /** @returns {InvoicePaymentMethod} */
718
+ declare function InvoicePaymentMethod(): InvoicePaymentMethod;
719
+ type InvoicePaymentMethod = {
720
+ pg_payment_method_id?: string;
688
721
  };
689
722
  /** @returns {InvoiceDetails} */
690
723
  declare function InvoiceDetails(): InvoiceDetails;
691
724
  type InvoiceDetails = {
692
- _id?: string;
693
- attemp?: number;
694
- auto_advance?: boolean;
725
+ period?: InvoiceDetailsPeriod;
695
726
  client?: InvoiceDetailsClient;
696
- collection_method?: string;
697
- created_at?: string;
727
+ auto_advance?: boolean;
698
728
  currency?: string;
699
- current_status?: string;
700
- hash_identifier?: string;
729
+ paid?: boolean;
730
+ attemp?: number;
731
+ _id?: string;
732
+ collection_method?: string;
733
+ subscriber_id?: string;
701
734
  invoice_url?: string;
702
- modified_at?: string;
703
- next_action_time?: string;
704
735
  number?: string;
705
- paid?: boolean;
706
- payment_method?: InvoicePaymentMethod;
707
- period?: InvoiceDetailsPeriod;
708
736
  pg_data?: any;
709
737
  receipt_number?: string;
710
738
  statement_descriptor?: string;
739
+ current_status?: string;
711
740
  status_trail?: InvoiceDetailsStatusTrail[];
712
- subscriber_id?: string;
713
- subscription?: string;
714
741
  subtotal?: number;
715
742
  total?: number;
743
+ subscription?: string;
744
+ next_action_time?: string;
745
+ created_at?: string;
746
+ modified_at?: string;
747
+ hash_identifier?: string;
748
+ payment_method?: InvoicePaymentMethod;
716
749
  };
717
- /** @returns {InvoiceDetailsClient} */
718
- declare function InvoiceDetailsClient(): InvoiceDetailsClient;
719
- type InvoiceDetailsClient = {
720
- address_lines?: string[];
721
- email?: string;
722
- name?: string;
723
- phone?: string;
724
- };
725
- /** @returns {InvoiceDetailsPeriod} */
726
- declare function InvoiceDetailsPeriod(): InvoiceDetailsPeriod;
727
- type InvoiceDetailsPeriod = {
728
- end?: string;
729
- start?: string;
730
- };
731
- /** @returns {InvoiceDetailsStatusTrail} */
732
- declare function InvoiceDetailsStatusTrail(): InvoiceDetailsStatusTrail;
733
- type InvoiceDetailsStatusTrail = {
734
- _id?: string;
735
- timestamp?: string;
736
- value?: string;
750
+ /** @returns {InvoiceItemsPlanRecurring} */
751
+ declare function InvoiceItemsPlanRecurring(): InvoiceItemsPlanRecurring;
752
+ type InvoiceItemsPlanRecurring = {
753
+ interval?: string;
754
+ interval_count?: number;
737
755
  };
738
- /** @returns {InvoiceItems} */
739
- declare function InvoiceItems(): InvoiceItems;
740
- type InvoiceItems = {
756
+ /** @returns {InvoiceItemsPlan} */
757
+ declare function InvoiceItemsPlan(): InvoiceItemsPlan;
758
+ type InvoiceItemsPlan = {
759
+ recurring?: InvoiceItemsPlanRecurring;
760
+ is_trial_plan?: boolean;
761
+ plan_group?: string;
762
+ tag_lines?: string[];
763
+ currency?: string;
764
+ is_active?: boolean;
765
+ is_visible?: boolean;
766
+ trial_period?: number;
767
+ addons?: string[];
768
+ tags?: string[];
769
+ type?: string;
770
+ country?: string;
741
771
  _id?: string;
772
+ name?: string;
773
+ description?: string;
742
774
  amount?: number;
775
+ product_suite_id?: string;
743
776
  created_at?: string;
744
- currency?: string;
745
- description?: string;
746
- invoice_id?: string;
747
777
  modified_at?: string;
748
- name?: string;
749
- period?: InvoiceItemsPeriod;
750
- plan?: InvoiceItemsPlan;
751
- quantity?: number;
752
- type?: string;
753
- unit_amount?: number;
754
778
  };
755
779
  /** @returns {InvoiceItemsPeriod} */
756
780
  declare function InvoiceItemsPeriod(): InvoiceItemsPeriod;
757
781
  type InvoiceItemsPeriod = {
758
- end?: string;
759
782
  start?: string;
783
+ end?: string;
760
784
  };
761
- /** @returns {InvoiceItemsPlan} */
762
- declare function InvoiceItemsPlan(): InvoiceItemsPlan;
763
- type InvoiceItemsPlan = {
785
+ /** @returns {InvoiceItems} */
786
+ declare function InvoiceItems(): InvoiceItems;
787
+ type InvoiceItems = {
764
788
  _id?: string;
765
- addons?: string[];
766
- amount?: number;
767
- country?: string;
768
- created_at?: string;
769
789
  currency?: string;
790
+ plan?: InvoiceItemsPlan;
791
+ name?: string;
792
+ quantity?: number;
770
793
  description?: string;
771
- is_active?: boolean;
772
- is_trial_plan?: boolean;
773
- is_visible?: boolean;
794
+ period?: InvoiceItemsPeriod;
795
+ unit_amount?: number;
796
+ amount?: number;
797
+ type?: string;
798
+ invoice_id?: string;
799
+ created_at?: string;
774
800
  modified_at?: string;
801
+ };
802
+ /** @returns {Invoice} */
803
+ declare function Invoice(): Invoice;
804
+ type Invoice = {
805
+ invoice?: InvoiceDetails;
806
+ invoice_items?: InvoiceItems[];
807
+ };
808
+ /** @returns {InvoicesDataClient} */
809
+ declare function InvoicesDataClient(): InvoicesDataClient;
810
+ type InvoicesDataClient = {
775
811
  name?: string;
776
- plan_group?: string;
777
- product_suite_id?: string;
778
- recurring?: InvoiceItemsPlanRecurring;
779
- tag_lines?: string[];
780
- tags?: string[];
781
- trial_period?: number;
782
- type?: string;
812
+ email?: string;
813
+ phone?: string;
814
+ address_lines?: string[];
783
815
  };
784
- /** @returns {InvoiceItemsPlanRecurring} */
785
- declare function InvoiceItemsPlanRecurring(): InvoiceItemsPlanRecurring;
786
- type InvoiceItemsPlanRecurring = {
787
- interval?: string;
788
- interval_count?: number;
816
+ /** @returns {InvoicesDataPeriod} */
817
+ declare function InvoicesDataPeriod(): InvoicesDataPeriod;
818
+ type InvoicesDataPeriod = {
819
+ start?: string;
820
+ end?: string;
789
821
  };
790
- /** @returns {InvoicePaymentMethod} */
791
- declare function InvoicePaymentMethod(): InvoicePaymentMethod;
792
- type InvoicePaymentMethod = {
822
+ /** @returns {InvoicesDataPaymentMethod} */
823
+ declare function InvoicesDataPaymentMethod(): InvoicesDataPaymentMethod;
824
+ type InvoicesDataPaymentMethod = {
793
825
  pg_payment_method_id?: string;
794
826
  };
795
- /** @returns {Invoices} */
796
- declare function Invoices(): Invoices;
797
- type Invoices = {
798
- data?: InvoicesData[];
799
- end?: number;
800
- limit?: number;
801
- page?: number;
802
- start?: number;
803
- total?: number;
804
- };
805
827
  /** @returns {InvoicesData} */
806
828
  declare function InvoicesData(): InvoicesData;
807
829
  type InvoicesData = {
808
830
  _id?: string;
809
- attemp?: number;
810
- auto_advance?: boolean;
811
831
  client?: InvoicesDataClient;
812
- collection_method?: string;
813
- created_at?: string;
832
+ auto_advance?: boolean;
814
833
  currency?: string;
815
- current_status?: string;
816
- hash_identifier?: string;
817
- invoice_items?: InvoiceItems[];
834
+ paid?: boolean;
835
+ attemp?: number;
836
+ collection_method?: string;
837
+ subscriber_id?: string;
818
838
  invoice_url?: string;
819
- modified_at?: string;
820
- next_action_time?: string;
821
839
  number?: string;
822
- paid?: boolean;
823
- payment_method?: InvoicesDataPaymentMethod;
824
- period?: InvoicesDataPeriod;
825
840
  pg_data?: any;
841
+ period?: InvoicesDataPeriod;
826
842
  receipt_number?: string;
827
843
  statement_descriptor?: string;
844
+ current_status?: string;
828
845
  status_trail?: InvoiceDetailsStatusTrail[];
829
- subscriber_id?: string;
830
- subscription?: string;
831
846
  subtotal?: number;
832
847
  total?: number;
833
- };
834
- /** @returns {InvoicesDataClient} */
835
- declare function InvoicesDataClient(): InvoicesDataClient;
836
- type InvoicesDataClient = {
837
- address_lines?: string[];
838
- email?: string;
839
- name?: string;
840
- phone?: string;
841
- };
842
- /** @returns {InvoicesDataPaymentMethod} */
843
- declare function InvoicesDataPaymentMethod(): InvoicesDataPaymentMethod;
844
- type InvoicesDataPaymentMethod = {
845
- pg_payment_method_id?: string;
846
- };
847
- /** @returns {InvoicesDataPeriod} */
848
- declare function InvoicesDataPeriod(): InvoicesDataPeriod;
849
- type InvoicesDataPeriod = {
850
- end?: string;
851
- start?: string;
852
- };
853
- /** @returns {Meta} */
854
- declare function Meta(): Meta;
855
- type Meta = {
856
- is_custom_plan?: boolean;
857
- is_plan_upgrade?: boolean;
858
- subscribe?: boolean;
859
- };
860
- /** @returns {OneTimeChargeEntity} */
861
- declare function OneTimeChargeEntity(): OneTimeChargeEntity;
862
- type OneTimeChargeEntity = {
863
- _id?: string;
864
- activated_on?: string;
865
- cancelled_on?: string;
866
- entity_id?: string;
867
- entity_type?: string;
868
- is_test?: boolean;
869
- meta?: any;
870
- metadata?: any;
871
- name?: string;
872
- price?: EntityChargePrice;
873
- pricing_type?: string;
874
- return_url?: string;
875
- status?: string;
876
- subscriber_id?: string;
877
- };
878
- /** @returns {OneTimeChargeItem} */
879
- declare function OneTimeChargeItem(): OneTimeChargeItem;
880
- type OneTimeChargeItem = {
881
- capped_amount?: number;
882
- is_test?: boolean;
883
- metadata?: any;
884
- name: string;
885
- price: EntityChargePrice;
886
- pricing_type: string;
887
- term?: string;
888
- };
889
- /** @returns {Phone} */
890
- declare function Phone(): Phone;
891
- type Phone = {
892
- phone_country_code?: string;
893
- phone_number?: string;
894
- };
895
- /** @returns {Plan} */
896
- declare function Plan(): Plan;
897
- type Plan = {
898
- _id?: string;
899
- addons?: string[];
900
- amount?: number;
901
- country?: string;
902
- created_at?: string;
903
- currency?: string;
904
- description?: string;
905
- is_active?: boolean;
906
- is_trial_plan?: boolean;
907
- is_visible?: boolean;
908
- modified_at?: string;
909
- name?: string;
910
- plan_group?: string;
911
- product_suite_id?: string;
912
- recurring?: PlanRecurring;
913
- tag_lines?: string[];
914
- tags?: string[];
915
- trial_period?: number;
916
- type?: string;
917
- };
918
- /** @returns {PlanRecurring} */
919
- declare function PlanRecurring(): PlanRecurring;
920
- type PlanRecurring = {
921
- interval?: string;
922
- interval_count?: number;
923
- };
924
- /** @returns {PlanStatusUpdateReq} */
925
- declare function PlanStatusUpdateReq(): PlanStatusUpdateReq;
926
- type PlanStatusUpdateReq = {
927
- plan_id?: string;
928
- reason?: string;
929
- seller_status?: string;
930
- };
931
- /** @returns {ResourceNotFound} */
932
- declare function ResourceNotFound(): ResourceNotFound;
933
- type ResourceNotFound = {
934
- /**
935
- * - Resource not found with {id}
936
- */
937
- message?: string;
938
- };
939
- /** @returns {SubscribePlanRes} */
940
- declare function SubscribePlanRes(): SubscribePlanRes;
941
- type SubscribePlanRes = {
942
- current_status?: string;
943
- meta?: Meta;
944
- redirect_url?: string;
945
- transaction_id?: string;
946
- };
947
- /** @returns {Subscription} */
948
- declare function Subscription(): Subscription;
949
- type Subscription = {
950
- _id?: string;
951
- cancel_at_period_end?: boolean;
952
- channel_type?: string;
953
- collection_method?: string;
848
+ subscription?: string;
849
+ next_action_time?: string;
954
850
  created_at?: string;
955
- current_period?: SubscriptionCurrentPeriod;
956
- current_status?: string;
957
- invoice_settings?: SubscriptionInvoiceSettings;
958
- is_active?: boolean;
959
- latest_invoice?: string;
960
851
  modified_at?: string;
961
- pause_collection?: SubscriptionPauseCollection;
962
- plan_data?: Plan;
963
- plan_id?: string;
964
- product_suite_id?: string;
965
- subscriber_id?: string;
966
- trial?: SubscriptionTrial;
967
- };
968
- /** @returns {SubscriptionActivateReq} */
969
- declare function SubscriptionActivateReq(): SubscriptionActivateReq;
970
- type SubscriptionActivateReq = {
971
- payment_method?: string;
972
- plan_id?: string;
973
- product_suite?: string;
974
- type?: string;
975
- unique_id?: string;
852
+ hash_identifier?: string;
853
+ payment_method?: InvoicesDataPaymentMethod;
854
+ invoice_items?: InvoiceItems[];
976
855
  };
977
- /** @returns {SubscriptionActivateRes} */
978
- declare function SubscriptionActivateRes(): SubscriptionActivateRes;
979
- type SubscriptionActivateRes = {
980
- data?: Subscription;
981
- success?: boolean;
856
+ /** @returns {Invoices} */
857
+ declare function Invoices(): Invoices;
858
+ type Invoices = {
859
+ data?: InvoicesData[];
860
+ start?: number;
861
+ end?: number;
862
+ limit?: number;
863
+ page?: number;
864
+ total?: number;
865
+ };
866
+ /** @returns {Phone} */
867
+ declare function Phone(): Phone;
868
+ type Phone = {
869
+ phone_number?: string;
870
+ phone_country_code?: string;
982
871
  };
983
872
  /** @returns {SubscriptionBillingAddress} */
984
873
  declare function SubscriptionBillingAddress(): SubscriptionBillingAddress;
985
874
  type SubscriptionBillingAddress = {
986
- city?: string;
987
875
  country?: string;
876
+ state?: string;
877
+ city?: string;
988
878
  line1?: string;
989
879
  line2?: string;
990
880
  postal_code?: string;
991
- state?: string;
992
- };
993
- /** @returns {SubscriptionCharge} */
994
- declare function SubscriptionCharge(): SubscriptionCharge;
995
- type SubscriptionCharge = {
996
- _id?: string;
997
- activated_on?: string;
998
- billing_date?: string;
999
- cancelled_on?: string;
1000
- capped_amount?: number;
1001
- current_period?: CurrentPeriod;
1002
- is_test?: boolean;
1003
- metadata?: any;
1004
- name?: string;
1005
- price?: EntityChargePrice;
1006
- pricing_type?: string;
1007
- recurring?: EntityChargeRecurring;
1008
- status?: string;
1009
- /**
1010
- * - Brief description for a charge
1011
- */
1012
- term?: string;
1013
- };
1014
- /** @returns {SubscriptionCurrentPeriod} */
1015
- declare function SubscriptionCurrentPeriod(): SubscriptionCurrentPeriod;
1016
- type SubscriptionCurrentPeriod = {
1017
- end?: string;
1018
- start?: string;
1019
881
  };
1020
882
  /** @returns {SubscriptionCustomer} */
1021
883
  declare function SubscriptionCustomer(): SubscriptionCustomer;
1022
884
  type SubscriptionCustomer = {
1023
- _id?: string;
885
+ phone?: Phone;
1024
886
  billing_address?: SubscriptionBillingAddress;
1025
- created_at?: string;
1026
- data?: any;
887
+ _id?: string;
888
+ unique_id?: string;
889
+ type?: string;
890
+ name?: string;
1027
891
  email?: string;
892
+ created_at?: string;
1028
893
  modified_at?: string;
1029
- name?: string;
1030
- phone?: Phone;
1031
- type?: string;
1032
- unique_id?: string;
894
+ data?: any;
1033
895
  };
1034
896
  /** @returns {SubscriptionCustomerCreate} */
1035
897
  declare function SubscriptionCustomerCreate(): SubscriptionCustomerCreate;
1036
898
  type SubscriptionCustomerCreate = {
1037
- billing_address?: SubscriptionBillingAddress;
1038
- email?: string;
1039
- name?: string;
1040
899
  phone?: Phone;
1041
- type?: string;
900
+ billing_address?: SubscriptionBillingAddress;
1042
901
  unique_id?: string;
902
+ type?: string;
903
+ name?: string;
904
+ email?: string;
905
+ };
906
+ /** @returns {SubscriptionCurrentPeriod} */
907
+ declare function SubscriptionCurrentPeriod(): SubscriptionCurrentPeriod;
908
+ type SubscriptionCurrentPeriod = {
909
+ start?: string;
910
+ end?: string;
911
+ };
912
+ /** @returns {SubscriptionPauseCollection} */
913
+ declare function SubscriptionPauseCollection(): SubscriptionPauseCollection;
914
+ type SubscriptionPauseCollection = {
915
+ behavior?: string;
916
+ resume_at?: string;
917
+ };
918
+ /** @returns {SubscriptionTrial} */
919
+ declare function SubscriptionTrial(): SubscriptionTrial;
920
+ type SubscriptionTrial = {
921
+ start?: string;
922
+ end?: string;
1043
923
  };
1044
924
  /** @returns {SubscriptionInvoiceSettings} */
1045
925
  declare function SubscriptionInvoiceSettings(): SubscriptionInvoiceSettings;
1046
926
  type SubscriptionInvoiceSettings = {
1047
- charging?: boolean;
1048
927
  generation?: boolean;
928
+ charging?: boolean;
1049
929
  };
1050
- /** @returns {SubscriptionLimit} */
1051
- declare function SubscriptionLimit(): SubscriptionLimit;
1052
- type SubscriptionLimit = {
1053
- application?: SubscriptionLimitApplication;
1054
- extensions?: SubscriptionLimitExtensions;
1055
- integrations?: SubscriptionLimitIntegrations;
1056
- is_trial_plan?: boolean;
1057
- marketplace?: SubscriptionLimitMarketplace;
1058
- other_platform?: SubscriptionLimitOtherPlatform;
1059
- products?: SubscriptionLimitProducts;
1060
- team?: SubscriptionLimitTeam;
930
+ /** @returns {Subscription} */
931
+ declare function Subscription(): Subscription;
932
+ type Subscription = {
933
+ current_period?: SubscriptionCurrentPeriod;
934
+ pause_collection?: SubscriptionPauseCollection;
935
+ trial?: SubscriptionTrial;
936
+ invoice_settings?: SubscriptionInvoiceSettings;
937
+ is_active?: boolean;
938
+ cancel_at_period_end?: boolean;
939
+ _id?: string;
940
+ subscriber_id?: string;
941
+ plan_id?: string;
942
+ product_suite_id?: string;
943
+ plan_data?: Plan;
944
+ current_status?: string;
945
+ collection_method?: string;
946
+ created_at?: string;
947
+ modified_at?: string;
948
+ latest_invoice?: string;
949
+ channel_type?: string;
950
+ };
951
+ /** @returns {SubscriptionStatus} */
952
+ declare function SubscriptionStatus(): SubscriptionStatus;
953
+ type SubscriptionStatus = {
954
+ is_enabled?: boolean;
955
+ subscription?: Subscription;
956
+ latest_invoice?: InvoicesData;
957
+ next_plan?: Plan;
958
+ current_subscriptions?: Subscription[];
959
+ mandate_amount?: string;
1061
960
  };
1062
961
  /** @returns {SubscriptionLimitApplication} */
1063
962
  declare function SubscriptionLimitApplication(): SubscriptionLimitApplication;
@@ -1066,18 +965,6 @@ type SubscriptionLimitApplication = {
1066
965
  hard_limit?: number;
1067
966
  soft_limit?: number;
1068
967
  };
1069
- /** @returns {SubscriptionLimitExtensions} */
1070
- declare function SubscriptionLimitExtensions(): SubscriptionLimitExtensions;
1071
- type SubscriptionLimitExtensions = {
1072
- enabled?: boolean;
1073
- limit?: number;
1074
- };
1075
- /** @returns {SubscriptionLimitIntegrations} */
1076
- declare function SubscriptionLimitIntegrations(): SubscriptionLimitIntegrations;
1077
- type SubscriptionLimitIntegrations = {
1078
- enabled?: boolean;
1079
- limit?: number;
1080
- };
1081
968
  /** @returns {SubscriptionLimitMarketplace} */
1082
969
  declare function SubscriptionLimitMarketplace(): SubscriptionLimitMarketplace;
1083
970
  type SubscriptionLimitMarketplace = {
@@ -1088,51 +975,98 @@ declare function SubscriptionLimitOtherPlatform(): SubscriptionLimitOtherPlatfor
1088
975
  type SubscriptionLimitOtherPlatform = {
1089
976
  enabled?: boolean;
1090
977
  };
978
+ /** @returns {SubscriptionLimitTeam} */
979
+ declare function SubscriptionLimitTeam(): SubscriptionLimitTeam;
980
+ type SubscriptionLimitTeam = {
981
+ limit?: number;
982
+ };
1091
983
  /** @returns {SubscriptionLimitProducts} */
1092
984
  declare function SubscriptionLimitProducts(): SubscriptionLimitProducts;
1093
985
  type SubscriptionLimitProducts = {
1094
986
  bulk?: boolean;
1095
987
  limit?: number;
1096
988
  };
1097
- /** @returns {SubscriptionLimitTeam} */
1098
- declare function SubscriptionLimitTeam(): SubscriptionLimitTeam;
1099
- type SubscriptionLimitTeam = {
989
+ /** @returns {SubscriptionLimitExtensions} */
990
+ declare function SubscriptionLimitExtensions(): SubscriptionLimitExtensions;
991
+ type SubscriptionLimitExtensions = {
992
+ enabled?: boolean;
1100
993
  limit?: number;
1101
994
  };
1102
- /** @returns {SubscriptionPauseCollection} */
1103
- declare function SubscriptionPauseCollection(): SubscriptionPauseCollection;
1104
- type SubscriptionPauseCollection = {
1105
- behavior?: string;
1106
- resume_at?: string;
995
+ /** @returns {SubscriptionLimitIntegrations} */
996
+ declare function SubscriptionLimitIntegrations(): SubscriptionLimitIntegrations;
997
+ type SubscriptionLimitIntegrations = {
998
+ enabled?: boolean;
999
+ limit?: number;
1107
1000
  };
1108
- /** @returns {SubscriptionStatus} */
1109
- declare function SubscriptionStatus(): SubscriptionStatus;
1110
- type SubscriptionStatus = {
1111
- current_subscriptions?: Subscription[];
1112
- is_enabled?: boolean;
1113
- latest_invoice?: InvoicesData;
1114
- mandate_amount?: string;
1115
- next_plan?: Plan;
1116
- subscription?: Subscription;
1001
+ /** @returns {SubscriptionLimit} */
1002
+ declare function SubscriptionLimit(): SubscriptionLimit;
1003
+ type SubscriptionLimit = {
1004
+ application?: SubscriptionLimitApplication;
1005
+ marketplace?: SubscriptionLimitMarketplace;
1006
+ other_platform?: SubscriptionLimitOtherPlatform;
1007
+ team?: SubscriptionLimitTeam;
1008
+ products?: SubscriptionLimitProducts;
1009
+ extensions?: SubscriptionLimitExtensions;
1010
+ integrations?: SubscriptionLimitIntegrations;
1011
+ is_trial_plan?: boolean;
1117
1012
  };
1118
- /** @returns {SubscriptionTrial} */
1119
- declare function SubscriptionTrial(): SubscriptionTrial;
1120
- type SubscriptionTrial = {
1121
- end?: string;
1122
- start?: string;
1013
+ /** @returns {SubscriptionActivateReq} */
1014
+ declare function SubscriptionActivateReq(): SubscriptionActivateReq;
1015
+ type SubscriptionActivateReq = {
1016
+ unique_id?: string;
1017
+ type?: string;
1018
+ product_suite?: string;
1019
+ plan_id?: string;
1020
+ payment_method?: string;
1123
1021
  };
1124
- /** @returns {SubscriptionTrialPeriod} */
1125
- declare function SubscriptionTrialPeriod(): SubscriptionTrialPeriod;
1126
- type SubscriptionTrialPeriod = {
1127
- end_date?: string;
1128
- start_date?: string;
1022
+ /** @returns {SubscriptionActivateRes} */
1023
+ declare function SubscriptionActivateRes(): SubscriptionActivateRes;
1024
+ type SubscriptionActivateRes = {
1025
+ success?: boolean;
1026
+ data?: Subscription;
1027
+ };
1028
+ /** @returns {CancelSubscriptionReq} */
1029
+ declare function CancelSubscriptionReq(): CancelSubscriptionReq;
1030
+ type CancelSubscriptionReq = {
1031
+ unique_id?: string;
1032
+ type?: string;
1033
+ product_suite?: string;
1034
+ subscription_id?: string;
1035
+ };
1036
+ /** @returns {CancelSubscriptionRes} */
1037
+ declare function CancelSubscriptionRes(): CancelSubscriptionRes;
1038
+ type CancelSubscriptionRes = {
1039
+ success?: boolean;
1040
+ data?: Subscription;
1041
+ };
1042
+ /** @returns {PlanStatusUpdateReq} */
1043
+ declare function PlanStatusUpdateReq(): PlanStatusUpdateReq;
1044
+ type PlanStatusUpdateReq = {
1045
+ plan_id?: string;
1046
+ reason?: string;
1047
+ seller_status?: string;
1129
1048
  };
1130
1049
  /** @returns {SunscribePlan} */
1131
1050
  declare function SunscribePlan(): SunscribePlan;
1132
1051
  type SunscribePlan = {
1133
- callback_url?: string;
1134
- collection_type?: string;
1135
1052
  entity_type?: string;
1136
- meta?: Meta;
1053
+ collection_type?: string;
1137
1054
  plan_id?: string;
1055
+ callback_url?: string;
1056
+ meta?: Meta;
1057
+ };
1058
+ /** @returns {Meta} */
1059
+ declare function Meta(): Meta;
1060
+ type Meta = {
1061
+ subscribe?: boolean;
1062
+ is_custom_plan?: boolean;
1063
+ is_plan_upgrade?: boolean;
1064
+ };
1065
+ /** @returns {SubscribePlanRes} */
1066
+ declare function SubscribePlanRes(): SubscribePlanRes;
1067
+ type SubscribePlanRes = {
1068
+ redirect_url?: string;
1069
+ transaction_id?: string;
1070
+ current_status?: string;
1071
+ meta?: Meta;
1138
1072
  };