@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +33 -19
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -21,7 +21,7 @@ class Rewards {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
23
23
|
* @name getGiveawayById
|
|
24
|
-
* @summary: Get giveaway by ID
|
|
24
|
+
* @summary: Get giveaway by ID
|
|
25
25
|
* @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
|
|
26
26
|
*/
|
|
27
27
|
async getGiveawayById(
|
|
@@ -100,7 +100,7 @@ class Rewards {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<RewardsPlatformModel.Offer>} - Success response
|
|
102
102
|
* @name getOfferByName
|
|
103
|
-
* @summary: Get offer by name
|
|
103
|
+
* @summary: Get offer by name
|
|
104
104
|
* @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
|
|
105
105
|
*/
|
|
106
106
|
async getOfferByName(
|
|
@@ -177,7 +177,7 @@ class Rewards {
|
|
|
177
177
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
178
178
|
* @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
|
|
179
179
|
* @name getRewardsConfiguration
|
|
180
|
-
* @summary: Get rewards configuration
|
|
180
|
+
* @summary: Get rewards configuration
|
|
181
181
|
* @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
|
|
182
182
|
*/
|
|
183
183
|
async getRewardsConfiguration(
|
|
@@ -252,7 +252,7 @@ class Rewards {
|
|
|
252
252
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
253
253
|
* @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
|
|
254
254
|
* @name getUserDetails
|
|
255
|
-
* @summary: Get user details
|
|
255
|
+
* @summary: Get user details
|
|
256
256
|
* @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
|
|
257
257
|
*/
|
|
258
258
|
async getUserDetails(
|
|
@@ -329,7 +329,7 @@ class Rewards {
|
|
|
329
329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
330
330
|
* @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
|
|
331
331
|
* @name getUserPointsHistory
|
|
332
|
-
* @summary: Get user points history
|
|
332
|
+
* @summary: Get user points history
|
|
333
333
|
* @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
|
|
334
334
|
*/
|
|
335
335
|
async getUserPointsHistory(
|
|
@@ -416,7 +416,7 @@ class Rewards {
|
|
|
416
416
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
417
417
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
418
418
|
* @name saveGiveAway
|
|
419
|
-
* @summary: Save giveaway
|
|
419
|
+
* @summary: Save giveaway
|
|
420
420
|
* @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
|
|
421
421
|
*/
|
|
422
422
|
async saveGiveAway(
|
|
@@ -497,7 +497,7 @@ class Rewards {
|
|
|
497
497
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
498
498
|
* @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
|
|
499
499
|
* @name setRewardsConfiguration
|
|
500
|
-
* @summary: Set rewards configuration
|
|
500
|
+
* @summary: Set rewards configuration
|
|
501
501
|
* @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
|
|
502
502
|
*/
|
|
503
503
|
async setRewardsConfiguration(
|
|
@@ -576,7 +576,7 @@ class Rewards {
|
|
|
576
576
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
577
|
* @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
|
|
578
578
|
* @name showGiveaways
|
|
579
|
-
* @summary: Display giveaways
|
|
579
|
+
* @summary: Display giveaways
|
|
580
580
|
* @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
|
|
581
581
|
*/
|
|
582
582
|
async showGiveaways(
|
|
@@ -659,7 +659,7 @@ class Rewards {
|
|
|
659
659
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
660
|
* @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
|
|
661
661
|
* @name showOffers
|
|
662
|
-
* @summary: Show offers
|
|
662
|
+
* @summary: Show offers
|
|
663
663
|
* @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
|
|
664
664
|
*/
|
|
665
665
|
async showOffers(
|
|
@@ -729,7 +729,7 @@ class Rewards {
|
|
|
729
729
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
730
730
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
731
731
|
* @name updateGiveAway
|
|
732
|
-
* @summary: Update giveaway
|
|
732
|
+
* @summary: Update giveaway
|
|
733
733
|
* @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
|
|
734
734
|
*/
|
|
735
735
|
async updateGiveAway(
|
|
@@ -812,7 +812,7 @@ class Rewards {
|
|
|
812
812
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
813
813
|
* @returns {Promise<RewardsPlatformModel.Offer>} - Success response
|
|
814
814
|
* @name updateOfferByName
|
|
815
|
-
* @summary: Update offer by name
|
|
815
|
+
* @summary: Update offer by name
|
|
816
816
|
* @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
|
|
817
817
|
*/
|
|
818
818
|
async updateOfferByName(
|
|
@@ -895,7 +895,7 @@ class Rewards {
|
|
|
895
895
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
896
896
|
* @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
|
|
897
897
|
* @name updateUserStatus
|
|
898
|
-
* @summary: Update user status
|
|
898
|
+
* @summary: Update user status
|
|
899
899
|
* @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
|
|
900
900
|
*/
|
|
901
901
|
async updateUserStatus(
|
|
@@ -12,7 +12,7 @@ declare class Serviceability {
|
|
|
12
12
|
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
|
|
13
13
|
* Success response
|
|
14
14
|
* @name createCourierPartnerRule
|
|
15
|
-
* @summary: Create Courier Rules
|
|
15
|
+
* @summary: Create Courier Rules
|
|
16
16
|
* @description: Creates Courier Rules with rule configuration and dp priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
17
17
|
*/
|
|
18
18
|
createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRule>;
|
|
@@ -66,7 +66,7 @@ declare class Serviceability {
|
|
|
66
66
|
* - Success response
|
|
67
67
|
*
|
|
68
68
|
* @name getApplicationServiceabilitySelfShipment
|
|
69
|
-
* @summary: Self-ship configuration of application
|
|
69
|
+
* @summary: Self-ship configuration of application
|
|
70
70
|
* @description: This API returns Self-ship configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationServiceabilitySelfShipment/).
|
|
71
71
|
*/
|
|
72
72
|
getApplicationServiceabilitySelfShipment({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationSelfShipConfigResponse>;
|
|
@@ -79,7 +79,7 @@ declare class Serviceability {
|
|
|
79
79
|
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
|
|
80
80
|
* Success response
|
|
81
81
|
* @name getCourierPartnerRule
|
|
82
|
-
* @summary: Fetch of Courier Rule
|
|
82
|
+
* @summary: Fetch of Courier Rule
|
|
83
83
|
* @description: This API returns Courier Rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
84
84
|
*/
|
|
85
85
|
getCourierPartnerRule({ ruleId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRule>;
|
|
@@ -147,7 +147,7 @@ declare class Serviceability {
|
|
|
147
147
|
* - Success response
|
|
148
148
|
*
|
|
149
149
|
* @name patchApplicationServiceabilitySelfShipment
|
|
150
|
-
* @summary: Self-ship configuration of application
|
|
150
|
+
* @summary: Self-ship configuration of application
|
|
151
151
|
* @description: This API updates Self-ship configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/patchApplicationServiceabilitySelfShipment/).
|
|
152
152
|
*/
|
|
153
153
|
patchApplicationServiceabilitySelfShipment({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationServiceabilitySelfShipmentParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationSelfShipConfigResponse>;
|
|
@@ -186,7 +186,7 @@ declare class Serviceability {
|
|
|
186
186
|
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
|
|
187
187
|
* Success response
|
|
188
188
|
* @name updateCourierRule
|
|
189
|
-
* @summary: Updating of Courier Rule
|
|
189
|
+
* @summary: Updating of Courier Rule
|
|
190
190
|
* @description: This API updates and returns Courier Rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
|
|
191
191
|
*/
|
|
192
192
|
updateCourierRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateCourierRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRule>;
|
|
@@ -200,7 +200,7 @@ declare class Serviceability {
|
|
|
200
200
|
* - Success response
|
|
201
201
|
*
|
|
202
202
|
* @name updatePincodeAuditHistory
|
|
203
|
-
* @summary: Update pincode audit history
|
|
203
|
+
* @summary: Update pincode audit history
|
|
204
204
|
* @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
|
|
205
205
|
*/
|
|
206
206
|
updatePincodeAuditHistory({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResponseData>;
|
|
@@ -214,7 +214,7 @@ declare class Serviceability {
|
|
|
214
214
|
* - Success response
|
|
215
215
|
*
|
|
216
216
|
* @name updatePincodeBulkView
|
|
217
|
-
* @summary: Update pincode bulk view
|
|
217
|
+
* @summary: Update pincode bulk view
|
|
218
218
|
* @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
|
|
219
219
|
*/
|
|
220
220
|
updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeBulkViewResponse>;
|
|
@@ -228,7 +228,7 @@ declare class Serviceability {
|
|
|
228
228
|
* - Success response
|
|
229
229
|
*
|
|
230
230
|
* @name updatePincodeCoDListing
|
|
231
|
-
* @summary: Update pincode CoD (Cash on Delivery) listing
|
|
231
|
+
* @summary: Update pincode CoD (Cash on Delivery) listing
|
|
232
232
|
* @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
|
|
233
233
|
*/
|
|
234
234
|
updatePincodeCoDListing({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResponse>;
|
|
@@ -241,7 +241,7 @@ declare class Serviceability {
|
|
|
241
241
|
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
|
|
242
242
|
* Success response
|
|
243
243
|
* @name updatePincodeMopView
|
|
244
|
-
* @summary: Update pincode MOP (Mode of Payment) view
|
|
244
|
+
* @summary: Update pincode MOP (Mode of Payment) view
|
|
245
245
|
* @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
|
|
246
246
|
*/
|
|
247
247
|
updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPresponse>;
|
|
@@ -24,7 +24,7 @@ class Serviceability {
|
|
|
24
24
|
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
|
|
25
25
|
* Success response
|
|
26
26
|
* @name createCourierPartnerRule
|
|
27
|
-
* @summary: Create Courier Rules
|
|
27
|
+
* @summary: Create Courier Rules
|
|
28
28
|
* @description: Creates Courier Rules with rule configuration and dp priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
29
29
|
*/
|
|
30
30
|
async createCourierPartnerRule(
|
|
@@ -346,7 +346,7 @@ class Serviceability {
|
|
|
346
346
|
* - Success response
|
|
347
347
|
*
|
|
348
348
|
* @name getApplicationServiceabilitySelfShipment
|
|
349
|
-
* @summary: Self-ship configuration of application
|
|
349
|
+
* @summary: Self-ship configuration of application
|
|
350
350
|
* @description: This API returns Self-ship configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getApplicationServiceabilitySelfShipment/).
|
|
351
351
|
*/
|
|
352
352
|
async getApplicationServiceabilitySelfShipment(
|
|
@@ -424,7 +424,7 @@ class Serviceability {
|
|
|
424
424
|
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
|
|
425
425
|
* Success response
|
|
426
426
|
* @name getCourierPartnerRule
|
|
427
|
-
* @summary: Fetch of Courier Rule
|
|
427
|
+
* @summary: Fetch of Courier Rule
|
|
428
428
|
* @description: This API returns Courier Rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
429
429
|
*/
|
|
430
430
|
async getCourierPartnerRule(
|
|
@@ -851,7 +851,7 @@ class Serviceability {
|
|
|
851
851
|
* - Success response
|
|
852
852
|
*
|
|
853
853
|
* @name patchApplicationServiceabilitySelfShipment
|
|
854
|
-
* @summary: Self-ship configuration of application
|
|
854
|
+
* @summary: Self-ship configuration of application
|
|
855
855
|
* @description: This API updates Self-ship configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/patchApplicationServiceabilitySelfShipment/).
|
|
856
856
|
*/
|
|
857
857
|
async patchApplicationServiceabilitySelfShipment(
|
|
@@ -1097,7 +1097,7 @@ class Serviceability {
|
|
|
1097
1097
|
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerRule>} -
|
|
1098
1098
|
* Success response
|
|
1099
1099
|
* @name updateCourierRule
|
|
1100
|
-
* @summary: Updating of Courier Rule
|
|
1100
|
+
* @summary: Updating of Courier Rule
|
|
1101
1101
|
* @description: This API updates and returns Courier Rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierRule/).
|
|
1102
1102
|
*/
|
|
1103
1103
|
async updateCourierRule(
|
|
@@ -1182,7 +1182,7 @@ class Serviceability {
|
|
|
1182
1182
|
* - Success response
|
|
1183
1183
|
*
|
|
1184
1184
|
* @name updatePincodeAuditHistory
|
|
1185
|
-
* @summary: Update pincode audit history
|
|
1185
|
+
* @summary: Update pincode audit history
|
|
1186
1186
|
* @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
|
|
1187
1187
|
*/
|
|
1188
1188
|
async updatePincodeAuditHistory(
|
|
@@ -1265,7 +1265,7 @@ class Serviceability {
|
|
|
1265
1265
|
* - Success response
|
|
1266
1266
|
*
|
|
1267
1267
|
* @name updatePincodeBulkView
|
|
1268
|
-
* @summary: Update pincode bulk view
|
|
1268
|
+
* @summary: Update pincode bulk view
|
|
1269
1269
|
* @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
|
|
1270
1270
|
*/
|
|
1271
1271
|
async updatePincodeBulkView(
|
|
@@ -1348,7 +1348,7 @@ class Serviceability {
|
|
|
1348
1348
|
* - Success response
|
|
1349
1349
|
*
|
|
1350
1350
|
* @name updatePincodeCoDListing
|
|
1351
|
-
* @summary: Update pincode CoD (Cash on Delivery) listing
|
|
1351
|
+
* @summary: Update pincode CoD (Cash on Delivery) listing
|
|
1352
1352
|
* @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
|
|
1353
1353
|
*/
|
|
1354
1354
|
async updatePincodeCoDListing(
|
|
@@ -1430,7 +1430,7 @@ class Serviceability {
|
|
|
1430
1430
|
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
|
|
1431
1431
|
* Success response
|
|
1432
1432
|
* @name updatePincodeMopView
|
|
1433
|
-
* @summary: Update pincode MOP (Mode of Payment) view
|
|
1433
|
+
* @summary: Update pincode MOP (Mode of Payment) view
|
|
1434
1434
|
* @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
|
|
1435
1435
|
*/
|
|
1436
1436
|
async updatePincodeMopView(
|
|
@@ -48,7 +48,7 @@ declare class Serviceability {
|
|
|
48
48
|
* - Success response
|
|
49
49
|
*
|
|
50
50
|
* @name createPackageMaterial
|
|
51
|
-
* @summary: Upsert of PackageMaterial in database
|
|
51
|
+
* @summary: Upsert of PackageMaterial in database
|
|
52
52
|
* @description: This API returns response of upsert of PackageMaterial in mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
|
|
53
53
|
*/
|
|
54
54
|
createPackageMaterial({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
@@ -61,7 +61,7 @@ declare class Serviceability {
|
|
|
61
61
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
62
62
|
* Success response
|
|
63
63
|
* @name createPackageMaterialRule
|
|
64
|
-
* @summary: Upsert of Package Material Rule in database
|
|
64
|
+
* @summary: Upsert of Package Material Rule in database
|
|
65
65
|
* @description: This API returns response of upsert of Package Material Rule in mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
66
66
|
*/
|
|
67
67
|
createPackageMaterialRule({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
|
|
@@ -71,7 +71,7 @@ declare class Serviceability {
|
|
|
71
71
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
72
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
|
|
73
73
|
* @name createZone
|
|
74
|
-
* @summary: Create zone
|
|
74
|
+
* @summary: Create zone
|
|
75
75
|
* @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
|
|
76
76
|
*/
|
|
77
77
|
createZone({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneResponse>;
|
|
@@ -82,7 +82,7 @@ declare class Serviceability {
|
|
|
82
82
|
* @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResponse>} -
|
|
83
83
|
* Success response
|
|
84
84
|
* @name getAllStores
|
|
85
|
-
* @summary: Get all stores
|
|
85
|
+
* @summary: Get all stores
|
|
86
86
|
* @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
|
|
87
87
|
*/
|
|
88
88
|
getAllStores({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoresViewResponse>;
|
|
@@ -118,7 +118,7 @@ declare class Serviceability {
|
|
|
118
118
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
119
119
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
120
120
|
* @name getCompanyConfiguration
|
|
121
|
-
* @summary: Get All Courier Rules applied to company
|
|
121
|
+
* @summary: Get All Courier Rules applied to company
|
|
122
122
|
* @description: This API returns all Courier Rules applied for company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
123
123
|
*/
|
|
124
124
|
getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
@@ -131,7 +131,7 @@ declare class Serviceability {
|
|
|
131
131
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
132
132
|
* Success response
|
|
133
133
|
* @name getCourierPartnerAccount
|
|
134
|
-
* @summary: Getting Courier Account of a company from database
|
|
134
|
+
* @summary: Getting Courier Account of a company from database
|
|
135
135
|
* @description: This API returns response DpAccount of a company from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
136
136
|
*/
|
|
137
137
|
getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
|
|
@@ -145,7 +145,7 @@ declare class Serviceability {
|
|
|
145
145
|
* - Success response
|
|
146
146
|
*
|
|
147
147
|
* @name getCourierPartnerAccounts
|
|
148
|
-
* @summary: Getting Courier Account list of a company
|
|
148
|
+
* @summary: Getting Courier Account list of a company
|
|
149
149
|
* @description: This API returns Courier Account of a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
150
150
|
*/
|
|
151
151
|
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResponse>;
|
|
@@ -170,7 +170,7 @@ declare class Serviceability {
|
|
|
170
170
|
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialList>} -
|
|
171
171
|
* Success response
|
|
172
172
|
* @name getPackageMaterialList
|
|
173
|
-
* @summary: Fetching of PackageMaterials from database
|
|
173
|
+
* @summary: Fetching of PackageMaterials from database
|
|
174
174
|
* @description: This API returns response of PackageMaterials from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
|
|
175
175
|
*/
|
|
176
176
|
getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialList>;
|
|
@@ -183,7 +183,7 @@ declare class Serviceability {
|
|
|
183
183
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
184
184
|
* Success response
|
|
185
185
|
* @name getPackageMaterialRule
|
|
186
|
-
* @summary: Fetching of Package Material from database
|
|
186
|
+
* @summary: Fetching of Package Material from database
|
|
187
187
|
* @description: This API returns response of Package Material from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
188
188
|
*/
|
|
189
189
|
getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
|
|
@@ -197,7 +197,7 @@ declare class Serviceability {
|
|
|
197
197
|
* - Success response
|
|
198
198
|
*
|
|
199
199
|
* @name getPackageMaterialRules
|
|
200
|
-
* @summary: Fetching of Package Material Rules from database
|
|
200
|
+
* @summary: Fetching of Package Material Rules from database
|
|
201
201
|
* @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
|
|
202
202
|
*/
|
|
203
203
|
getPackageMaterialRules({ pageNo, pageSize, isActive, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialRuleList>;
|
|
@@ -209,7 +209,7 @@ declare class Serviceability {
|
|
|
209
209
|
* - Success response
|
|
210
210
|
*
|
|
211
211
|
* @name getPackageMaterials
|
|
212
|
-
* @summary: Fetching of Package Material from database
|
|
212
|
+
* @summary: Fetching of Package Material from database
|
|
213
213
|
* @description: This API returns response of Package Material from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
214
214
|
*/
|
|
215
215
|
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
@@ -253,7 +253,7 @@ declare class Serviceability {
|
|
|
253
253
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
254
254
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
255
255
|
* @name updateCompanyConfiguration
|
|
256
|
-
* @summary: Apply Courier Rule to company
|
|
256
|
+
* @summary: Apply Courier Rule to company
|
|
257
257
|
* @description: Apply Courier Rule to company with rules priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
258
258
|
*/
|
|
259
259
|
updateCompanyConfiguration({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
@@ -266,7 +266,7 @@ declare class Serviceability {
|
|
|
266
266
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
267
267
|
* Success response
|
|
268
268
|
* @name updateCourierPartnerAccount
|
|
269
|
-
* @summary: Update Courier Account in database
|
|
269
|
+
* @summary: Update Courier Account in database
|
|
270
270
|
* @description: Updates Courier Account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
271
271
|
*/
|
|
272
272
|
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResponse>;
|
|
@@ -279,7 +279,7 @@ declare class Serviceability {
|
|
|
279
279
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
280
280
|
* Success response
|
|
281
281
|
* @name updatePackageMaterialRule
|
|
282
|
-
* @summary: Fetching of Package Material Rules into database
|
|
282
|
+
* @summary: Fetching of Package Material Rules into database
|
|
283
283
|
* @description: This API updates Package Material Rules into mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
284
284
|
*/
|
|
285
285
|
updatePackageMaterialRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResponse>;
|
|
@@ -293,7 +293,7 @@ declare class Serviceability {
|
|
|
293
293
|
* - Success response
|
|
294
294
|
*
|
|
295
295
|
* @name updatePackageMaterials
|
|
296
|
-
* @summary: Update Package Material to database
|
|
296
|
+
* @summary: Update Package Material to database
|
|
297
297
|
* @description: This API updates Package Materials from into mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
|
|
298
298
|
*/
|
|
299
299
|
updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResponse>;
|
|
@@ -279,7 +279,7 @@ class Serviceability {
|
|
|
279
279
|
* - Success response
|
|
280
280
|
*
|
|
281
281
|
* @name createPackageMaterial
|
|
282
|
-
* @summary: Upsert of PackageMaterial in database
|
|
282
|
+
* @summary: Upsert of PackageMaterial in database
|
|
283
283
|
* @description: This API returns response of upsert of PackageMaterial in mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterial/).
|
|
284
284
|
*/
|
|
285
285
|
async createPackageMaterial(
|
|
@@ -363,7 +363,7 @@ class Serviceability {
|
|
|
363
363
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
364
364
|
* Success response
|
|
365
365
|
* @name createPackageMaterialRule
|
|
366
|
-
* @summary: Upsert of Package Material Rule in database
|
|
366
|
+
* @summary: Upsert of Package Material Rule in database
|
|
367
367
|
* @description: This API returns response of upsert of Package Material Rule in mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
368
368
|
*/
|
|
369
369
|
async createPackageMaterialRule(
|
|
@@ -444,7 +444,7 @@ class Serviceability {
|
|
|
444
444
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
445
445
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
|
|
446
446
|
* @name createZone
|
|
447
|
-
* @summary: Create zone
|
|
447
|
+
* @summary: Create zone
|
|
448
448
|
* @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
|
|
449
449
|
*/
|
|
450
450
|
async createZone(
|
|
@@ -524,7 +524,7 @@ class Serviceability {
|
|
|
524
524
|
* @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResponse>} -
|
|
525
525
|
* Success response
|
|
526
526
|
* @name getAllStores
|
|
527
|
-
* @summary: Get all stores
|
|
527
|
+
* @summary: Get all stores
|
|
528
528
|
* @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
|
|
529
529
|
*/
|
|
530
530
|
async getAllStores(
|
|
@@ -849,7 +849,7 @@ class Serviceability {
|
|
|
849
849
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
850
850
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
851
851
|
* @name getCompanyConfiguration
|
|
852
|
-
* @summary: Get All Courier Rules applied to company
|
|
852
|
+
* @summary: Get All Courier Rules applied to company
|
|
853
853
|
* @description: This API returns all Courier Rules applied for company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
854
854
|
*/
|
|
855
855
|
async getCompanyConfiguration(
|
|
@@ -929,7 +929,7 @@ class Serviceability {
|
|
|
929
929
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
930
930
|
* Success response
|
|
931
931
|
* @name getCourierPartnerAccount
|
|
932
|
-
* @summary: Getting Courier Account of a company from database
|
|
932
|
+
* @summary: Getting Courier Account of a company from database
|
|
933
933
|
* @description: This API returns response DpAccount of a company from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
934
934
|
*/
|
|
935
935
|
async getCourierPartnerAccount(
|
|
@@ -1014,7 +1014,7 @@ class Serviceability {
|
|
|
1014
1014
|
* - Success response
|
|
1015
1015
|
*
|
|
1016
1016
|
* @name getCourierPartnerAccounts
|
|
1017
|
-
* @summary: Getting Courier Account list of a company
|
|
1017
|
+
* @summary: Getting Courier Account list of a company
|
|
1018
1018
|
* @description: This API returns Courier Account of a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
1019
1019
|
*/
|
|
1020
1020
|
async getCourierPartnerAccounts(
|
|
@@ -1196,7 +1196,7 @@ class Serviceability {
|
|
|
1196
1196
|
* @returns {Promise<ServiceabilityPlatformModel.PackageMaterialList>} -
|
|
1197
1197
|
* Success response
|
|
1198
1198
|
* @name getPackageMaterialList
|
|
1199
|
-
* @summary: Fetching of PackageMaterials from database
|
|
1199
|
+
* @summary: Fetching of PackageMaterials from database
|
|
1200
1200
|
* @description: This API returns response of PackageMaterials from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialList/).
|
|
1201
1201
|
*/
|
|
1202
1202
|
async getPackageMaterialList(
|
|
@@ -1295,7 +1295,7 @@ class Serviceability {
|
|
|
1295
1295
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
1296
1296
|
* Success response
|
|
1297
1297
|
* @name getPackageMaterialRule
|
|
1298
|
-
* @summary: Fetching of Package Material from database
|
|
1298
|
+
* @summary: Fetching of Package Material from database
|
|
1299
1299
|
* @description: This API returns response of Package Material from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
1300
1300
|
*/
|
|
1301
1301
|
async getPackageMaterialRule(
|
|
@@ -1380,7 +1380,7 @@ class Serviceability {
|
|
|
1380
1380
|
* - Success response
|
|
1381
1381
|
*
|
|
1382
1382
|
* @name getPackageMaterialRules
|
|
1383
|
-
* @summary: Fetching of Package Material Rules from database
|
|
1383
|
+
* @summary: Fetching of Package Material Rules from database
|
|
1384
1384
|
* @description: This API returns response of Package Materials Rules from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterialRules/).
|
|
1385
1385
|
*/
|
|
1386
1386
|
async getPackageMaterialRules(
|
|
@@ -1470,7 +1470,7 @@ class Serviceability {
|
|
|
1470
1470
|
* - Success response
|
|
1471
1471
|
*
|
|
1472
1472
|
* @name getPackageMaterials
|
|
1473
|
-
* @summary: Fetching of Package Material from database
|
|
1473
|
+
* @summary: Fetching of Package Material from database
|
|
1474
1474
|
* @description: This API returns response of Package Material from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
1475
1475
|
*/
|
|
1476
1476
|
async getPackageMaterials(
|
|
@@ -1840,7 +1840,7 @@ class Serviceability {
|
|
|
1840
1840
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1841
1841
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
1842
1842
|
* @name updateCompanyConfiguration
|
|
1843
|
-
* @summary: Apply Courier Rule to company
|
|
1843
|
+
* @summary: Apply Courier Rule to company
|
|
1844
1844
|
* @description: Apply Courier Rule to company with rules priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
1845
1845
|
*/
|
|
1846
1846
|
async updateCompanyConfiguration(
|
|
@@ -1924,7 +1924,7 @@ class Serviceability {
|
|
|
1924
1924
|
* @returns {Promise<ServiceabilityPlatformModel.CourierAccountResponse>} -
|
|
1925
1925
|
* Success response
|
|
1926
1926
|
* @name updateCourierPartnerAccount
|
|
1927
|
-
* @summary: Update Courier Account in database
|
|
1927
|
+
* @summary: Update Courier Account in database
|
|
1928
1928
|
* @description: Updates Courier Account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
1929
1929
|
*/
|
|
1930
1930
|
async updateCourierPartnerAccount(
|
|
@@ -2010,7 +2010,7 @@ class Serviceability {
|
|
|
2010
2010
|
* @returns {Promise<ServiceabilityPlatformModel.PackageRuleResponse>} -
|
|
2011
2011
|
* Success response
|
|
2012
2012
|
* @name updatePackageMaterialRule
|
|
2013
|
-
* @summary: Fetching of Package Material Rules into database
|
|
2013
|
+
* @summary: Fetching of Package Material Rules into database
|
|
2014
2014
|
* @description: This API updates Package Material Rules into mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
2015
2015
|
*/
|
|
2016
2016
|
async updatePackageMaterialRule(
|
|
@@ -2097,7 +2097,7 @@ class Serviceability {
|
|
|
2097
2097
|
* - Success response
|
|
2098
2098
|
*
|
|
2099
2099
|
* @name updatePackageMaterials
|
|
2100
|
-
* @summary: Update Package Material to database
|
|
2100
|
+
* @summary: Update Package Material to database
|
|
2101
2101
|
* @description: This API updates Package Materials from into mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePackageMaterials/).
|
|
2102
2102
|
*/
|
|
2103
2103
|
async updatePackageMaterials(
|
|
@@ -955,7 +955,6 @@ export = ServiceabilityPlatformModel;
|
|
|
955
955
|
* @property {number[]} ignore_locations
|
|
956
956
|
* @property {number[]} assign_locations
|
|
957
957
|
* @property {number} [seller_id]
|
|
958
|
-
* @property {number} [store_id]
|
|
959
958
|
*/
|
|
960
959
|
/**
|
|
961
960
|
* @typedef OptimlLocationsRequestSchema
|
|
@@ -990,6 +989,7 @@ export = ServiceabilityPlatformModel;
|
|
|
990
989
|
/**
|
|
991
990
|
* @typedef OptimalLocationsResponse
|
|
992
991
|
* @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
|
|
992
|
+
* @property {ErrorResponse[]} [faulty_articles]
|
|
993
993
|
*/
|
|
994
994
|
declare class ServiceabilityPlatformModel {
|
|
995
995
|
}
|
|
@@ -2105,7 +2105,6 @@ type OptimalLocationsArticles = {
|
|
|
2105
2105
|
ignore_locations: number[];
|
|
2106
2106
|
assign_locations: number[];
|
|
2107
2107
|
seller_id?: number;
|
|
2108
|
-
store_id?: number;
|
|
2109
2108
|
};
|
|
2110
2109
|
/** @returns {OptimlLocationsRequestSchema} */
|
|
2111
2110
|
declare function OptimlLocationsRequestSchema(): OptimlLocationsRequestSchema;
|
|
@@ -2144,4 +2143,5 @@ type OptimalLocationAssignedStoresResponse = {
|
|
|
2144
2143
|
declare function OptimalLocationsResponse(): OptimalLocationsResponse;
|
|
2145
2144
|
type OptimalLocationsResponse = {
|
|
2146
2145
|
assigned_stores: OptimalLocationAssignedStoresResponse[];
|
|
2146
|
+
faulty_articles?: ErrorResponse[];
|
|
2147
2147
|
};
|
|
@@ -1081,7 +1081,6 @@ const Joi = require("joi");
|
|
|
1081
1081
|
* @property {number[]} ignore_locations
|
|
1082
1082
|
* @property {number[]} assign_locations
|
|
1083
1083
|
* @property {number} [seller_id]
|
|
1084
|
-
* @property {number} [store_id]
|
|
1085
1084
|
*/
|
|
1086
1085
|
|
|
1087
1086
|
/**
|
|
@@ -1120,6 +1119,7 @@ const Joi = require("joi");
|
|
|
1120
1119
|
/**
|
|
1121
1120
|
* @typedef OptimalLocationsResponse
|
|
1122
1121
|
* @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
|
|
1122
|
+
* @property {ErrorResponse[]} [faulty_articles]
|
|
1123
1123
|
*/
|
|
1124
1124
|
|
|
1125
1125
|
class ServiceabilityPlatformModel {
|
|
@@ -2532,7 +2532,6 @@ class ServiceabilityPlatformModel {
|
|
|
2532
2532
|
ignore_locations: Joi.array().items(Joi.number()).required(),
|
|
2533
2533
|
assign_locations: Joi.array().items(Joi.number()).required(),
|
|
2534
2534
|
seller_id: Joi.number(),
|
|
2535
|
-
store_id: Joi.number(),
|
|
2536
2535
|
});
|
|
2537
2536
|
}
|
|
2538
2537
|
|
|
@@ -2585,6 +2584,9 @@ class ServiceabilityPlatformModel {
|
|
|
2585
2584
|
ServiceabilityPlatformModel.OptimalLocationAssignedStoresResponse()
|
|
2586
2585
|
)
|
|
2587
2586
|
.required(),
|
|
2587
|
+
faulty_articles: Joi.array().items(
|
|
2588
|
+
ServiceabilityPlatformModel.ErrorResponse()
|
|
2589
|
+
),
|
|
2588
2590
|
});
|
|
2589
2591
|
}
|
|
2590
2592
|
}
|
|
@@ -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>;
|
|
@@ -31,7 +31,7 @@ declare class Share {
|
|
|
31
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
32
|
* @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
|
|
33
33
|
* @name getShortLinkClickStats
|
|
34
|
-
* @summary: Get short link click statistics
|
|
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
37
|
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
|
|
@@ -41,7 +41,7 @@ declare class Share {
|
|
|
41
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
42
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
43
43
|
* @name getShortLinks
|
|
44
|
-
* @summary: Get short links
|
|
44
|
+
* @summary: Get short links
|
|
45
45
|
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
46
46
|
*/
|
|
47
47
|
getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
|
|
@@ -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 by ID
|
|
56
|
+
* @summary: Update short link by ID
|
|
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>;
|