@gofynd/fdk-client-javascript 1.2.0 → 1.3.0
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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -147,7 +147,7 @@ export = CartApplicationModel;
|
|
|
147
147
|
* @property {string} [billing_address_id]
|
|
148
148
|
* @property {string} [callback_url]
|
|
149
149
|
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
150
|
-
* @property {
|
|
150
|
+
* @property {Object} [customer_details] - Customer details
|
|
151
151
|
* @property {Object} [delivery_address]
|
|
152
152
|
* @property {Object} [extra_meta]
|
|
153
153
|
* @property {string} [id]
|
|
@@ -170,7 +170,7 @@ export = CartApplicationModel;
|
|
|
170
170
|
* @property {string} [callback_url]
|
|
171
171
|
* @property {string} [cart_id]
|
|
172
172
|
* @property {Object} [custom_meta]
|
|
173
|
-
* @property {
|
|
173
|
+
* @property {Object} [customer_details] - Customer details
|
|
174
174
|
* @property {Object} [delivery_address]
|
|
175
175
|
* @property {Object} [extra_meta]
|
|
176
176
|
* @property {string} [id]
|
|
@@ -1074,7 +1074,7 @@ type CartCheckoutDetailRequest = {
|
|
|
1074
1074
|
/**
|
|
1075
1075
|
* - Customer details
|
|
1076
1076
|
*/
|
|
1077
|
-
customer_details?:
|
|
1077
|
+
customer_details?: any;
|
|
1078
1078
|
delivery_address?: any;
|
|
1079
1079
|
extra_meta?: any;
|
|
1080
1080
|
id?: string;
|
|
@@ -1101,7 +1101,7 @@ type CartCheckoutDetailV2Request = {
|
|
|
1101
1101
|
/**
|
|
1102
1102
|
* - Customer details
|
|
1103
1103
|
*/
|
|
1104
|
-
customer_details?:
|
|
1104
|
+
customer_details?: any;
|
|
1105
1105
|
delivery_address?: any;
|
|
1106
1106
|
extra_meta?: any;
|
|
1107
1107
|
id?: string;
|
|
@@ -165,7 +165,7 @@ const Joi = require("joi");
|
|
|
165
165
|
* @property {string} [billing_address_id]
|
|
166
166
|
* @property {string} [callback_url]
|
|
167
167
|
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
168
|
-
* @property {
|
|
168
|
+
* @property {Object} [customer_details] - Customer details
|
|
169
169
|
* @property {Object} [delivery_address]
|
|
170
170
|
* @property {Object} [extra_meta]
|
|
171
171
|
* @property {string} [id]
|
|
@@ -189,7 +189,7 @@ const Joi = require("joi");
|
|
|
189
189
|
* @property {string} [callback_url]
|
|
190
190
|
* @property {string} [cart_id]
|
|
191
191
|
* @property {Object} [custom_meta]
|
|
192
|
-
* @property {
|
|
192
|
+
* @property {Object} [customer_details] - Customer details
|
|
193
193
|
* @property {Object} [delivery_address]
|
|
194
194
|
* @property {Object} [extra_meta]
|
|
195
195
|
* @property {string} [id]
|
|
@@ -1130,7 +1130,7 @@ class CartApplicationModel {
|
|
|
1130
1130
|
custom_meta: Joi.array().items(
|
|
1131
1131
|
CartApplicationModel.CartCheckoutCustomMeta()
|
|
1132
1132
|
),
|
|
1133
|
-
customer_details:
|
|
1133
|
+
customer_details: Joi.any().allow(null),
|
|
1134
1134
|
delivery_address: Joi.any(),
|
|
1135
1135
|
extra_meta: Joi.any(),
|
|
1136
1136
|
id: Joi.string().allow("").allow(null),
|
|
@@ -1156,7 +1156,7 @@ class CartApplicationModel {
|
|
|
1156
1156
|
callback_url: Joi.string().allow("").allow(null),
|
|
1157
1157
|
cart_id: Joi.string().allow(""),
|
|
1158
1158
|
custom_meta: Joi.any(),
|
|
1159
|
-
customer_details:
|
|
1159
|
+
customer_details: Joi.any().allow(null),
|
|
1160
1160
|
delivery_address: Joi.any(),
|
|
1161
1161
|
extra_meta: Joi.any(),
|
|
1162
1162
|
id: Joi.string().allow("").allow(null),
|
|
@@ -38,31 +38,34 @@ declare class Catalog {
|
|
|
38
38
|
updateUrls(urls: any): void;
|
|
39
39
|
/**
|
|
40
40
|
* @param {CatalogApplicationValidator.FollowByIdParam} arg - Arg object.
|
|
41
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
43
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
43
44
|
* @name followById
|
|
44
45
|
* @summary: Follow an entity (product/brand/collection)
|
|
45
46
|
* @description: Follow a particular entity such as product, brand, collection specified by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
46
47
|
*/
|
|
47
|
-
followById({ collectionType, collectionId }?: CatalogApplicationValidator.FollowByIdParam, {
|
|
48
|
+
followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
48
49
|
/**
|
|
49
50
|
* @param {CatalogApplicationValidator.GetBrandDetailBySlugParam} arg - Arg object.
|
|
51
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
52
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
53
|
* @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
|
|
52
54
|
* @name getBrandDetailBySlug
|
|
53
55
|
* @summary: Get metadata of a brand
|
|
54
56
|
* @description: Fetch metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrandDetailBySlug/).
|
|
55
57
|
*/
|
|
56
|
-
getBrandDetailBySlug({ slug }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, {
|
|
58
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandDetailResponse>;
|
|
57
59
|
/**
|
|
58
60
|
* @param {CatalogApplicationValidator.GetBrandsParam} arg - Arg object.
|
|
61
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
62
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
60
63
|
* @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
|
|
61
64
|
* @name getBrands
|
|
62
65
|
* @summary: Get all the brands
|
|
63
66
|
* @description: A brand is the name under which a product is sold. Use this API to list all the brands. You can also filter the brands by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
64
67
|
*/
|
|
65
|
-
getBrands({ department, pageNo, pageSize }?: CatalogApplicationValidator.GetBrandsParam, {
|
|
68
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandListingResponse>;
|
|
66
69
|
/**
|
|
67
70
|
* @param {Object} arg - Arg object.
|
|
68
71
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -80,6 +83,7 @@ declare class Catalog {
|
|
|
80
83
|
}): Paginator<CatalogApplicationModel.BrandListingResponse>;
|
|
81
84
|
/**
|
|
82
85
|
* @param {CatalogApplicationValidator.GetCategoriesParam} arg - Arg object.
|
|
86
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
83
87
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
84
88
|
* @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
|
|
85
89
|
* Success response
|
|
@@ -87,20 +91,22 @@ declare class Catalog {
|
|
|
87
91
|
* @summary: List all the categories
|
|
88
92
|
* @description: Use this API to list all the categories. You can also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
89
93
|
*/
|
|
90
|
-
getCategories({ department }?: CatalogApplicationValidator.GetCategoriesParam, {
|
|
94
|
+
getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryListingResponse>;
|
|
91
95
|
/**
|
|
92
96
|
* @param {CatalogApplicationValidator.GetCategoryDetailBySlugParam} arg - Arg object.
|
|
97
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
93
98
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
94
99
|
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
|
|
95
100
|
* @name getCategoryDetailBySlug
|
|
96
101
|
* @summary: Get metadata of a category
|
|
97
102
|
* @description: Fetch metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
98
103
|
*/
|
|
99
|
-
getCategoryDetailBySlug({ slug }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, {
|
|
104
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryMetaResponse>;
|
|
100
105
|
/**
|
|
101
106
|
* @param {CatalogApplicationValidator.GetCollectionDetailBySlugParam} arg
|
|
102
107
|
* - Arg object.
|
|
103
108
|
*
|
|
109
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
110
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
105
111
|
* @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
|
|
106
112
|
* Success response
|
|
@@ -108,10 +114,11 @@ declare class Catalog {
|
|
|
108
114
|
* @summary: Get a particular collection
|
|
109
115
|
* @description: Get the details of a collection by its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
110
116
|
*/
|
|
111
|
-
getCollectionDetailBySlug({ slug }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, {
|
|
117
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CollectionDetailResponse>;
|
|
112
118
|
/**
|
|
113
119
|
* @param {CatalogApplicationValidator.GetCollectionItemsBySlugParam} arg -
|
|
114
120
|
* Arg object.
|
|
121
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
115
122
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
116
123
|
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
117
124
|
* Success response
|
|
@@ -119,7 +126,7 @@ declare class Catalog {
|
|
|
119
126
|
* @summary: Get the items in a collection
|
|
120
127
|
* @description: Get items in a collection specified by its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
121
128
|
*/
|
|
122
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, {
|
|
129
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
123
130
|
/**
|
|
124
131
|
* @param {Object} arg - Arg object.
|
|
125
132
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -151,6 +158,7 @@ declare class Catalog {
|
|
|
151
158
|
}): Paginator<CatalogApplicationModel.ProductListingResponse>;
|
|
152
159
|
/**
|
|
153
160
|
* @param {CatalogApplicationValidator.GetCollectionsParam} arg - Arg object.
|
|
161
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
154
162
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
155
163
|
* @returns {Promise<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
156
164
|
* - Success response
|
|
@@ -159,7 +167,7 @@ declare class Catalog {
|
|
|
159
167
|
* @summary: List all the collections
|
|
160
168
|
* @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
161
169
|
*/
|
|
162
|
-
getCollections({ pageNo, pageSize, tag, q }?: CatalogApplicationValidator.GetCollectionsParam, {
|
|
170
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
|
|
163
171
|
/**
|
|
164
172
|
* @param {Object} arg - Arg object.
|
|
165
173
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
@@ -178,6 +186,7 @@ declare class Catalog {
|
|
|
178
186
|
* @param {CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam} arg
|
|
179
187
|
* - Arg object.
|
|
180
188
|
*
|
|
189
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
190
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
182
191
|
* @returns {Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>}
|
|
183
192
|
* - Success response
|
|
@@ -186,26 +195,30 @@ declare class Catalog {
|
|
|
186
195
|
* @summary: Get comparison between frequently compared products with the given product
|
|
187
196
|
* @description: Use this API to compare a given product automatically with products that are frequently compared with it. Only one slug is needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
188
197
|
*/
|
|
189
|
-
getComparedFrequentlyProductBySlug({ slug }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, {
|
|
198
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>;
|
|
190
199
|
/**
|
|
200
|
+
* @param {CatalogApplicationValidator.GetDepartmentsParam} arg - Arg object.
|
|
201
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
191
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
192
203
|
* @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
|
|
193
204
|
* @name getDepartments
|
|
194
205
|
* @summary: List all the departments
|
|
195
206
|
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
196
207
|
*/
|
|
197
|
-
getDepartments({
|
|
208
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogApplicationModel.DepartmentResponse>;
|
|
198
209
|
/**
|
|
199
210
|
* @param {CatalogApplicationValidator.GetFollowIdsParam} arg - Arg object.
|
|
211
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
200
212
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
201
213
|
* @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
|
|
202
214
|
* @name getFollowIds
|
|
203
215
|
* @summary: Get the IDs of followed products, brands and collections.
|
|
204
216
|
* @description: You can get the IDs of all the followed Products, Brands and Collections. Pass collection_type as query parameter to fetch specific Ids - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
205
217
|
*/
|
|
206
|
-
getFollowIds({ collectionType }?: CatalogApplicationValidator.GetFollowIdsParam, {
|
|
218
|
+
getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowIdsResponse>;
|
|
207
219
|
/**
|
|
208
220
|
* @param {CatalogApplicationValidator.GetFollowedListingParam} arg - Arg object.
|
|
221
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
209
222
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
210
223
|
* @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
|
|
211
224
|
* Success response
|
|
@@ -213,7 +226,7 @@ declare class Catalog {
|
|
|
213
226
|
* @summary: Get a list of followed Products, Brands, Collections
|
|
214
227
|
* @description: Users can follow a product they like. This API retrieves the products the user have followed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
215
228
|
*/
|
|
216
|
-
getFollowedListing({ collectionType, pageId, pageSize }?: CatalogApplicationValidator.GetFollowedListingParam, {
|
|
229
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponse>;
|
|
217
230
|
/**
|
|
218
231
|
* @param {Object} arg - Arg object.
|
|
219
232
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
@@ -229,6 +242,7 @@ declare class Catalog {
|
|
|
229
242
|
}): Paginator<CatalogApplicationModel.GetFollowListingResponse>;
|
|
230
243
|
/**
|
|
231
244
|
* @param {CatalogApplicationValidator.GetFollowerCountByIdParam} arg - Arg object.
|
|
245
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
232
246
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
233
247
|
* @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
|
|
234
248
|
* Success response
|
|
@@ -236,16 +250,17 @@ declare class Catalog {
|
|
|
236
250
|
* @summary: Get Follow Count
|
|
237
251
|
* @description: Get the total count of followers for a given collection type and collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
|
|
238
252
|
*/
|
|
239
|
-
getFollowerCountById({ collectionType, collectionId }?: CatalogApplicationValidator.GetFollowerCountByIdParam, {
|
|
253
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowerCountResponse>;
|
|
240
254
|
/**
|
|
241
255
|
* @param {CatalogApplicationValidator.GetHomeProductsParam} arg - Arg object.
|
|
256
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
242
257
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
243
258
|
* @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
|
|
244
259
|
* @name getHomeProducts
|
|
245
260
|
* @summary: List the products
|
|
246
261
|
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getHomeProducts/).
|
|
247
262
|
*/
|
|
248
|
-
getHomeProducts({ sortOn, pageId, pageSize }?: CatalogApplicationValidator.GetHomeProductsParam, {
|
|
263
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetHomeProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.HomeListingResponse>;
|
|
249
264
|
/**
|
|
250
265
|
* @param {Object} arg - Arg object.
|
|
251
266
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
@@ -262,6 +277,7 @@ declare class Catalog {
|
|
|
262
277
|
}): Paginator<CatalogApplicationModel.HomeListingResponse>;
|
|
263
278
|
/**
|
|
264
279
|
* @param {CatalogApplicationValidator.GetInStockLocationsParam} arg - Arg object.
|
|
280
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
265
281
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
266
282
|
* @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
|
|
267
283
|
* Success response
|
|
@@ -269,7 +285,7 @@ declare class Catalog {
|
|
|
269
285
|
* @summary: Get store meta information.
|
|
270
286
|
* @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
271
287
|
*/
|
|
272
|
-
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude }?: CatalogApplicationValidator.GetInStockLocationsParam, {
|
|
288
|
+
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetInStockLocationsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ApplicationStoreListing>;
|
|
273
289
|
/**
|
|
274
290
|
* @param {Object} arg - Arg object.
|
|
275
291
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -295,26 +311,29 @@ declare class Catalog {
|
|
|
295
311
|
}): Paginator<CatalogApplicationModel.ApplicationStoreListing>;
|
|
296
312
|
/**
|
|
297
313
|
* @param {CatalogApplicationValidator.GetLocationDetailsByIdParam} arg - Arg object.
|
|
314
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
298
315
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
299
316
|
* @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
|
|
300
317
|
* @name getLocationDetailsById
|
|
301
318
|
* @summary: Get store meta information.
|
|
302
319
|
* @description: Use this API to get meta details for a store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
303
320
|
*/
|
|
304
|
-
getLocationDetailsById({ locationId }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, {
|
|
321
|
+
getLocationDetailsById({ locationId, requestHeaders }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreDetails>;
|
|
305
322
|
/**
|
|
306
323
|
* @param {CatalogApplicationValidator.GetProductBundlesBySlugParam} arg - Arg object.
|
|
324
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
307
325
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
308
326
|
* @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
|
|
309
327
|
* @name getProductBundlesBySlug
|
|
310
328
|
* @summary: Get product bundles
|
|
311
329
|
* @description: Use this API to retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
312
330
|
*/
|
|
313
|
-
getProductBundlesBySlug({ slug, id }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, {
|
|
331
|
+
getProductBundlesBySlug({ slug, id, requestHeaders }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductBundle>;
|
|
314
332
|
/**
|
|
315
333
|
* @param {CatalogApplicationValidator.GetProductComparisonBySlugsParam} arg
|
|
316
334
|
* - Arg object.
|
|
317
335
|
*
|
|
336
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
318
337
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
319
338
|
* @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
|
|
320
339
|
* Success response
|
|
@@ -322,18 +341,20 @@ declare class Catalog {
|
|
|
322
341
|
* @summary: Compare products
|
|
323
342
|
* @description: Use this API to compare the features of products belonging to the same category. Note that at least one slug is mandatory in the request query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
324
343
|
*/
|
|
325
|
-
getProductComparisonBySlugs({ slug }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, {
|
|
344
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductsComparisonResponse>;
|
|
326
345
|
/**
|
|
327
346
|
* @param {CatalogApplicationValidator.GetProductDetailBySlugParam} arg - Arg object.
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
328
348
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
329
349
|
* @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
|
|
330
350
|
* @name getProductDetailBySlug
|
|
331
351
|
* @summary: Get a product
|
|
332
352
|
* @description: Use this API to retrieve a product by its slug value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
333
353
|
*/
|
|
334
|
-
getProductDetailBySlug({ slug }?: CatalogApplicationValidator.GetProductDetailBySlugParam, {
|
|
354
|
+
getProductDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductDetail>;
|
|
335
355
|
/**
|
|
336
356
|
* @param {CatalogApplicationValidator.GetProductPriceBySlugParam} arg - Arg object.
|
|
357
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
358
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
338
359
|
* @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
|
|
339
360
|
* Success response
|
|
@@ -341,9 +362,10 @@ declare class Catalog {
|
|
|
341
362
|
* @summary: Get the price of a product size at a PIN Code
|
|
342
363
|
* @description: Prices may vary for different sizes of a product. Use this API to retrieve the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
|
|
343
364
|
*/
|
|
344
|
-
getProductPriceBySlug({ slug, size, storeId, pincode, moq }?: CatalogApplicationValidator.GetProductPriceBySlugParam, {
|
|
365
|
+
getProductPriceBySlug({ slug, size, storeId, pincode, moq, requestHeaders }?: CatalogApplicationValidator.GetProductPriceBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizePriceResponseV3>;
|
|
345
366
|
/**
|
|
346
367
|
* @param {CatalogApplicationValidator.GetProductSellersBySlugParam} arg - Arg object.
|
|
368
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
347
369
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
348
370
|
* @returns {Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
349
371
|
* - Success response
|
|
@@ -352,7 +374,7 @@ declare class Catalog {
|
|
|
352
374
|
* @summary: Get the sellers of a product size at a PIN Code
|
|
353
375
|
* @description: A product of a particular size may be sold by multiple sellers. Use this API to fetch the sellers having the stock of a particular size at a given PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
354
376
|
*/
|
|
355
|
-
getProductSellersBySlug({ slug, size, pincode, strategy, pageNo, pageSize }?: CatalogApplicationValidator.GetProductSellersBySlugParam, {
|
|
377
|
+
getProductSellersBySlug({ slug, size, pincode, strategy, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetProductSellersBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
356
378
|
/**
|
|
357
379
|
* @param {Object} arg - Arg object.
|
|
358
380
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -379,15 +401,17 @@ declare class Catalog {
|
|
|
379
401
|
}): Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
380
402
|
/**
|
|
381
403
|
* @param {CatalogApplicationValidator.GetProductSizesBySlugParam} arg - Arg object.
|
|
404
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
382
405
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
383
406
|
* @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
|
|
384
407
|
* @name getProductSizesBySlug
|
|
385
408
|
* @summary: Get the sizes of a product
|
|
386
409
|
* @description: A product can have multiple sizes. Use this API to fetch all the available sizes of a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
|
|
387
410
|
*/
|
|
388
|
-
getProductSizesBySlug({ slug, storeId }?: CatalogApplicationValidator.GetProductSizesBySlugParam, {
|
|
411
|
+
getProductSizesBySlug({ slug, storeId, requestHeaders }?: CatalogApplicationValidator.GetProductSizesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizes>;
|
|
389
412
|
/**
|
|
390
413
|
* @param {CatalogApplicationValidator.GetProductStockByIdsParam} arg - Arg object.
|
|
414
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
391
415
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
392
416
|
* @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
|
|
393
417
|
* Success response
|
|
@@ -395,18 +419,19 @@ declare class Catalog {
|
|
|
395
419
|
* @summary: Get the stock of a product
|
|
396
420
|
* @description: Retrieve the available stock of the products. Use this API to retrieve stock of multiple products (up to 50) at a time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
397
421
|
*/
|
|
398
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc }?: CatalogApplicationValidator.GetProductStockByIdsParam, {
|
|
422
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockStatusResponse>;
|
|
399
423
|
/**
|
|
400
424
|
* @param {CatalogApplicationValidator.GetProductStockForTimeByIdsParam} arg
|
|
401
425
|
* - Arg object.
|
|
402
426
|
*
|
|
427
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
403
428
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
404
429
|
* @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
|
|
405
430
|
* @name getProductStockForTimeByIds
|
|
406
431
|
* @summary: Get the stock of a product
|
|
407
432
|
* @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
408
433
|
*/
|
|
409
|
-
getProductStockForTimeByIds({ timestamp, pageSize, pageId }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, {
|
|
434
|
+
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockPolling>;
|
|
410
435
|
/**
|
|
411
436
|
* @param {Object} arg - Arg object.
|
|
412
437
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
@@ -422,6 +447,7 @@ declare class Catalog {
|
|
|
422
447
|
/**
|
|
423
448
|
* @param {CatalogApplicationValidator.GetProductVariantsBySlugParam} arg -
|
|
424
449
|
* Arg object.
|
|
450
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
425
451
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
426
452
|
* @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
|
|
427
453
|
* Success response
|
|
@@ -429,9 +455,10 @@ declare class Catalog {
|
|
|
429
455
|
* @summary: Get variant of a particular product
|
|
430
456
|
* @description: A product can have a different type of variants such as colour, shade, memory. Use this API to fetch all the available variants of a product using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
|
|
431
457
|
*/
|
|
432
|
-
getProductVariantsBySlug({ slug }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, {
|
|
458
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponse>;
|
|
433
459
|
/**
|
|
434
460
|
* @param {CatalogApplicationValidator.GetProductsParam} arg - Arg object.
|
|
461
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
435
462
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
436
463
|
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
437
464
|
* Success response
|
|
@@ -439,7 +466,7 @@ declare class Catalog {
|
|
|
439
466
|
* @summary: Get all the products
|
|
440
467
|
* @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
441
468
|
*/
|
|
442
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType }?: CatalogApplicationValidator.GetProductsParam, {
|
|
469
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
443
470
|
/**
|
|
444
471
|
* @param {Object} arg - Arg object.
|
|
445
472
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -467,17 +494,19 @@ declare class Catalog {
|
|
|
467
494
|
}): Paginator<CatalogApplicationModel.ProductListingResponse>;
|
|
468
495
|
/**
|
|
469
496
|
* @param {CatalogApplicationValidator.GetSearchResultsParam} arg - Arg object.
|
|
497
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
470
498
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
471
499
|
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
|
|
472
500
|
* @name getSearchResults
|
|
473
501
|
* @summary: Get relevant suggestions for a search query
|
|
474
502
|
* @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
475
503
|
*/
|
|
476
|
-
getSearchResults({ q }?: CatalogApplicationValidator.GetSearchResultsParam, {
|
|
504
|
+
getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.AutoCompleteResponse>;
|
|
477
505
|
/**
|
|
478
506
|
* @param {CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam} arg
|
|
479
507
|
* - Arg object.
|
|
480
508
|
*
|
|
509
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
481
510
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
482
511
|
* @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
|
|
483
512
|
* Success response
|
|
@@ -485,16 +514,17 @@ declare class Catalog {
|
|
|
485
514
|
* @summary: Get comparison between similar products
|
|
486
515
|
* @description: Use this API to compare a given product automatically with similar products. Only one slug is needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
487
516
|
*/
|
|
488
|
-
getSimilarComparisonProductBySlug({ slug }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, {
|
|
517
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductCompareResponse>;
|
|
489
518
|
/**
|
|
490
519
|
* @param {CatalogApplicationValidator.GetStoresParam} arg - Arg object.
|
|
520
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
491
521
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
492
522
|
* @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
|
|
493
523
|
* @name getStores
|
|
494
524
|
* @summary: Get store meta information.
|
|
495
525
|
* @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
496
526
|
*/
|
|
497
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude }?: CatalogApplicationValidator.GetStoresParam, {
|
|
527
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponse>;
|
|
498
528
|
/**
|
|
499
529
|
* @param {Object} arg - Arg object.
|
|
500
530
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -520,13 +550,14 @@ declare class Catalog {
|
|
|
520
550
|
}): Paginator<CatalogApplicationModel.StoreListingResponse>;
|
|
521
551
|
/**
|
|
522
552
|
* @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
|
|
553
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
523
554
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
524
555
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
525
556
|
* @name unfollowById
|
|
526
557
|
* @summary: Unfollow an entity (product/brand/collection)
|
|
527
558
|
* @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
528
559
|
*/
|
|
529
|
-
unfollowById({ collectionType, collectionId }?: CatalogApplicationValidator.UnfollowByIdParam, {
|
|
560
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
530
561
|
}
|
|
531
562
|
import CatalogApplicationValidator = require("./CatalogApplicationValidator");
|
|
532
563
|
import CatalogApplicationModel = require("./CatalogApplicationModel");
|