@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -3,108 +3,35 @@ const Joi = require("joi");
|
|
|
3
3
|
/**
|
|
4
4
|
* @typedef SubscriptionChargeRes
|
|
5
5
|
* @property {string} [_id] - Unique identifier for the subscription charge
|
|
6
|
-
* @property {string} [product_suit_id] -
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* @property {string} [
|
|
10
|
-
* @property {string} [
|
|
11
|
-
*
|
|
12
|
-
* @property {
|
|
6
|
+
* @property {string} [product_suit_id] - A unique identifier for a product
|
|
7
|
+
* suite, which represents a specific collection or group of products within
|
|
8
|
+
* the system.
|
|
9
|
+
* @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
|
|
10
|
+
* @property {string} [entity_type] - Specifies the type of entity related to
|
|
11
|
+
* the operation, such as 'extension' or 'subscription'
|
|
12
|
+
* @property {string} [name] - The name of the extension plan
|
|
13
|
+
* @property {string} [status] - Current status of the extension subscription
|
|
14
|
+
* @property {number} [trial_days] - The number of days allocated for the trial period
|
|
13
15
|
* @property {string} [activated_on] - Date when the charge was activated
|
|
14
16
|
* @property {string} [cancelled_on] - Date when the charge was cancelled
|
|
15
|
-
* @property {boolean} [is_test] - Indicates
|
|
17
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
18
|
+
* a test mode.
|
|
16
19
|
* @property {string} [created_at] - Timestamp when the charge was created
|
|
17
20
|
* @property {string} [modified_at] - Timestamp when the charge was last modified
|
|
18
|
-
* @property {string} [company_id] -
|
|
21
|
+
* @property {string} [company_id] - The unique identifier of the company.
|
|
19
22
|
* @property {Object[]} [line_items] - List of line items associated with the charge
|
|
20
23
|
*/
|
|
21
24
|
|
|
22
25
|
/**
|
|
23
|
-
* @typedef
|
|
24
|
-
* @property {string} [
|
|
25
|
-
* @property {string} [entity_type] - The type of entity associated with the
|
|
26
|
-
* charge (e.g., 'extension', 'subscription').
|
|
27
|
-
* @property {string} [entity_id] - Unique identifier for the entity associated
|
|
28
|
-
* with the charge.
|
|
29
|
-
* @property {string} [name] - The name of the charge.
|
|
30
|
-
* @property {string} [term] - Description of the charge term.
|
|
31
|
-
* @property {string} [charge_type] - The type of charge (e.g., 'standalone',
|
|
32
|
-
* 'recurring').
|
|
33
|
-
* @property {string} [pricing_type] - The pricing model for the charge (e.g.,
|
|
34
|
-
* 'one_time', 'recurring').
|
|
35
|
-
* @property {EntityChargePrice} [price]
|
|
36
|
-
* @property {ChargeRecurring} [recurring]
|
|
37
|
-
* @property {string} [status] - Current status of the charge.
|
|
38
|
-
* @property {number} [capped_amount] - Maximum amount that can be charged, if applicable.
|
|
39
|
-
* @property {string} [activated_on] - Date and time when the charge was activated.
|
|
40
|
-
* @property {string} [cancelled_on] - Date and time when the charge was cancelled.
|
|
41
|
-
* @property {string} [billing_date] - Date and time when the charge was billed.
|
|
42
|
-
* @property {SubscriptionTrialPeriod} [current_period]
|
|
43
|
-
* @property {string} [modified_at] - Date and time when the charge details were
|
|
44
|
-
* last modified.
|
|
45
|
-
* @property {string} [created_at] - Date and time when the charge was created.
|
|
46
|
-
* @property {boolean} [is_test] - Indicates whether the charge is for testing purposes.
|
|
47
|
-
* @property {string} [company_id] - Company id.
|
|
48
|
-
* @property {Object} [meta] - Additional metadata associated with the charge.
|
|
49
|
-
* @property {number} [__v] - Internal version key for the charge record.
|
|
26
|
+
* @typedef BadRequestSchema
|
|
27
|
+
* @property {string} [message] - Failure message.
|
|
50
28
|
*/
|
|
51
29
|
|
|
52
30
|
/**
|
|
53
31
|
* @typedef ResourceNotFound
|
|
54
32
|
* @property {string} [message] - Resource not found with {id}
|
|
55
|
-
* @property {
|
|
56
|
-
* @property {
|
|
57
|
-
*/
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* @typedef CreateOneTimeCharge
|
|
61
|
-
* @property {string} [name] - The name of the one-time charge to be created.
|
|
62
|
-
* @property {OneTimeChargeItem} [charge]
|
|
63
|
-
* @property {boolean} [is_test] - Indicates whether the charge creation is for
|
|
64
|
-
* testing purposes.
|
|
65
|
-
* @property {string} [return_url] - URL to which the user will be redirected
|
|
66
|
-
* after creating the charge.
|
|
67
|
-
*/
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* @typedef CreateOneTimeChargeResponse
|
|
71
|
-
* @property {Charge} [charge]
|
|
72
|
-
* @property {string} [confirm_url] - URL to which users are redirected to
|
|
73
|
-
* confirm or complete the payment or subscription process.
|
|
74
|
-
*/
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
* @typedef BadRequest
|
|
78
|
-
* @property {string} [message] - Failure message.
|
|
79
|
-
*/
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* @typedef CreateSubscriptionCharge
|
|
83
|
-
* @property {string} name - The name of the charge.
|
|
84
|
-
* @property {number} [trial_days]
|
|
85
|
-
* @property {ChargeLineItem[]} line_items
|
|
86
|
-
* @property {boolean} [is_test] - Indicates whether the charge is for testing purposes.
|
|
87
|
-
* @property {string} return_url - The URL passed in request which extension
|
|
88
|
-
* expects in return.
|
|
89
|
-
*/
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* @typedef CreateSubscriptionResponse
|
|
93
|
-
* @property {EntitySubscription} [subscription]
|
|
94
|
-
* @property {string} [confirm_url] - URL to which users are redirected to
|
|
95
|
-
* confirm or complete the payment or subscription process.
|
|
96
|
-
*/
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* @typedef EntityChargePrice
|
|
100
|
-
* @property {number} [amount] - The amount for the price. The minimum value is 1.
|
|
101
|
-
* @property {string} [currency_code] - The currency code for the price
|
|
102
|
-
*/
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* @typedef ChargeRecurring
|
|
106
|
-
* @property {string} [interval]
|
|
107
|
-
* @property {number} [interval_time]
|
|
33
|
+
* @property {number} [code] - The HTTP status code associated with the error
|
|
34
|
+
* @property {boolean} [success] - Indicates if the request was successful
|
|
108
35
|
*/
|
|
109
36
|
|
|
110
37
|
/**
|
|
@@ -114,8 +41,9 @@ const Joi = require("joi");
|
|
|
114
41
|
*/
|
|
115
42
|
|
|
116
43
|
/**
|
|
117
|
-
* @typedef
|
|
118
|
-
* @property {
|
|
44
|
+
* @typedef EntityChargePrice
|
|
45
|
+
* @property {number} [amount] - The amount for the price. The minimum value is 1.
|
|
46
|
+
* @property {string} [currency_code] - The currency code for the price
|
|
119
47
|
*/
|
|
120
48
|
|
|
121
49
|
/**
|
|
@@ -125,43 +53,59 @@ const Joi = require("joi");
|
|
|
125
53
|
* @property {string} [pricing_type] - The type of pricing for the charge item.
|
|
126
54
|
* @property {EntityChargePrice} [price]
|
|
127
55
|
* @property {number} [capped_amount] - The maximum amount that can be charged
|
|
128
|
-
* for
|
|
129
|
-
* @property {boolean} [is_test] - Indicates whether the
|
|
130
|
-
*
|
|
56
|
+
* for a particular service or item
|
|
57
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
58
|
+
* a test mode.
|
|
131
59
|
* @property {Object} [metadata] - Additional metadata associated with the charge item.
|
|
132
60
|
*/
|
|
133
61
|
|
|
134
62
|
/**
|
|
135
|
-
* @typedef
|
|
136
|
-
* @property {string} name -
|
|
137
|
-
* @property {
|
|
138
|
-
* @property {
|
|
139
|
-
*
|
|
140
|
-
* @property {
|
|
141
|
-
*
|
|
142
|
-
* @property {number} [capped_amount]
|
|
143
|
-
* @property {number} [trial_days]
|
|
144
|
-
* @property {boolean} [is_test]
|
|
145
|
-
* @property {Object} [metadata]
|
|
63
|
+
* @typedef CreateOneTimeCharge
|
|
64
|
+
* @property {string} [name] - The name of the one-time charge to be created.
|
|
65
|
+
* @property {OneTimeChargeItem} [charge]
|
|
66
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
67
|
+
* a test mode.
|
|
68
|
+
* @property {string} [return_url] - URL to which the user will be redirected
|
|
69
|
+
* after creating the charge.
|
|
146
70
|
*/
|
|
147
71
|
|
|
148
72
|
/**
|
|
149
|
-
* @typedef
|
|
150
|
-
* @property {string} [
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
* @
|
|
157
|
-
* @property {
|
|
158
|
-
* @property {
|
|
159
|
-
*
|
|
160
|
-
* @property {string} [
|
|
161
|
-
* @property {string} [
|
|
162
|
-
* @property {
|
|
163
|
-
* @property {string} [
|
|
164
|
-
*
|
|
73
|
+
* @typedef ChargeRecurring
|
|
74
|
+
* @property {string} [interval] - The interval at which the recurring charge is
|
|
75
|
+
* applied. Examples include "month", "year", etc.
|
|
76
|
+
* @property {number} [interval_time]
|
|
77
|
+
*/
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* @typedef ChargeDetails
|
|
81
|
+
* @property {string} [_id] - Unique identifier for the charge.
|
|
82
|
+
* @property {string} [entity_type] - Specifies the type of entity related to
|
|
83
|
+
* the operation, such as 'extension' or 'subscription'
|
|
84
|
+
* @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
|
|
85
|
+
* @property {string} [name] - The name of the extension plan
|
|
86
|
+
* @property {string} [term] - Description of the charge term.
|
|
87
|
+
* @property {string} [charge_type] - The type of charge (e.g., 'standalone',
|
|
88
|
+
* 'recurring').
|
|
89
|
+
* @property {string} [pricing_type] - The pricing model for the charge (e.g.,
|
|
90
|
+
* 'one_time', 'recurring').
|
|
91
|
+
* @property {EntityChargePrice} [price]
|
|
92
|
+
* @property {ChargeRecurring} [recurring]
|
|
93
|
+
* @property {string} [status] - Current status of the charge.
|
|
94
|
+
* @property {number} [capped_amount] - The maximum amount that can be charged
|
|
95
|
+
* for a particular service or item
|
|
96
|
+
* @property {string} [activated_on] - Date and time when the charge was activated.
|
|
97
|
+
* @property {string} [cancelled_on] - Date and time when the charge was cancelled.
|
|
98
|
+
* @property {string} [billing_date] - The date when the billing occurred. This
|
|
99
|
+
* field is optional and may be null if the billing date is not specified.
|
|
100
|
+
* @property {SubscriptionTrialPeriod} [current_period]
|
|
101
|
+
* @property {string} [modified_at] - Date and time when the charge details were
|
|
102
|
+
* last modified.
|
|
103
|
+
* @property {string} [created_at] - Date and time when the charge was created.
|
|
104
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
105
|
+
* a test mode.
|
|
106
|
+
* @property {string} [company_id] - The unique identifier of the company.
|
|
107
|
+
* @property {Object} [meta] - Additional metadata associated with the charge.
|
|
108
|
+
* @property {number} [__v] - Internal version key for the charge record.
|
|
165
109
|
*/
|
|
166
110
|
|
|
167
111
|
/**
|
|
@@ -169,53 +113,93 @@ const Joi = require("joi");
|
|
|
169
113
|
* @property {string} [term] - Description of the charge term or usage.
|
|
170
114
|
* @property {string} [charge_type] - Type of the charge (e.g., 'subscription',
|
|
171
115
|
* 'extension').
|
|
172
|
-
* @property {number} [capped_amount] -
|
|
173
|
-
*
|
|
174
|
-
* @property {string} [billing_date] -
|
|
175
|
-
* not
|
|
116
|
+
* @property {number} [capped_amount] - The maximum amount that can be charged
|
|
117
|
+
* for a particular service or item
|
|
118
|
+
* @property {string} [billing_date] - The date when the billing occurred. This
|
|
119
|
+
* field is optional and may be null if the billing date is not specified.
|
|
176
120
|
* @property {string} [created_at] - Date and time when the charge entity was created.
|
|
177
121
|
* @property {string} [modified_at] - Date and time when the charge entity was
|
|
178
122
|
* last modified.
|
|
179
123
|
* @property {number} [__v] - Internal version key for the charge record.
|
|
180
124
|
* @property {string} [_id] - Unique identifier for the charge entity.
|
|
181
125
|
* @property {string} [name] - The name of the one-time charge.
|
|
182
|
-
* @property {string} [status] - Current status of the charge (e.g., 'pending'
|
|
183
|
-
* 'completed').
|
|
126
|
+
* @property {string} [status] - Current status of the charge (e.g., 'pending').
|
|
184
127
|
* @property {string} [activated_on] - Date and time when the charge was
|
|
185
128
|
* activated. Null if not yet activated.
|
|
186
129
|
* @property {string} [cancelled_on] - Date and time when the charge was
|
|
187
130
|
* cancelled. Null if not cancelled.
|
|
188
131
|
* @property {Object} [metadata] - Additional metadata associated with the charge.
|
|
189
132
|
* @property {string} [return_url] - URL to redirect to after processing the charge.
|
|
190
|
-
* @property {boolean} [is_test] - Indicates whether the
|
|
133
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
134
|
+
* a test mode.
|
|
191
135
|
* @property {string} [pricing_type] - Pricing model for the charge (e.g., 'one_time').
|
|
192
|
-
* @property {string} [subscriber_id] -
|
|
193
|
-
*
|
|
194
|
-
* @property {string} [entity_type] -
|
|
195
|
-
*
|
|
196
|
-
* @property {string} [entity_id] - Unique identifier for the entity
|
|
197
|
-
* with the charge.
|
|
136
|
+
* @property {string} [subscriber_id] - The unique identifier for the company in
|
|
137
|
+
* the system.
|
|
138
|
+
* @property {string} [entity_type] - Specifies the type of entity related to
|
|
139
|
+
* the operation, such as 'extension' or 'subscription'
|
|
140
|
+
* @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
|
|
198
141
|
* @property {Object} [meta] - Additional metadata associated with the charge.
|
|
199
142
|
* @property {EntityChargePrice} [price]
|
|
200
143
|
*/
|
|
201
144
|
|
|
145
|
+
/**
|
|
146
|
+
* @typedef CreateOneTimeChargeResponseSchemas
|
|
147
|
+
* @property {Charge} [charge]
|
|
148
|
+
* @property {string} [confirm_url] - URL to which users are redirected to
|
|
149
|
+
* confirm or complete the payment or subscription process.
|
|
150
|
+
*/
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* @typedef Charge
|
|
154
|
+
* @property {OneTimeChargeEntity} [final_charge]
|
|
155
|
+
*/
|
|
156
|
+
|
|
202
157
|
/**
|
|
203
158
|
* @typedef EntityChargeRecurring
|
|
204
|
-
* @property {string} interval - The interval
|
|
159
|
+
* @property {string} interval - The interval at which the recurring charge is
|
|
160
|
+
* applied. Examples include "month", "year", etc.
|
|
161
|
+
*/
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* @typedef ChargeLineItem
|
|
165
|
+
* @property {string} name - Its name of the extension plan.
|
|
166
|
+
* @property {string} term - It indicates how it will be charged.
|
|
167
|
+
* @property {string} pricing_type - Specifies the type of pricing for the
|
|
168
|
+
* extension subscription. It indicates whether the subscription will be
|
|
169
|
+
* automatically renewed, charged once, or based on usage.
|
|
170
|
+
* @property {EntityChargePrice} price
|
|
171
|
+
* @property {EntityChargeRecurring} [recurring]
|
|
172
|
+
* @property {number} [capped_amount] - The maximum amount that can be charged
|
|
173
|
+
* for a particular service or item
|
|
174
|
+
* @property {number} [trial_days] - The number of days allocated for the trial period
|
|
175
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
176
|
+
* a test mode.
|
|
177
|
+
* @property {Object} [metadata]
|
|
178
|
+
*/
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* @typedef CreateSubscriptionCharge
|
|
182
|
+
* @property {string} name - The name of the extension plan
|
|
183
|
+
* @property {number} [trial_days] - The number of days allocated for the trial period
|
|
184
|
+
* @property {ChargeLineItem[]} line_items
|
|
185
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
186
|
+
* a test mode.
|
|
187
|
+
* @property {string} return_url - The URL to which the user will be redirected
|
|
188
|
+
* after the subscription process is complete.
|
|
205
189
|
*/
|
|
206
190
|
|
|
207
191
|
/**
|
|
208
192
|
* @typedef EntityChargeDetails
|
|
209
|
-
* @property {string} [_id] -
|
|
210
|
-
* @property {string} [subscription_id] -
|
|
211
|
-
* @property {string} [subscriber_id] -
|
|
212
|
-
*
|
|
213
|
-
* @property {string} [entity_type] -
|
|
214
|
-
*
|
|
215
|
-
* @property {string} [entity_id] - Unique identifier for the entity
|
|
216
|
-
*
|
|
217
|
-
* @property {string} [
|
|
218
|
-
*
|
|
193
|
+
* @property {string} [_id] - The unique identifier for the charge.
|
|
194
|
+
* @property {string} [subscription_id] - The unique identifier of the subscription.
|
|
195
|
+
* @property {string} [subscriber_id] - The unique identifier for the company in
|
|
196
|
+
* the system.
|
|
197
|
+
* @property {string} [entity_type] - Specifies the type of entity related to
|
|
198
|
+
* the operation, such as 'extension' or 'subscription'
|
|
199
|
+
* @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
|
|
200
|
+
* @property {string} [name] - The name of the extension plan
|
|
201
|
+
* @property {string} [term] - Detailed description of the terms and conditions
|
|
202
|
+
* associated with the charge.
|
|
219
203
|
* @property {string} [charge_type] - The type of charge (e.g., 'standalone',
|
|
220
204
|
* 'recurring').
|
|
221
205
|
* @property {string} [pricing_type] - The pricing model for the charge (e.g.,
|
|
@@ -223,20 +207,53 @@ const Joi = require("joi");
|
|
|
223
207
|
* @property {EntityChargePrice} [price]
|
|
224
208
|
* @property {ChargeRecurring} [recurring]
|
|
225
209
|
* @property {string} [status] - Current status of the charge.
|
|
226
|
-
* @property {number} [capped_amount] -
|
|
210
|
+
* @property {number} [capped_amount] - The maximum amount that can be charged
|
|
211
|
+
* for a particular service or item
|
|
227
212
|
* @property {string} [activated_on] - Date and time when the charge was activated.
|
|
228
213
|
* @property {string} [cancelled_on] - Date and time when the charge was cancelled.
|
|
229
|
-
* @property {string} [billing_date] -
|
|
214
|
+
* @property {string} [billing_date] - The date when the billing occurred. This
|
|
215
|
+
* field is optional and may be null if the billing date is not specified.
|
|
230
216
|
* @property {SubscriptionTrialPeriod} [current_period]
|
|
231
217
|
* @property {string} [modified_at] - Date and time when the charge details were
|
|
232
218
|
* last modified.
|
|
233
219
|
* @property {string} [created_at] - Date and time when the charge was created.
|
|
234
|
-
* @property {boolean} [is_test] - Indicates whether the
|
|
235
|
-
*
|
|
220
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
221
|
+
* a test mode.
|
|
222
|
+
* @property {string} [company_id] - The unique identifier of the company.
|
|
236
223
|
* @property {Object} [meta] - Additional metadata associated with the charge.
|
|
237
224
|
* @property {number} [__v] - Internal version key for the charge record.
|
|
238
225
|
*/
|
|
239
226
|
|
|
227
|
+
/**
|
|
228
|
+
* @typedef EntitySubscription
|
|
229
|
+
* @property {string} [_id] - Unique identifier for the subscription charge
|
|
230
|
+
* @property {string} [product_suit_id] - A unique identifier for a product
|
|
231
|
+
* suite, which represents a specific collection or group of products within
|
|
232
|
+
* the system.
|
|
233
|
+
* @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
|
|
234
|
+
* @property {string} [entity_type] - Specifies the type of entity related to
|
|
235
|
+
* the operation, such as 'extension' or 'subscription'
|
|
236
|
+
* @property {string} [name] - The name of the extension plan
|
|
237
|
+
* @property {string} [status] - Current status of the subscription charge
|
|
238
|
+
* @property {number} [trial_days] - The number of days allocated for the trial period
|
|
239
|
+
* @property {boolean} [is_test] - Indicates whether the operation or data is in
|
|
240
|
+
* a test mode.
|
|
241
|
+
* @property {string} [created_at] - Timestamp when the charge was created
|
|
242
|
+
* @property {string} [modified_at] - Timestamp when the charge was last modified
|
|
243
|
+
* @property {string} [subscriber_id] - The unique identifier for the company in
|
|
244
|
+
* the system.
|
|
245
|
+
* @property {EntityChargeDetails[]} [line_items]
|
|
246
|
+
* @property {string} [return_url] - The URL passed in request which extension
|
|
247
|
+
* expects in return.
|
|
248
|
+
*/
|
|
249
|
+
|
|
250
|
+
/**
|
|
251
|
+
* @typedef CreateSubscription
|
|
252
|
+
* @property {EntitySubscription} [subscription]
|
|
253
|
+
* @property {string} [confirm_url] - URL to which users are redirected to post
|
|
254
|
+
* initiation of extension installation.
|
|
255
|
+
*/
|
|
256
|
+
|
|
240
257
|
class BillingPlatformModel {
|
|
241
258
|
/** @returns {SubscriptionChargeRes} */
|
|
242
259
|
static SubscriptionChargeRes() {
|
|
@@ -258,30 +275,10 @@ class BillingPlatformModel {
|
|
|
258
275
|
});
|
|
259
276
|
}
|
|
260
277
|
|
|
261
|
-
/** @returns {
|
|
262
|
-
static
|
|
278
|
+
/** @returns {BadRequestSchema} */
|
|
279
|
+
static BadRequestSchema() {
|
|
263
280
|
return Joi.object({
|
|
264
|
-
|
|
265
|
-
entity_type: Joi.string().allow(""),
|
|
266
|
-
entity_id: Joi.string().allow(""),
|
|
267
|
-
name: Joi.string().allow(""),
|
|
268
|
-
term: Joi.string().allow(""),
|
|
269
|
-
charge_type: Joi.string().allow(""),
|
|
270
|
-
pricing_type: Joi.string().allow(""),
|
|
271
|
-
price: BillingPlatformModel.EntityChargePrice(),
|
|
272
|
-
recurring: BillingPlatformModel.ChargeRecurring(),
|
|
273
|
-
status: Joi.string().allow(""),
|
|
274
|
-
capped_amount: Joi.number(),
|
|
275
|
-
activated_on: Joi.string().allow(""),
|
|
276
|
-
cancelled_on: Joi.string().allow(""),
|
|
277
|
-
billing_date: Joi.string().allow(""),
|
|
278
|
-
current_period: BillingPlatformModel.SubscriptionTrialPeriod(),
|
|
279
|
-
modified_at: Joi.string().allow(""),
|
|
280
|
-
created_at: Joi.string().allow(""),
|
|
281
|
-
is_test: Joi.boolean(),
|
|
282
|
-
company_id: Joi.string().allow(""),
|
|
283
|
-
meta: Joi.any(),
|
|
284
|
-
__v: Joi.number(),
|
|
281
|
+
message: Joi.string().allow(""),
|
|
285
282
|
});
|
|
286
283
|
}
|
|
287
284
|
|
|
@@ -289,70 +286,8 @@ class BillingPlatformModel {
|
|
|
289
286
|
static ResourceNotFound() {
|
|
290
287
|
return Joi.object({
|
|
291
288
|
message: Joi.string().allow(""),
|
|
292
|
-
code: Joi.
|
|
293
|
-
success: Joi.
|
|
294
|
-
});
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
/** @returns {CreateOneTimeCharge} */
|
|
298
|
-
static CreateOneTimeCharge() {
|
|
299
|
-
return Joi.object({
|
|
300
|
-
name: Joi.string().allow(""),
|
|
301
|
-
charge: BillingPlatformModel.OneTimeChargeItem(),
|
|
302
|
-
is_test: Joi.boolean(),
|
|
303
|
-
return_url: Joi.string().allow(""),
|
|
304
|
-
});
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
/** @returns {CreateOneTimeChargeResponse} */
|
|
308
|
-
static CreateOneTimeChargeResponse() {
|
|
309
|
-
return Joi.object({
|
|
310
|
-
charge: BillingPlatformModel.Charge(),
|
|
311
|
-
confirm_url: Joi.string().allow(""),
|
|
312
|
-
});
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
/** @returns {BadRequest} */
|
|
316
|
-
static BadRequest() {
|
|
317
|
-
return Joi.object({
|
|
318
|
-
message: Joi.string().allow(""),
|
|
319
|
-
});
|
|
320
|
-
}
|
|
321
|
-
|
|
322
|
-
/** @returns {CreateSubscriptionCharge} */
|
|
323
|
-
static CreateSubscriptionCharge() {
|
|
324
|
-
return Joi.object({
|
|
325
|
-
name: Joi.string().allow("").required(),
|
|
326
|
-
trial_days: Joi.number(),
|
|
327
|
-
line_items: Joi.array()
|
|
328
|
-
.items(BillingPlatformModel.ChargeLineItem())
|
|
329
|
-
.required(),
|
|
330
|
-
is_test: Joi.boolean(),
|
|
331
|
-
return_url: Joi.string().allow("").required(),
|
|
332
|
-
});
|
|
333
|
-
}
|
|
334
|
-
|
|
335
|
-
/** @returns {CreateSubscriptionResponse} */
|
|
336
|
-
static CreateSubscriptionResponse() {
|
|
337
|
-
return Joi.object({
|
|
338
|
-
subscription: BillingPlatformModel.EntitySubscription(),
|
|
339
|
-
confirm_url: Joi.string().allow(""),
|
|
340
|
-
});
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
/** @returns {EntityChargePrice} */
|
|
344
|
-
static EntityChargePrice() {
|
|
345
|
-
return Joi.object({
|
|
346
|
-
amount: Joi.number(),
|
|
347
|
-
currency_code: Joi.string().allow(""),
|
|
348
|
-
});
|
|
349
|
-
}
|
|
350
|
-
|
|
351
|
-
/** @returns {ChargeRecurring} */
|
|
352
|
-
static ChargeRecurring() {
|
|
353
|
-
return Joi.object({
|
|
354
|
-
interval: Joi.string().allow(""),
|
|
355
|
-
interval_time: Joi.number(),
|
|
289
|
+
code: Joi.number(),
|
|
290
|
+
success: Joi.boolean(),
|
|
356
291
|
});
|
|
357
292
|
}
|
|
358
293
|
|
|
@@ -364,10 +299,11 @@ class BillingPlatformModel {
|
|
|
364
299
|
});
|
|
365
300
|
}
|
|
366
301
|
|
|
367
|
-
/** @returns {
|
|
368
|
-
static
|
|
302
|
+
/** @returns {EntityChargePrice} */
|
|
303
|
+
static EntityChargePrice() {
|
|
369
304
|
return Joi.object({
|
|
370
|
-
|
|
305
|
+
amount: Joi.number(),
|
|
306
|
+
currency_code: Joi.string().allow(""),
|
|
371
307
|
});
|
|
372
308
|
}
|
|
373
309
|
|
|
@@ -380,41 +316,52 @@ class BillingPlatformModel {
|
|
|
380
316
|
price: BillingPlatformModel.EntityChargePrice(),
|
|
381
317
|
capped_amount: Joi.number(),
|
|
382
318
|
is_test: Joi.boolean(),
|
|
383
|
-
metadata: Joi.any(),
|
|
319
|
+
metadata: Joi.object().pattern(/\S/, Joi.any()),
|
|
384
320
|
});
|
|
385
321
|
}
|
|
386
322
|
|
|
387
|
-
/** @returns {
|
|
388
|
-
static
|
|
323
|
+
/** @returns {CreateOneTimeCharge} */
|
|
324
|
+
static CreateOneTimeCharge() {
|
|
389
325
|
return Joi.object({
|
|
390
|
-
name: Joi.string().allow("")
|
|
391
|
-
|
|
392
|
-
pricing_type: Joi.string().allow("").required(),
|
|
393
|
-
price: BillingPlatformModel.EntityChargePrice().required(),
|
|
394
|
-
recurring: BillingPlatformModel.EntityChargeRecurring(),
|
|
395
|
-
capped_amount: Joi.number(),
|
|
396
|
-
trial_days: Joi.number(),
|
|
326
|
+
name: Joi.string().allow(""),
|
|
327
|
+
charge: BillingPlatformModel.OneTimeChargeItem(),
|
|
397
328
|
is_test: Joi.boolean(),
|
|
398
|
-
|
|
329
|
+
return_url: Joi.string().allow(""),
|
|
399
330
|
});
|
|
400
331
|
}
|
|
401
332
|
|
|
402
|
-
/** @returns {
|
|
403
|
-
static
|
|
333
|
+
/** @returns {ChargeRecurring} */
|
|
334
|
+
static ChargeRecurring() {
|
|
335
|
+
return Joi.object({
|
|
336
|
+
interval: Joi.string().allow(""),
|
|
337
|
+
interval_time: Joi.number(),
|
|
338
|
+
});
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/** @returns {ChargeDetails} */
|
|
342
|
+
static ChargeDetails() {
|
|
404
343
|
return Joi.object({
|
|
405
344
|
_id: Joi.string().allow(""),
|
|
406
|
-
product_suit_id: Joi.string().allow(""),
|
|
407
|
-
entity_id: Joi.string().allow(""),
|
|
408
345
|
entity_type: Joi.string().allow(""),
|
|
346
|
+
entity_id: Joi.string().allow(""),
|
|
409
347
|
name: Joi.string().allow(""),
|
|
348
|
+
term: Joi.string().allow(""),
|
|
349
|
+
charge_type: Joi.string().allow(""),
|
|
350
|
+
pricing_type: Joi.string().allow(""),
|
|
351
|
+
price: BillingPlatformModel.EntityChargePrice(),
|
|
352
|
+
recurring: BillingPlatformModel.ChargeRecurring(),
|
|
410
353
|
status: Joi.string().allow(""),
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
354
|
+
capped_amount: Joi.number(),
|
|
355
|
+
activated_on: Joi.string().allow(""),
|
|
356
|
+
cancelled_on: Joi.string().allow(""),
|
|
357
|
+
billing_date: Joi.string().allow(""),
|
|
358
|
+
current_period: BillingPlatformModel.SubscriptionTrialPeriod(),
|
|
414
359
|
modified_at: Joi.string().allow(""),
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
360
|
+
created_at: Joi.string().allow(""),
|
|
361
|
+
is_test: Joi.boolean(),
|
|
362
|
+
company_id: Joi.string().allow(""),
|
|
363
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
364
|
+
__v: Joi.number(),
|
|
418
365
|
});
|
|
419
366
|
}
|
|
420
367
|
|
|
@@ -433,18 +380,33 @@ class BillingPlatformModel {
|
|
|
433
380
|
status: Joi.string().allow(""),
|
|
434
381
|
activated_on: Joi.string().allow("").allow(null),
|
|
435
382
|
cancelled_on: Joi.string().allow("").allow(null),
|
|
436
|
-
metadata: Joi.any(),
|
|
383
|
+
metadata: Joi.object().pattern(/\S/, Joi.any()),
|
|
437
384
|
return_url: Joi.string().allow(""),
|
|
438
385
|
is_test: Joi.boolean(),
|
|
439
386
|
pricing_type: Joi.string().allow(""),
|
|
440
387
|
subscriber_id: Joi.string().allow(""),
|
|
441
388
|
entity_type: Joi.string().allow(""),
|
|
442
389
|
entity_id: Joi.string().allow(""),
|
|
443
|
-
meta: Joi.any(),
|
|
390
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
444
391
|
price: BillingPlatformModel.EntityChargePrice(),
|
|
445
392
|
});
|
|
446
393
|
}
|
|
447
394
|
|
|
395
|
+
/** @returns {CreateOneTimeChargeResponseSchemas} */
|
|
396
|
+
static CreateOneTimeChargeResponseSchemas() {
|
|
397
|
+
return Joi.object({
|
|
398
|
+
charge: BillingPlatformModel.Charge(),
|
|
399
|
+
confirm_url: Joi.string().allow(""),
|
|
400
|
+
});
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
/** @returns {Charge} */
|
|
404
|
+
static Charge() {
|
|
405
|
+
return Joi.object({
|
|
406
|
+
final_charge: BillingPlatformModel.OneTimeChargeEntity(),
|
|
407
|
+
});
|
|
408
|
+
}
|
|
409
|
+
|
|
448
410
|
/** @returns {EntityChargeRecurring} */
|
|
449
411
|
static EntityChargeRecurring() {
|
|
450
412
|
return Joi.object({
|
|
@@ -452,6 +414,34 @@ class BillingPlatformModel {
|
|
|
452
414
|
});
|
|
453
415
|
}
|
|
454
416
|
|
|
417
|
+
/** @returns {ChargeLineItem} */
|
|
418
|
+
static ChargeLineItem() {
|
|
419
|
+
return Joi.object({
|
|
420
|
+
name: Joi.string().allow("").required(),
|
|
421
|
+
term: Joi.string().allow("").required(),
|
|
422
|
+
pricing_type: Joi.string().allow("").required(),
|
|
423
|
+
price: BillingPlatformModel.EntityChargePrice().required(),
|
|
424
|
+
recurring: BillingPlatformModel.EntityChargeRecurring(),
|
|
425
|
+
capped_amount: Joi.number(),
|
|
426
|
+
trial_days: Joi.number(),
|
|
427
|
+
is_test: Joi.boolean(),
|
|
428
|
+
metadata: Joi.object().pattern(/\S/, Joi.any()),
|
|
429
|
+
});
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
/** @returns {CreateSubscriptionCharge} */
|
|
433
|
+
static CreateSubscriptionCharge() {
|
|
434
|
+
return Joi.object({
|
|
435
|
+
name: Joi.string().allow("").required(),
|
|
436
|
+
trial_days: Joi.number(),
|
|
437
|
+
line_items: Joi.array()
|
|
438
|
+
.items(BillingPlatformModel.ChargeLineItem())
|
|
439
|
+
.required(),
|
|
440
|
+
is_test: Joi.boolean(),
|
|
441
|
+
return_url: Joi.string().allow("").required(),
|
|
442
|
+
});
|
|
443
|
+
}
|
|
444
|
+
|
|
455
445
|
/** @returns {EntityChargeDetails} */
|
|
456
446
|
static EntityChargeDetails() {
|
|
457
447
|
return Joi.object({
|
|
@@ -476,9 +466,36 @@ class BillingPlatformModel {
|
|
|
476
466
|
created_at: Joi.string().allow(""),
|
|
477
467
|
is_test: Joi.boolean(),
|
|
478
468
|
company_id: Joi.string().allow(""),
|
|
479
|
-
meta: Joi.any(),
|
|
469
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
480
470
|
__v: Joi.number(),
|
|
481
471
|
});
|
|
482
472
|
}
|
|
473
|
+
|
|
474
|
+
/** @returns {EntitySubscription} */
|
|
475
|
+
static EntitySubscription() {
|
|
476
|
+
return Joi.object({
|
|
477
|
+
_id: Joi.string().allow(""),
|
|
478
|
+
product_suit_id: Joi.string().allow(""),
|
|
479
|
+
entity_id: Joi.string().allow(""),
|
|
480
|
+
entity_type: Joi.string().allow(""),
|
|
481
|
+
name: Joi.string().allow(""),
|
|
482
|
+
status: Joi.string().allow(""),
|
|
483
|
+
trial_days: Joi.number(),
|
|
484
|
+
is_test: Joi.boolean(),
|
|
485
|
+
created_at: Joi.string().allow(""),
|
|
486
|
+
modified_at: Joi.string().allow(""),
|
|
487
|
+
subscriber_id: Joi.string().allow(""),
|
|
488
|
+
line_items: Joi.array().items(BillingPlatformModel.EntityChargeDetails()),
|
|
489
|
+
return_url: Joi.string().allow(""),
|
|
490
|
+
});
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
/** @returns {CreateSubscription} */
|
|
494
|
+
static CreateSubscription() {
|
|
495
|
+
return Joi.object({
|
|
496
|
+
subscription: BillingPlatformModel.EntitySubscription(),
|
|
497
|
+
confirm_url: Joi.string().allow(""),
|
|
498
|
+
});
|
|
499
|
+
}
|
|
483
500
|
}
|
|
484
501
|
module.exports = BillingPlatformModel;
|