@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.4
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 +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +54 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -89
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- 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 +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- 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 +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- 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 +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- 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 +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
export = ServiceabilityPlatformValidator;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef BulkServiceabilityParam
|
|
4
|
-
* @property {string} extensionId - Unique Identifier of
|
|
5
|
-
* @property {string} schemeId - Unique identifier of
|
|
6
|
-
* @property {ServiceabilityPlatformModel.
|
|
4
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
5
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
6
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
9
|
* @typedef BulkTatParam
|
|
10
|
-
* @property {string} extensionId - Unique Identifier of
|
|
11
|
-
* @property {string} schemeId - Unique identifier of
|
|
12
|
-
* @property {ServiceabilityPlatformModel.
|
|
10
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
11
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
12
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
|
|
13
13
|
*/
|
|
14
14
|
/**
|
|
15
15
|
* @typedef CreateCourierPartnerAccountParam
|
|
16
|
-
* @property {ServiceabilityPlatformModel.
|
|
16
|
+
* @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
|
|
17
17
|
*/
|
|
18
18
|
/**
|
|
19
19
|
* @typedef CreatePackageMaterialParam
|
|
@@ -30,8 +30,8 @@ export = ServiceabilityPlatformValidator;
|
|
|
30
30
|
/** @typedef GetAllStoresParam */
|
|
31
31
|
/**
|
|
32
32
|
* @typedef GetBulkServiceabilityParam
|
|
33
|
-
* @property {string} extensionId - Unique Identifier of
|
|
34
|
-
* @property {string} schemeId - Unique identifier of
|
|
33
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
34
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
35
35
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
36
36
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
37
37
|
* @property {string} [batchId] - Unique identifier of bulk job
|
|
@@ -44,8 +44,8 @@ export = ServiceabilityPlatformValidator;
|
|
|
44
44
|
*/
|
|
45
45
|
/**
|
|
46
46
|
* @typedef GetBulkTatParam
|
|
47
|
-
* @property {string} extensionId - Unique Identifier of
|
|
48
|
-
* @property {string} schemeId - Unique identifier of
|
|
47
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
48
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
49
49
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
50
50
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
51
51
|
* @property {string} [batchId] - Unique identifier of bulk job
|
|
@@ -59,7 +59,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
59
59
|
/** @typedef GetCompanyConfigurationParam */
|
|
60
60
|
/**
|
|
61
61
|
* @typedef GetCourierPartnerAccountParam
|
|
62
|
-
* @property {string} accountId - Unique ID of courier
|
|
62
|
+
* @property {string} accountId - Unique ID of courier account
|
|
63
63
|
*/
|
|
64
64
|
/**
|
|
65
65
|
* @typedef GetCourierPartnerAccountsParam
|
|
@@ -71,7 +71,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
71
71
|
*/
|
|
72
72
|
/**
|
|
73
73
|
* @typedef GetOptimalLocationsParam
|
|
74
|
-
* @property {ServiceabilityPlatformModel.
|
|
74
|
+
* @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
|
|
75
75
|
*/
|
|
76
76
|
/**
|
|
77
77
|
* @typedef GetPackageMaterialListParam
|
|
@@ -94,12 +94,13 @@ export = ServiceabilityPlatformValidator;
|
|
|
94
94
|
*/
|
|
95
95
|
/**
|
|
96
96
|
* @typedef GetPackageMaterialsParam
|
|
97
|
-
* @property {string} packageMaterialId -
|
|
97
|
+
* @property {string} packageMaterialId - A `package_material_id` is a unique
|
|
98
|
+
* identifier for a Package Material
|
|
98
99
|
*/
|
|
99
100
|
/**
|
|
100
101
|
* @typedef GetServiceabilityParam
|
|
101
|
-
* @property {string} extensionId - Unique Identifier of
|
|
102
|
-
* @property {string} schemeId - Unique identifier of
|
|
102
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
103
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
103
104
|
* @property {string} regionId - Unique identifier of a region
|
|
104
105
|
*/
|
|
105
106
|
/**
|
|
@@ -125,8 +126,8 @@ export = ServiceabilityPlatformValidator;
|
|
|
125
126
|
*/
|
|
126
127
|
/**
|
|
127
128
|
* @typedef UpdateCourierPartnerAccountParam
|
|
128
|
-
* @property {string} accountId - Unique ID of courier
|
|
129
|
-
* @property {ServiceabilityPlatformModel.
|
|
129
|
+
* @property {string} accountId - Unique ID of courier account
|
|
130
|
+
* @property {ServiceabilityPlatformModel.CourierAccount} body
|
|
130
131
|
*/
|
|
131
132
|
/**
|
|
132
133
|
* @typedef UpdatePackageMaterialRuleParam
|
|
@@ -136,13 +137,14 @@ export = ServiceabilityPlatformValidator;
|
|
|
136
137
|
*/
|
|
137
138
|
/**
|
|
138
139
|
* @typedef UpdatePackageMaterialsParam
|
|
139
|
-
* @property {string} packageMaterialId -
|
|
140
|
+
* @property {string} packageMaterialId - A `package_material_id` is a unique
|
|
141
|
+
* identifier for a Package Material
|
|
140
142
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
141
143
|
*/
|
|
142
144
|
/**
|
|
143
145
|
* @typedef UpdateServiceabilityParam
|
|
144
|
-
* @property {string} extensionId - Unique Identifier of
|
|
145
|
-
* @property {string} schemeId - Unique identifier of
|
|
146
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
147
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
146
148
|
* @property {string} regionId - Unique identifier of a region
|
|
147
149
|
* @property {ServiceabilityPlatformModel.ServiceabilityModel} body
|
|
148
150
|
*/
|
|
@@ -210,28 +212,28 @@ declare namespace ServiceabilityPlatformValidator {
|
|
|
210
212
|
}
|
|
211
213
|
type BulkServiceabilityParam = {
|
|
212
214
|
/**
|
|
213
|
-
* - Unique Identifier of
|
|
215
|
+
* - Unique Identifier of CP Extension
|
|
214
216
|
*/
|
|
215
217
|
extensionId: string;
|
|
216
218
|
/**
|
|
217
|
-
* - Unique identifier of
|
|
219
|
+
* - Unique identifier of a scheme
|
|
218
220
|
*/
|
|
219
221
|
schemeId: string;
|
|
220
|
-
body: ServiceabilityPlatformModel.
|
|
222
|
+
body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
|
|
221
223
|
};
|
|
222
224
|
type BulkTatParam = {
|
|
223
225
|
/**
|
|
224
|
-
* - Unique Identifier of
|
|
226
|
+
* - Unique Identifier of CP Extension
|
|
225
227
|
*/
|
|
226
228
|
extensionId: string;
|
|
227
229
|
/**
|
|
228
|
-
* - Unique identifier of
|
|
230
|
+
* - Unique identifier of a scheme
|
|
229
231
|
*/
|
|
230
232
|
schemeId: string;
|
|
231
|
-
body: ServiceabilityPlatformModel.
|
|
233
|
+
body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
|
|
232
234
|
};
|
|
233
235
|
type CreateCourierPartnerAccountParam = {
|
|
234
|
-
body: ServiceabilityPlatformModel.
|
|
236
|
+
body: ServiceabilityPlatformModel.CourierAccountRequestBody;
|
|
235
237
|
};
|
|
236
238
|
type CreatePackageMaterialParam = {
|
|
237
239
|
body: ServiceabilityPlatformModel.PackageMaterial;
|
|
@@ -244,11 +246,11 @@ type CreateZoneParam = {
|
|
|
244
246
|
};
|
|
245
247
|
type GetBulkServiceabilityParam = {
|
|
246
248
|
/**
|
|
247
|
-
* - Unique Identifier of
|
|
249
|
+
* - Unique Identifier of CP Extension
|
|
248
250
|
*/
|
|
249
251
|
extensionId: string;
|
|
250
252
|
/**
|
|
251
|
-
* - Unique identifier of
|
|
253
|
+
* - Unique identifier of a scheme
|
|
252
254
|
*/
|
|
253
255
|
schemeId: string;
|
|
254
256
|
/**
|
|
@@ -290,11 +292,11 @@ type GetBulkServiceabilityParam = {
|
|
|
290
292
|
};
|
|
291
293
|
type GetBulkTatParam = {
|
|
292
294
|
/**
|
|
293
|
-
* - Unique Identifier of
|
|
295
|
+
* - Unique Identifier of CP Extension
|
|
294
296
|
*/
|
|
295
297
|
extensionId: string;
|
|
296
298
|
/**
|
|
297
|
-
* - Unique identifier of
|
|
299
|
+
* - Unique identifier of a scheme
|
|
298
300
|
*/
|
|
299
301
|
schemeId: string;
|
|
300
302
|
/**
|
|
@@ -336,7 +338,7 @@ type GetBulkTatParam = {
|
|
|
336
338
|
};
|
|
337
339
|
type GetCourierPartnerAccountParam = {
|
|
338
340
|
/**
|
|
339
|
-
* - Unique ID of courier
|
|
341
|
+
* - Unique ID of courier account
|
|
340
342
|
*/
|
|
341
343
|
accountId: string;
|
|
342
344
|
};
|
|
@@ -363,7 +365,7 @@ type GetCourierPartnerAccountsParam = {
|
|
|
363
365
|
transportType?: string;
|
|
364
366
|
};
|
|
365
367
|
type GetOptimalLocationsParam = {
|
|
366
|
-
body: ServiceabilityPlatformModel.
|
|
368
|
+
body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
|
|
367
369
|
};
|
|
368
370
|
type GetPackageMaterialListParam = {
|
|
369
371
|
/**
|
|
@@ -410,17 +412,18 @@ type GetPackageMaterialRulesParam = {
|
|
|
410
412
|
};
|
|
411
413
|
type GetPackageMaterialsParam = {
|
|
412
414
|
/**
|
|
413
|
-
* -
|
|
415
|
+
* - A `package_material_id` is a unique
|
|
416
|
+
* identifier for a Package Material
|
|
414
417
|
*/
|
|
415
418
|
packageMaterialId: string;
|
|
416
419
|
};
|
|
417
420
|
type GetServiceabilityParam = {
|
|
418
421
|
/**
|
|
419
|
-
* - Unique Identifier of
|
|
422
|
+
* - Unique Identifier of CP Extension
|
|
420
423
|
*/
|
|
421
424
|
extensionId: string;
|
|
422
425
|
/**
|
|
423
|
-
* - Unique identifier of
|
|
426
|
+
* - Unique identifier of a scheme
|
|
424
427
|
*/
|
|
425
428
|
schemeId: string;
|
|
426
429
|
/**
|
|
@@ -481,10 +484,10 @@ type UpdateCompanyConfigurationParam = {
|
|
|
481
484
|
};
|
|
482
485
|
type UpdateCourierPartnerAccountParam = {
|
|
483
486
|
/**
|
|
484
|
-
* - Unique ID of courier
|
|
487
|
+
* - Unique ID of courier account
|
|
485
488
|
*/
|
|
486
489
|
accountId: string;
|
|
487
|
-
body: ServiceabilityPlatformModel.
|
|
490
|
+
body: ServiceabilityPlatformModel.CourierAccount;
|
|
488
491
|
};
|
|
489
492
|
type UpdatePackageMaterialRuleParam = {
|
|
490
493
|
/**
|
|
@@ -496,18 +499,19 @@ type UpdatePackageMaterialRuleParam = {
|
|
|
496
499
|
};
|
|
497
500
|
type UpdatePackageMaterialsParam = {
|
|
498
501
|
/**
|
|
499
|
-
* -
|
|
502
|
+
* - A `package_material_id` is a unique
|
|
503
|
+
* identifier for a Package Material
|
|
500
504
|
*/
|
|
501
505
|
packageMaterialId: string;
|
|
502
506
|
body: ServiceabilityPlatformModel.PackageMaterial;
|
|
503
507
|
};
|
|
504
508
|
type UpdateServiceabilityParam = {
|
|
505
509
|
/**
|
|
506
|
-
* - Unique Identifier of
|
|
510
|
+
* - Unique Identifier of CP Extension
|
|
507
511
|
*/
|
|
508
512
|
extensionId: string;
|
|
509
513
|
/**
|
|
510
|
-
* - Unique identifier of
|
|
514
|
+
* - Unique identifier of a scheme
|
|
511
515
|
*/
|
|
512
516
|
schemeId: string;
|
|
513
517
|
/**
|
|
@@ -4,21 +4,21 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* @typedef BulkServiceabilityParam
|
|
7
|
-
* @property {string} extensionId - Unique Identifier of
|
|
8
|
-
* @property {string} schemeId - Unique identifier of
|
|
9
|
-
* @property {ServiceabilityPlatformModel.
|
|
7
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
8
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
9
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
|
|
10
10
|
*/
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* @typedef BulkTatParam
|
|
14
|
-
* @property {string} extensionId - Unique Identifier of
|
|
15
|
-
* @property {string} schemeId - Unique identifier of
|
|
16
|
-
* @property {ServiceabilityPlatformModel.
|
|
14
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
15
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
16
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
|
|
17
17
|
*/
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
20
|
* @typedef CreateCourierPartnerAccountParam
|
|
21
|
-
* @property {ServiceabilityPlatformModel.
|
|
21
|
+
* @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
24
|
/**
|
|
@@ -40,8 +40,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
42
|
* @typedef GetBulkServiceabilityParam
|
|
43
|
-
* @property {string} extensionId - Unique Identifier of
|
|
44
|
-
* @property {string} schemeId - Unique identifier of
|
|
43
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
44
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
45
45
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
46
46
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
47
47
|
* @property {string} [batchId] - Unique identifier of bulk job
|
|
@@ -55,8 +55,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
57
|
* @typedef GetBulkTatParam
|
|
58
|
-
* @property {string} extensionId - Unique Identifier of
|
|
59
|
-
* @property {string} schemeId - Unique identifier of
|
|
58
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
59
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
60
60
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
61
61
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
62
62
|
* @property {string} [batchId] - Unique identifier of bulk job
|
|
@@ -72,7 +72,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
74
|
* @typedef GetCourierPartnerAccountParam
|
|
75
|
-
* @property {string} accountId - Unique ID of courier
|
|
75
|
+
* @property {string} accountId - Unique ID of courier account
|
|
76
76
|
*/
|
|
77
77
|
|
|
78
78
|
/**
|
|
@@ -86,7 +86,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
88
|
* @typedef GetOptimalLocationsParam
|
|
89
|
-
* @property {ServiceabilityPlatformModel.
|
|
89
|
+
* @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
|
|
90
90
|
*/
|
|
91
91
|
|
|
92
92
|
/**
|
|
@@ -113,13 +113,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
113
113
|
|
|
114
114
|
/**
|
|
115
115
|
* @typedef GetPackageMaterialsParam
|
|
116
|
-
* @property {string} packageMaterialId -
|
|
116
|
+
* @property {string} packageMaterialId - A `package_material_id` is a unique
|
|
117
|
+
* identifier for a Package Material
|
|
117
118
|
*/
|
|
118
119
|
|
|
119
120
|
/**
|
|
120
121
|
* @typedef GetServiceabilityParam
|
|
121
|
-
* @property {string} extensionId - Unique Identifier of
|
|
122
|
-
* @property {string} schemeId - Unique identifier of
|
|
122
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
123
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
123
124
|
* @property {string} regionId - Unique identifier of a region
|
|
124
125
|
*/
|
|
125
126
|
|
|
@@ -149,8 +150,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
149
150
|
|
|
150
151
|
/**
|
|
151
152
|
* @typedef UpdateCourierPartnerAccountParam
|
|
152
|
-
* @property {string} accountId - Unique ID of courier
|
|
153
|
-
* @property {ServiceabilityPlatformModel.
|
|
153
|
+
* @property {string} accountId - Unique ID of courier account
|
|
154
|
+
* @property {ServiceabilityPlatformModel.CourierAccount} body
|
|
154
155
|
*/
|
|
155
156
|
|
|
156
157
|
/**
|
|
@@ -162,14 +163,15 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
162
163
|
|
|
163
164
|
/**
|
|
164
165
|
* @typedef UpdatePackageMaterialsParam
|
|
165
|
-
* @property {string} packageMaterialId -
|
|
166
|
+
* @property {string} packageMaterialId - A `package_material_id` is a unique
|
|
167
|
+
* identifier for a Package Material
|
|
166
168
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
167
169
|
*/
|
|
168
170
|
|
|
169
171
|
/**
|
|
170
172
|
* @typedef UpdateServiceabilityParam
|
|
171
|
-
* @property {string} extensionId - Unique Identifier of
|
|
172
|
-
* @property {string} schemeId - Unique identifier of
|
|
173
|
+
* @property {string} extensionId - Unique Identifier of CP Extension
|
|
174
|
+
* @property {string} schemeId - Unique identifier of a scheme
|
|
173
175
|
* @property {string} regionId - Unique identifier of a region
|
|
174
176
|
* @property {ServiceabilityPlatformModel.ServiceabilityModel} body
|
|
175
177
|
*/
|
|
@@ -186,7 +188,7 @@ class ServiceabilityPlatformValidator {
|
|
|
186
188
|
return Joi.object({
|
|
187
189
|
extensionId: Joi.string().allow("").required(),
|
|
188
190
|
schemeId: Joi.string().allow("").required(),
|
|
189
|
-
body: ServiceabilityPlatformModel.
|
|
191
|
+
body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
|
|
190
192
|
}).required();
|
|
191
193
|
}
|
|
192
194
|
|
|
@@ -195,14 +197,14 @@ class ServiceabilityPlatformValidator {
|
|
|
195
197
|
return Joi.object({
|
|
196
198
|
extensionId: Joi.string().allow("").required(),
|
|
197
199
|
schemeId: Joi.string().allow("").required(),
|
|
198
|
-
body: ServiceabilityPlatformModel.
|
|
200
|
+
body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
|
|
199
201
|
}).required();
|
|
200
202
|
}
|
|
201
203
|
|
|
202
204
|
/** @returns {CreateCourierPartnerAccountParam} */
|
|
203
205
|
static createCourierPartnerAccount() {
|
|
204
206
|
return Joi.object({
|
|
205
|
-
body: ServiceabilityPlatformModel.
|
|
207
|
+
body: ServiceabilityPlatformModel.CourierAccountRequestBody().required(),
|
|
206
208
|
}).required();
|
|
207
209
|
}
|
|
208
210
|
|
|
@@ -292,7 +294,7 @@ class ServiceabilityPlatformValidator {
|
|
|
292
294
|
/** @returns {GetOptimalLocationsParam} */
|
|
293
295
|
static getOptimalLocations() {
|
|
294
296
|
return Joi.object({
|
|
295
|
-
body: ServiceabilityPlatformModel.
|
|
297
|
+
body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema().required(),
|
|
296
298
|
}).required();
|
|
297
299
|
}
|
|
298
300
|
|
|
@@ -373,7 +375,7 @@ class ServiceabilityPlatformValidator {
|
|
|
373
375
|
static updateCourierPartnerAccount() {
|
|
374
376
|
return Joi.object({
|
|
375
377
|
accountId: Joi.string().allow("").required(),
|
|
376
|
-
body: ServiceabilityPlatformModel.
|
|
378
|
+
body: ServiceabilityPlatformModel.CourierAccount().required(),
|
|
377
379
|
}).required();
|
|
378
380
|
}
|
|
379
381
|
|
|
@@ -29,12 +29,12 @@ declare class Share {
|
|
|
29
29
|
*
|
|
30
30
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
|
-
* @returns {Promise<SharePlatformModel.
|
|
32
|
+
* @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
|
|
33
33
|
* @name getShortLinkClickStats
|
|
34
34
|
* @summary: Get short link click statistics
|
|
35
35
|
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
|
|
36
36
|
*/
|
|
37
|
-
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.
|
|
37
|
+
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
|
|
38
38
|
/**
|
|
39
39
|
* @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
|
|
40
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -179,7 +179,7 @@ class Share {
|
|
|
179
179
|
*
|
|
180
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<SharePlatformModel.
|
|
182
|
+
* @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
|
|
183
183
|
* @name getShortLinkClickStats
|
|
184
184
|
* @summary: Get short link click statistics
|
|
185
185
|
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
|
|
@@ -232,7 +232,7 @@ class Share {
|
|
|
232
232
|
|
|
233
233
|
const {
|
|
234
234
|
error: res_error,
|
|
235
|
-
} = SharePlatformModel.
|
|
235
|
+
} = SharePlatformModel.ClickStatsResponse().validate(responseData, {
|
|
236
236
|
abortEarly: false,
|
|
237
237
|
allowUnknown: true,
|
|
238
238
|
});
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = SharePlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef ClickStatsResponse
|
|
4
4
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
5
5
|
* the short link.
|
|
6
6
|
*/
|
|
@@ -55,24 +55,12 @@ export = SharePlatformModel;
|
|
|
55
55
|
* @property {Attribution} [attribution]
|
|
56
56
|
* @property {SocialMediaTags} [social_media_tags]
|
|
57
57
|
* @property {number} [count]
|
|
58
|
-
* @property {shortLinkReqMeta} [meta]
|
|
59
|
-
*/
|
|
60
|
-
/**
|
|
61
|
-
* @typedef shortLinkReqMeta
|
|
62
|
-
* @property {boolean} [for_sms] - For_sms flag specifies that the short-link
|
|
63
|
-
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
64
|
-
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
65
|
-
* @property {string} [sms_header] - This field is used to override the sms
|
|
66
|
-
* header to be used to generate a short-link for SMS communication in
|
|
67
|
-
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
68
|
-
* for_sms flag set to true.
|
|
69
58
|
*/
|
|
70
59
|
/**
|
|
71
60
|
* @typedef UrlInfo
|
|
72
61
|
* @property {string} [original]
|
|
73
62
|
* @property {string} [hash]
|
|
74
63
|
* @property {string} [short_url]
|
|
75
|
-
* @property {string} [alias]
|
|
76
64
|
*/
|
|
77
65
|
/**
|
|
78
66
|
* @typedef ShortLinkRes
|
|
@@ -119,11 +107,11 @@ export = SharePlatformModel;
|
|
|
119
107
|
declare class SharePlatformModel {
|
|
120
108
|
}
|
|
121
109
|
declare namespace SharePlatformModel {
|
|
122
|
-
export {
|
|
110
|
+
export { ClickStatsResponse, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
123
111
|
}
|
|
124
|
-
/** @returns {
|
|
125
|
-
declare function
|
|
126
|
-
type
|
|
112
|
+
/** @returns {ClickStatsResponse} */
|
|
113
|
+
declare function ClickStatsResponse(): ClickStatsResponse;
|
|
114
|
+
type ClickStatsResponse = {
|
|
127
115
|
/**
|
|
128
116
|
* - An array of click statistics for
|
|
129
117
|
* the short link.
|
|
@@ -204,24 +192,6 @@ type ShortLinkReq = {
|
|
|
204
192
|
attribution?: Attribution;
|
|
205
193
|
social_media_tags?: SocialMediaTags;
|
|
206
194
|
count?: number;
|
|
207
|
-
meta?: shortLinkReqMeta;
|
|
208
|
-
};
|
|
209
|
-
/** @returns {shortLinkReqMeta} */
|
|
210
|
-
declare function shortLinkReqMeta(): shortLinkReqMeta;
|
|
211
|
-
type shortLinkReqMeta = {
|
|
212
|
-
/**
|
|
213
|
-
* - For_sms flag specifies that the short-link
|
|
214
|
-
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
215
|
-
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
216
|
-
*/
|
|
217
|
-
for_sms?: boolean;
|
|
218
|
-
/**
|
|
219
|
-
* - This field is used to override the sms
|
|
220
|
-
* header to be used to generate a short-link for SMS communication in
|
|
221
|
-
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
222
|
-
* for_sms flag set to true.
|
|
223
|
-
*/
|
|
224
|
-
sms_header?: string;
|
|
225
195
|
};
|
|
226
196
|
/** @returns {UrlInfo} */
|
|
227
197
|
declare function UrlInfo(): UrlInfo;
|
|
@@ -229,7 +199,6 @@ type UrlInfo = {
|
|
|
229
199
|
original?: string;
|
|
230
200
|
hash?: string;
|
|
231
201
|
short_url?: string;
|
|
232
|
-
alias?: string;
|
|
233
202
|
};
|
|
234
203
|
/** @returns {ShortLinkRes} */
|
|
235
204
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef ClickStatsResponse
|
|
5
5
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
6
6
|
* the short link.
|
|
7
7
|
*/
|
|
@@ -64,18 +64,6 @@ const Joi = require("joi");
|
|
|
64
64
|
* @property {Attribution} [attribution]
|
|
65
65
|
* @property {SocialMediaTags} [social_media_tags]
|
|
66
66
|
* @property {number} [count]
|
|
67
|
-
* @property {shortLinkReqMeta} [meta]
|
|
68
|
-
*/
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* @typedef shortLinkReqMeta
|
|
72
|
-
* @property {boolean} [for_sms] - For_sms flag specifies that the short-link
|
|
73
|
-
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
74
|
-
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
75
|
-
* @property {string} [sms_header] - This field is used to override the sms
|
|
76
|
-
* header to be used to generate a short-link for SMS communication in
|
|
77
|
-
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
78
|
-
* for_sms flag set to true.
|
|
79
67
|
*/
|
|
80
68
|
|
|
81
69
|
/**
|
|
@@ -83,7 +71,6 @@ const Joi = require("joi");
|
|
|
83
71
|
* @property {string} [original]
|
|
84
72
|
* @property {string} [hash]
|
|
85
73
|
* @property {string} [short_url]
|
|
86
|
-
* @property {string} [alias]
|
|
87
74
|
*/
|
|
88
75
|
|
|
89
76
|
/**
|
|
@@ -133,8 +120,8 @@ const Joi = require("joi");
|
|
|
133
120
|
*/
|
|
134
121
|
|
|
135
122
|
class SharePlatformModel {
|
|
136
|
-
/** @returns {
|
|
137
|
-
static
|
|
123
|
+
/** @returns {ClickStatsResponse} */
|
|
124
|
+
static ClickStatsResponse() {
|
|
138
125
|
return Joi.object({
|
|
139
126
|
click_stats: Joi.array()
|
|
140
127
|
.items(SharePlatformModel.ClickStatsItem())
|
|
@@ -215,15 +202,6 @@ class SharePlatformModel {
|
|
|
215
202
|
attribution: SharePlatformModel.Attribution(),
|
|
216
203
|
social_media_tags: SharePlatformModel.SocialMediaTags(),
|
|
217
204
|
count: Joi.number(),
|
|
218
|
-
meta: SharePlatformModel.shortLinkReqMeta(),
|
|
219
|
-
});
|
|
220
|
-
}
|
|
221
|
-
|
|
222
|
-
/** @returns {shortLinkReqMeta} */
|
|
223
|
-
static shortLinkReqMeta() {
|
|
224
|
-
return Joi.object({
|
|
225
|
-
for_sms: Joi.boolean(),
|
|
226
|
-
sms_header: Joi.string().allow(""),
|
|
227
205
|
});
|
|
228
206
|
}
|
|
229
207
|
|
|
@@ -233,7 +211,6 @@ class SharePlatformModel {
|
|
|
233
211
|
original: Joi.string().allow(""),
|
|
234
212
|
hash: Joi.string().allow(""),
|
|
235
213
|
short_url: Joi.string().allow(""),
|
|
236
|
-
alias: Joi.string().allow(""),
|
|
237
214
|
});
|
|
238
215
|
}
|
|
239
216
|
|
|
@@ -252,7 +229,7 @@ class SharePlatformModel {
|
|
|
252
229
|
application: Joi.string().allow(""),
|
|
253
230
|
user_id: Joi.string().allow(""),
|
|
254
231
|
created_at: Joi.string().allow(""),
|
|
255
|
-
meta: Joi.
|
|
232
|
+
meta: Joi.any(),
|
|
256
233
|
updated_at: Joi.string().allow(""),
|
|
257
234
|
personalized: Joi.boolean(),
|
|
258
235
|
campaign: SharePlatformModel.CampaignShortLink(),
|
|
@@ -177,12 +177,12 @@ declare class Theme {
|
|
|
177
177
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
178
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ThemePlatformModel.
|
|
180
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
183
|
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
|
-
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.
|
|
185
|
+
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradableResponse>;
|
|
186
186
|
/**
|
|
187
187
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
188
188
|
* - Arg object
|
|
@@ -204,7 +204,7 @@ declare class Theme {
|
|
|
204
204
|
* @summary: Update a page
|
|
205
205
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
206
206
|
*/
|
|
207
|
-
updatePage({ themeId, pageValue,
|
|
207
|
+
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
208
208
|
/**
|
|
209
209
|
* @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
|
|
210
210
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|