@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8
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 +26 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +8 -0
- package/sdk/application/ApplicationClient.js +14 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
- package/sdk/application/Cart/CartApplicationClient.js +20 -20
- package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
- package/sdk/application/Cart/CartApplicationModel.js +783 -552
- package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
- package/sdk/application/Cart/CartApplicationValidator.js +100 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
- package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
- package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
- package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
- package/sdk/application/Common/CommonApplicationModel.js +59 -58
- package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
- package/sdk/application/Common/CommonApplicationValidator.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
- package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
- package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
- package/sdk/application/Content/ContentApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
- package/sdk/application/Content/ContentApplicationModel.js +342 -276
- package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
- package/sdk/application/Content/ContentApplicationValidator.js +11 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
- package/sdk/application/Lead/LeadApplicationModel.js +110 -67
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
- package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
- package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
- package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
- package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
- package/sdk/application/Order/OrderApplicationClient.js +10 -10
- package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
- package/sdk/application/Order/OrderApplicationModel.js +392 -316
- package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
- package/sdk/application/Order/OrderApplicationValidator.js +15 -14
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
- package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
- package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
- package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
- package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
- package/sdk/application/Share/ShareApplicationModel.js +53 -37
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
- package/sdk/application/Share/ShareApplicationValidator.js +2 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
- package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
- package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
- package/sdk/application/User/UserApplicationClient.d.ts +36 -36
- package/sdk/application/User/UserApplicationClient.js +36 -36
- package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
- package/sdk/application/User/UserApplicationModel.js +298 -244
- package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
- package/sdk/application/User/UserApplicationValidator.js +40 -40
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
- package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
- package/sdk/common/Clickstream.js +95 -15
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/common/Utility.js +19 -0
- package/sdk/common/utils.js +8 -1
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
- package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/PartnerClient.d.ts +8 -0
- package/sdk/partner/PartnerClient.js +14 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
- package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
- package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
- package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
- package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
- package/sdk/platform/Cart/CartPlatformModel.js +8 -8
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
- package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
- package/sdk/platform/Content/ContentPlatformModel.js +30 -15
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
- package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
- package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformClient.js +165 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
- package/sdk/platform/Order/OrderPlatformModel.js +367 -41
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
- package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +8 -0
- package/sdk/platform/PlatformClient.js +14 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
- package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
- package/sdk/platform/Share/SharePlatformModel.js +7 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
- package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
- package/sdk/platform/User/UserPlatformModel.js +9 -11
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
- package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
- package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
- package/sdk/public/Billing/BillingPublicClient.js +80 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
- package/sdk/public/Billing/BillingPublicModel.js +252 -87
- package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
- package/sdk/public/Billing/BillingPublicValidator.js +12 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
- package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
- package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
- package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
|
@@ -88,7 +88,7 @@ class Catalog {
|
|
|
88
88
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
89
89
|
* @name followById
|
|
90
90
|
* @summary: Create item, brand, product
|
|
91
|
-
* @description:
|
|
91
|
+
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
92
92
|
*/
|
|
93
93
|
async followById(
|
|
94
94
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -166,7 +166,7 @@ class Catalog {
|
|
|
166
166
|
* @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
|
|
167
167
|
* @name getBrandDetailBySlug
|
|
168
168
|
* @summary: Get a brand
|
|
169
|
-
* @description:
|
|
169
|
+
* @description: Get 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/).
|
|
170
170
|
*/
|
|
171
171
|
async getBrandDetailBySlug(
|
|
172
172
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -246,7 +246,7 @@ class Catalog {
|
|
|
246
246
|
* @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
|
|
247
247
|
* @name getBrands
|
|
248
248
|
* @summary: List brands
|
|
249
|
-
* @description:
|
|
249
|
+
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
250
250
|
*/
|
|
251
251
|
async getBrands(
|
|
252
252
|
{ department, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -325,11 +325,11 @@ class Catalog {
|
|
|
325
325
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
326
326
|
* parameter to filter products by a particular department. See the list
|
|
327
327
|
* of available departments below. Also, you can get available departments
|
|
328
|
-
* from the endpoint /service/application/catalog/v1.0/departments
|
|
328
|
+
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
329
329
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
330
330
|
* @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
|
|
331
331
|
* @summary: List brands
|
|
332
|
-
* @description:
|
|
332
|
+
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
333
333
|
*/
|
|
334
334
|
getBrandsPaginator({ department, pageSize } = {}) {
|
|
335
335
|
const paginator = new Paginator();
|
|
@@ -360,7 +360,7 @@ class Catalog {
|
|
|
360
360
|
* Success response
|
|
361
361
|
* @name getCategories
|
|
362
362
|
* @summary: List product categories
|
|
363
|
-
* @description:
|
|
363
|
+
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
364
364
|
*/
|
|
365
365
|
async getCategories(
|
|
366
366
|
{ department, requestHeaders } = { requestHeaders: {} },
|
|
@@ -439,7 +439,7 @@ class Catalog {
|
|
|
439
439
|
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
|
|
440
440
|
* @name getCategoryDetailBySlug
|
|
441
441
|
* @summary: Get category by slug
|
|
442
|
-
* @description:
|
|
442
|
+
* @description: Get detailed information about a specific product category using its slug and get 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/).
|
|
443
443
|
*/
|
|
444
444
|
async getCategoryDetailBySlug(
|
|
445
445
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -522,7 +522,7 @@ class Catalog {
|
|
|
522
522
|
* Success response
|
|
523
523
|
* @name getCollectionDetailBySlug
|
|
524
524
|
* @summary: Get a collection
|
|
525
|
-
* @description:
|
|
525
|
+
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
526
526
|
*/
|
|
527
527
|
async getCollectionDetailBySlug(
|
|
528
528
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -704,11 +704,11 @@ class Catalog {
|
|
|
704
704
|
* @param {string} [arg.f] - The search filter parameters. Filter parameters
|
|
705
705
|
* will be passed in f parameter as shown in the example below. Double
|
|
706
706
|
* Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
|
|
707
|
-
* indicates a new filter
|
|
707
|
+
* indicates a new filter parameter applied as an AND condition.
|
|
708
708
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
709
709
|
* name of product, brand, category, or collection.
|
|
710
|
-
* @param {boolean} [arg.filters] -
|
|
711
|
-
*
|
|
710
|
+
* @param {boolean} [arg.filters] - True for fetching all filter parameters
|
|
711
|
+
* and False for disabling the filter parameters.
|
|
712
712
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
713
713
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
714
714
|
* either ascending or descending order. See the supported values below.
|
|
@@ -760,7 +760,7 @@ class Catalog {
|
|
|
760
760
|
*
|
|
761
761
|
* @name getCollections
|
|
762
762
|
* @summary: List collections
|
|
763
|
-
* @description:
|
|
763
|
+
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
764
764
|
*/
|
|
765
765
|
async getCollections(
|
|
766
766
|
{ pageNo, pageSize, tag, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -838,11 +838,11 @@ class Catalog {
|
|
|
838
838
|
/**
|
|
839
839
|
* @param {Object} arg - Arg object.
|
|
840
840
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
841
|
-
* @param {string[]} [arg.tag] - List of tags to filter collections
|
|
842
|
-
* @param {string} [arg.q] - Name of the collection to filter collection
|
|
841
|
+
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
842
|
+
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
843
843
|
* @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
844
844
|
* @summary: List collections
|
|
845
|
-
* @description:
|
|
845
|
+
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
846
846
|
*/
|
|
847
847
|
getCollectionsPaginator({ pageSize, tag, q } = {}) {
|
|
848
848
|
const paginator = new Paginator();
|
|
@@ -877,7 +877,7 @@ class Catalog {
|
|
|
877
877
|
*
|
|
878
878
|
* @name getComparedFrequentlyProductBySlug
|
|
879
879
|
* @summary: List frequent products
|
|
880
|
-
* @description:
|
|
880
|
+
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
881
881
|
*/
|
|
882
882
|
async getComparedFrequentlyProductBySlug(
|
|
883
883
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -957,7 +957,7 @@ class Catalog {
|
|
|
957
957
|
* @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
|
|
958
958
|
* @name getDepartments
|
|
959
959
|
* @summary: List departments
|
|
960
|
-
* @description:
|
|
960
|
+
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
961
961
|
*/
|
|
962
962
|
async getDepartments(
|
|
963
963
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1035,7 +1035,7 @@ class Catalog {
|
|
|
1035
1035
|
* @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
|
|
1036
1036
|
* @name getFollowIds
|
|
1037
1037
|
* @summary: List Ids of followed item, brand, product
|
|
1038
|
-
* @description:
|
|
1038
|
+
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
1039
1039
|
*/
|
|
1040
1040
|
async getFollowIds(
|
|
1041
1041
|
{ collectionType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1115,7 +1115,7 @@ class Catalog {
|
|
|
1115
1115
|
* Success response
|
|
1116
1116
|
* @name getFollowedListing
|
|
1117
1117
|
* @summary: List followed products, brands
|
|
1118
|
-
* @description:
|
|
1118
|
+
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
1119
1119
|
*/
|
|
1120
1120
|
async getFollowedListing(
|
|
1121
1121
|
{ collectionType, pageId, pageSize, requestHeaders } = {
|
|
@@ -1197,7 +1197,7 @@ class Catalog {
|
|
|
1197
1197
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
1198
1198
|
* @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
|
|
1199
1199
|
* @summary: List followed products, brands
|
|
1200
|
-
* @description:
|
|
1200
|
+
* @description: Get a list of products or brands the user is following.
|
|
1201
1201
|
*/
|
|
1202
1202
|
getFollowedListingPaginator({ collectionType, pageSize } = {}) {
|
|
1203
1203
|
const paginator = new Paginator();
|
|
@@ -1228,7 +1228,7 @@ class Catalog {
|
|
|
1228
1228
|
* Success response
|
|
1229
1229
|
* @name getFollowerCountById
|
|
1230
1230
|
* @summary: Get follower count
|
|
1231
|
-
* @description:
|
|
1231
|
+
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
|
|
1232
1232
|
*/
|
|
1233
1233
|
async getFollowerCountById(
|
|
1234
1234
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1421,7 +1421,7 @@ class Catalog {
|
|
|
1421
1421
|
* Success response
|
|
1422
1422
|
* @name getInStockLocations
|
|
1423
1423
|
* @summary: List stores with inventory
|
|
1424
|
-
* @description:
|
|
1424
|
+
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
1425
1425
|
*/
|
|
1426
1426
|
async getInStockLocations(
|
|
1427
1427
|
{
|
|
@@ -1516,14 +1516,14 @@ class Catalog {
|
|
|
1516
1516
|
* @param {string} [arg.q] - Search a store by its name or store_code.
|
|
1517
1517
|
* @param {string} [arg.city] - Search stores by the city in which they are situated.
|
|
1518
1518
|
* @param {number} [arg.range] - Use this to retrieve stores within a
|
|
1519
|
-
* particular range in meters, e.g. 10000, to indicate a 10km range
|
|
1519
|
+
* particular range in meters, e.g. 10000, to indicate a 10km range.
|
|
1520
1520
|
* @param {number} [arg.latitude] - Latitude of the location from where one
|
|
1521
|
-
* wants to
|
|
1521
|
+
* wants to retrieve the nearest stores, e.g. 72.8691788.
|
|
1522
1522
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
1523
|
-
* one wants to
|
|
1523
|
+
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
1524
1524
|
* @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
|
|
1525
1525
|
* @summary: List stores with inventory
|
|
1526
|
-
* @description:
|
|
1526
|
+
* @description: List stores where specified products are currently in stock.
|
|
1527
1527
|
*/
|
|
1528
1528
|
getInStockLocationsPaginator({
|
|
1529
1529
|
pageSize,
|
|
@@ -1564,7 +1564,7 @@ class Catalog {
|
|
|
1564
1564
|
* @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
|
|
1565
1565
|
* @name getLocationDetailsById
|
|
1566
1566
|
* @summary: Get selling location
|
|
1567
|
-
* @description:
|
|
1567
|
+
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
1568
1568
|
*/
|
|
1569
1569
|
async getLocationDetailsById(
|
|
1570
1570
|
{ locationId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1644,7 +1644,7 @@ class Catalog {
|
|
|
1644
1644
|
* @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
|
|
1645
1645
|
* @name getProductBundlesBySlug
|
|
1646
1646
|
* @summary: List product bundles
|
|
1647
|
-
* @description:
|
|
1647
|
+
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
1648
1648
|
*/
|
|
1649
1649
|
async getProductBundlesBySlug(
|
|
1650
1650
|
{ slug, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1729,7 +1729,7 @@ class Catalog {
|
|
|
1729
1729
|
* Success response
|
|
1730
1730
|
* @name getProductComparisonBySlugs
|
|
1731
1731
|
* @summary: List products for comparison
|
|
1732
|
-
* @description:
|
|
1732
|
+
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
1733
1733
|
*/
|
|
1734
1734
|
async getProductComparisonBySlugs(
|
|
1735
1735
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1810,7 +1810,7 @@ class Catalog {
|
|
|
1810
1810
|
* @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
|
|
1811
1811
|
* @name getProductDetailBySlug
|
|
1812
1812
|
* @summary: Get a product
|
|
1813
|
-
* @description:
|
|
1813
|
+
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
1814
1814
|
*/
|
|
1815
1815
|
async getProductDetailBySlug(
|
|
1816
1816
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1891,7 +1891,7 @@ class Catalog {
|
|
|
1891
1891
|
* Success response
|
|
1892
1892
|
* @name getProductPriceBySlug
|
|
1893
1893
|
* @summary: Get product price
|
|
1894
|
-
* @description:
|
|
1894
|
+
* @description: Get 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/).
|
|
1895
1895
|
*/
|
|
1896
1896
|
async getProductPriceBySlug(
|
|
1897
1897
|
{ slug, size, storeId, moq, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1975,7 +1975,7 @@ class Catalog {
|
|
|
1975
1975
|
*
|
|
1976
1976
|
* @name getProductSellersBySlug
|
|
1977
1977
|
* @summary: List sellers
|
|
1978
|
-
* @description:
|
|
1978
|
+
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
1979
1979
|
*/
|
|
1980
1980
|
async getProductSellersBySlug(
|
|
1981
1981
|
{ slug, size, strategy, pageNo, pageSize, requestHeaders } = {
|
|
@@ -2057,16 +2057,16 @@ class Catalog {
|
|
|
2057
2057
|
* @param {Object} arg - Arg object.
|
|
2058
2058
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
2059
2059
|
* identifier of a product. You can get slug value from the endpoint
|
|
2060
|
-
* /service/application/catalog/v1.0/products
|
|
2060
|
+
* /service/application/catalog/v1.0/products/.
|
|
2061
2061
|
* @param {string} arg.size - A string indicating the size of the product,
|
|
2062
2062
|
* e.g. S, M, XL. You can get slug value from the endpoint
|
|
2063
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
2063
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
2064
2064
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
2065
2065
|
* eg, fast-delivery, low-price, optimal.
|
|
2066
2066
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
2067
2067
|
* @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
2068
2068
|
* @summary: List sellers
|
|
2069
|
-
* @description:
|
|
2069
|
+
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
2070
2070
|
*/
|
|
2071
2071
|
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize } = {}) {
|
|
2072
2072
|
const paginator = new Paginator();
|
|
@@ -2180,7 +2180,7 @@ class Catalog {
|
|
|
2180
2180
|
* Success response
|
|
2181
2181
|
* @name getProductStockByIds
|
|
2182
2182
|
* @summary: Get product stocks
|
|
2183
|
-
* @description:
|
|
2183
|
+
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
2184
2184
|
*/
|
|
2185
2185
|
async getProductStockByIds(
|
|
2186
2186
|
{ itemId, alu, skuCode, ean, upc, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2267,7 +2267,7 @@ class Catalog {
|
|
|
2267
2267
|
* @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
|
|
2268
2268
|
* @name getProductStockForTimeByIds
|
|
2269
2269
|
* @summary: List future stock
|
|
2270
|
-
* @description:
|
|
2270
|
+
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
2271
2271
|
*/
|
|
2272
2272
|
async getProductStockForTimeByIds(
|
|
2273
2273
|
{ timestamp, pageSize, pageId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2345,11 +2345,11 @@ class Catalog {
|
|
|
2345
2345
|
|
|
2346
2346
|
/**
|
|
2347
2347
|
* @param {Object} arg - Arg object.
|
|
2348
|
-
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
2348
|
+
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
2349
2349
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
2350
2350
|
* @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
|
|
2351
2351
|
* @summary: List future stock
|
|
2352
|
-
* @description:
|
|
2352
|
+
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time.
|
|
2353
2353
|
*/
|
|
2354
2354
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize } = {}) {
|
|
2355
2355
|
const paginator = new Paginator();
|
|
@@ -2381,7 +2381,7 @@ class Catalog {
|
|
|
2381
2381
|
* Success response
|
|
2382
2382
|
* @name getProductVariantsBySlug
|
|
2383
2383
|
* @summary: List product variants
|
|
2384
|
-
* @description:
|
|
2384
|
+
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
|
|
2385
2385
|
*/
|
|
2386
2386
|
async getProductVariantsBySlug(
|
|
2387
2387
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2462,7 +2462,7 @@ class Catalog {
|
|
|
2462
2462
|
* Success response
|
|
2463
2463
|
* @name getProducts
|
|
2464
2464
|
* @summary: List products
|
|
2465
|
-
* @description:
|
|
2465
|
+
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
2466
2466
|
*/
|
|
2467
2467
|
async getProducts(
|
|
2468
2468
|
{
|
|
@@ -2558,16 +2558,16 @@ class Catalog {
|
|
|
2558
2558
|
* @param {string} [arg.f] - The search filter parameters. Filter parameters
|
|
2559
2559
|
* will be passed in f parameter as shown in the example below. Double
|
|
2560
2560
|
* Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
|
|
2561
|
-
* indicates a new filter
|
|
2562
|
-
* @param {boolean} [arg.filters] -
|
|
2563
|
-
*
|
|
2561
|
+
* indicates a new filter parameter applied as an AND condition.
|
|
2562
|
+
* @param {boolean} [arg.filters] - True for fetching all filter parameters
|
|
2563
|
+
* and False for disabling the filter parameters.
|
|
2564
2564
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
2565
2565
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
2566
2566
|
* either ascending or descending order. See the supported values below.
|
|
2567
2567
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
2568
2568
|
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
2569
2569
|
* @summary: List products
|
|
2570
|
-
* @description:
|
|
2570
|
+
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
|
|
2571
2571
|
*/
|
|
2572
2572
|
getProductsPaginator({ q, f, filters, sortOn, pageSize } = {}) {
|
|
2573
2573
|
const paginator = new Paginator();
|
|
@@ -2602,7 +2602,7 @@ class Catalog {
|
|
|
2602
2602
|
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
|
|
2603
2603
|
* @name getSearchResults
|
|
2604
2604
|
* @summary: List product, brand, category
|
|
2605
|
-
* @description:
|
|
2605
|
+
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
2606
2606
|
*/
|
|
2607
2607
|
async getSearchResults(
|
|
2608
2608
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2684,7 +2684,7 @@ class Catalog {
|
|
|
2684
2684
|
* Success response
|
|
2685
2685
|
* @name getSimilarComparisonProductBySlug
|
|
2686
2686
|
* @summary: List similar products
|
|
2687
|
-
* @description:
|
|
2687
|
+
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
2688
2688
|
*/
|
|
2689
2689
|
async getSimilarComparisonProductBySlug(
|
|
2690
2690
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2764,7 +2764,7 @@ class Catalog {
|
|
|
2764
2764
|
* @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
|
|
2765
2765
|
* @name getStores
|
|
2766
2766
|
* @summary: List available stores
|
|
2767
|
-
* @description:
|
|
2767
|
+
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
2768
2768
|
*/
|
|
2769
2769
|
async getStores(
|
|
2770
2770
|
{
|
|
@@ -2859,15 +2859,15 @@ class Catalog {
|
|
|
2859
2859
|
* @param {string} [arg.q] - Search a store by its name or store_code.
|
|
2860
2860
|
* @param {string} [arg.city] - Search stores by the city in which they are situated.
|
|
2861
2861
|
* @param {number} [arg.range] - Use this to retrieve stores within a
|
|
2862
|
-
* particular range in meters, e.g. 10000, to indicate a 10km range
|
|
2862
|
+
* particular range in meters, e.g. 10000, to indicate a 10km range.
|
|
2863
2863
|
* @param {number} [arg.latitude] - Latitude of the location from where one
|
|
2864
|
-
* wants to
|
|
2864
|
+
* wants to retrieve the nearest stores, e.g. 72.8691788.
|
|
2865
2865
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
2866
|
-
* one wants to
|
|
2866
|
+
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
2867
2867
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
2868
2868
|
* @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
|
|
2869
2869
|
* @summary: List available stores
|
|
2870
|
-
* @description:
|
|
2870
|
+
* @description: List all stores associated with the sales channel.
|
|
2871
2871
|
*/
|
|
2872
2872
|
getStoresPaginator({
|
|
2873
2873
|
pageSize,
|
|
@@ -2910,7 +2910,7 @@ class Catalog {
|
|
|
2910
2910
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
2911
2911
|
* @name unfollowById
|
|
2912
2912
|
* @summary: Delete item, brand, product
|
|
2913
|
-
* @description:
|
|
2913
|
+
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
2914
2914
|
*/
|
|
2915
2915
|
async unfollowById(
|
|
2916
2916
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|