@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -39,30 +39,30 @@ declare class Catalog {
|
|
|
39
39
|
/**
|
|
40
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
41
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
|
-
* @returns {Promise<
|
|
42
|
+
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
43
43
|
* @name followById
|
|
44
44
|
* @summary: Create item, brand, product
|
|
45
45
|
* @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/).
|
|
46
46
|
*/
|
|
47
|
-
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
47
|
+
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
48
48
|
/**
|
|
49
49
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
50
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
|
-
* @returns {Promise<
|
|
51
|
+
* @returns {Promise<BrandDetailResponseSchema>} - Success response
|
|
52
52
|
* @name getBrandDetailBySlug
|
|
53
53
|
* @summary: Get a brand
|
|
54
54
|
* @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/).
|
|
55
55
|
*/
|
|
56
|
-
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
56
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BrandDetailResponseSchema>;
|
|
57
57
|
/**
|
|
58
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
59
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
60
|
-
* @returns {Promise<
|
|
60
|
+
* @returns {Promise<BrandListingResponseSchema>} - Success response
|
|
61
61
|
* @name getBrands
|
|
62
62
|
* @summary: List brands
|
|
63
63
|
* @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/).
|
|
64
64
|
*/
|
|
65
|
-
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
65
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponseSchema>;
|
|
66
66
|
/**
|
|
67
67
|
* @param {Object} arg - Arg object.
|
|
68
68
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -70,50 +70,50 @@ declare class Catalog {
|
|
|
70
70
|
* of available departments below. Also, you can get available departments
|
|
71
71
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
72
72
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
73
|
-
* @returns {Paginator<
|
|
73
|
+
* @returns {Paginator<BrandListingResponseSchema>}
|
|
74
74
|
* @summary: List brands
|
|
75
75
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
76
76
|
*/
|
|
77
77
|
getBrandsPaginator({ department, pageSize }?: {
|
|
78
78
|
department?: string;
|
|
79
79
|
pageSize?: number;
|
|
80
|
-
}): Paginator<
|
|
80
|
+
}): Paginator<BrandListingResponseSchema>;
|
|
81
81
|
/**
|
|
82
82
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
83
83
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
84
|
-
* @returns {Promise<
|
|
84
|
+
* @returns {Promise<CategoryListingResponseSchema>} - Success response
|
|
85
85
|
* @name getCategories
|
|
86
86
|
* @summary: List product categories
|
|
87
87
|
* @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/).
|
|
88
88
|
*/
|
|
89
|
-
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
89
|
+
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponseSchema>;
|
|
90
90
|
/**
|
|
91
91
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
92
92
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
93
|
-
* @returns {Promise<
|
|
93
|
+
* @returns {Promise<CategoryMetaResponseSchema>} - Success response
|
|
94
94
|
* @name getCategoryDetailBySlug
|
|
95
95
|
* @summary: Get category by slug
|
|
96
96
|
* @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/).
|
|
97
97
|
*/
|
|
98
|
-
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
98
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CategoryMetaResponseSchema>;
|
|
99
99
|
/**
|
|
100
100
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
101
101
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
102
|
-
* @returns {Promise<
|
|
102
|
+
* @returns {Promise<CollectionDetailResponseSchema>} - Success response
|
|
103
103
|
* @name getCollectionDetailBySlug
|
|
104
104
|
* @summary: Get a collection
|
|
105
105
|
* @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/).
|
|
106
106
|
*/
|
|
107
|
-
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
107
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CollectionDetailResponseSchema>;
|
|
108
108
|
/**
|
|
109
109
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
110
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
111
|
-
* @returns {Promise<
|
|
111
|
+
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
112
112
|
* @name getCollectionItemsBySlug
|
|
113
113
|
* @summary: Lists items of collection
|
|
114
114
|
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
115
115
|
*/
|
|
116
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
116
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductListingResponseSchema>;
|
|
117
117
|
/**
|
|
118
118
|
* @param {Object} arg - Arg object.
|
|
119
119
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -131,7 +131,7 @@ declare class Catalog {
|
|
|
131
131
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
132
132
|
* either ascending or descending order. See the supported values below.
|
|
133
133
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
134
|
-
* @returns {Paginator<
|
|
134
|
+
* @returns {Paginator<ProductListingResponseSchema>}
|
|
135
135
|
* @summary: Lists items of collection
|
|
136
136
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
137
137
|
*/
|
|
@@ -142,22 +142,22 @@ declare class Catalog {
|
|
|
142
142
|
filters?: boolean;
|
|
143
143
|
sortOn?: string;
|
|
144
144
|
pageSize?: number;
|
|
145
|
-
}): Paginator<
|
|
145
|
+
}): Paginator<ProductListingResponseSchema>;
|
|
146
146
|
/**
|
|
147
147
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
148
148
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
149
|
-
* @returns {Promise<
|
|
149
|
+
* @returns {Promise<GetCollectionListingResponseSchema>} - Success response
|
|
150
150
|
* @name getCollections
|
|
151
151
|
* @summary: List collections
|
|
152
152
|
* @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/).
|
|
153
153
|
*/
|
|
154
|
-
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
154
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponseSchema>;
|
|
155
155
|
/**
|
|
156
156
|
* @param {Object} arg - Arg object.
|
|
157
157
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
158
158
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
159
159
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
160
|
-
* @returns {Paginator<
|
|
160
|
+
* @returns {Paginator<GetCollectionListingResponseSchema>}
|
|
161
161
|
* @summary: List collections
|
|
162
162
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
163
163
|
*/
|
|
@@ -165,88 +165,89 @@ declare class Catalog {
|
|
|
165
165
|
pageSize?: number;
|
|
166
166
|
tag?: string[];
|
|
167
167
|
q?: string;
|
|
168
|
-
}): Paginator<
|
|
168
|
+
}): Paginator<GetCollectionListingResponseSchema>;
|
|
169
169
|
/**
|
|
170
170
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
171
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
172
|
-
* @returns {Promise<
|
|
172
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponseSchema>} -
|
|
173
|
+
* Success response
|
|
173
174
|
* @name getComparedFrequentlyProductBySlug
|
|
174
175
|
* @summary: List frequent products
|
|
175
176
|
* @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/).
|
|
176
177
|
*/
|
|
177
|
-
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
178
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductFrequentlyComparedSimilarResponseSchema>;
|
|
178
179
|
/**
|
|
179
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
180
181
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
181
|
-
* @returns {Promise<
|
|
182
|
+
* @returns {Promise<DepartmentResponseSchema>} - Success response
|
|
182
183
|
* @name getDepartments
|
|
183
184
|
* @summary: List departments
|
|
184
185
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
185
186
|
*/
|
|
186
|
-
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
187
|
+
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponseSchema>;
|
|
187
188
|
/**
|
|
188
189
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
190
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
190
|
-
* @returns {Promise<
|
|
191
|
+
* @returns {Promise<FollowIdsResponseSchema>} - Success response
|
|
191
192
|
* @name getFollowIds
|
|
192
193
|
* @summary: List Ids of followed item, brand, product
|
|
193
194
|
* @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/).
|
|
194
195
|
*/
|
|
195
|
-
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
196
|
+
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponseSchema>;
|
|
196
197
|
/**
|
|
197
198
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
198
199
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
199
|
-
* @returns {Promise<
|
|
200
|
+
* @returns {Promise<GetFollowListingResponseSchema>} - Success response
|
|
200
201
|
* @name getFollowedListing
|
|
201
202
|
* @summary: List followed products, brands
|
|
202
203
|
* @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/).
|
|
203
204
|
*/
|
|
204
|
-
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
205
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFollowListingResponseSchema>;
|
|
205
206
|
/**
|
|
206
207
|
* @param {Object} arg - Arg object.
|
|
207
208
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
208
209
|
* products, brands, or collections.
|
|
209
210
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
210
|
-
* @returns {Paginator<
|
|
211
|
+
* @returns {Paginator<GetFollowListingResponseSchema>}
|
|
211
212
|
* @summary: List followed products, brands
|
|
212
213
|
* @description: Get a list of products or brands the user is following.
|
|
213
214
|
*/
|
|
214
215
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
215
216
|
collectionType: string;
|
|
216
217
|
pageSize?: number;
|
|
217
|
-
}): Paginator<
|
|
218
|
+
}): Paginator<GetFollowListingResponseSchema>;
|
|
218
219
|
/**
|
|
219
220
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
220
221
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
221
|
-
* @returns {Promise<
|
|
222
|
+
* @returns {Promise<FollowerCountResponseSchema>} - Success response
|
|
222
223
|
* @name getFollowerCountById
|
|
223
224
|
* @summary: Get follower count
|
|
224
225
|
* @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/).
|
|
225
226
|
*/
|
|
226
|
-
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
227
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowerCountResponseSchema>;
|
|
227
228
|
/**
|
|
228
229
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
229
230
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
230
|
-
* @returns {Promise<
|
|
231
|
+
* @returns {Promise<HomeListingResponseSchema>} - Success response
|
|
231
232
|
* @name getHomeProducts
|
|
232
233
|
* @summary: List homepage-featured products
|
|
233
234
|
* @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/).
|
|
234
235
|
*/
|
|
235
|
-
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
236
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponseSchema>;
|
|
236
237
|
/**
|
|
237
238
|
* @param {Object} arg - Arg object.
|
|
238
239
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
239
240
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
240
241
|
* either ascending or descending order.
|
|
241
242
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
242
|
-
* @returns {Paginator<
|
|
243
|
+
* @returns {Paginator<HomeListingResponseSchema>}
|
|
243
244
|
* @summary: List homepage-featured products
|
|
244
245
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
245
246
|
*/
|
|
246
247
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
247
248
|
sortOn?: string;
|
|
248
249
|
pageSize?: number;
|
|
249
|
-
}): Paginator<
|
|
250
|
+
}): Paginator<HomeListingResponseSchema>;
|
|
250
251
|
/**
|
|
251
252
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
252
253
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -300,12 +301,12 @@ declare class Catalog {
|
|
|
300
301
|
/**
|
|
301
302
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
302
303
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
303
|
-
* @returns {Promise<
|
|
304
|
+
* @returns {Promise<ProductsComparisonResponseSchema>} - Success response
|
|
304
305
|
* @name getProductComparisonBySlugs
|
|
305
306
|
* @summary: List products for comparison
|
|
306
307
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
307
308
|
*/
|
|
308
|
-
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
309
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponseSchema>;
|
|
309
310
|
/**
|
|
310
311
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
311
312
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -366,12 +367,12 @@ declare class Catalog {
|
|
|
366
367
|
/**
|
|
367
368
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
368
369
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
369
|
-
* @returns {Promise<
|
|
370
|
+
* @returns {Promise<ProductStockStatusResponseSchema>} - Success response
|
|
370
371
|
* @name getProductStockByIds
|
|
371
372
|
* @summary: Get product stocks
|
|
372
373
|
* @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/).
|
|
373
374
|
*/
|
|
374
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
375
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponseSchema>;
|
|
375
376
|
/**
|
|
376
377
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
377
378
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -396,21 +397,21 @@ declare class Catalog {
|
|
|
396
397
|
/**
|
|
397
398
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
398
399
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
399
|
-
* @returns {Promise<
|
|
400
|
+
* @returns {Promise<ProductVariantsResponseSchema>} - Success response
|
|
400
401
|
* @name getProductVariantsBySlug
|
|
401
402
|
* @summary: List product variants
|
|
402
403
|
* @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/).
|
|
403
404
|
*/
|
|
404
|
-
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
405
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductVariantsResponseSchema>;
|
|
405
406
|
/**
|
|
406
407
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
407
408
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
408
|
-
* @returns {Promise<
|
|
409
|
+
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
409
410
|
* @name getProducts
|
|
410
411
|
* @summary: List products
|
|
411
412
|
* @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/).
|
|
412
413
|
*/
|
|
413
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
414
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponseSchema>;
|
|
414
415
|
/**
|
|
415
416
|
* @param {Object} arg - Arg object.
|
|
416
417
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -425,7 +426,7 @@ declare class Catalog {
|
|
|
425
426
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
426
427
|
* either ascending or descending order. See the supported values below.
|
|
427
428
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
428
|
-
* @returns {Paginator<
|
|
429
|
+
* @returns {Paginator<ProductListingResponseSchema>}
|
|
429
430
|
* @summary: List products
|
|
430
431
|
* @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.
|
|
431
432
|
*/
|
|
@@ -435,34 +436,34 @@ declare class Catalog {
|
|
|
435
436
|
filters?: boolean;
|
|
436
437
|
sortOn?: string;
|
|
437
438
|
pageSize?: number;
|
|
438
|
-
}): Paginator<
|
|
439
|
+
}): Paginator<ProductListingResponseSchema>;
|
|
439
440
|
/**
|
|
440
441
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
441
442
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
442
|
-
* @returns {Promise<
|
|
443
|
+
* @returns {Promise<AutoCompleteResponseSchema>} - Success response
|
|
443
444
|
* @name getSearchResults
|
|
444
445
|
* @summary: List product, brand, category
|
|
445
446
|
* @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/).
|
|
446
447
|
*/
|
|
447
|
-
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
448
|
+
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponseSchema>;
|
|
448
449
|
/**
|
|
449
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
450
451
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
451
|
-
* @returns {Promise<
|
|
452
|
+
* @returns {Promise<ProductCompareResponseSchema>} - Success response
|
|
452
453
|
* @name getSimilarComparisonProductBySlug
|
|
453
454
|
* @summary: List similar products
|
|
454
455
|
* @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/).
|
|
455
456
|
*/
|
|
456
|
-
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
457
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductCompareResponseSchema>;
|
|
457
458
|
/**
|
|
458
459
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
460
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
460
|
-
* @returns {Promise<
|
|
461
|
+
* @returns {Promise<StoreListingResponseSchema>} - Success response
|
|
461
462
|
* @name getStores
|
|
462
463
|
* @summary: List available stores
|
|
463
464
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
464
465
|
*/
|
|
465
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
466
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponseSchema>;
|
|
466
467
|
/**
|
|
467
468
|
* @param {Object} arg - Arg object.
|
|
468
469
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -475,7 +476,7 @@ declare class Catalog {
|
|
|
475
476
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
476
477
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
477
478
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
478
|
-
* @returns {Paginator<
|
|
479
|
+
* @returns {Paginator<StoreListingResponseSchema>}
|
|
479
480
|
* @summary: List available stores
|
|
480
481
|
* @description: List all stores associated with the sales channel.
|
|
481
482
|
*/
|
|
@@ -487,15 +488,15 @@ declare class Catalog {
|
|
|
487
488
|
latitude?: number;
|
|
488
489
|
longitude?: number;
|
|
489
490
|
tags?: string;
|
|
490
|
-
}): Paginator<
|
|
491
|
+
}): Paginator<StoreListingResponseSchema>;
|
|
491
492
|
/**
|
|
492
493
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
493
494
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
494
|
-
* @returns {Promise<
|
|
495
|
+
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
495
496
|
* @name unfollowById
|
|
496
497
|
* @summary: Delete item, brand, product
|
|
497
498
|
* @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/).
|
|
498
499
|
*/
|
|
499
|
-
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
500
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
500
501
|
}
|
|
501
502
|
import Paginator = require("../../common/Paginator");
|