@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +130 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- 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 +19 -30
- package/sdk/application/Content/ContentApplicationClient.js +40 -60
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +126 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +118 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +62 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +65 -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 +4 -2
- 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 +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- 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 +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5039 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1976 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6941 -2203
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- 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 +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- 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 +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +48 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +134 -43
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +38 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +56 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- 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 +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +895 -8
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- 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/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -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 courier partner extension.
|
|
5
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
6
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobDetails} 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 courier partner extension.
|
|
11
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
12
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
|
|
13
13
|
*/
|
|
14
14
|
/**
|
|
15
15
|
* @typedef CreateCourierPartnerAccountParam
|
|
16
|
-
* @property {ServiceabilityPlatformModel.
|
|
16
|
+
* @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} 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 courier partner extension.
|
|
34
|
+
* @property {string} schemeId - Unique identifier of courier partner 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 courier partner extension.
|
|
48
|
+
* @property {string} schemeId - Unique identifier of courier partner 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 account
|
|
62
|
+
* @property {string} accountId - Unique ID of courier partner 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.OptimlLocationsDetailsSchema} body
|
|
75
75
|
*/
|
|
76
76
|
/**
|
|
77
77
|
* @typedef GetPackageMaterialListParam
|
|
@@ -94,13 +94,12 @@ export = ServiceabilityPlatformValidator;
|
|
|
94
94
|
*/
|
|
95
95
|
/**
|
|
96
96
|
* @typedef GetPackageMaterialsParam
|
|
97
|
-
* @property {string} packageMaterialId -
|
|
98
|
-
* identifier for a Package Material
|
|
97
|
+
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
99
98
|
*/
|
|
100
99
|
/**
|
|
101
100
|
* @typedef GetServiceabilityParam
|
|
102
|
-
* @property {string} extensionId - Unique Identifier of
|
|
103
|
-
* @property {string} schemeId - Unique identifier of
|
|
101
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
102
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
104
103
|
* @property {string} regionId - Unique identifier of a region
|
|
105
104
|
*/
|
|
106
105
|
/**
|
|
@@ -113,8 +112,8 @@ export = ServiceabilityPlatformValidator;
|
|
|
113
112
|
*/
|
|
114
113
|
/**
|
|
115
114
|
* @typedef UpdateCourierPartnerAccountParam
|
|
116
|
-
* @property {string} accountId - Unique ID of courier account
|
|
117
|
-
* @property {ServiceabilityPlatformModel.
|
|
115
|
+
* @property {string} accountId - Unique ID of courier partner account
|
|
116
|
+
* @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
|
|
118
117
|
*/
|
|
119
118
|
/**
|
|
120
119
|
* @typedef UpdatePackageMaterialRuleParam
|
|
@@ -124,14 +123,13 @@ export = ServiceabilityPlatformValidator;
|
|
|
124
123
|
*/
|
|
125
124
|
/**
|
|
126
125
|
* @typedef UpdatePackageMaterialsParam
|
|
127
|
-
* @property {string} packageMaterialId -
|
|
128
|
-
* identifier for a Package Material
|
|
126
|
+
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
129
127
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
130
128
|
*/
|
|
131
129
|
/**
|
|
132
130
|
* @typedef UpdateServiceabilityParam
|
|
133
|
-
* @property {string} extensionId - Unique Identifier of
|
|
134
|
-
* @property {string} schemeId - Unique identifier of
|
|
131
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
132
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
135
133
|
* @property {string} regionId - Unique identifier of a region
|
|
136
134
|
* @property {ServiceabilityPlatformModel.ServiceabilityModel} body
|
|
137
135
|
*/
|
|
@@ -197,28 +195,28 @@ declare namespace ServiceabilityPlatformValidator {
|
|
|
197
195
|
}
|
|
198
196
|
type BulkServiceabilityParam = {
|
|
199
197
|
/**
|
|
200
|
-
* - Unique Identifier of
|
|
198
|
+
* - Unique Identifier of courier partner extension.
|
|
201
199
|
*/
|
|
202
200
|
extensionId: string;
|
|
203
201
|
/**
|
|
204
|
-
* - Unique identifier of
|
|
202
|
+
* - Unique identifier of courier partner scheme.
|
|
205
203
|
*/
|
|
206
204
|
schemeId: string;
|
|
207
|
-
body: ServiceabilityPlatformModel.
|
|
205
|
+
body: ServiceabilityPlatformModel.BulkRegionJobDetails;
|
|
208
206
|
};
|
|
209
207
|
type BulkTatParam = {
|
|
210
208
|
/**
|
|
211
|
-
* - Unique Identifier of
|
|
209
|
+
* - Unique Identifier of courier partner extension.
|
|
212
210
|
*/
|
|
213
211
|
extensionId: string;
|
|
214
212
|
/**
|
|
215
|
-
* - Unique identifier of
|
|
213
|
+
* - Unique identifier of courier partner scheme.
|
|
216
214
|
*/
|
|
217
215
|
schemeId: string;
|
|
218
|
-
body: ServiceabilityPlatformModel.
|
|
216
|
+
body: ServiceabilityPlatformModel.BulkRegionJobDetails;
|
|
219
217
|
};
|
|
220
218
|
type CreateCourierPartnerAccountParam = {
|
|
221
|
-
body: ServiceabilityPlatformModel.
|
|
219
|
+
body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
|
|
222
220
|
};
|
|
223
221
|
type CreatePackageMaterialParam = {
|
|
224
222
|
body: ServiceabilityPlatformModel.PackageMaterial;
|
|
@@ -231,11 +229,11 @@ type CreateZoneParam = {
|
|
|
231
229
|
};
|
|
232
230
|
type GetBulkServiceabilityParam = {
|
|
233
231
|
/**
|
|
234
|
-
* - Unique Identifier of
|
|
232
|
+
* - Unique Identifier of courier partner extension.
|
|
235
233
|
*/
|
|
236
234
|
extensionId: string;
|
|
237
235
|
/**
|
|
238
|
-
* - Unique identifier of
|
|
236
|
+
* - Unique identifier of courier partner scheme.
|
|
239
237
|
*/
|
|
240
238
|
schemeId: string;
|
|
241
239
|
/**
|
|
@@ -277,11 +275,11 @@ type GetBulkServiceabilityParam = {
|
|
|
277
275
|
};
|
|
278
276
|
type GetBulkTatParam = {
|
|
279
277
|
/**
|
|
280
|
-
* - Unique Identifier of
|
|
278
|
+
* - Unique Identifier of courier partner extension.
|
|
281
279
|
*/
|
|
282
280
|
extensionId: string;
|
|
283
281
|
/**
|
|
284
|
-
* - Unique identifier of
|
|
282
|
+
* - Unique identifier of courier partner scheme.
|
|
285
283
|
*/
|
|
286
284
|
schemeId: string;
|
|
287
285
|
/**
|
|
@@ -323,7 +321,7 @@ type GetBulkTatParam = {
|
|
|
323
321
|
};
|
|
324
322
|
type GetCourierPartnerAccountParam = {
|
|
325
323
|
/**
|
|
326
|
-
* - Unique ID of courier account
|
|
324
|
+
* - Unique ID of courier partner account
|
|
327
325
|
*/
|
|
328
326
|
accountId: string;
|
|
329
327
|
};
|
|
@@ -350,7 +348,7 @@ type GetCourierPartnerAccountsParam = {
|
|
|
350
348
|
transportType?: string;
|
|
351
349
|
};
|
|
352
350
|
type GetOptimalLocationsParam = {
|
|
353
|
-
body: ServiceabilityPlatformModel.
|
|
351
|
+
body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
|
|
354
352
|
};
|
|
355
353
|
type GetPackageMaterialListParam = {
|
|
356
354
|
/**
|
|
@@ -397,18 +395,17 @@ type GetPackageMaterialRulesParam = {
|
|
|
397
395
|
};
|
|
398
396
|
type GetPackageMaterialsParam = {
|
|
399
397
|
/**
|
|
400
|
-
* -
|
|
401
|
-
* identifier for a Package Material
|
|
398
|
+
* - Unique identifier for a Package. Material
|
|
402
399
|
*/
|
|
403
400
|
packageMaterialId: string;
|
|
404
401
|
};
|
|
405
402
|
type GetServiceabilityParam = {
|
|
406
403
|
/**
|
|
407
|
-
* - Unique Identifier of
|
|
404
|
+
* - Unique Identifier of courier partner extension.
|
|
408
405
|
*/
|
|
409
406
|
extensionId: string;
|
|
410
407
|
/**
|
|
411
|
-
* - Unique identifier of
|
|
408
|
+
* - Unique identifier of courier partner scheme.
|
|
412
409
|
*/
|
|
413
410
|
schemeId: string;
|
|
414
411
|
/**
|
|
@@ -427,10 +424,10 @@ type UpdateCompanyConfigurationParam = {
|
|
|
427
424
|
};
|
|
428
425
|
type UpdateCourierPartnerAccountParam = {
|
|
429
426
|
/**
|
|
430
|
-
* - Unique ID of courier account
|
|
427
|
+
* - Unique ID of courier partner account
|
|
431
428
|
*/
|
|
432
429
|
accountId: string;
|
|
433
|
-
body: ServiceabilityPlatformModel.
|
|
430
|
+
body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
|
|
434
431
|
};
|
|
435
432
|
type UpdatePackageMaterialRuleParam = {
|
|
436
433
|
/**
|
|
@@ -442,19 +439,18 @@ type UpdatePackageMaterialRuleParam = {
|
|
|
442
439
|
};
|
|
443
440
|
type UpdatePackageMaterialsParam = {
|
|
444
441
|
/**
|
|
445
|
-
* -
|
|
446
|
-
* identifier for a Package Material
|
|
442
|
+
* - Unique identifier for a Package. Material
|
|
447
443
|
*/
|
|
448
444
|
packageMaterialId: string;
|
|
449
445
|
body: ServiceabilityPlatformModel.PackageMaterial;
|
|
450
446
|
};
|
|
451
447
|
type UpdateServiceabilityParam = {
|
|
452
448
|
/**
|
|
453
|
-
* - Unique Identifier of
|
|
449
|
+
* - Unique Identifier of courier partner extension.
|
|
454
450
|
*/
|
|
455
451
|
extensionId: string;
|
|
456
452
|
/**
|
|
457
|
-
* - Unique identifier of
|
|
453
|
+
* - Unique identifier of courier partner scheme.
|
|
458
454
|
*/
|
|
459
455
|
schemeId: string;
|
|
460
456
|
/**
|
|
@@ -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 courier partner extension.
|
|
8
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
9
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobDetails} 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 courier partner extension.
|
|
15
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
16
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
|
|
17
17
|
*/
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
20
|
* @typedef CreateCourierPartnerAccountParam
|
|
21
|
-
* @property {ServiceabilityPlatformModel.
|
|
21
|
+
* @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} 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 courier partner extension.
|
|
44
|
+
* @property {string} schemeId - Unique identifier of courier partner 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 courier partner extension.
|
|
59
|
+
* @property {string} schemeId - Unique identifier of courier partner 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 account
|
|
75
|
+
* @property {string} accountId - Unique ID of courier partner 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.OptimlLocationsDetailsSchema} body
|
|
90
90
|
*/
|
|
91
91
|
|
|
92
92
|
/**
|
|
@@ -113,14 +113,13 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
113
113
|
|
|
114
114
|
/**
|
|
115
115
|
* @typedef GetPackageMaterialsParam
|
|
116
|
-
* @property {string} packageMaterialId -
|
|
117
|
-
* identifier for a Package Material
|
|
116
|
+
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
118
117
|
*/
|
|
119
118
|
|
|
120
119
|
/**
|
|
121
120
|
* @typedef GetServiceabilityParam
|
|
122
|
-
* @property {string} extensionId - Unique Identifier of
|
|
123
|
-
* @property {string} schemeId - Unique identifier of
|
|
121
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
122
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
124
123
|
* @property {string} regionId - Unique identifier of a region
|
|
125
124
|
*/
|
|
126
125
|
|
|
@@ -136,8 +135,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
136
135
|
|
|
137
136
|
/**
|
|
138
137
|
* @typedef UpdateCourierPartnerAccountParam
|
|
139
|
-
* @property {string} accountId - Unique ID of courier account
|
|
140
|
-
* @property {ServiceabilityPlatformModel.
|
|
138
|
+
* @property {string} accountId - Unique ID of courier partner account
|
|
139
|
+
* @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
|
|
141
140
|
*/
|
|
142
141
|
|
|
143
142
|
/**
|
|
@@ -149,15 +148,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
149
148
|
|
|
150
149
|
/**
|
|
151
150
|
* @typedef UpdatePackageMaterialsParam
|
|
152
|
-
* @property {string} packageMaterialId -
|
|
153
|
-
* identifier for a Package Material
|
|
151
|
+
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
154
152
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
155
153
|
*/
|
|
156
154
|
|
|
157
155
|
/**
|
|
158
156
|
* @typedef UpdateServiceabilityParam
|
|
159
|
-
* @property {string} extensionId - Unique Identifier of
|
|
160
|
-
* @property {string} schemeId - Unique identifier of
|
|
157
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
158
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
161
159
|
* @property {string} regionId - Unique identifier of a region
|
|
162
160
|
* @property {ServiceabilityPlatformModel.ServiceabilityModel} body
|
|
163
161
|
*/
|
|
@@ -174,7 +172,7 @@ class ServiceabilityPlatformValidator {
|
|
|
174
172
|
return Joi.object({
|
|
175
173
|
extensionId: Joi.string().allow("").required(),
|
|
176
174
|
schemeId: Joi.string().allow("").required(),
|
|
177
|
-
body: ServiceabilityPlatformModel.
|
|
175
|
+
body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
|
|
178
176
|
}).required();
|
|
179
177
|
}
|
|
180
178
|
|
|
@@ -183,14 +181,14 @@ class ServiceabilityPlatformValidator {
|
|
|
183
181
|
return Joi.object({
|
|
184
182
|
extensionId: Joi.string().allow("").required(),
|
|
185
183
|
schemeId: Joi.string().allow("").required(),
|
|
186
|
-
body: ServiceabilityPlatformModel.
|
|
184
|
+
body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
|
|
187
185
|
}).required();
|
|
188
186
|
}
|
|
189
187
|
|
|
190
188
|
/** @returns {CreateCourierPartnerAccountParam} */
|
|
191
189
|
static createCourierPartnerAccount() {
|
|
192
190
|
return Joi.object({
|
|
193
|
-
body: ServiceabilityPlatformModel.
|
|
191
|
+
body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
|
|
194
192
|
}).required();
|
|
195
193
|
}
|
|
196
194
|
|
|
@@ -280,7 +278,7 @@ class ServiceabilityPlatformValidator {
|
|
|
280
278
|
/** @returns {GetOptimalLocationsParam} */
|
|
281
279
|
static getOptimalLocations() {
|
|
282
280
|
return Joi.object({
|
|
283
|
-
body: ServiceabilityPlatformModel.
|
|
281
|
+
body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema().required(),
|
|
284
282
|
}).required();
|
|
285
283
|
}
|
|
286
284
|
|
|
@@ -345,7 +343,7 @@ class ServiceabilityPlatformValidator {
|
|
|
345
343
|
static updateCourierPartnerAccount() {
|
|
346
344
|
return Joi.object({
|
|
347
345
|
accountId: Joi.string().allow("").required(),
|
|
348
|
-
body: ServiceabilityPlatformModel.
|
|
346
|
+
body: ServiceabilityPlatformModel.CourierAccountUpdateDetails().required(),
|
|
349
347
|
}).required();
|
|
350
348
|
}
|
|
351
349
|
|
|
@@ -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.ClickStatsResult>} - 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.ClickStatsResult>;
|
|
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.ClickStatsResult>} - 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.ClickStatsResult().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 ClickStatsResult
|
|
4
4
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
5
5
|
* the short link.
|
|
6
6
|
*/
|
|
@@ -55,12 +55,24 @@ 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.
|
|
58
69
|
*/
|
|
59
70
|
/**
|
|
60
71
|
* @typedef UrlInfo
|
|
61
72
|
* @property {string} [original]
|
|
62
73
|
* @property {string} [hash]
|
|
63
74
|
* @property {string} [short_url]
|
|
75
|
+
* @property {string} [alias]
|
|
64
76
|
*/
|
|
65
77
|
/**
|
|
66
78
|
* @typedef ShortLinkRes
|
|
@@ -107,11 +119,11 @@ export = SharePlatformModel;
|
|
|
107
119
|
declare class SharePlatformModel {
|
|
108
120
|
}
|
|
109
121
|
declare namespace SharePlatformModel {
|
|
110
|
-
export {
|
|
122
|
+
export { ClickStatsResult, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, shortLinkReqMeta, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
111
123
|
}
|
|
112
|
-
/** @returns {
|
|
113
|
-
declare function
|
|
114
|
-
type
|
|
124
|
+
/** @returns {ClickStatsResult} */
|
|
125
|
+
declare function ClickStatsResult(): ClickStatsResult;
|
|
126
|
+
type ClickStatsResult = {
|
|
115
127
|
/**
|
|
116
128
|
* - An array of click statistics for
|
|
117
129
|
* the short link.
|
|
@@ -192,6 +204,24 @@ type ShortLinkReq = {
|
|
|
192
204
|
attribution?: Attribution;
|
|
193
205
|
social_media_tags?: SocialMediaTags;
|
|
194
206
|
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;
|
|
195
225
|
};
|
|
196
226
|
/** @returns {UrlInfo} */
|
|
197
227
|
declare function UrlInfo(): UrlInfo;
|
|
@@ -199,6 +229,7 @@ type UrlInfo = {
|
|
|
199
229
|
original?: string;
|
|
200
230
|
hash?: string;
|
|
201
231
|
short_url?: string;
|
|
232
|
+
alias?: string;
|
|
202
233
|
};
|
|
203
234
|
/** @returns {ShortLinkRes} */
|
|
204
235
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef ClickStatsResult
|
|
5
5
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
6
6
|
* the short link.
|
|
7
7
|
*/
|
|
@@ -64,6 +64,18 @@ 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.
|
|
67
79
|
*/
|
|
68
80
|
|
|
69
81
|
/**
|
|
@@ -71,6 +83,7 @@ const Joi = require("joi");
|
|
|
71
83
|
* @property {string} [original]
|
|
72
84
|
* @property {string} [hash]
|
|
73
85
|
* @property {string} [short_url]
|
|
86
|
+
* @property {string} [alias]
|
|
74
87
|
*/
|
|
75
88
|
|
|
76
89
|
/**
|
|
@@ -120,8 +133,8 @@ const Joi = require("joi");
|
|
|
120
133
|
*/
|
|
121
134
|
|
|
122
135
|
class SharePlatformModel {
|
|
123
|
-
/** @returns {
|
|
124
|
-
static
|
|
136
|
+
/** @returns {ClickStatsResult} */
|
|
137
|
+
static ClickStatsResult() {
|
|
125
138
|
return Joi.object({
|
|
126
139
|
click_stats: Joi.array()
|
|
127
140
|
.items(SharePlatformModel.ClickStatsItem())
|
|
@@ -202,6 +215,15 @@ class SharePlatformModel {
|
|
|
202
215
|
attribution: SharePlatformModel.Attribution(),
|
|
203
216
|
social_media_tags: SharePlatformModel.SocialMediaTags(),
|
|
204
217
|
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(""),
|
|
205
227
|
});
|
|
206
228
|
}
|
|
207
229
|
|
|
@@ -211,6 +233,7 @@ class SharePlatformModel {
|
|
|
211
233
|
original: Joi.string().allow(""),
|
|
212
234
|
hash: Joi.string().allow(""),
|
|
213
235
|
short_url: Joi.string().allow(""),
|
|
236
|
+
alias: Joi.string().allow(""),
|
|
214
237
|
});
|
|
215
238
|
}
|
|
216
239
|
|
|
@@ -229,7 +252,7 @@ class SharePlatformModel {
|
|
|
229
252
|
application: Joi.string().allow(""),
|
|
230
253
|
user_id: Joi.string().allow(""),
|
|
231
254
|
created_at: Joi.string().allow(""),
|
|
232
|
-
meta: Joi.any(),
|
|
255
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
233
256
|
updated_at: Joi.string().allow(""),
|
|
234
257
|
personalized: Joi.boolean(),
|
|
235
258
|
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.ThemeUpgradable>} - 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.ThemeUpgradable>;
|
|
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, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
207
|
+
updatePage({ themeId, pageValue, socketId, 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 `{}`
|