@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -9,7 +9,7 @@ declare class Catalog {
|
|
|
9
9
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
10
10
|
* @name addInventory
|
|
11
11
|
* @summary: Add Inventory for particular size and store.
|
|
12
|
-
* @description:
|
|
12
|
+
* @description: Allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
|
|
13
13
|
*/
|
|
14
14
|
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
15
15
|
/**
|
|
@@ -18,8 +18,8 @@ declare class Catalog {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
20
20
|
* @name allSizes
|
|
21
|
-
* @summary:
|
|
22
|
-
* @description:
|
|
21
|
+
* @summary: Get all product sizes.
|
|
22
|
+
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
|
|
23
23
|
*/
|
|
24
24
|
allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
|
|
25
25
|
/**
|
|
@@ -28,8 +28,8 @@ declare class Catalog {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
|
|
30
30
|
* @name bulkHsnCode
|
|
31
|
-
* @summary: Bulk
|
|
32
|
-
* @description:
|
|
31
|
+
* @summary: Bulk update HSN codes.
|
|
32
|
+
* @description: Perform bulk updates of HSN codes for products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
|
|
33
33
|
*/
|
|
34
34
|
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponse>;
|
|
35
35
|
/**
|
|
@@ -38,8 +38,8 @@ declare class Catalog {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
40
40
|
* @name createBulkInventory
|
|
41
|
-
* @summary: Create
|
|
42
|
-
* @description:
|
|
41
|
+
* @summary: Create bulk inventory.
|
|
42
|
+
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
|
|
43
43
|
*/
|
|
44
44
|
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
45
45
|
/**
|
|
@@ -48,8 +48,8 @@ declare class Catalog {
|
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
50
50
|
* @name createBulkInventoryJob
|
|
51
|
-
* @summary: Create
|
|
52
|
-
* @description:
|
|
51
|
+
* @summary: Create bulk inventory upload job.
|
|
52
|
+
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
53
53
|
*/
|
|
54
54
|
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
55
55
|
/**
|
|
@@ -68,8 +68,8 @@ declare class Catalog {
|
|
|
68
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
70
70
|
* @name createCategories
|
|
71
|
-
* @summary: Create
|
|
72
|
-
* @description:
|
|
71
|
+
* @summary: Create categories.
|
|
72
|
+
* @description: Lets user create product categories on for the seller on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
73
73
|
*/
|
|
74
74
|
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
75
75
|
/**
|
|
@@ -79,8 +79,8 @@ declare class Catalog {
|
|
|
79
79
|
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
80
80
|
* Success response
|
|
81
81
|
* @name createDepartments
|
|
82
|
-
* @summary: Create
|
|
83
|
-
* @description: Create departments
|
|
82
|
+
* @summary: Create departments.
|
|
83
|
+
* @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
84
84
|
*/
|
|
85
85
|
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
86
86
|
/**
|
|
@@ -89,8 +89,8 @@ declare class Catalog {
|
|
|
89
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
90
|
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
91
91
|
* @name createInventoryExport
|
|
92
|
-
* @summary: Create
|
|
93
|
-
* @description:
|
|
92
|
+
* @summary: Create inventory export.
|
|
93
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
94
94
|
*/
|
|
95
95
|
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
96
96
|
/**
|
|
@@ -99,8 +99,8 @@ declare class Catalog {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
101
101
|
* @name createInventoryExportJob
|
|
102
|
-
* @summary: Create
|
|
103
|
-
* @description:
|
|
102
|
+
* @summary: Create inventory export job.
|
|
103
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
104
104
|
*/
|
|
105
105
|
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
106
106
|
/**
|
|
@@ -120,7 +120,7 @@ declare class Catalog {
|
|
|
120
120
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
121
121
|
* @name createProduct
|
|
122
122
|
* @summary: Create a product.
|
|
123
|
-
* @description:
|
|
123
|
+
* @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
|
|
124
124
|
*/
|
|
125
125
|
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
126
126
|
/**
|
|
@@ -129,8 +129,8 @@ declare class Catalog {
|
|
|
129
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
130
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
131
131
|
* @name createProductAssetsInBulk
|
|
132
|
-
* @summary: Create
|
|
133
|
-
* @description:
|
|
132
|
+
* @summary: Create product assets in bulk.
|
|
133
|
+
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
134
134
|
*/
|
|
135
135
|
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
136
136
|
/**
|
|
@@ -141,8 +141,8 @@ declare class Catalog {
|
|
|
141
141
|
* - Success response
|
|
142
142
|
*
|
|
143
143
|
* @name createProductBundle
|
|
144
|
-
* @summary: Create
|
|
145
|
-
* @description: Create
|
|
144
|
+
* @summary: Create a product bundle.
|
|
145
|
+
* @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
146
146
|
*/
|
|
147
147
|
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
148
148
|
/**
|
|
@@ -152,8 +152,8 @@ declare class Catalog {
|
|
|
152
152
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
153
153
|
* Success response
|
|
154
154
|
* @name createProductExportJob
|
|
155
|
-
* @summary: Create
|
|
156
|
-
* @description:
|
|
155
|
+
* @summary: Create product export job.
|
|
156
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
157
157
|
*/
|
|
158
158
|
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
159
159
|
/**
|
|
@@ -162,8 +162,8 @@ declare class Catalog {
|
|
|
162
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
163
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
164
164
|
* @name createProductsInBulk
|
|
165
|
-
* @summary: Create products in bulk
|
|
166
|
-
* @description:
|
|
165
|
+
* @summary: Create products in bulk.
|
|
166
|
+
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
|
|
167
167
|
*/
|
|
168
168
|
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
169
169
|
/**
|
|
@@ -173,7 +173,7 @@ declare class Catalog {
|
|
|
173
173
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
174
174
|
* @name createSizeGuide
|
|
175
175
|
* @summary: Create a size guide.
|
|
176
|
-
* @description:
|
|
176
|
+
* @description: Allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
177
177
|
*/
|
|
178
178
|
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
179
179
|
/**
|
|
@@ -182,8 +182,8 @@ declare class Catalog {
|
|
|
182
182
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
183
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
184
184
|
* @name deleteBulkInventoryJob
|
|
185
|
-
* @summary: Delete
|
|
186
|
-
* @description:
|
|
185
|
+
* @summary: Delete inventory bulk upload job.
|
|
186
|
+
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
187
187
|
*/
|
|
188
188
|
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
189
189
|
/**
|
|
@@ -193,7 +193,7 @@ declare class Catalog {
|
|
|
193
193
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
194
194
|
* @name deleteProduct
|
|
195
195
|
* @summary: Delete a product.
|
|
196
|
-
* @description:
|
|
196
|
+
* @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
197
197
|
*/
|
|
198
198
|
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
199
199
|
/**
|
|
@@ -202,8 +202,8 @@ declare class Catalog {
|
|
|
202
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
204
204
|
* @name deleteProductBulkJob
|
|
205
|
-
* @summary: Delete
|
|
206
|
-
* @description:
|
|
205
|
+
* @summary: Delete product bulk upload job.
|
|
206
|
+
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
207
207
|
*/
|
|
208
208
|
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
209
209
|
/**
|
|
@@ -212,8 +212,8 @@ declare class Catalog {
|
|
|
212
212
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
213
213
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
214
214
|
* @name deleteRealtimeInventory
|
|
215
|
-
* @summary:
|
|
216
|
-
* @description:
|
|
215
|
+
* @summary: Delete realtime inventory.
|
|
216
|
+
* @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
217
217
|
*/
|
|
218
218
|
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
219
219
|
/**
|
|
@@ -223,8 +223,8 @@ declare class Catalog {
|
|
|
223
223
|
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
|
|
224
224
|
* Success response
|
|
225
225
|
* @name deleteSize
|
|
226
|
-
* @summary: Delete
|
|
227
|
-
* @description:
|
|
226
|
+
* @summary: Delete product size.
|
|
227
|
+
* @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
228
228
|
*/
|
|
229
229
|
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
|
|
230
230
|
/**
|
|
@@ -235,8 +235,8 @@ declare class Catalog {
|
|
|
235
235
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
236
236
|
* @returns {Promise<string>} - Success response
|
|
237
237
|
* @name downloadInventoryTemplateView
|
|
238
|
-
* @summary: Download
|
|
239
|
-
* @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
238
|
+
* @summary: Download inventory template view.
|
|
239
|
+
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
240
240
|
*/
|
|
241
241
|
downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
242
242
|
/**
|
|
@@ -247,8 +247,8 @@ declare class Catalog {
|
|
|
247
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
248
248
|
* @returns {Promise<string>} - Success response
|
|
249
249
|
* @name downloadProductTemplateViews
|
|
250
|
-
* @summary: Download
|
|
251
|
-
* @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
250
|
+
* @summary: Download product template views.
|
|
251
|
+
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
252
252
|
*/
|
|
253
253
|
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
254
254
|
/**
|
|
@@ -258,7 +258,7 @@ declare class Catalog {
|
|
|
258
258
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
259
259
|
* @name editProduct
|
|
260
260
|
* @summary: Edit a product.
|
|
261
|
-
* @description:
|
|
261
|
+
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
|
|
262
262
|
*/
|
|
263
263
|
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
264
264
|
/**
|
|
@@ -267,8 +267,8 @@ declare class Catalog {
|
|
|
267
267
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
268
268
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
269
269
|
* @name exportInventoryConfig
|
|
270
|
-
* @summary:
|
|
271
|
-
* @description:
|
|
270
|
+
* @summary: Export inventory configuration.
|
|
271
|
+
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportInventoryConfig/).
|
|
272
272
|
*/
|
|
273
273
|
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
274
274
|
/**
|
|
@@ -279,8 +279,8 @@ declare class Catalog {
|
|
|
279
279
|
* - Success response
|
|
280
280
|
*
|
|
281
281
|
* @name getAllProductHsnCodes
|
|
282
|
-
* @summary:
|
|
283
|
-
* @description:
|
|
282
|
+
* @summary: Get all product HSN codes.
|
|
283
|
+
* @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
284
284
|
*/
|
|
285
285
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
286
286
|
/**
|
|
@@ -289,8 +289,8 @@ declare class Catalog {
|
|
|
289
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
290
|
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
|
|
291
291
|
* @name getCategoryData
|
|
292
|
-
* @summary: Get
|
|
293
|
-
* @description:
|
|
292
|
+
* @summary: Get category data.
|
|
293
|
+
* @description: Retrieve detailed information about a specific category with the associated meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
294
294
|
*/
|
|
295
295
|
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
|
|
296
296
|
/**
|
|
@@ -320,8 +320,8 @@ declare class Catalog {
|
|
|
320
320
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
321
321
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
322
322
|
* @name getCompanyMetrics
|
|
323
|
-
* @summary: Get
|
|
324
|
-
* @description:
|
|
323
|
+
* @summary: Get company metrics.
|
|
324
|
+
* @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
|
|
325
325
|
*/
|
|
326
326
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
327
327
|
/**
|
|
@@ -330,8 +330,8 @@ declare class Catalog {
|
|
|
330
330
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
331
331
|
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
332
332
|
* @name getDepartmentData
|
|
333
|
-
* @summary: Get
|
|
334
|
-
* @description:
|
|
333
|
+
* @summary: Get department data.
|
|
334
|
+
* @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
335
335
|
*/
|
|
336
336
|
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
337
337
|
/**
|
|
@@ -340,8 +340,8 @@ declare class Catalog {
|
|
|
340
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
341
341
|
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
342
342
|
* @name getGenderAttribute
|
|
343
|
-
* @summary: Get gender attribute
|
|
344
|
-
* @description:
|
|
343
|
+
* @summary: Get gender attribute.
|
|
344
|
+
* @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
345
345
|
*/
|
|
346
346
|
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
347
347
|
/**
|
|
@@ -350,8 +350,8 @@ declare class Catalog {
|
|
|
350
350
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
351
351
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
352
352
|
* @name getHsnCode
|
|
353
|
-
* @summary:
|
|
354
|
-
* @description:
|
|
353
|
+
* @summary: Get HSN code.
|
|
354
|
+
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
|
|
355
355
|
*/
|
|
356
356
|
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
357
357
|
/**
|
|
@@ -360,10 +360,34 @@ declare class Catalog {
|
|
|
360
360
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
361
361
|
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
|
|
362
362
|
* @name getInventories
|
|
363
|
-
* @summary:
|
|
364
|
-
* @description:
|
|
363
|
+
* @summary: Retrieve inventories.
|
|
364
|
+
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
365
365
|
*/
|
|
366
366
|
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
|
|
367
|
+
/**
|
|
368
|
+
* @param {Object} arg - Arg object.
|
|
369
|
+
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
370
|
+
* @param {string} [arg.size] - Size of which inventory is to get.
|
|
371
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
372
|
+
* page. Default is 12.
|
|
373
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
374
|
+
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
375
|
+
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
376
|
+
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
377
|
+
* or Primary Identifier) of which inventory is to get.
|
|
378
|
+
* @returns {Paginator<CatalogPlatformModel.GetInventoriesResponse>}
|
|
379
|
+
* @summary: Retrieve inventories.
|
|
380
|
+
* @description: Allows to get Inventories data for particular company.
|
|
381
|
+
*/
|
|
382
|
+
getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
|
|
383
|
+
itemId?: string;
|
|
384
|
+
size?: string;
|
|
385
|
+
pageSize?: number;
|
|
386
|
+
q?: string;
|
|
387
|
+
sellable?: boolean;
|
|
388
|
+
storeIds?: number[];
|
|
389
|
+
sizeIdentifier?: string;
|
|
390
|
+
}): Paginator<CatalogPlatformModel.GetInventoriesResponse>;
|
|
367
391
|
/**
|
|
368
392
|
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
369
393
|
* - Arg object
|
|
@@ -372,10 +396,21 @@ declare class Catalog {
|
|
|
372
396
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
373
397
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
374
398
|
* @name getInventoryBulkUploadHistory
|
|
375
|
-
* @summary:
|
|
376
|
-
* @description:
|
|
399
|
+
* @summary: Retrieve inventory bulk upload history.
|
|
400
|
+
* @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
377
401
|
*/
|
|
378
402
|
getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
403
|
+
/**
|
|
404
|
+
* @param {Object} arg - Arg object.
|
|
405
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
406
|
+
* page. Default is 12.
|
|
407
|
+
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
408
|
+
* @summary: Retrieve inventory bulk upload history.
|
|
409
|
+
* @description: Helps to get bulk Inventory upload jobs data.
|
|
410
|
+
*/
|
|
411
|
+
getInventoryBulkUploadHistoryPaginator({ pageSize }?: {
|
|
412
|
+
pageSize?: number;
|
|
413
|
+
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
379
414
|
/**
|
|
380
415
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
381
416
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -383,10 +418,29 @@ declare class Catalog {
|
|
|
383
418
|
* @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
|
|
384
419
|
* Success response
|
|
385
420
|
* @name getInventoryBySize
|
|
386
|
-
* @summary: Get
|
|
387
|
-
* @description:
|
|
421
|
+
* @summary: Get inventory by size.
|
|
422
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
|
|
388
423
|
*/
|
|
389
424
|
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
425
|
+
/**
|
|
426
|
+
* @param {Object} arg - Arg object.
|
|
427
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
428
|
+
* @param {string} arg.size - Size of which inventory is to get.
|
|
429
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
430
|
+
* page. Default is 12.
|
|
431
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
432
|
+
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
433
|
+
* @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
|
|
434
|
+
* @summary: Get inventory by size.
|
|
435
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
436
|
+
*/
|
|
437
|
+
getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: {
|
|
438
|
+
itemId: number;
|
|
439
|
+
size: string;
|
|
440
|
+
pageSize?: number;
|
|
441
|
+
q?: string;
|
|
442
|
+
sellable?: boolean;
|
|
443
|
+
}): Paginator<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
390
444
|
/**
|
|
391
445
|
* @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
|
|
392
446
|
* - Arg object
|
|
@@ -397,18 +451,38 @@ declare class Catalog {
|
|
|
397
451
|
* - Success response
|
|
398
452
|
*
|
|
399
453
|
* @name getInventoryBySizeIdentifier
|
|
400
|
-
* @summary: Get
|
|
401
|
-
* @description:
|
|
454
|
+
* @summary: Get inventory by size identifier.
|
|
455
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
402
456
|
*/
|
|
403
457
|
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
458
|
+
/**
|
|
459
|
+
* @param {Object} arg - Arg object.
|
|
460
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
461
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
462
|
+
* or Primary Identifier) of which inventory is to get.
|
|
463
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
464
|
+
* page. Default is 12.
|
|
465
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
466
|
+
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
467
|
+
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
468
|
+
* @summary: Get inventory by size identifier.
|
|
469
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
470
|
+
*/
|
|
471
|
+
getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
|
|
472
|
+
itemId: number;
|
|
473
|
+
sizeIdentifier: string;
|
|
474
|
+
pageSize?: number;
|
|
475
|
+
q?: string;
|
|
476
|
+
locationIds?: number[];
|
|
477
|
+
}): Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
404
478
|
/**
|
|
405
479
|
* @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
|
|
406
480
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
407
481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
408
482
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
409
483
|
* @name getInventoryExport
|
|
410
|
-
* @summary:
|
|
411
|
-
* @description:
|
|
484
|
+
* @summary: Retrieve inventory export data.
|
|
485
|
+
* @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
|
|
412
486
|
*/
|
|
413
487
|
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
414
488
|
/**
|
|
@@ -437,8 +511,8 @@ declare class Catalog {
|
|
|
437
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
438
512
|
* @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
|
|
439
513
|
* @name getOptimalLocations
|
|
440
|
-
* @summary:
|
|
441
|
-
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
514
|
+
* @summary: Get optimal locations.
|
|
515
|
+
* @description: Retrieve the most suitable locations based on certain criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
442
516
|
*/
|
|
443
517
|
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
|
|
444
518
|
/**
|
|
@@ -447,8 +521,8 @@ declare class Catalog {
|
|
|
447
521
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
522
|
* @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
|
|
449
523
|
* @name getProduct
|
|
450
|
-
* @summary: Get
|
|
451
|
-
* @description:
|
|
524
|
+
* @summary: Get product details.
|
|
525
|
+
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
452
526
|
*/
|
|
453
527
|
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
|
|
454
528
|
/**
|
|
@@ -457,10 +531,21 @@ declare class Catalog {
|
|
|
457
531
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
532
|
* @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
|
|
459
533
|
* @name getProductAssetsInBulk
|
|
460
|
-
* @summary:
|
|
461
|
-
* @description:
|
|
534
|
+
* @summary: Retrieve product assets in bulk.
|
|
535
|
+
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
462
536
|
*/
|
|
463
537
|
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
|
|
538
|
+
/**
|
|
539
|
+
* @param {Object} arg - Arg object.
|
|
540
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
541
|
+
* page. Default is 12.
|
|
542
|
+
* @returns {Paginator<CatalogPlatformModel.BulkAssetResponse>}
|
|
543
|
+
* @summary: Retrieve product assets in bulk.
|
|
544
|
+
* @description: Helps to retrieve bulk asset jobs data associated to a particular company.
|
|
545
|
+
*/
|
|
546
|
+
getProductAssetsInBulkPaginator({ pageSize }?: {
|
|
547
|
+
pageSize?: number;
|
|
548
|
+
}): Paginator<CatalogPlatformModel.BulkAssetResponse>;
|
|
464
549
|
/**
|
|
465
550
|
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
466
551
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -468,8 +553,8 @@ declare class Catalog {
|
|
|
468
553
|
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
|
|
469
554
|
* Success response
|
|
470
555
|
* @name getProductAttributes
|
|
471
|
-
* @summary: Get
|
|
472
|
-
* @description:
|
|
556
|
+
* @summary: Get product attributes.
|
|
557
|
+
* @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
473
558
|
*/
|
|
474
559
|
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
|
|
475
560
|
/**
|
|
@@ -478,10 +563,23 @@ declare class Catalog {
|
|
|
478
563
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
479
564
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
480
565
|
* @name getProductBulkUploadHistory
|
|
481
|
-
* @summary:
|
|
482
|
-
* @description:
|
|
566
|
+
* @summary: Retrieve product bulk upload history.
|
|
567
|
+
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
483
568
|
*/
|
|
484
569
|
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
570
|
+
/**
|
|
571
|
+
* @param {Object} arg - Arg object.
|
|
572
|
+
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
573
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
574
|
+
* page. Default is 12.
|
|
575
|
+
* @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
|
|
576
|
+
* @summary: Retrieve product bulk upload history.
|
|
577
|
+
* @description: Helps to get bulk product upload jobs data.
|
|
578
|
+
*/
|
|
579
|
+
getProductBulkUploadHistoryPaginator({ search, pageSize }?: {
|
|
580
|
+
search?: string;
|
|
581
|
+
pageSize?: number;
|
|
582
|
+
}): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
|
|
485
583
|
/**
|
|
486
584
|
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
487
585
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -490,8 +588,8 @@ declare class Catalog {
|
|
|
490
588
|
* - Success response
|
|
491
589
|
*
|
|
492
590
|
* @name getProductBundle
|
|
493
|
-
* @summary:
|
|
494
|
-
* @description:
|
|
591
|
+
* @summary: Retrieve product bundles.
|
|
592
|
+
* @description: Retrieve a list of product bundles available in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
495
593
|
*/
|
|
496
594
|
getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
497
595
|
/**
|
|
@@ -501,8 +599,8 @@ declare class Catalog {
|
|
|
501
599
|
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
502
600
|
* Success response
|
|
503
601
|
* @name getProductBundleDetail
|
|
504
|
-
* @summary: Get
|
|
505
|
-
* @description:
|
|
602
|
+
* @summary: Get product bundle details.
|
|
603
|
+
* @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
506
604
|
*/
|
|
507
605
|
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
508
606
|
/**
|
|
@@ -512,8 +610,8 @@ declare class Catalog {
|
|
|
512
610
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
513
611
|
* Success response
|
|
514
612
|
* @name getProductExportJobs
|
|
515
|
-
* @summary:
|
|
516
|
-
* @description:
|
|
613
|
+
* @summary: Retrieve product export jobs.
|
|
614
|
+
* @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
517
615
|
*/
|
|
518
616
|
getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
519
617
|
/**
|
|
@@ -522,8 +620,8 @@ declare class Catalog {
|
|
|
522
620
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
523
621
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
|
|
524
622
|
* @name getProductSize
|
|
525
|
-
* @summary: Get
|
|
526
|
-
* @description:
|
|
623
|
+
* @summary: Get product size details.
|
|
624
|
+
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
527
625
|
*/
|
|
528
626
|
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
|
|
529
627
|
/**
|
|
@@ -532,8 +630,8 @@ declare class Catalog {
|
|
|
532
630
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
533
631
|
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
|
|
534
632
|
* @name getProductTags
|
|
535
|
-
* @summary: Get
|
|
536
|
-
* @description:
|
|
633
|
+
* @summary: Get product tags.
|
|
634
|
+
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
537
635
|
*/
|
|
538
636
|
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
|
|
539
637
|
/**
|
|
@@ -542,8 +640,8 @@ declare class Catalog {
|
|
|
542
640
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
543
641
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
544
642
|
* @name getProductValidation
|
|
545
|
-
* @summary:
|
|
546
|
-
* @description:
|
|
643
|
+
* @summary: Get product validation.
|
|
644
|
+
* @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
|
|
547
645
|
*/
|
|
548
646
|
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
549
647
|
/**
|
|
@@ -553,18 +651,45 @@ declare class Catalog {
|
|
|
553
651
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
|
|
554
652
|
* Success response
|
|
555
653
|
* @name getProducts
|
|
556
|
-
* @summary:
|
|
557
|
-
* @description:
|
|
654
|
+
* @summary: Retrieve products.
|
|
655
|
+
* @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
|
|
558
656
|
*/
|
|
559
657
|
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
658
|
+
/**
|
|
659
|
+
* @param {Object} arg - Arg object.
|
|
660
|
+
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
661
|
+
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
662
|
+
* Category Ids
|
|
663
|
+
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
664
|
+
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
665
|
+
* Department Ids
|
|
666
|
+
* @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
|
|
667
|
+
* @param {string} [arg.q] - Get multiple products filtered by q string
|
|
668
|
+
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
669
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
670
|
+
* page. Default is 10.
|
|
671
|
+
* @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
|
|
672
|
+
* @summary: Retrieve products.
|
|
673
|
+
* @description: Retrieve a list of products available
|
|
674
|
+
*/
|
|
675
|
+
getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageSize, }?: {
|
|
676
|
+
brandIds?: number[];
|
|
677
|
+
categoryIds?: number[];
|
|
678
|
+
itemIds?: number[];
|
|
679
|
+
departmentIds?: number[];
|
|
680
|
+
itemCode?: string[];
|
|
681
|
+
q?: string;
|
|
682
|
+
tags?: string[];
|
|
683
|
+
pageSize?: number;
|
|
684
|
+
}): Paginator<CatalogPlatformModel.ProductListingResponseV2>;
|
|
560
685
|
/**
|
|
561
686
|
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
562
687
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
563
688
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
689
|
* @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
|
|
565
690
|
* @name getSellerInsights
|
|
566
|
-
* @summary:
|
|
567
|
-
* @description:
|
|
691
|
+
* @summary: Get seller insights.
|
|
692
|
+
* @description: Retrieve insights and analytics related to sellers within the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
568
693
|
*/
|
|
569
694
|
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
|
|
570
695
|
/**
|
|
@@ -573,8 +698,8 @@ declare class Catalog {
|
|
|
573
698
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
574
699
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
575
700
|
* @name getSingleProductHSNCode
|
|
576
|
-
* @summary:
|
|
577
|
-
* @description:
|
|
701
|
+
* @summary: Get single product HSN code.
|
|
702
|
+
* @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
578
703
|
*/
|
|
579
704
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
580
705
|
/**
|
|
@@ -583,8 +708,8 @@ declare class Catalog {
|
|
|
583
708
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
709
|
* @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
|
|
585
710
|
* @name getSizeGuide
|
|
586
|
-
* @summary: Get
|
|
587
|
-
* @description:
|
|
711
|
+
* @summary: Get size guide details.
|
|
712
|
+
* @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
588
713
|
*/
|
|
589
714
|
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
|
|
590
715
|
/**
|
|
@@ -593,8 +718,8 @@ declare class Catalog {
|
|
|
593
718
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
594
719
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
595
720
|
* @name getSizeGuides
|
|
596
|
-
* @summary:
|
|
597
|
-
* @description:
|
|
721
|
+
* @summary: Retrieve size guides.
|
|
722
|
+
* @description: Allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
|
|
598
723
|
*/
|
|
599
724
|
getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
600
725
|
/**
|
|
@@ -603,48 +728,121 @@ declare class Catalog {
|
|
|
603
728
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
729
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
605
730
|
* @name getStoreDetail
|
|
606
|
-
* @summary: Get
|
|
607
|
-
* @description:
|
|
731
|
+
* @summary: Get store details.
|
|
732
|
+
* @description: Retrieve the details of the store associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
|
|
608
733
|
*/
|
|
609
734
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
735
|
+
/**
|
|
736
|
+
* @param {Object} arg - Arg object.
|
|
737
|
+
* @param {string} [arg.q] - The search related the store for the company id.
|
|
738
|
+
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
739
|
+
* the page for the company id.
|
|
740
|
+
* @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
|
|
741
|
+
* @summary: Get store details.
|
|
742
|
+
* @description: Retrieve the details of the store associated with the company ID passed.
|
|
743
|
+
*/
|
|
744
|
+
getStoreDetailPaginator({ q, pageSize }?: {
|
|
745
|
+
q?: string;
|
|
746
|
+
pageSize?: number;
|
|
747
|
+
}): Paginator<CatalogPlatformModel.OptinStoreDetails>;
|
|
610
748
|
/**
|
|
611
749
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
612
750
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
613
751
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
614
752
|
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
|
|
615
753
|
* @name getVariantsOfProducts
|
|
616
|
-
* @summary: Get
|
|
617
|
-
* @description:
|
|
754
|
+
* @summary: Get variants of products.
|
|
755
|
+
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
618
756
|
*/
|
|
619
757
|
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
|
|
758
|
+
/**
|
|
759
|
+
* @param {Object} arg - Arg object.
|
|
760
|
+
* @param {number} arg.itemId - Get list of variants of item Id
|
|
761
|
+
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
762
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
763
|
+
* page. Default is 10.
|
|
764
|
+
* @returns {Paginator<CatalogPlatformModel.ProductVariantsResponse>}
|
|
765
|
+
* @summary: Get variants of products.
|
|
766
|
+
* @description: Retrieve variants of a specific product.
|
|
767
|
+
*/
|
|
768
|
+
getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: {
|
|
769
|
+
itemId: number;
|
|
770
|
+
variantType: string;
|
|
771
|
+
pageSize?: number;
|
|
772
|
+
}): Paginator<CatalogPlatformModel.ProductVariantsResponse>;
|
|
620
773
|
/**
|
|
621
774
|
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
622
775
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
623
776
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
624
777
|
* @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
|
|
625
778
|
* @name listCategories
|
|
626
|
-
* @summary:
|
|
627
|
-
* @description:
|
|
779
|
+
* @summary: List categories.
|
|
780
|
+
* @description: Retrieve a list of meta associated available product categories in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
628
781
|
*/
|
|
629
782
|
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
|
|
783
|
+
/**
|
|
784
|
+
* @param {Object} arg - Arg object.
|
|
785
|
+
* @param {string} [arg.level] - Get category for multiple levels
|
|
786
|
+
* @param {number} [arg.department] - Get category for multiple departments filtered
|
|
787
|
+
* @param {string} [arg.q] - Get multiple categories filtered by search string
|
|
788
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
789
|
+
* page. Default is 10.
|
|
790
|
+
* @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
|
|
791
|
+
* @param {string} [arg.slug] - Get category by slug
|
|
792
|
+
* @returns {Paginator<CatalogPlatformModel.CategoryResponse>}
|
|
793
|
+
* @summary: List categories.
|
|
794
|
+
* @description: Retrieve a list of meta associated available product categories in the catalog.
|
|
795
|
+
*/
|
|
796
|
+
listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
|
|
797
|
+
level?: string;
|
|
798
|
+
department?: number;
|
|
799
|
+
q?: string;
|
|
800
|
+
pageSize?: number;
|
|
801
|
+
uids?: number[];
|
|
802
|
+
slug?: string;
|
|
803
|
+
}): Paginator<CatalogPlatformModel.CategoryResponse>;
|
|
630
804
|
/**
|
|
631
805
|
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
632
806
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
633
807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
634
808
|
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
635
809
|
* @name listDepartmentsData
|
|
636
|
-
* @summary: List
|
|
810
|
+
* @summary: List department data.
|
|
637
811
|
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
|
|
638
812
|
*/
|
|
639
813
|
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
814
|
+
/**
|
|
815
|
+
* @param {Object} arg - Arg object.
|
|
816
|
+
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
817
|
+
* set, standard, digital
|
|
818
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
819
|
+
* page. Default is 10.
|
|
820
|
+
* @param {string} [arg.name] - Can search departments by passing name.
|
|
821
|
+
* @param {string} [arg.search] - Can search departments by passing name of
|
|
822
|
+
* the department in search parameter.
|
|
823
|
+
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
824
|
+
* whether they are active or inactive.
|
|
825
|
+
* @param {string} [arg.slug] - Can filter by slug
|
|
826
|
+
* @returns {Paginator<CatalogPlatformModel.DepartmentsResponse>}
|
|
827
|
+
* @summary: List department data.
|
|
828
|
+
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
829
|
+
*/
|
|
830
|
+
listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: {
|
|
831
|
+
itemType?: string;
|
|
832
|
+
pageSize?: number;
|
|
833
|
+
name?: string;
|
|
834
|
+
search?: string;
|
|
835
|
+
isActive?: boolean;
|
|
836
|
+
slug?: string;
|
|
837
|
+
}): Paginator<CatalogPlatformModel.DepartmentsResponse>;
|
|
640
838
|
/**
|
|
641
839
|
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
642
840
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
643
841
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
644
842
|
* @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
|
|
645
843
|
* @name listHSNCodes
|
|
646
|
-
* @summary: List HSN
|
|
647
|
-
* @description:
|
|
844
|
+
* @summary: List HSN codes.
|
|
845
|
+
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
648
846
|
*/
|
|
649
847
|
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
|
|
650
848
|
/**
|
|
@@ -655,8 +853,8 @@ declare class Catalog {
|
|
|
655
853
|
* - Success response
|
|
656
854
|
*
|
|
657
855
|
* @name listInventoryExport
|
|
658
|
-
* @summary:
|
|
659
|
-
* @description:
|
|
856
|
+
* @summary: List inventory exports.
|
|
857
|
+
* @description: Helps you the retrieve the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
660
858
|
*/
|
|
661
859
|
listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
662
860
|
/**
|
|
@@ -665,8 +863,8 @@ declare class Catalog {
|
|
|
665
863
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
666
864
|
* @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
|
|
667
865
|
* @name listProductTemplate
|
|
668
|
-
* @summary: List
|
|
669
|
-
* @description: Allows you to list all product templates, also can filter by department - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
866
|
+
* @summary: List product templates.
|
|
867
|
+
* @description: Allows you to list all product templates, also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
670
868
|
*/
|
|
671
869
|
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
|
|
672
870
|
/**
|
|
@@ -679,8 +877,8 @@ declare class Catalog {
|
|
|
679
877
|
* - Success response
|
|
680
878
|
*
|
|
681
879
|
* @name listProductTemplateCategories
|
|
682
|
-
* @summary: List
|
|
683
|
-
* @description: Allows you to list all product categories values for the departments specified - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
880
|
+
* @summary: List product template categories.
|
|
881
|
+
* @description: Allows you to list all product categories values for the departments specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
684
882
|
*/
|
|
685
883
|
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
|
|
686
884
|
/**
|
|
@@ -692,8 +890,8 @@ declare class Catalog {
|
|
|
692
890
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
693
891
|
* Success response
|
|
694
892
|
* @name listProductTemplateExportDetails
|
|
695
|
-
* @summary:
|
|
696
|
-
* @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
893
|
+
* @summary: List product template export details.
|
|
894
|
+
* @description: Retrieve export details related to product templates. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
697
895
|
*/
|
|
698
896
|
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
699
897
|
/**
|
|
@@ -703,8 +901,8 @@ declare class Catalog {
|
|
|
703
901
|
* @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
|
|
704
902
|
* Success response
|
|
705
903
|
* @name listTemplateBrandTypeValues
|
|
706
|
-
* @summary:
|
|
707
|
-
* @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
904
|
+
* @summary: List template brand type values.
|
|
905
|
+
* @description: Retrieve values related to template brand types. The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
708
906
|
*/
|
|
709
907
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
710
908
|
/**
|
|
@@ -713,8 +911,8 @@ declare class Catalog {
|
|
|
713
911
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
714
912
|
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
715
913
|
* @name updateCategory
|
|
716
|
-
* @summary: Update
|
|
717
|
-
* @description:
|
|
914
|
+
* @summary: Update category data.
|
|
915
|
+
* @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
718
916
|
*/
|
|
719
917
|
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
720
918
|
/**
|
|
@@ -723,8 +921,8 @@ declare class Catalog {
|
|
|
723
921
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
724
922
|
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
725
923
|
* @name updateDepartment
|
|
726
|
-
* @summary: Update
|
|
727
|
-
* @description:
|
|
924
|
+
* @summary: Update department data.
|
|
925
|
+
* @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
728
926
|
*/
|
|
729
927
|
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
730
928
|
/**
|
|
@@ -733,8 +931,8 @@ declare class Catalog {
|
|
|
733
931
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
734
932
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
735
933
|
* @name updateHsnCode
|
|
736
|
-
* @summary: Update
|
|
737
|
-
* @description:
|
|
934
|
+
* @summary: Update HSN code.
|
|
935
|
+
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
|
|
738
936
|
*/
|
|
739
937
|
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
740
938
|
/**
|
|
@@ -743,8 +941,8 @@ declare class Catalog {
|
|
|
743
941
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
744
942
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
745
943
|
* @name updateInventories
|
|
746
|
-
* @summary:
|
|
747
|
-
* @description:
|
|
944
|
+
* @summary: Update inventories.
|
|
945
|
+
* @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
748
946
|
*/
|
|
749
947
|
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
750
948
|
/**
|
|
@@ -767,8 +965,8 @@ declare class Catalog {
|
|
|
767
965
|
* - Success response
|
|
768
966
|
*
|
|
769
967
|
* @name updateProductBundle
|
|
770
|
-
* @summary: Update a
|
|
771
|
-
* @description:
|
|
968
|
+
* @summary: Update a product bundle.
|
|
969
|
+
* @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
772
970
|
*/
|
|
773
971
|
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
774
972
|
/**
|
|
@@ -777,8 +975,8 @@ declare class Catalog {
|
|
|
777
975
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
778
976
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
779
977
|
* @name updateRealtimeInventory
|
|
780
|
-
* @summary:
|
|
781
|
-
* @description:
|
|
978
|
+
* @summary: Update realtime inventory.
|
|
979
|
+
* @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
782
980
|
*/
|
|
783
981
|
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
784
982
|
/**
|
|
@@ -787,8 +985,8 @@ declare class Catalog {
|
|
|
787
985
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
788
986
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
789
987
|
* @name updateSizeGuide
|
|
790
|
-
* @summary:
|
|
791
|
-
* @description:
|
|
988
|
+
* @summary: Update a size guide.
|
|
989
|
+
* @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
792
990
|
*/
|
|
793
991
|
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
794
992
|
/**
|
|
@@ -797,8 +995,8 @@ declare class Catalog {
|
|
|
797
995
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
798
996
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
799
997
|
* @name uploadBulkProducts
|
|
800
|
-
* @summary:
|
|
801
|
-
* @description:
|
|
998
|
+
* @summary: Upload bulk products.
|
|
999
|
+
* @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
802
1000
|
*/
|
|
803
1001
|
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
804
1002
|
/**
|
|
@@ -808,8 +1006,8 @@ declare class Catalog {
|
|
|
808
1006
|
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
|
|
809
1007
|
* Success response
|
|
810
1008
|
* @name validateProductTemplate
|
|
811
|
-
* @summary: Validate
|
|
812
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
|
|
1009
|
+
* @summary: Validate product template.
|
|
1010
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
|
|
813
1011
|
*/
|
|
814
1012
|
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
|
|
815
1013
|
/**
|
|
@@ -821,10 +1019,11 @@ declare class Catalog {
|
|
|
821
1019
|
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
|
|
822
1020
|
* Success response
|
|
823
1021
|
* @name validateProductTemplateSchema
|
|
824
|
-
* @summary: Validate
|
|
825
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1022
|
+
* @summary: Validate product template schema.
|
|
1023
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
826
1024
|
*/
|
|
827
1025
|
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
|
|
828
1026
|
}
|
|
829
1027
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
830
1028
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
1029
|
+
import Paginator = require("../../common/Paginator");
|