@gofynd/fdk-client-javascript 1.4.16-beta.3 → 1.4.16-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 -117
- 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 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -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 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- 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/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -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/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 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- 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 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- 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 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- 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 +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -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 +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -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 +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- 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 +6 -810
- 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 -111
|
@@ -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
|
/**
|
|
@@ -111,7 +112,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
111
112
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
112
113
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
113
114
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
114
|
-
* @property {string} [
|
|
115
|
+
* @property {string} [applicationIds] - Zones filtered by applications
|
|
115
116
|
* @property {string} [q] - Search with name as a free text
|
|
116
117
|
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
117
118
|
* @property {string} [state] - State name
|
|
@@ -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
|
/**
|
|
@@ -448,9 +451,9 @@ type GetZonesParam = {
|
|
|
448
451
|
*/
|
|
449
452
|
isActive?: boolean;
|
|
450
453
|
/**
|
|
451
|
-
* - Zones filtered by
|
|
454
|
+
* - Zones filtered by applications
|
|
452
455
|
*/
|
|
453
|
-
|
|
456
|
+
applicationIds?: string;
|
|
454
457
|
/**
|
|
455
458
|
* - Search with name as a free text
|
|
456
459
|
*/
|
|
@@ -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
|
|
|
@@ -133,7 +134,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
133
134
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
134
135
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
135
136
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
136
|
-
* @property {string} [
|
|
137
|
+
* @property {string} [applicationIds] - Zones filtered by applications
|
|
137
138
|
* @property {string} [q] - Search with name as a free text
|
|
138
139
|
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
139
140
|
* @property {string} [state] - State name
|
|
@@ -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
|
|
|
@@ -352,7 +354,7 @@ class ServiceabilityPlatformValidator {
|
|
|
352
354
|
pageNo: Joi.number(),
|
|
353
355
|
pageSize: Joi.number(),
|
|
354
356
|
isActive: Joi.boolean(),
|
|
355
|
-
|
|
357
|
+
applicationIds: Joi.string().allow(""),
|
|
356
358
|
q: Joi.string().allow(""),
|
|
357
359
|
countryIsoCode: Joi.string().allow(""),
|
|
358
360
|
state: Joi.string().allow(""),
|
|
@@ -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
|
|
|
@@ -9,7 +9,7 @@ declare class Share {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
11
11
|
* @name createShortLink
|
|
12
|
-
* @summary: Create short link
|
|
12
|
+
* @summary: Create short link
|
|
13
13
|
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
|
|
14
14
|
*/
|
|
15
15
|
createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
@@ -19,7 +19,7 @@ declare class Share {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
21
21
|
* @name getShortLinkByHash
|
|
22
|
-
* @summary: Get short link by hash
|
|
22
|
+
* @summary: Get short link by hash
|
|
23
23
|
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
|
|
24
24
|
*/
|
|
25
25
|
getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
@@ -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 `{}`
|
|
@@ -53,7 +53,7 @@ declare class Share {
|
|
|
53
53
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
55
55
|
* @name updateShortLinkById
|
|
56
|
-
* @summary: Update short link
|
|
56
|
+
* @summary: Update short link
|
|
57
57
|
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
58
58
|
*/
|
|
59
59
|
updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
@@ -21,7 +21,7 @@ class Share {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
23
23
|
* @name createShortLink
|
|
24
|
-
* @summary: Create short link
|
|
24
|
+
* @summary: Create short link
|
|
25
25
|
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
|
|
26
26
|
*/
|
|
27
27
|
async createShortLink(
|
|
@@ -61,7 +61,7 @@ class Share {
|
|
|
61
61
|
const response = await PlatformAPIClient.execute(
|
|
62
62
|
this.config,
|
|
63
63
|
"post",
|
|
64
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link
|
|
64
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
|
|
65
65
|
query_params,
|
|
66
66
|
body,
|
|
67
67
|
requestHeaders,
|
|
@@ -100,7 +100,7 @@ class Share {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
102
102
|
* @name getShortLinkByHash
|
|
103
|
-
* @summary: Get short link by hash
|
|
103
|
+
* @summary: Get short link by hash
|
|
104
104
|
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
|
|
105
105
|
*/
|
|
106
106
|
async getShortLinkByHash(
|
|
@@ -140,7 +140,7 @@ class Share {
|
|
|
140
140
|
const response = await PlatformAPIClient.execute(
|
|
141
141
|
this.config,
|
|
142
142
|
"get",
|
|
143
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}
|
|
143
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
|
|
144
144
|
query_params,
|
|
145
145
|
undefined,
|
|
146
146
|
requestHeaders,
|
|
@@ -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
|
});
|
|
@@ -325,7 +325,7 @@ class Share {
|
|
|
325
325
|
const response = await PlatformAPIClient.execute(
|
|
326
326
|
this.config,
|
|
327
327
|
"get",
|
|
328
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link
|
|
328
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
|
|
329
329
|
query_params,
|
|
330
330
|
undefined,
|
|
331
331
|
requestHeaders,
|
|
@@ -366,7 +366,7 @@ class Share {
|
|
|
366
366
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
367
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
368
368
|
* @name updateShortLinkById
|
|
369
|
-
* @summary: Update short link
|
|
369
|
+
* @summary: Update short link
|
|
370
370
|
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
371
371
|
*/
|
|
372
372
|
async updateShortLinkById(
|
|
@@ -408,7 +408,7 @@ class Share {
|
|
|
408
408
|
const response = await PlatformAPIClient.execute(
|
|
409
409
|
this.config,
|
|
410
410
|
"patch",
|
|
411
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}
|
|
411
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
|
|
412
412
|
query_params,
|
|
413
413
|
body,
|
|
414
414
|
requestHeaders,
|
|
@@ -5,7 +5,7 @@ export = SharePlatformApplicationValidator;
|
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
7
7
|
* @typedef GetShortLinkByHashParam
|
|
8
|
-
* @property {string} hash
|
|
8
|
+
* @property {string} hash - Hash of short url
|
|
9
9
|
*/
|
|
10
10
|
/**
|
|
11
11
|
* @typedef GetShortLinkClickStatsParam
|
|
@@ -24,7 +24,7 @@ export = SharePlatformApplicationValidator;
|
|
|
24
24
|
*/
|
|
25
25
|
/**
|
|
26
26
|
* @typedef UpdateShortLinkByIdParam
|
|
27
|
-
* @property {string} id -
|
|
27
|
+
* @property {string} id - Short link document identifier
|
|
28
28
|
* @property {SharePlatformModel.ShortLinkReq} body
|
|
29
29
|
*/
|
|
30
30
|
declare class SharePlatformApplicationValidator {
|
|
@@ -46,6 +46,9 @@ type CreateShortLinkParam = {
|
|
|
46
46
|
body: SharePlatformModel.ShortLinkReq;
|
|
47
47
|
};
|
|
48
48
|
type GetShortLinkByHashParam = {
|
|
49
|
+
/**
|
|
50
|
+
* - Hash of short url
|
|
51
|
+
*/
|
|
49
52
|
hash: string;
|
|
50
53
|
};
|
|
51
54
|
type GetShortLinkClickStatsParam = {
|
|
@@ -87,7 +90,7 @@ type GetShortLinksParam = {
|
|
|
87
90
|
};
|
|
88
91
|
type UpdateShortLinkByIdParam = {
|
|
89
92
|
/**
|
|
90
|
-
* -
|
|
93
|
+
* - Short link document identifier
|
|
91
94
|
*/
|
|
92
95
|
id: string;
|
|
93
96
|
body: SharePlatformModel.ShortLinkReq;
|
|
@@ -9,7 +9,7 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
11
|
* @typedef GetShortLinkByHashParam
|
|
12
|
-
* @property {string} hash
|
|
12
|
+
* @property {string} hash - Hash of short url
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
/**
|
|
@@ -31,7 +31,7 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
33
|
* @typedef UpdateShortLinkByIdParam
|
|
34
|
-
* @property {string} id -
|
|
34
|
+
* @property {string} id - Short link document identifier
|
|
35
35
|
* @property {SharePlatformModel.ShortLinkReq} body
|
|
36
36
|
*/
|
|
37
37
|
|