@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +6 -4
- package/sdk/application/Cart/CartApplicationModel.js +6 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +90 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +113 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -4,69 +4,77 @@ declare class Catalog {
|
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
6
|
* @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
|
|
7
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
7
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
8
9
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
9
10
|
* @name addInventory
|
|
10
11
|
* @summary: Add Inventory for particular size and store.
|
|
11
12
|
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
|
|
12
13
|
*/
|
|
13
|
-
addInventory({ itemId, size, body }?: CatalogPlatformValidator.AddInventoryParam, {
|
|
14
|
+
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
14
15
|
/**
|
|
15
16
|
* @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
16
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
17
19
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
18
20
|
* @name allSizes
|
|
19
21
|
* @summary: All Sizes for a given Product
|
|
20
22
|
* @description: This API allows to get All Sizes for a given Product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
|
|
21
23
|
*/
|
|
22
|
-
allSizes({ itemId }?: CatalogPlatformValidator.AllSizesParam, {
|
|
24
|
+
allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
|
|
23
25
|
/**
|
|
24
26
|
* @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
|
|
27
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
29
|
* @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
|
|
27
30
|
* @name bulkHsnCode
|
|
28
31
|
* @summary: Bulk Create or Update Hsn Code.
|
|
29
32
|
* @description: Bulk Create or Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
|
|
30
33
|
*/
|
|
31
|
-
bulkHsnCode({ body }?: CatalogPlatformValidator.BulkHsnCodeParam, {
|
|
34
|
+
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponse>;
|
|
32
35
|
/**
|
|
33
36
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
34
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
35
39
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
36
40
|
* @name createBulkInventory
|
|
37
41
|
* @summary: Create products in bulk associated with given batch Id.
|
|
38
42
|
* @description: This API 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/).
|
|
39
43
|
*/
|
|
40
|
-
createBulkInventory({ batchId, body }?: CatalogPlatformValidator.CreateBulkInventoryParam, {
|
|
44
|
+
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
41
45
|
/**
|
|
42
46
|
* @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
|
|
47
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
43
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
49
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
45
50
|
* @name createBulkInventoryJob
|
|
46
51
|
* @summary: Create a Bulk Inventory upload Job.
|
|
47
52
|
* @description: This API helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
48
53
|
*/
|
|
49
|
-
createBulkInventoryJob({ body }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, {
|
|
54
|
+
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
50
55
|
/**
|
|
51
56
|
* @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
|
|
57
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
59
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
54
60
|
* @name createBulkProductUploadJob
|
|
55
61
|
* @summary: Create a Bulk product to upload job.
|
|
56
62
|
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
|
|
57
63
|
*/
|
|
58
|
-
createBulkProductUploadJob({ body }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, {
|
|
64
|
+
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
59
65
|
/**
|
|
60
66
|
* @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
|
|
67
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
61
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
69
|
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
63
70
|
* @name createCategories
|
|
64
71
|
* @summary: Create product categories
|
|
65
72
|
* @description: This API lets user create product categories - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
66
73
|
*/
|
|
67
|
-
createCategories({ body }?: CatalogPlatformValidator.CreateCategoriesParam, {
|
|
74
|
+
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
68
75
|
/**
|
|
69
76
|
* @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
|
|
77
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
79
|
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
72
80
|
* Success response
|
|
@@ -74,54 +82,60 @@ declare class Catalog {
|
|
|
74
82
|
* @summary: Create the department.
|
|
75
83
|
* @description: Create departments using the API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
76
84
|
*/
|
|
77
|
-
createDepartments({ body }?: CatalogPlatformValidator.CreateDepartmentsParam, {
|
|
85
|
+
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
78
86
|
/**
|
|
79
87
|
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
88
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
80
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
81
90
|
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
82
91
|
* @name createInventoryExport
|
|
83
92
|
* @summary: Create an inventory export job.
|
|
84
93
|
* @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
85
94
|
*/
|
|
86
|
-
createInventoryExport({ body }?: CatalogPlatformValidator.CreateInventoryExportParam, {
|
|
95
|
+
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
87
96
|
/**
|
|
88
97
|
* @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
89
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
100
|
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
91
101
|
* @name createInventoryExportJob
|
|
92
102
|
* @summary: Create a Inventory export Job.
|
|
93
103
|
* @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
94
104
|
*/
|
|
95
|
-
createInventoryExportJob({ body }?: CatalogPlatformValidator.CreateInventoryExportJobParam, {
|
|
105
|
+
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
96
106
|
/**
|
|
97
107
|
* @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
|
|
108
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
98
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
110
|
* @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
|
|
100
111
|
* @name createMarketplaceOptin
|
|
101
112
|
* @summary: Create/Update opt-in infomation.
|
|
102
113
|
* @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
|
|
103
114
|
*/
|
|
104
|
-
createMarketplaceOptin({ marketplace, body }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, {
|
|
115
|
+
createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
|
|
105
116
|
/**
|
|
106
117
|
* @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
|
|
118
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
107
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
108
120
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
109
121
|
* @name createProduct
|
|
110
122
|
* @summary: Create a product.
|
|
111
123
|
* @description: This API allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
|
|
112
124
|
*/
|
|
113
|
-
createProduct({ body }?: CatalogPlatformValidator.CreateProductParam, {
|
|
125
|
+
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
114
126
|
/**
|
|
115
127
|
* @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
|
|
128
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
116
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
117
130
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
118
131
|
* @name createProductAssetsInBulk
|
|
119
132
|
* @summary: Create a Bulk asset upload Job.
|
|
120
133
|
* @description: This API helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
121
134
|
*/
|
|
122
|
-
createProductAssetsInBulk({ body }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, {
|
|
135
|
+
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
123
136
|
/**
|
|
124
137
|
* @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
|
|
138
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
125
139
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
126
140
|
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
127
141
|
* - Success response
|
|
@@ -130,9 +144,10 @@ declare class Catalog {
|
|
|
130
144
|
* @summary: Create Product Bundle
|
|
131
145
|
* @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
132
146
|
*/
|
|
133
|
-
createProductBundle({ body }?: CatalogPlatformValidator.CreateProductBundleParam, {
|
|
147
|
+
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
134
148
|
/**
|
|
135
149
|
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
150
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
136
151
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
137
152
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
138
153
|
* Success response
|
|
@@ -140,72 +155,80 @@ declare class Catalog {
|
|
|
140
155
|
* @summary: Create a product export job.
|
|
141
156
|
* @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
142
157
|
*/
|
|
143
|
-
createProductExportJob({ body }?: CatalogPlatformValidator.CreateProductExportJobParam, {
|
|
158
|
+
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
144
159
|
/**
|
|
145
160
|
* @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
|
|
161
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
146
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
163
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
148
164
|
* @name createProductsInBulk
|
|
149
165
|
* @summary: Create products in bulk associated with given batch Id.
|
|
150
166
|
* @description: This API 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/).
|
|
151
167
|
*/
|
|
152
|
-
createProductsInBulk({ batchId, body }?: CatalogPlatformValidator.CreateProductsInBulkParam, {
|
|
168
|
+
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
153
169
|
/**
|
|
154
170
|
* @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
|
|
171
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
172
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
173
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
157
174
|
* @name createSizeGuide
|
|
158
175
|
* @summary: Create a size guide.
|
|
159
176
|
* @description: This API allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
160
177
|
*/
|
|
161
|
-
createSizeGuide({ body }?: CatalogPlatformValidator.CreateSizeGuideParam, {
|
|
178
|
+
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
162
179
|
/**
|
|
163
180
|
* @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
|
|
181
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
164
182
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
183
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
166
184
|
* @name deleteBulkInventoryJob
|
|
167
185
|
* @summary: Delete Bulk Inventory job.
|
|
168
186
|
* @description: This API allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
169
187
|
*/
|
|
170
|
-
deleteBulkInventoryJob({ batchId }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, {
|
|
188
|
+
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
171
189
|
/**
|
|
172
190
|
* @param {CatalogPlatformValidator.DeleteInventoryParam} arg - Arg object
|
|
191
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
173
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
193
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
175
194
|
* @name deleteInventory
|
|
176
195
|
* @summary: Delete a Inventory.
|
|
177
196
|
* @description: This API allows to delete inventory of a particular product for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteInventory/).
|
|
178
197
|
*/
|
|
179
|
-
deleteInventory({ size, itemId, locationId }?: CatalogPlatformValidator.DeleteInventoryParam, {
|
|
198
|
+
deleteInventory({ size, itemId, locationId, requestHeaders }?: CatalogPlatformValidator.DeleteInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
180
199
|
/**
|
|
181
200
|
* @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
|
|
201
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
182
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
203
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
184
204
|
* @name deleteProduct
|
|
185
205
|
* @summary: Delete a product.
|
|
186
206
|
* @description: This API allows to delete product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
187
207
|
*/
|
|
188
|
-
deleteProduct({ itemId }?: CatalogPlatformValidator.DeleteProductParam, {
|
|
208
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
189
209
|
/**
|
|
190
210
|
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
211
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
191
212
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
192
213
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
193
214
|
* @name deleteProductBulkJob
|
|
194
215
|
* @summary: Delete Bulk product job.
|
|
195
216
|
* @description: This API allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
196
217
|
*/
|
|
197
|
-
deleteProductBulkJob({ batchId }?: CatalogPlatformValidator.DeleteProductBulkJobParam, {
|
|
218
|
+
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
198
219
|
/**
|
|
199
220
|
* @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
|
|
221
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
200
222
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
201
223
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
202
224
|
* @name deleteRealtimeInventory
|
|
203
225
|
* @summary: Add Inventory for particular size and store.
|
|
204
226
|
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
205
227
|
*/
|
|
206
|
-
deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, {
|
|
228
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
207
229
|
/**
|
|
208
230
|
* @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
|
|
231
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
209
232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
210
233
|
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
|
|
211
234
|
* Success response
|
|
@@ -213,49 +236,54 @@ declare class Catalog {
|
|
|
213
236
|
* @summary: Delete a Size associated with product.
|
|
214
237
|
* @description: This API allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
215
238
|
*/
|
|
216
|
-
deleteSize({ itemId, size }?: CatalogPlatformValidator.DeleteSizeParam, {
|
|
239
|
+
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
|
|
217
240
|
/**
|
|
218
241
|
* @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
|
|
219
242
|
* - Arg object
|
|
220
243
|
*
|
|
244
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
221
245
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
222
246
|
* @returns {Promise<string>} - Success response
|
|
223
247
|
* @name downloadInventoryTemplateView
|
|
224
248
|
* @summary: Download Product Template View
|
|
225
249
|
* @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
226
250
|
*/
|
|
227
|
-
downloadInventoryTemplateView({ itemType }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, {
|
|
251
|
+
downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
228
252
|
/**
|
|
229
253
|
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
230
254
|
* - Arg object
|
|
231
255
|
*
|
|
256
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
232
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
233
258
|
* @returns {Promise<string>} - Success response
|
|
234
259
|
* @name downloadProductTemplateViews
|
|
235
260
|
* @summary: Download Product Template View
|
|
236
261
|
* @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
237
262
|
*/
|
|
238
|
-
downloadProductTemplateViews({ slug }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, {
|
|
263
|
+
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
239
264
|
/**
|
|
240
265
|
* @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
|
|
266
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
241
267
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
242
268
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
243
269
|
* @name editProduct
|
|
244
270
|
* @summary: Edit a product.
|
|
245
271
|
* @description: This API allows to edit product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
|
|
246
272
|
*/
|
|
247
|
-
editProduct({ itemId, body }?: CatalogPlatformValidator.EditProductParam, {
|
|
273
|
+
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
248
274
|
/**
|
|
249
275
|
* @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
|
|
276
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
250
277
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
251
278
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
252
279
|
* @name exportInventoryConfig
|
|
253
280
|
* @summary: Get List of different filters for inventory export
|
|
254
281
|
* @description: This API allows get 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/).
|
|
255
282
|
*/
|
|
256
|
-
exportInventoryConfig({ filterType }?: CatalogPlatformValidator.ExportInventoryConfigParam, {
|
|
283
|
+
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
257
284
|
/**
|
|
258
285
|
* @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
|
|
286
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
259
287
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
288
|
* @returns {Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>}
|
|
261
289
|
* - Success response
|
|
@@ -264,18 +292,20 @@ declare class Catalog {
|
|
|
264
292
|
* @summary: Hsn Code List.
|
|
265
293
|
* @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
266
294
|
*/
|
|
267
|
-
getAllProductHsnCodes({ pageNo, pageSize, q, type }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, {
|
|
295
|
+
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
268
296
|
/**
|
|
269
297
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
298
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
299
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
300
|
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
|
|
272
301
|
* @name getCategoryData
|
|
273
302
|
* @summary: Get product category by uid
|
|
274
303
|
* @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
275
304
|
*/
|
|
276
|
-
getCategoryData({ uid }?: CatalogPlatformValidator.GetCategoryDataParam, {
|
|
305
|
+
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
|
|
277
306
|
/**
|
|
278
307
|
* @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
|
|
308
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
279
309
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
310
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
|
|
281
311
|
* Success response
|
|
@@ -283,74 +313,82 @@ declare class Catalog {
|
|
|
283
313
|
* @summary: Get the Company Brand details of Optin.
|
|
284
314
|
* @description: Get the details of the Brands associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
|
|
285
315
|
*/
|
|
286
|
-
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, {
|
|
316
|
+
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
287
317
|
/**
|
|
288
318
|
* @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
|
|
319
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
289
320
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
321
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
291
322
|
* @name getCompanyDetail
|
|
292
323
|
* @summary: Get the Company details.
|
|
293
324
|
* @description: Get the details of the company associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
|
|
294
325
|
*/
|
|
295
|
-
getCompanyDetail({
|
|
326
|
+
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
296
327
|
/**
|
|
297
328
|
* @param {CatalogPlatformValidator.GetCompanyMetricsParam} arg - Arg object
|
|
329
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
298
330
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
299
331
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
300
332
|
* @name getCompanyMetrics
|
|
301
333
|
* @summary: Get the Company metrics
|
|
302
334
|
* @description: Get the Company metrics associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
|
|
303
335
|
*/
|
|
304
|
-
getCompanyMetrics({
|
|
336
|
+
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
305
337
|
/**
|
|
306
338
|
* @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
|
|
339
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
307
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
308
341
|
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
309
342
|
* @name getDepartmentData
|
|
310
343
|
* @summary: Get specific departments details by passing in unique id of the department.
|
|
311
344
|
* @description: Allows you to get department data, by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
312
345
|
*/
|
|
313
|
-
getDepartmentData({ uid }?: CatalogPlatformValidator.GetDepartmentDataParam, {
|
|
346
|
+
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
314
347
|
/**
|
|
315
348
|
* @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
|
|
349
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
316
350
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
317
351
|
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
318
352
|
* @name getGenderAttribute
|
|
319
353
|
* @summary: Get gender attribute details
|
|
320
354
|
* @description: This API allows to view the gender attribute details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
321
355
|
*/
|
|
322
|
-
getGenderAttribute({ attributeSlug }?: CatalogPlatformValidator.GetGenderAttributeParam, {
|
|
356
|
+
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
323
357
|
/**
|
|
324
358
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
359
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
360
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
361
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
327
362
|
* @name getHsnCode
|
|
328
363
|
* @summary: Fetch Hsn Code.
|
|
329
364
|
* @description: Fetch Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
|
|
330
365
|
*/
|
|
331
|
-
getHsnCode({ id }?: CatalogPlatformValidator.GetHsnCodeParam, {
|
|
366
|
+
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
332
367
|
/**
|
|
333
368
|
* @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
|
|
369
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
334
370
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
371
|
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
|
|
336
372
|
* @name getInventories
|
|
337
373
|
* @summary: Get Inventory for company
|
|
338
374
|
* @description: This API allows get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
339
375
|
*/
|
|
340
|
-
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, }?: CatalogPlatformValidator.GetInventoriesParam, {
|
|
376
|
+
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
|
|
341
377
|
/**
|
|
342
378
|
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
343
379
|
* - Arg object
|
|
344
380
|
*
|
|
381
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
382
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
383
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
347
384
|
* @name getInventoryBulkUploadHistory
|
|
348
385
|
* @summary: Get a list of all bulk Inventory upload jobs.
|
|
349
386
|
* @description: This API helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
350
387
|
*/
|
|
351
|
-
getInventoryBulkUploadHistory({ pageNo, pageSize }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, {
|
|
388
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
352
389
|
/**
|
|
353
390
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
391
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
354
392
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
355
393
|
* @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
|
|
356
394
|
* Success response
|
|
@@ -358,11 +396,12 @@ declare class Catalog {
|
|
|
358
396
|
* @summary: Get Inventory for company
|
|
359
397
|
* @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
|
|
360
398
|
*/
|
|
361
|
-
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable }?: CatalogPlatformValidator.GetInventoryBySizeParam, {
|
|
399
|
+
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
362
400
|
/**
|
|
363
401
|
* @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
|
|
364
402
|
* - Arg object
|
|
365
403
|
*
|
|
404
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
366
405
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
406
|
* @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
368
407
|
* - Success response
|
|
@@ -371,54 +410,60 @@ declare class Catalog {
|
|
|
371
410
|
* @summary: Get Inventory for company
|
|
372
411
|
* @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
373
412
|
*/
|
|
374
|
-
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, {
|
|
413
|
+
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
375
414
|
/**
|
|
376
415
|
* @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
|
|
416
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
377
417
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
378
418
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
379
419
|
* @name getInventoryExport
|
|
380
420
|
* @summary: Get Inventory export history.
|
|
381
421
|
* @description: This API helps to get Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
|
|
382
422
|
*/
|
|
383
|
-
getInventoryExport({
|
|
423
|
+
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
384
424
|
/**
|
|
385
425
|
* @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object
|
|
426
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
386
427
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
387
428
|
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
388
429
|
* @name getMarketplaceOptinDetail
|
|
389
430
|
* @summary: Get opt-in infomation.
|
|
390
431
|
* @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
391
432
|
*/
|
|
392
|
-
getMarketplaceOptinDetail({
|
|
433
|
+
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
393
434
|
/**
|
|
394
435
|
* @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
436
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
395
437
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
396
438
|
* @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
|
|
397
439
|
* @name getOptimalLocations
|
|
398
440
|
* @summary: Location Reassignment
|
|
399
|
-
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
441
|
+
* @description: Location Reassignment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
400
442
|
*/
|
|
401
|
-
getOptimalLocations({ body }?: CatalogPlatformValidator.GetOptimalLocationsParam, {
|
|
443
|
+
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
|
|
402
444
|
/**
|
|
403
445
|
* @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
|
|
446
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
404
447
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
405
448
|
* @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
|
|
406
449
|
* @name getProduct
|
|
407
450
|
* @summary: Get a single product.
|
|
408
451
|
* @description: This API helps to get data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
409
452
|
*/
|
|
410
|
-
getProduct({ itemId, brandUid, itemCode }?: CatalogPlatformValidator.GetProductParam, {
|
|
453
|
+
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
|
|
411
454
|
/**
|
|
412
455
|
* @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
|
|
456
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
413
457
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
414
458
|
* @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
|
|
415
459
|
* @name getProductAssetsInBulk
|
|
416
460
|
* @summary: Get a list of all bulk asset jobs.
|
|
417
461
|
* @description: This API helps to get bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
418
462
|
*/
|
|
419
|
-
getProductAssetsInBulk({ pageNo, pageSize }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, {
|
|
463
|
+
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
|
|
420
464
|
/**
|
|
421
465
|
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
466
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
422
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
423
468
|
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
|
|
424
469
|
* Success response
|
|
@@ -426,18 +471,20 @@ declare class Catalog {
|
|
|
426
471
|
* @summary: Get list of all the attributes by their l3_categories
|
|
427
472
|
* @description: This API allows to list all the attributes by their l3_categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
428
473
|
*/
|
|
429
|
-
getProductAttributes({ category, filter }?: CatalogPlatformValidator.GetProductAttributesParam, {
|
|
474
|
+
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
|
|
430
475
|
/**
|
|
431
476
|
* @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
|
|
477
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
432
478
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
433
479
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
434
480
|
* @name getProductBulkUploadHistory
|
|
435
481
|
* @summary: Get a list of all bulk product upload jobs.
|
|
436
482
|
* @description: This API helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
437
483
|
*/
|
|
438
|
-
getProductBulkUploadHistory({ search, pageNo, pageSize }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, {
|
|
484
|
+
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
439
485
|
/**
|
|
440
486
|
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
487
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
441
488
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
442
489
|
* @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
|
|
443
490
|
* - Success response
|
|
@@ -446,9 +493,10 @@ declare class Catalog {
|
|
|
446
493
|
* @summary: List all Product Bundles
|
|
447
494
|
* @description: Get all product bundles for a particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
448
495
|
*/
|
|
449
|
-
getProductBundle({ q, slug }?: CatalogPlatformValidator.GetProductBundleParam, {
|
|
496
|
+
getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
450
497
|
/**
|
|
451
498
|
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
499
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
452
500
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
453
501
|
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
454
502
|
* Success response
|
|
@@ -456,9 +504,10 @@ declare class Catalog {
|
|
|
456
504
|
* @summary: Get a particular Product Bundle details
|
|
457
505
|
* @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
458
506
|
*/
|
|
459
|
-
getProductBundleDetail({ id }?: CatalogPlatformValidator.GetProductBundleDetailParam, {
|
|
507
|
+
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
460
508
|
/**
|
|
461
509
|
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
510
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
462
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
463
512
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
464
513
|
* Success response
|
|
@@ -466,36 +515,40 @@ declare class Catalog {
|
|
|
466
515
|
* @summary: Allows you to list all product templates export list details
|
|
467
516
|
* @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
468
517
|
*/
|
|
469
|
-
getProductExportJobs({ status, fromDate, toDate, q }?: CatalogPlatformValidator.GetProductExportJobsParam, {
|
|
518
|
+
getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
470
519
|
/**
|
|
471
520
|
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
521
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
472
522
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
473
523
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
|
|
474
524
|
* @name getProductSize
|
|
475
525
|
* @summary: Get a single product size.
|
|
476
526
|
* @description: This API helps to get data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
477
527
|
*/
|
|
478
|
-
getProductSize({ itemId, itemCode, brandUid, uid }?: CatalogPlatformValidator.GetProductSizeParam, {
|
|
528
|
+
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
|
|
479
529
|
/**
|
|
480
530
|
* @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
|
|
531
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
481
532
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
482
533
|
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
|
|
483
534
|
* @name getProductTags
|
|
484
535
|
* @summary: Get a list of all tags associated with company.
|
|
485
536
|
* @description: This API helps to get tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
486
537
|
*/
|
|
487
|
-
getProductTags({
|
|
538
|
+
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
|
|
488
539
|
/**
|
|
489
540
|
* @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
|
|
541
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
490
542
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
491
543
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
492
544
|
* @name getProductValidation
|
|
493
545
|
* @summary: Validate product/size data
|
|
494
546
|
* @description: This API validates product data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
|
|
495
547
|
*/
|
|
496
|
-
getProductValidation({
|
|
548
|
+
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
497
549
|
/**
|
|
498
550
|
* @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
|
|
551
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
499
552
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
553
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
|
|
501
554
|
* Success response
|
|
@@ -503,90 +556,100 @@ declare class Catalog {
|
|
|
503
556
|
* @summary: Get product list
|
|
504
557
|
* @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
|
|
505
558
|
*/
|
|
506
|
-
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: CatalogPlatformValidator.GetProductsParam, {
|
|
559
|
+
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
507
560
|
/**
|
|
508
561
|
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
562
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
509
563
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
510
564
|
* @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
|
|
511
565
|
* @name getSellerInsights
|
|
512
566
|
* @summary: Analytics data of catalog and inventory that are being cross-selled.
|
|
513
567
|
* @description: Analytics data of catalog and inventory that are being cross-selled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
514
568
|
*/
|
|
515
|
-
getSellerInsights({ sellerAppId }?: CatalogPlatformValidator.GetSellerInsightsParam, {
|
|
569
|
+
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
|
|
516
570
|
/**
|
|
517
571
|
* @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
|
|
572
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
518
573
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
519
574
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
520
575
|
* @name getSingleProductHSNCode
|
|
521
576
|
* @summary: Hsn Code List.
|
|
522
577
|
* @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
523
578
|
*/
|
|
524
|
-
getSingleProductHSNCode({ reportingHsn }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, {
|
|
579
|
+
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
525
580
|
/**
|
|
526
581
|
* @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
|
|
582
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
527
583
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
528
584
|
* @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
|
|
529
585
|
* @name getSizeGuide
|
|
530
586
|
* @summary: Get a single size guide.
|
|
531
587
|
* @description: This API helps to get data associated to a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
532
588
|
*/
|
|
533
|
-
getSizeGuide({ id }?: CatalogPlatformValidator.GetSizeGuideParam, {
|
|
589
|
+
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
|
|
534
590
|
/**
|
|
535
591
|
* @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
|
|
592
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
536
593
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
537
594
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
538
595
|
* @name getSizeGuides
|
|
539
596
|
* @summary: Get list of size guides
|
|
540
597
|
* @description: This API 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/).
|
|
541
598
|
*/
|
|
542
|
-
getSizeGuides({ active, q, tag, pageNo, pageSize }?: CatalogPlatformValidator.GetSizeGuidesParam, {
|
|
599
|
+
getSizeGuides({ active, q, tag, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
543
600
|
/**
|
|
544
601
|
* @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
|
|
602
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
545
603
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
546
604
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
547
605
|
* @name getStoreDetail
|
|
548
606
|
* @summary: Get the Store details.
|
|
549
607
|
* @description: Get 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/).
|
|
550
608
|
*/
|
|
551
|
-
getStoreDetail({ q, pageNo, pageSize }?: CatalogPlatformValidator.GetStoreDetailParam, {
|
|
609
|
+
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
552
610
|
/**
|
|
553
611
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
612
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
554
613
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
555
614
|
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
|
|
556
615
|
* @name getVariantsOfProducts
|
|
557
616
|
* @summary: Get product list
|
|
558
617
|
* @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
559
618
|
*/
|
|
560
|
-
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize }?: CatalogPlatformValidator.GetVariantsOfProductsParam, {
|
|
619
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
|
|
561
620
|
/**
|
|
562
621
|
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
622
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
563
623
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
624
|
* @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
|
|
565
625
|
* @name listCategories
|
|
566
626
|
* @summary: Get product categories list
|
|
567
627
|
* @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
568
628
|
*/
|
|
569
|
-
listCategories({ level, departments, q, pageNo, pageSize }?: CatalogPlatformValidator.ListCategoriesParam, {
|
|
629
|
+
listCategories({ level, departments, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
|
|
570
630
|
/**
|
|
571
631
|
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
632
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
572
633
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
573
634
|
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
574
635
|
* @name listDepartmentsData
|
|
575
636
|
* @summary: List all Departments.
|
|
576
637
|
* @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/).
|
|
577
638
|
*/
|
|
578
|
-
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive }?: CatalogPlatformValidator.ListDepartmentsDataParam, {
|
|
639
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, requestHeaders }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
579
640
|
/**
|
|
580
641
|
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
642
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
581
643
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
582
644
|
* @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
|
|
583
645
|
* @name listHSNCodes
|
|
584
646
|
* @summary: List HSN Codes
|
|
585
647
|
* @description: Allows you to list all hsn Codes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
586
648
|
*/
|
|
587
|
-
listHSNCodes({
|
|
649
|
+
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
|
|
588
650
|
/**
|
|
589
651
|
* @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
|
|
652
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
590
653
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
591
654
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
|
|
592
655
|
* - Success response
|
|
@@ -595,20 +658,22 @@ declare class Catalog {
|
|
|
595
658
|
* @summary: Get the history of the inventory export.
|
|
596
659
|
* @description: This API helps you the get the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
597
660
|
*/
|
|
598
|
-
listInventoryExport({ status, fromDate, toDate, q }?: CatalogPlatformValidator.ListInventoryExportParam, {
|
|
661
|
+
listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
599
662
|
/**
|
|
600
663
|
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
664
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
601
665
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
602
666
|
* @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
|
|
603
667
|
* @name listProductTemplate
|
|
604
668
|
* @summary: List all Templates
|
|
605
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/).
|
|
606
670
|
*/
|
|
607
|
-
listProductTemplate({ department }?: CatalogPlatformValidator.ListProductTemplateParam, {
|
|
671
|
+
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
|
|
608
672
|
/**
|
|
609
673
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
610
674
|
* - Arg object
|
|
611
675
|
*
|
|
676
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
612
677
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
613
678
|
* @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
|
|
614
679
|
* - Success response
|
|
@@ -617,11 +682,12 @@ declare class Catalog {
|
|
|
617
682
|
* @summary: List Department specifiec product categories
|
|
618
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/).
|
|
619
684
|
*/
|
|
620
|
-
listProductTemplateCategories({ departments, itemType }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, {
|
|
685
|
+
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
|
|
621
686
|
/**
|
|
622
687
|
* @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
|
|
623
688
|
* - Arg object
|
|
624
689
|
*
|
|
690
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
625
691
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
626
692
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
627
693
|
* Success response
|
|
@@ -629,9 +695,10 @@ declare class Catalog {
|
|
|
629
695
|
* @summary: Allows you to list all product templates export list details
|
|
630
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/).
|
|
631
697
|
*/
|
|
632
|
-
listProductTemplateExportDetails({
|
|
698
|
+
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
633
699
|
/**
|
|
634
700
|
* @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
|
|
701
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
635
702
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
636
703
|
* @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
|
|
637
704
|
* Success response
|
|
@@ -639,45 +706,50 @@ declare class Catalog {
|
|
|
639
706
|
* @summary: Allows you to list all values for Templates, Brands or Type
|
|
640
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/).
|
|
641
708
|
*/
|
|
642
|
-
listTemplateBrandTypeValues({ filter, templateTag, itemType }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, {
|
|
709
|
+
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
643
710
|
/**
|
|
644
711
|
* @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
|
|
712
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
645
713
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
646
714
|
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
647
715
|
* @name updateCategory
|
|
648
716
|
* @summary: Update product categories
|
|
649
717
|
* @description: Update a product category using this api - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
650
718
|
*/
|
|
651
|
-
updateCategory({ uid, body }?: CatalogPlatformValidator.UpdateCategoryParam, {
|
|
719
|
+
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
652
720
|
/**
|
|
653
721
|
* @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
|
|
722
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
654
723
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
655
724
|
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
656
725
|
* @name updateDepartment
|
|
657
726
|
* @summary: Update the department by their uid.
|
|
658
727
|
* @description: Update the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
659
728
|
*/
|
|
660
|
-
updateDepartment({ uid, body }?: CatalogPlatformValidator.UpdateDepartmentParam, {
|
|
729
|
+
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
661
730
|
/**
|
|
662
731
|
* @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
|
|
732
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
663
733
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
664
734
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
665
735
|
* @name updateHsnCode
|
|
666
736
|
* @summary: Update Hsn Code.
|
|
667
737
|
* @description: Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
|
|
668
738
|
*/
|
|
669
|
-
updateHsnCode({ id, body }?: CatalogPlatformValidator.UpdateHsnCodeParam, {
|
|
739
|
+
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
670
740
|
/**
|
|
671
741
|
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
742
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
672
743
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
673
744
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
674
745
|
* @name updateInventories
|
|
675
746
|
* @summary: Add Inventory for particular size and store.
|
|
676
747
|
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
677
748
|
*/
|
|
678
|
-
updateInventories({ body }?: CatalogPlatformValidator.UpdateInventoriesParam, {
|
|
749
|
+
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
679
750
|
/**
|
|
680
751
|
* @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
|
|
752
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
681
753
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
682
754
|
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
683
755
|
* - Success response
|
|
@@ -686,36 +758,40 @@ declare class Catalog {
|
|
|
686
758
|
* @summary: Update a Product Bundle
|
|
687
759
|
* @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
688
760
|
*/
|
|
689
|
-
updateProductBundle({ id, body }?: CatalogPlatformValidator.UpdateProductBundleParam, {
|
|
761
|
+
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
690
762
|
/**
|
|
691
763
|
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
764
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
692
765
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
693
766
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
694
767
|
* @name updateRealtimeInventory
|
|
695
768
|
* @summary: Add Inventory for particular size and store.
|
|
696
769
|
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
697
770
|
*/
|
|
698
|
-
updateRealtimeInventory({ itemId, sellerIdentifier, body }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, {
|
|
771
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
699
772
|
/**
|
|
700
773
|
* @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
|
|
774
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
701
775
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
702
776
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
703
777
|
* @name updateSizeGuide
|
|
704
778
|
* @summary: Edit a size guide.
|
|
705
779
|
* @description: This API allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
706
780
|
*/
|
|
707
|
-
updateSizeGuide({ id, body }?: CatalogPlatformValidator.UpdateSizeGuideParam, {
|
|
781
|
+
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
708
782
|
/**
|
|
709
783
|
* @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
|
|
784
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
710
785
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
711
786
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
712
787
|
* @name uploadBulkProducts
|
|
713
788
|
* @summary: Create a Bulk product to upload job.
|
|
714
789
|
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
715
790
|
*/
|
|
716
|
-
uploadBulkProducts({ department, productType, body }?: CatalogPlatformValidator.UploadBulkProductsParam, {
|
|
791
|
+
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
717
792
|
/**
|
|
718
793
|
* @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
|
|
794
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
719
795
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
720
796
|
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
|
|
721
797
|
* Success response
|
|
@@ -723,11 +799,12 @@ declare class Catalog {
|
|
|
723
799
|
* @summary: Validate Product Template Schema
|
|
724
800
|
* @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/).
|
|
725
801
|
*/
|
|
726
|
-
validateProductTemplate({ slug }?: CatalogPlatformValidator.ValidateProductTemplateParam, {
|
|
802
|
+
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
|
|
727
803
|
/**
|
|
728
804
|
* @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
|
|
729
805
|
* - Arg object
|
|
730
806
|
*
|
|
807
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
731
808
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
732
809
|
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
|
|
733
810
|
* Success response
|
|
@@ -735,7 +812,7 @@ declare class Catalog {
|
|
|
735
812
|
* @summary: Validate Product Template Schema
|
|
736
813
|
* @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/).
|
|
737
814
|
*/
|
|
738
|
-
validateProductTemplateSchema({ itemType }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, {
|
|
815
|
+
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
|
|
739
816
|
}
|
|
740
817
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
741
818
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|