@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef ApplicationResponse
|
|
5
5
|
* @property {Application} [application]
|
|
6
6
|
*/
|
|
7
7
|
|
|
@@ -62,15 +62,14 @@ const Joi = require("joi");
|
|
|
62
62
|
* @property {ApplicationCors} [cors]
|
|
63
63
|
* @property {ApplicationAuth} [auth]
|
|
64
64
|
* @property {string} [description] - It contains detailed information about the
|
|
65
|
-
* sales channel
|
|
65
|
+
* sales channel.
|
|
66
66
|
* @property {string} [channel_type] - It indicates different channel types like
|
|
67
|
-
* store, website-and-mobile-apps. Default value is store
|
|
67
|
+
* store, website-and-mobile-apps. Default value is store
|
|
68
68
|
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
69
69
|
* of seconds until the key expires
|
|
70
70
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
71
71
|
* internal or not
|
|
72
|
-
* @property {boolean} [is_active] - Indicates
|
|
73
|
-
* or not active
|
|
72
|
+
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
74
73
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
75
74
|
* of the sales channel
|
|
76
75
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
@@ -78,32 +77,31 @@ const Joi = require("joi");
|
|
|
78
77
|
* of owner who owns the application
|
|
79
78
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
80
79
|
* where the sales channel exists
|
|
81
|
-
* @property {string} [token] -
|
|
80
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
82
81
|
* channel. It is required and auto-generated.
|
|
83
82
|
* @property {ApplicationRedirections[]} [redirections]
|
|
84
83
|
* @property {ApplicationMeta[]} [meta]
|
|
85
84
|
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
86
|
-
* @property {string} [
|
|
85
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
|
|
87
86
|
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
88
87
|
* @property {SecureUrl} [banner]
|
|
89
88
|
* @property {SecureUrl} [logo]
|
|
90
89
|
* @property {SecureUrl} [favicon]
|
|
91
90
|
* @property {Domain[]} [domains]
|
|
92
|
-
* @property {string} [app_type] - It shows
|
|
93
|
-
* development mode
|
|
91
|
+
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
94
92
|
* @property {SecureUrl} [mobile_logo]
|
|
95
93
|
* @property {Domain} [domain]
|
|
96
94
|
* @property {string} [slug]
|
|
95
|
+
* @property {string} [mode]
|
|
96
|
+
* @property {string} [status]
|
|
97
|
+
* @property {TokenSchema[]} [tokens]
|
|
97
98
|
*/
|
|
98
99
|
|
|
99
100
|
/**
|
|
100
|
-
* @typedef
|
|
101
|
-
* @property {string} [
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* @typedef BadRequestSchema
|
|
106
|
-
* @property {string} [message] - Failure message (in a string format)
|
|
101
|
+
* @typedef TokenSchema
|
|
102
|
+
* @property {string} [token]
|
|
103
|
+
* @property {Object} [created_by]
|
|
104
|
+
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
107
105
|
*/
|
|
108
106
|
|
|
109
107
|
/**
|
|
@@ -145,9 +143,46 @@ const Joi = require("joi");
|
|
|
145
143
|
* @property {LocationCountry[]} [items]
|
|
146
144
|
*/
|
|
147
145
|
|
|
146
|
+
/**
|
|
147
|
+
* @typedef VersionApplication
|
|
148
|
+
* @property {string} [name]
|
|
149
|
+
* @property {string} [version]
|
|
150
|
+
*/
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* @typedef VersionDeviceOS
|
|
154
|
+
* @property {string} [name]
|
|
155
|
+
*/
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* @typedef VersionDevice
|
|
159
|
+
* @property {VersionDeviceOS} [os]
|
|
160
|
+
*/
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* @typedef VersionRequest
|
|
164
|
+
* @property {VersionApplication} application
|
|
165
|
+
* @property {VersionDevice} device
|
|
166
|
+
*/
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* @typedef VersionUpdateDialogue
|
|
170
|
+
* @property {string} [type]
|
|
171
|
+
* @property {number} [interval]
|
|
172
|
+
*/
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* @typedef VersionResponse
|
|
176
|
+
* @property {string} type
|
|
177
|
+
* @property {string} title
|
|
178
|
+
* @property {string} description
|
|
179
|
+
* @property {VersionUpdateDialogue} update_dialog
|
|
180
|
+
* @property {boolean} is_app_blocked
|
|
181
|
+
*/
|
|
182
|
+
|
|
148
183
|
class ConfigurationPublicModel {
|
|
149
|
-
/** @returns {
|
|
150
|
-
static
|
|
184
|
+
/** @returns {ApplicationResponse} */
|
|
185
|
+
static ApplicationResponse() {
|
|
151
186
|
return Joi.object({
|
|
152
187
|
application: ConfigurationPublicModel.Application(),
|
|
153
188
|
});
|
|
@@ -232,7 +267,7 @@ class ConfigurationPublicModel {
|
|
|
232
267
|
),
|
|
233
268
|
meta: Joi.array().items(ConfigurationPublicModel.ApplicationMeta()),
|
|
234
269
|
created_at: Joi.string().allow(""),
|
|
235
|
-
|
|
270
|
+
modified_at: Joi.string().allow(""),
|
|
236
271
|
__v: Joi.number(),
|
|
237
272
|
banner: ConfigurationPublicModel.SecureUrl(),
|
|
238
273
|
logo: ConfigurationPublicModel.SecureUrl(),
|
|
@@ -242,20 +277,18 @@ class ConfigurationPublicModel {
|
|
|
242
277
|
mobile_logo: ConfigurationPublicModel.SecureUrl(),
|
|
243
278
|
domain: ConfigurationPublicModel.Domain(),
|
|
244
279
|
slug: Joi.string().allow(""),
|
|
280
|
+
mode: Joi.string().allow(""),
|
|
281
|
+
status: Joi.string().allow(""),
|
|
282
|
+
tokens: Joi.array().items(ConfigurationPublicModel.TokenSchema()),
|
|
245
283
|
});
|
|
246
284
|
}
|
|
247
285
|
|
|
248
|
-
/** @returns {
|
|
249
|
-
static
|
|
286
|
+
/** @returns {TokenSchema} */
|
|
287
|
+
static TokenSchema() {
|
|
250
288
|
return Joi.object({
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
/** @returns {BadRequestSchema} */
|
|
256
|
-
static BadRequestSchema() {
|
|
257
|
-
return Joi.object({
|
|
258
|
-
message: Joi.string().allow(""),
|
|
289
|
+
token: Joi.string().allow(""),
|
|
290
|
+
created_by: Joi.object().pattern(/\S/, Joi.any()),
|
|
291
|
+
created_at: Joi.string().allow(""),
|
|
259
292
|
});
|
|
260
293
|
}
|
|
261
294
|
|
|
@@ -305,5 +338,54 @@ class ConfigurationPublicModel {
|
|
|
305
338
|
items: Joi.array().items(ConfigurationPublicModel.LocationCountry()),
|
|
306
339
|
});
|
|
307
340
|
}
|
|
341
|
+
|
|
342
|
+
/** @returns {VersionApplication} */
|
|
343
|
+
static VersionApplication() {
|
|
344
|
+
return Joi.object({
|
|
345
|
+
name: Joi.string().allow(""),
|
|
346
|
+
version: Joi.string().allow(""),
|
|
347
|
+
});
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
/** @returns {VersionDeviceOS} */
|
|
351
|
+
static VersionDeviceOS() {
|
|
352
|
+
return Joi.object({
|
|
353
|
+
name: Joi.string().allow(""),
|
|
354
|
+
});
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
/** @returns {VersionDevice} */
|
|
358
|
+
static VersionDevice() {
|
|
359
|
+
return Joi.object({
|
|
360
|
+
os: ConfigurationPublicModel.VersionDeviceOS(),
|
|
361
|
+
});
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
/** @returns {VersionRequest} */
|
|
365
|
+
static VersionRequest() {
|
|
366
|
+
return Joi.object({
|
|
367
|
+
application: ConfigurationPublicModel.VersionApplication().required(),
|
|
368
|
+
device: ConfigurationPublicModel.VersionDevice().required(),
|
|
369
|
+
});
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
/** @returns {VersionUpdateDialogue} */
|
|
373
|
+
static VersionUpdateDialogue() {
|
|
374
|
+
return Joi.object({
|
|
375
|
+
type: Joi.string().allow(""),
|
|
376
|
+
interval: Joi.number(),
|
|
377
|
+
});
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
/** @returns {VersionResponse} */
|
|
381
|
+
static VersionResponse() {
|
|
382
|
+
return Joi.object({
|
|
383
|
+
type: Joi.string().allow("").required(),
|
|
384
|
+
title: Joi.string().allow("").required(),
|
|
385
|
+
description: Joi.string().allow("").required(),
|
|
386
|
+
update_dialog: ConfigurationPublicModel.VersionUpdateDialogue().required(),
|
|
387
|
+
is_app_blocked: Joi.boolean().required(),
|
|
388
|
+
});
|
|
389
|
+
}
|
|
308
390
|
}
|
|
309
391
|
module.exports = ConfigurationPublicModel;
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
export = ConfigurationPublicValidator;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef CheckVersionIsUpToDateParam
|
|
4
|
+
* @property {ConfigurationPublicModel.VersionRequest} body
|
|
5
|
+
*/
|
|
2
6
|
/**
|
|
3
7
|
* @typedef GetLocationsParam
|
|
4
8
|
* @property {string} [locationType] - Provide location type to query on.
|
|
@@ -13,14 +17,19 @@ export = ConfigurationPublicValidator;
|
|
|
13
17
|
* @property {string} [query] - Provide application name
|
|
14
18
|
*/
|
|
15
19
|
declare class ConfigurationPublicValidator {
|
|
20
|
+
/** @returns {CheckVersionIsUpToDateParam} */
|
|
21
|
+
static checkVersionIsUpToDate(): CheckVersionIsUpToDateParam;
|
|
16
22
|
/** @returns {GetLocationsParam} */
|
|
17
23
|
static getLocations(): GetLocationsParam;
|
|
18
24
|
/** @returns {SearchApplicationParam} */
|
|
19
25
|
static searchApplication(): SearchApplicationParam;
|
|
20
26
|
}
|
|
21
27
|
declare namespace ConfigurationPublicValidator {
|
|
22
|
-
export { GetLocationsParam, SearchApplicationParam };
|
|
28
|
+
export { CheckVersionIsUpToDateParam, GetLocationsParam, SearchApplicationParam };
|
|
23
29
|
}
|
|
30
|
+
type CheckVersionIsUpToDateParam = {
|
|
31
|
+
body: ConfigurationPublicModel.VersionRequest;
|
|
32
|
+
};
|
|
24
33
|
type GetLocationsParam = {
|
|
25
34
|
/**
|
|
26
35
|
* - Provide location type to query on.
|
|
@@ -41,3 +50,4 @@ type SearchApplicationParam = {
|
|
|
41
50
|
*/
|
|
42
51
|
query?: string;
|
|
43
52
|
};
|
|
53
|
+
import ConfigurationPublicModel = require("./ConfigurationPublicModel");
|
|
@@ -2,6 +2,11 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
const ConfigurationPublicModel = require("./ConfigurationPublicModel");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* @typedef CheckVersionIsUpToDateParam
|
|
7
|
+
* @property {ConfigurationPublicModel.VersionRequest} body
|
|
8
|
+
*/
|
|
9
|
+
|
|
5
10
|
/**
|
|
6
11
|
* @typedef GetLocationsParam
|
|
7
12
|
* @property {string} [locationType] - Provide location type to query on.
|
|
@@ -18,6 +23,13 @@ const ConfigurationPublicModel = require("./ConfigurationPublicModel");
|
|
|
18
23
|
*/
|
|
19
24
|
|
|
20
25
|
class ConfigurationPublicValidator {
|
|
26
|
+
/** @returns {CheckVersionIsUpToDateParam} */
|
|
27
|
+
static checkVersionIsUpToDate() {
|
|
28
|
+
return Joi.object({
|
|
29
|
+
body: ConfigurationPublicModel.VersionRequest().required(),
|
|
30
|
+
}).required();
|
|
31
|
+
}
|
|
32
|
+
|
|
21
33
|
/** @returns {GetLocationsParam} */
|
|
22
34
|
static getLocations() {
|
|
23
35
|
return Joi.object({
|
|
@@ -14,6 +14,8 @@ declare class Content {
|
|
|
14
14
|
getMenuContentByType: string;
|
|
15
15
|
getNavbar: string;
|
|
16
16
|
getPricingBanner: string;
|
|
17
|
+
getSDKDocumentation: string;
|
|
18
|
+
getSDKDocumentationByType: string;
|
|
17
19
|
};
|
|
18
20
|
_urls: {};
|
|
19
21
|
updateUrls(urls: any): void;
|
|
@@ -127,6 +129,26 @@ declare class Content {
|
|
|
127
129
|
* @description: Retrieve pricing banner information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getPricingBanner/).
|
|
128
130
|
*/
|
|
129
131
|
getPricingBanner({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.PricingBannerSchema>;
|
|
132
|
+
/**
|
|
133
|
+
* @param {ContentPublicValidator.GetSDKDocumentationParam} arg - Arg object.
|
|
134
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
136
|
+
* @returns {Promise<ContentPublicModel.SDKLinksResponseSchema>} - Success response
|
|
137
|
+
* @name getSDKDocumentation
|
|
138
|
+
* @summary: Get documentation link of Software Development Kit
|
|
139
|
+
* @description: Get documentation of SDK - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getSDKDocumentation/).
|
|
140
|
+
*/
|
|
141
|
+
getSDKDocumentation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.SDKLinksResponseSchema>;
|
|
142
|
+
/**
|
|
143
|
+
* @param {ContentPublicValidator.GetSDKDocumentationByTypeParam} arg - Arg object.
|
|
144
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
145
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
146
|
+
* @returns {Promise<ContentPublicModel.SDKbyTypeResponseSchema>} - Success response
|
|
147
|
+
* @name getSDKDocumentationByType
|
|
148
|
+
* @summary: Get documentation of Software Development Kit by its type
|
|
149
|
+
* @description: Get documentation of SDK by its type - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getSDKDocumentationByType/).
|
|
150
|
+
*/
|
|
151
|
+
getSDKDocumentationByType({ type, requestHeaders }?: ContentPublicValidator.GetSDKDocumentationByTypeParam, { responseHeaders }?: object): Promise<ContentPublicModel.SDKbyTypeResponseSchema>;
|
|
130
152
|
}
|
|
131
153
|
import ContentPublicModel = require("./ContentPublicModel");
|
|
132
154
|
import ContentPublicValidator = require("./ContentPublicValidator");
|
|
@@ -28,6 +28,8 @@ class Content {
|
|
|
28
28
|
getMenuContentByType: "/service/public/content/menu/{type}",
|
|
29
29
|
getNavbar: "/service/public/content/navbar",
|
|
30
30
|
getPricingBanner: "/service/public/content/pricing-banner",
|
|
31
|
+
getSDKDocumentation: "/service/public/content/sdk-readme",
|
|
32
|
+
getSDKDocumentationByType: "/service/public/content/sdk-readme/{type}",
|
|
31
33
|
};
|
|
32
34
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
33
35
|
(urls, [method, relativeUrl]) => {
|
|
@@ -1013,6 +1015,187 @@ class Content {
|
|
|
1013
1015
|
|
|
1014
1016
|
return response;
|
|
1015
1017
|
}
|
|
1018
|
+
|
|
1019
|
+
/**
|
|
1020
|
+
* @param {ContentPublicValidator.GetSDKDocumentationParam} arg - Arg object.
|
|
1021
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1022
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
1023
|
+
* @returns {Promise<ContentPublicModel.SDKLinksResponseSchema>} - Success response
|
|
1024
|
+
* @name getSDKDocumentation
|
|
1025
|
+
* @summary: Get documentation link of Software Development Kit
|
|
1026
|
+
* @description: Get documentation of SDK - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getSDKDocumentation/).
|
|
1027
|
+
*/
|
|
1028
|
+
async getSDKDocumentation(
|
|
1029
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
1030
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1031
|
+
) {
|
|
1032
|
+
let invalidInput = [];
|
|
1033
|
+
if (invalidInput.length) {
|
|
1034
|
+
const error = new Error();
|
|
1035
|
+
error.message = "Missing required field";
|
|
1036
|
+
error.details = invalidInput;
|
|
1037
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1038
|
+
}
|
|
1039
|
+
|
|
1040
|
+
const { error } = ContentPublicValidator.getSDKDocumentation().validate(
|
|
1041
|
+
{},
|
|
1042
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1043
|
+
);
|
|
1044
|
+
if (error) {
|
|
1045
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1049
|
+
const {
|
|
1050
|
+
error: warrning,
|
|
1051
|
+
} = ContentPublicValidator.getSDKDocumentation().validate(
|
|
1052
|
+
{},
|
|
1053
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1054
|
+
);
|
|
1055
|
+
if (warrning) {
|
|
1056
|
+
Logger({
|
|
1057
|
+
level: "WARN",
|
|
1058
|
+
message: `Parameter Validation warrnings for public > Content > getSDKDocumentation \n ${warrning}`,
|
|
1059
|
+
});
|
|
1060
|
+
}
|
|
1061
|
+
|
|
1062
|
+
const query_params = {};
|
|
1063
|
+
|
|
1064
|
+
const xHeaders = {};
|
|
1065
|
+
|
|
1066
|
+
const response = await PublicAPIClient.execute(
|
|
1067
|
+
this._conf,
|
|
1068
|
+
"get",
|
|
1069
|
+
constructUrl({
|
|
1070
|
+
url: this._urls["getSDKDocumentation"],
|
|
1071
|
+
params: {},
|
|
1072
|
+
}),
|
|
1073
|
+
query_params,
|
|
1074
|
+
undefined,
|
|
1075
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1076
|
+
{ responseHeaders }
|
|
1077
|
+
);
|
|
1078
|
+
|
|
1079
|
+
let responseData = response;
|
|
1080
|
+
if (responseHeaders) {
|
|
1081
|
+
responseData = response[0];
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
const {
|
|
1085
|
+
error: res_error,
|
|
1086
|
+
} = ContentPublicModel.SDKLinksResponseSchema().validate(responseData, {
|
|
1087
|
+
abortEarly: false,
|
|
1088
|
+
allowUnknown: true,
|
|
1089
|
+
});
|
|
1090
|
+
|
|
1091
|
+
if (res_error) {
|
|
1092
|
+
if (this._conf.options.strictResponseCheck === true) {
|
|
1093
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1094
|
+
} else {
|
|
1095
|
+
Logger({
|
|
1096
|
+
level: "WARN",
|
|
1097
|
+
message: `Response Validation Warnings for public > Content > getSDKDocumentation \n ${res_error}`,
|
|
1098
|
+
});
|
|
1099
|
+
}
|
|
1100
|
+
}
|
|
1101
|
+
|
|
1102
|
+
return response;
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
/**
|
|
1106
|
+
* @param {ContentPublicValidator.GetSDKDocumentationByTypeParam} arg - Arg object.
|
|
1107
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1108
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
1109
|
+
* @returns {Promise<ContentPublicModel.SDKbyTypeResponseSchema>} - Success response
|
|
1110
|
+
* @name getSDKDocumentationByType
|
|
1111
|
+
* @summary: Get documentation of Software Development Kit by its type
|
|
1112
|
+
* @description: Get documentation of SDK by its type - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getSDKDocumentationByType/).
|
|
1113
|
+
*/
|
|
1114
|
+
async getSDKDocumentationByType(
|
|
1115
|
+
{ type, requestHeaders } = { requestHeaders: {} },
|
|
1116
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1117
|
+
) {
|
|
1118
|
+
let invalidInput = [];
|
|
1119
|
+
|
|
1120
|
+
if (!type) {
|
|
1121
|
+
invalidInput.push({
|
|
1122
|
+
message: `The 'type' field is required.`,
|
|
1123
|
+
path: ["type"],
|
|
1124
|
+
});
|
|
1125
|
+
}
|
|
1126
|
+
if (invalidInput.length) {
|
|
1127
|
+
const error = new Error();
|
|
1128
|
+
error.message = "Missing required field";
|
|
1129
|
+
error.details = invalidInput;
|
|
1130
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1131
|
+
}
|
|
1132
|
+
|
|
1133
|
+
const {
|
|
1134
|
+
error,
|
|
1135
|
+
} = ContentPublicValidator.getSDKDocumentationByType().validate(
|
|
1136
|
+
{ type },
|
|
1137
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1138
|
+
);
|
|
1139
|
+
if (error) {
|
|
1140
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1144
|
+
const {
|
|
1145
|
+
error: warrning,
|
|
1146
|
+
} = ContentPublicValidator.getSDKDocumentationByType().validate(
|
|
1147
|
+
{ type },
|
|
1148
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1149
|
+
);
|
|
1150
|
+
if (warrning) {
|
|
1151
|
+
Logger({
|
|
1152
|
+
level: "WARN",
|
|
1153
|
+
message: `Parameter Validation warrnings for public > Content > getSDKDocumentationByType \n ${warrning}`,
|
|
1154
|
+
});
|
|
1155
|
+
}
|
|
1156
|
+
|
|
1157
|
+
const query_params = {};
|
|
1158
|
+
|
|
1159
|
+
const xHeaders = {};
|
|
1160
|
+
|
|
1161
|
+
const response = await PublicAPIClient.execute(
|
|
1162
|
+
this._conf,
|
|
1163
|
+
"get",
|
|
1164
|
+
constructUrl({
|
|
1165
|
+
url: this._urls["getSDKDocumentationByType"],
|
|
1166
|
+
params: { type },
|
|
1167
|
+
}),
|
|
1168
|
+
query_params,
|
|
1169
|
+
undefined,
|
|
1170
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1171
|
+
{ responseHeaders }
|
|
1172
|
+
);
|
|
1173
|
+
|
|
1174
|
+
let responseData = response;
|
|
1175
|
+
if (responseHeaders) {
|
|
1176
|
+
responseData = response[0];
|
|
1177
|
+
}
|
|
1178
|
+
|
|
1179
|
+
const {
|
|
1180
|
+
error: res_error,
|
|
1181
|
+
} = ContentPublicModel.SDKbyTypeResponseSchema().validate(responseData, {
|
|
1182
|
+
abortEarly: false,
|
|
1183
|
+
allowUnknown: true,
|
|
1184
|
+
});
|
|
1185
|
+
|
|
1186
|
+
if (res_error) {
|
|
1187
|
+
if (this._conf.options.strictResponseCheck === true) {
|
|
1188
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1189
|
+
} else {
|
|
1190
|
+
Logger({
|
|
1191
|
+
level: "WARN",
|
|
1192
|
+
message: `Response Validation Warnings for public > Content > getSDKDocumentationByType \n ${res_error}`,
|
|
1193
|
+
});
|
|
1194
|
+
}
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
return response;
|
|
1198
|
+
}
|
|
1016
1199
|
}
|
|
1017
1200
|
|
|
1018
1201
|
module.exports = Content;
|
|
@@ -267,6 +267,23 @@ export = ContentPublicModel;
|
|
|
267
267
|
* @typedef CredentialsSchema
|
|
268
268
|
* @property {CredentialSchema[]} [items]
|
|
269
269
|
*/
|
|
270
|
+
/**
|
|
271
|
+
* @typedef SDKLinksResponseSchema
|
|
272
|
+
* @property {SDKLinkObjectSchema[]} [readmes]
|
|
273
|
+
*/
|
|
274
|
+
/**
|
|
275
|
+
* @typedef SDKLinkObjectSchema
|
|
276
|
+
* @property {string} [owner]
|
|
277
|
+
* @property {string} [repo]
|
|
278
|
+
* @property {string} [path]
|
|
279
|
+
* @property {string} [image]
|
|
280
|
+
* @property {string} [name]
|
|
281
|
+
* @property {string} [type]
|
|
282
|
+
*/
|
|
283
|
+
/**
|
|
284
|
+
* @typedef SDKbyTypeResponseSchema
|
|
285
|
+
* @property {string} [readme_content]
|
|
286
|
+
*/
|
|
270
287
|
/**
|
|
271
288
|
* @typedef ContentAPIError
|
|
272
289
|
* @property {string} [message]
|
|
@@ -281,7 +298,7 @@ export = ContentPublicModel;
|
|
|
281
298
|
declare class ContentPublicModel {
|
|
282
299
|
}
|
|
283
300
|
declare namespace ContentPublicModel {
|
|
284
|
-
export { BasicDetailsPayloadSchema, WhatsNew, Features, BusinessAccount, SellerSupport, MenuSchema, MenusSchema, MenuTypeSchema, CompanyLevelMenuItemSchema, ApplicationLevelMenuItemSchema, VisibleOnSchema, SalesChannelSchema, OtherSellerSchema, FooterContentSchema, AnalyticsTagsSchema, CustomPageBySlugSchema, ItemSchema, CreateCustomPageSeoSchema, RawHtmlContentSchema, FooterSchema, HomePageContentSchema, NavItemSchema, NavbarSchema, MediaSchema, CreatedBySchema, PricingBannerSchema, SdkReadmeSchema, TagsSchema, CustomItemSchema, PageSchema, UserSchema, CredentialSchema, ConfigurationSchema, CredentialsSchema, ContentAPIError };
|
|
301
|
+
export { BasicDetailsPayloadSchema, WhatsNew, Features, BusinessAccount, SellerSupport, MenuSchema, MenusSchema, MenuTypeSchema, CompanyLevelMenuItemSchema, ApplicationLevelMenuItemSchema, VisibleOnSchema, SalesChannelSchema, OtherSellerSchema, FooterContentSchema, AnalyticsTagsSchema, CustomPageBySlugSchema, ItemSchema, CreateCustomPageSeoSchema, RawHtmlContentSchema, FooterSchema, HomePageContentSchema, NavItemSchema, NavbarSchema, MediaSchema, CreatedBySchema, PricingBannerSchema, SdkReadmeSchema, TagsSchema, CustomItemSchema, PageSchema, UserSchema, CredentialSchema, ConfigurationSchema, CredentialsSchema, SDKLinksResponseSchema, SDKLinkObjectSchema, SDKbyTypeResponseSchema, ContentAPIError };
|
|
285
302
|
}
|
|
286
303
|
/** @returns {BasicDetailsPayloadSchema} */
|
|
287
304
|
declare function BasicDetailsPayloadSchema(): BasicDetailsPayloadSchema;
|
|
@@ -585,6 +602,26 @@ declare function CredentialsSchema(): CredentialsSchema;
|
|
|
585
602
|
type CredentialsSchema = {
|
|
586
603
|
items?: CredentialSchema[];
|
|
587
604
|
};
|
|
605
|
+
/** @returns {SDKLinksResponseSchema} */
|
|
606
|
+
declare function SDKLinksResponseSchema(): SDKLinksResponseSchema;
|
|
607
|
+
type SDKLinksResponseSchema = {
|
|
608
|
+
readmes?: SDKLinkObjectSchema[];
|
|
609
|
+
};
|
|
610
|
+
/** @returns {SDKLinkObjectSchema} */
|
|
611
|
+
declare function SDKLinkObjectSchema(): SDKLinkObjectSchema;
|
|
612
|
+
type SDKLinkObjectSchema = {
|
|
613
|
+
owner?: string;
|
|
614
|
+
repo?: string;
|
|
615
|
+
path?: string;
|
|
616
|
+
image?: string;
|
|
617
|
+
name?: string;
|
|
618
|
+
type?: string;
|
|
619
|
+
};
|
|
620
|
+
/** @returns {SDKbyTypeResponseSchema} */
|
|
621
|
+
declare function SDKbyTypeResponseSchema(): SDKbyTypeResponseSchema;
|
|
622
|
+
type SDKbyTypeResponseSchema = {
|
|
623
|
+
readme_content?: string;
|
|
624
|
+
};
|
|
588
625
|
/** @returns {ContentAPIError} */
|
|
589
626
|
declare function ContentAPIError(): ContentAPIError;
|
|
590
627
|
type ContentAPIError = {
|
|
@@ -302,6 +302,26 @@ const Joi = require("joi");
|
|
|
302
302
|
* @property {CredentialSchema[]} [items]
|
|
303
303
|
*/
|
|
304
304
|
|
|
305
|
+
/**
|
|
306
|
+
* @typedef SDKLinksResponseSchema
|
|
307
|
+
* @property {SDKLinkObjectSchema[]} [readmes]
|
|
308
|
+
*/
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* @typedef SDKLinkObjectSchema
|
|
312
|
+
* @property {string} [owner]
|
|
313
|
+
* @property {string} [repo]
|
|
314
|
+
* @property {string} [path]
|
|
315
|
+
* @property {string} [image]
|
|
316
|
+
* @property {string} [name]
|
|
317
|
+
* @property {string} [type]
|
|
318
|
+
*/
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* @typedef SDKbyTypeResponseSchema
|
|
322
|
+
* @property {string} [readme_content]
|
|
323
|
+
*/
|
|
324
|
+
|
|
305
325
|
/**
|
|
306
326
|
* @typedef ContentAPIError
|
|
307
327
|
* @property {string} [message]
|
|
@@ -689,6 +709,32 @@ class ContentPublicModel {
|
|
|
689
709
|
});
|
|
690
710
|
}
|
|
691
711
|
|
|
712
|
+
/** @returns {SDKLinksResponseSchema} */
|
|
713
|
+
static SDKLinksResponseSchema() {
|
|
714
|
+
return Joi.object({
|
|
715
|
+
readmes: Joi.array().items(ContentPublicModel.SDKLinkObjectSchema()),
|
|
716
|
+
});
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
/** @returns {SDKLinkObjectSchema} */
|
|
720
|
+
static SDKLinkObjectSchema() {
|
|
721
|
+
return Joi.object({
|
|
722
|
+
owner: Joi.string().allow(""),
|
|
723
|
+
repo: Joi.string().allow(""),
|
|
724
|
+
path: Joi.string().allow(""),
|
|
725
|
+
image: Joi.string().allow(""),
|
|
726
|
+
name: Joi.string().allow(""),
|
|
727
|
+
type: Joi.string().allow(""),
|
|
728
|
+
});
|
|
729
|
+
}
|
|
730
|
+
|
|
731
|
+
/** @returns {SDKbyTypeResponseSchema} */
|
|
732
|
+
static SDKbyTypeResponseSchema() {
|
|
733
|
+
return Joi.object({
|
|
734
|
+
readme_content: Joi.string().allow(""),
|
|
735
|
+
});
|
|
736
|
+
}
|
|
737
|
+
|
|
692
738
|
/** @returns {ContentAPIError} */
|
|
693
739
|
static ContentAPIError() {
|
|
694
740
|
return Joi.object({
|
|
@@ -699,7 +745,7 @@ class ContentPublicModel {
|
|
|
699
745
|
info: Joi.string().allow(""),
|
|
700
746
|
request_id: Joi.string().allow(""),
|
|
701
747
|
stack_trace: Joi.string().allow(""),
|
|
702
|
-
meta: Joi.
|
|
748
|
+
meta: Joi.any(),
|
|
703
749
|
});
|
|
704
750
|
}
|
|
705
751
|
}
|
|
@@ -23,6 +23,11 @@ export = ContentPublicValidator;
|
|
|
23
23
|
*/
|
|
24
24
|
/** @typedef GetNavbarParam */
|
|
25
25
|
/** @typedef GetPricingBannerParam */
|
|
26
|
+
/** @typedef GetSDKDocumentationParam */
|
|
27
|
+
/**
|
|
28
|
+
* @typedef GetSDKDocumentationByTypeParam
|
|
29
|
+
* @property {string} type - Type of SDK
|
|
30
|
+
*/
|
|
26
31
|
declare class ContentPublicValidator {
|
|
27
32
|
/** @returns {GetAllTagsParam} */
|
|
28
33
|
static getAllTags(): any;
|
|
@@ -46,9 +51,13 @@ declare class ContentPublicValidator {
|
|
|
46
51
|
static getNavbar(): any;
|
|
47
52
|
/** @returns {GetPricingBannerParam} */
|
|
48
53
|
static getPricingBanner(): any;
|
|
54
|
+
/** @returns {GetSDKDocumentationParam} */
|
|
55
|
+
static getSDKDocumentation(): any;
|
|
56
|
+
/** @returns {GetSDKDocumentationByTypeParam} */
|
|
57
|
+
static getSDKDocumentationByType(): GetSDKDocumentationByTypeParam;
|
|
49
58
|
}
|
|
50
59
|
declare namespace ContentPublicValidator {
|
|
51
|
-
export { GetAllTagsParam, GetAnalyticsTagsParam, GetBasicDetailsParam, GetCredentialsByEntityParam, GetCustomPageParam, GetFooterContentParam, GetHomePageContentParam, GetMenuContentParam, GetMenuContentByTypeParam, GetNavbarParam, GetPricingBannerParam };
|
|
60
|
+
export { GetAllTagsParam, GetAnalyticsTagsParam, GetBasicDetailsParam, GetCredentialsByEntityParam, GetCustomPageParam, GetFooterContentParam, GetHomePageContentParam, GetMenuContentParam, GetMenuContentByTypeParam, GetNavbarParam, GetPricingBannerParam, GetSDKDocumentationParam, GetSDKDocumentationByTypeParam };
|
|
52
61
|
}
|
|
53
62
|
type GetCredentialsByEntityParam = {
|
|
54
63
|
/**
|
|
@@ -75,6 +84,12 @@ type GetMenuContentByTypeParam = {
|
|
|
75
84
|
*/
|
|
76
85
|
type: string;
|
|
77
86
|
};
|
|
87
|
+
type GetSDKDocumentationByTypeParam = {
|
|
88
|
+
/**
|
|
89
|
+
* - Type of SDK
|
|
90
|
+
*/
|
|
91
|
+
type: string;
|
|
92
|
+
};
|
|
78
93
|
type GetAllTagsParam = any;
|
|
79
94
|
type GetAnalyticsTagsParam = any;
|
|
80
95
|
type GetBasicDetailsParam = any;
|
|
@@ -82,3 +97,4 @@ type GetFooterContentParam = any;
|
|
|
82
97
|
type GetMenuContentParam = any;
|
|
83
98
|
type GetNavbarParam = any;
|
|
84
99
|
type GetPricingBannerParam = any;
|
|
100
|
+
type GetSDKDocumentationParam = any;
|