@gofynd/fdk-client-javascript 1.4.16-beta.2 → 1.4.16-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +6 -810
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -6,12 +6,12 @@ declare class Catalog {
|
|
|
6
6
|
* @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
9
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
10
10
|
* @name addInventory
|
|
11
11
|
* @summary: Create Inventory
|
|
12
12
|
* @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
|
|
13
13
|
*/
|
|
14
|
-
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
14
|
+
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
15
15
|
/**
|
|
16
16
|
* @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
|
|
17
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -26,76 +26,74 @@ declare class Catalog {
|
|
|
26
26
|
* @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
|
|
27
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
29
|
+
* @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
|
|
30
30
|
* @name bulkHsnCode
|
|
31
31
|
* @summary: Create Bulk update HSN
|
|
32
32
|
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
|
|
33
33
|
*/
|
|
34
|
-
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
34
|
+
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponse>;
|
|
35
35
|
/**
|
|
36
36
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
37
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
39
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
40
40
|
* @name createBulkInventory
|
|
41
41
|
* @summary: Create bulk inventory
|
|
42
42
|
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
|
|
43
43
|
*/
|
|
44
|
-
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
44
|
+
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
|
|
47
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
49
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
50
50
|
* @name createBulkInventoryJob
|
|
51
51
|
* @summary: Create bulk inventory upload job
|
|
52
52
|
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
53
53
|
*/
|
|
54
|
-
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
54
|
+
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
|
|
57
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
59
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
60
60
|
* @name createBulkProductUploadJob
|
|
61
61
|
* @summary: Create products bulk upload
|
|
62
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/).
|
|
63
63
|
*/
|
|
64
|
-
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
64
|
+
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
65
65
|
/**
|
|
66
66
|
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
67
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
70
|
-
* Success response
|
|
69
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
71
70
|
* @name createInventoryExport
|
|
72
71
|
* @summary: Create inventory export
|
|
73
72
|
* @description: creates export job for inventory data associated with a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
74
73
|
*/
|
|
75
|
-
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
74
|
+
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
76
75
|
/**
|
|
77
76
|
* @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
|
|
78
77
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
81
|
-
* Success response
|
|
79
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
82
80
|
* @name createInventoryExportJob
|
|
83
81
|
* @summary: Create inventory export job
|
|
84
82
|
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
85
83
|
*/
|
|
86
|
-
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
84
|
+
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
87
85
|
/**
|
|
88
86
|
* @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
|
|
89
87
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
88
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
89
|
+
* @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>}
|
|
92
90
|
* - Success response
|
|
93
91
|
*
|
|
94
92
|
* @name createMarketplaceOptin
|
|
95
93
|
* @summary: Create or Update opt-in infomation
|
|
96
94
|
* @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
|
|
97
95
|
*/
|
|
98
|
-
createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
96
|
+
createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>;
|
|
99
97
|
/**
|
|
100
98
|
* @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
|
|
101
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -110,109 +108,106 @@ declare class Catalog {
|
|
|
110
108
|
* @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
|
|
111
109
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
110
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
113
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
111
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
114
112
|
* @name createProductAssetsInBulk
|
|
115
113
|
* @summary: Create product assets in bulk
|
|
116
114
|
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
117
115
|
*/
|
|
118
|
-
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
116
|
+
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
119
117
|
/**
|
|
120
118
|
* @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
|
|
121
119
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
120
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
121
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
124
122
|
* - Success response
|
|
125
123
|
*
|
|
126
124
|
* @name createProductBundle
|
|
127
125
|
* @summary: Create product bundle
|
|
128
126
|
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
129
127
|
*/
|
|
130
|
-
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
128
|
+
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
131
129
|
/**
|
|
132
130
|
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
133
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
134
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
135
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
136
|
-
*
|
|
137
|
-
*
|
|
133
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
134
|
+
* Success response
|
|
138
135
|
* @name createProductExportJob
|
|
139
136
|
* @summary: Create product export job
|
|
140
137
|
* @description: Allows to create a product export job for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
141
138
|
*/
|
|
142
|
-
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
139
|
+
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
143
140
|
/**
|
|
144
141
|
* @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
|
|
145
142
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
146
143
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
144
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
148
145
|
* @name createProductsInBulk
|
|
149
146
|
* @summary: Create products in bulk
|
|
150
147
|
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
|
|
151
148
|
*/
|
|
152
|
-
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
149
|
+
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
153
150
|
/**
|
|
154
151
|
* @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
|
|
155
152
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
156
153
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
157
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
154
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
158
155
|
* @name createSizeGuide
|
|
159
156
|
* @summary: Create size guide
|
|
160
157
|
* @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
161
158
|
*/
|
|
162
|
-
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
159
|
+
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
163
160
|
/**
|
|
164
161
|
* @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
|
|
165
162
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
163
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
164
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
168
165
|
* @name deleteBulkInventoryJob
|
|
169
166
|
* @summary: Delete inventory bulk upload job
|
|
170
167
|
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
171
168
|
*/
|
|
172
|
-
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
169
|
+
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
173
170
|
/**
|
|
174
171
|
* @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
|
|
175
172
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
176
173
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
177
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
174
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
178
175
|
* @name deleteProduct
|
|
179
176
|
* @summary: Delete product
|
|
180
|
-
* @description: Users can delete a product by providing the
|
|
177
|
+
* @description: Users can delete a product using this by providing the itemid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
181
178
|
*/
|
|
182
|
-
deleteProduct({ itemId,
|
|
179
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
183
180
|
/**
|
|
184
181
|
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
185
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
184
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
188
185
|
* @name deleteProductBulkJob
|
|
189
186
|
* @summary: Delete product bulk-upload job
|
|
190
187
|
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
191
188
|
*/
|
|
192
|
-
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
189
|
+
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
193
190
|
/**
|
|
194
191
|
* @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
|
|
195
192
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
196
193
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
197
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
198
|
-
* Success response
|
|
194
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
199
195
|
* @name deleteRealtimeInventory
|
|
200
196
|
* @summary: Delete an inventory
|
|
201
197
|
* @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
202
198
|
*/
|
|
203
|
-
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
199
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
204
200
|
/**
|
|
205
201
|
* @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
|
|
206
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
203
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
209
|
-
*
|
|
210
|
-
*
|
|
204
|
+
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
|
|
205
|
+
* Success response
|
|
211
206
|
* @name deleteSize
|
|
212
207
|
* @summary: Delete product size
|
|
213
208
|
* @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
214
209
|
*/
|
|
215
|
-
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
210
|
+
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
|
|
216
211
|
/**
|
|
217
212
|
* @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
|
|
218
213
|
* - Arg object
|
|
@@ -241,12 +236,12 @@ declare class Catalog {
|
|
|
241
236
|
* @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
|
|
242
237
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
243
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
244
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
239
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
245
240
|
* @name editProduct
|
|
246
241
|
* @summary: Update a product
|
|
247
242
|
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
|
|
248
243
|
*/
|
|
249
|
-
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
244
|
+
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
250
245
|
/**
|
|
251
246
|
* @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
|
|
252
247
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -283,13 +278,12 @@ declare class Catalog {
|
|
|
283
278
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
284
279
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
285
280
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
286
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
287
|
-
* Success response
|
|
281
|
+
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
|
|
288
282
|
* @name getCategoryData
|
|
289
283
|
* @summary: Get category by uid
|
|
290
284
|
* @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
291
285
|
*/
|
|
292
|
-
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
286
|
+
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
|
|
293
287
|
/**
|
|
294
288
|
* @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
|
|
295
289
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -325,13 +319,12 @@ declare class Catalog {
|
|
|
325
319
|
* @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
|
|
326
320
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
327
321
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
328
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
329
|
-
* Success response
|
|
322
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
330
323
|
* @name getDepartmentData
|
|
331
324
|
* @summary: Get department by uid
|
|
332
325
|
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
333
326
|
*/
|
|
334
|
-
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
327
|
+
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
335
328
|
/**
|
|
336
329
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
337
330
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -346,13 +339,12 @@ declare class Catalog {
|
|
|
346
339
|
* @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
|
|
347
340
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
341
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
349
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
350
|
-
* Success response
|
|
342
|
+
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
|
|
351
343
|
* @name getInventories
|
|
352
344
|
* @summary: List Inventory
|
|
353
345
|
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
354
346
|
*/
|
|
355
|
-
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
347
|
+
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
|
|
356
348
|
/**
|
|
357
349
|
* @param {Object} arg - Arg object.
|
|
358
350
|
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
@@ -380,7 +372,7 @@ declare class Catalog {
|
|
|
380
372
|
* inventories less then or equal to provided date based on qty_type value.
|
|
381
373
|
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
382
374
|
* or Primary Identifier) of which inventory is to get.
|
|
383
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
375
|
+
* @returns {Paginator<CatalogPlatformModel.GetInventoriesResponse>}
|
|
384
376
|
* @summary: List Inventory
|
|
385
377
|
* @description: Allows to get Inventories data for particular company.
|
|
386
378
|
*/
|
|
@@ -399,7 +391,7 @@ declare class Catalog {
|
|
|
399
391
|
fromDate?: string;
|
|
400
392
|
toDate?: string;
|
|
401
393
|
sizeIdentifier?: string;
|
|
402
|
-
}): Paginator<CatalogPlatformModel.
|
|
394
|
+
}): Paginator<CatalogPlatformModel.GetInventoriesResponse>;
|
|
403
395
|
/**
|
|
404
396
|
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
405
397
|
* - Arg object
|
|
@@ -523,57 +515,54 @@ declare class Catalog {
|
|
|
523
515
|
* @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
524
516
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
525
517
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
526
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
527
|
-
* Success response
|
|
518
|
+
* @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
|
|
528
519
|
* @name getOptimalLocations
|
|
529
520
|
* @summary: Get optimal locations
|
|
530
521
|
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
531
522
|
*/
|
|
532
|
-
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
523
|
+
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
|
|
533
524
|
/**
|
|
534
525
|
* @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
|
|
535
526
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
536
527
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
537
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
538
|
-
* Success response
|
|
528
|
+
* @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
|
|
539
529
|
* @name getProduct
|
|
540
530
|
* @summary: Get a product
|
|
541
531
|
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
542
532
|
*/
|
|
543
|
-
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
533
|
+
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
|
|
544
534
|
/**
|
|
545
535
|
* @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
|
|
546
536
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
547
537
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
538
|
+
* @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
|
|
549
539
|
* @name getProductAssetsInBulk
|
|
550
540
|
* @summary: Get product assets
|
|
551
541
|
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
552
542
|
*/
|
|
553
|
-
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
543
|
+
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
|
|
554
544
|
/**
|
|
555
545
|
* @param {Object} arg - Arg object.
|
|
556
546
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
557
547
|
* page. Default is 12.
|
|
558
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
548
|
+
* @returns {Paginator<CatalogPlatformModel.BulkAssetResponse>}
|
|
559
549
|
* @summary: Get product assets
|
|
560
550
|
* @description: Helps to retrieve bulk asset jobs data associated to a particular company.
|
|
561
551
|
*/
|
|
562
552
|
getProductAssetsInBulkPaginator({ pageSize }?: {
|
|
563
553
|
pageSize?: number;
|
|
564
|
-
}): Paginator<CatalogPlatformModel.
|
|
554
|
+
}): Paginator<CatalogPlatformModel.BulkAssetResponse>;
|
|
565
555
|
/**
|
|
566
556
|
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
567
557
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
568
558
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
569
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
570
|
-
*
|
|
571
|
-
*
|
|
559
|
+
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
|
|
560
|
+
* Success response
|
|
572
561
|
* @name getProductAttributes
|
|
573
562
|
* @summary: List product attributes
|
|
574
563
|
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
575
564
|
*/
|
|
576
|
-
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
565
|
+
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
|
|
577
566
|
/**
|
|
578
567
|
* @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
|
|
579
568
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -601,60 +590,56 @@ declare class Catalog {
|
|
|
601
590
|
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
602
591
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
603
592
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
593
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
|
|
605
594
|
* - Success response
|
|
606
595
|
*
|
|
607
596
|
* @name getProductBundle
|
|
608
597
|
* @summary: List product bundles
|
|
609
598
|
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
610
599
|
*/
|
|
611
|
-
getProductBundle({ q, slug,
|
|
600
|
+
getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
612
601
|
/**
|
|
613
602
|
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
614
603
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
615
604
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
616
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
617
|
-
*
|
|
618
|
-
*
|
|
605
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
606
|
+
* Success response
|
|
619
607
|
* @name getProductBundleDetail
|
|
620
608
|
* @summary: Get product bundle
|
|
621
609
|
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
622
610
|
*/
|
|
623
|
-
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
611
|
+
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
624
612
|
/**
|
|
625
613
|
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
626
614
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
627
615
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
628
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
629
|
-
*
|
|
630
|
-
*
|
|
616
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
617
|
+
* Success response
|
|
631
618
|
* @name getProductExportJobs
|
|
632
619
|
* @summary: Get product export jobs
|
|
633
620
|
* @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
634
621
|
*/
|
|
635
|
-
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
622
|
+
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
636
623
|
/**
|
|
637
624
|
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
638
625
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
639
626
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
640
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
641
|
-
* Success response
|
|
627
|
+
* @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
|
|
642
628
|
* @name getProductSize
|
|
643
629
|
* @summary: List product size
|
|
644
630
|
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
645
631
|
*/
|
|
646
|
-
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
632
|
+
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
|
|
647
633
|
/**
|
|
648
634
|
* @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
|
|
649
635
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
650
636
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
651
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
652
|
-
* Success response
|
|
637
|
+
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
|
|
653
638
|
* @name getProductTags
|
|
654
639
|
* @summary: List product tags
|
|
655
640
|
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
656
641
|
*/
|
|
657
|
-
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
642
|
+
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
|
|
658
643
|
/**
|
|
659
644
|
* @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
|
|
660
645
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -717,13 +702,12 @@ declare class Catalog {
|
|
|
717
702
|
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
718
703
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
719
704
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
720
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
721
|
-
* Success response
|
|
705
|
+
* @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
|
|
722
706
|
* @name getSellerInsights
|
|
723
707
|
* @summary: Get seller catalog counts
|
|
724
708
|
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
725
709
|
*/
|
|
726
|
-
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
710
|
+
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
|
|
727
711
|
/**
|
|
728
712
|
* @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
|
|
729
713
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -738,12 +722,12 @@ declare class Catalog {
|
|
|
738
722
|
* @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
|
|
739
723
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
740
724
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
741
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
725
|
+
* @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
|
|
742
726
|
* @name getSizeGuide
|
|
743
727
|
* @summary: Get size guide
|
|
744
728
|
* @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
745
729
|
*/
|
|
746
|
-
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
730
|
+
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
|
|
747
731
|
/**
|
|
748
732
|
* @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
|
|
749
733
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -781,20 +765,19 @@ declare class Catalog {
|
|
|
781
765
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
782
766
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
783
767
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
784
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
785
|
-
* Success response
|
|
768
|
+
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
|
|
786
769
|
* @name getVariantsOfProducts
|
|
787
770
|
* @summary: Get variants
|
|
788
771
|
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
789
772
|
*/
|
|
790
|
-
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
773
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
|
|
791
774
|
/**
|
|
792
775
|
* @param {Object} arg - Arg object.
|
|
793
776
|
* @param {number} arg.itemId - Get list of variants of item Id
|
|
794
777
|
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
795
778
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
796
779
|
* page. Default is 10.
|
|
797
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
780
|
+
* @returns {Paginator<CatalogPlatformModel.ProductVariantsResponse>}
|
|
798
781
|
* @summary: Get variants
|
|
799
782
|
* @description: Retrieve variants of a specific product.
|
|
800
783
|
*/
|
|
@@ -802,17 +785,17 @@ declare class Catalog {
|
|
|
802
785
|
itemId: number;
|
|
803
786
|
variantType: string;
|
|
804
787
|
pageSize?: number;
|
|
805
|
-
}): Paginator<CatalogPlatformModel.
|
|
788
|
+
}): Paginator<CatalogPlatformModel.ProductVariantsResponse>;
|
|
806
789
|
/**
|
|
807
790
|
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
808
791
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
809
792
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
810
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
793
|
+
* @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
|
|
811
794
|
* @name listCategories
|
|
812
795
|
* @summary: List categories
|
|
813
796
|
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
814
797
|
*/
|
|
815
|
-
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
798
|
+
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
|
|
816
799
|
/**
|
|
817
800
|
* @param {Object} arg - Arg object.
|
|
818
801
|
* @param {string} [arg.level] - Get category for multiple levels
|
|
@@ -822,7 +805,7 @@ declare class Catalog {
|
|
|
822
805
|
* page. Default is 10.
|
|
823
806
|
* @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
|
|
824
807
|
* @param {string} [arg.slug] - Get category by slug
|
|
825
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
808
|
+
* @returns {Paginator<CatalogPlatformModel.CategoryResponse>}
|
|
826
809
|
* @summary: List categories
|
|
827
810
|
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
|
|
828
811
|
*/
|
|
@@ -833,18 +816,17 @@ declare class Catalog {
|
|
|
833
816
|
pageSize?: number;
|
|
834
817
|
uids?: number[];
|
|
835
818
|
slug?: string;
|
|
836
|
-
}): Paginator<CatalogPlatformModel.
|
|
819
|
+
}): Paginator<CatalogPlatformModel.CategoryResponse>;
|
|
837
820
|
/**
|
|
838
821
|
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
839
822
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
840
823
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
841
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
842
|
-
* Success response
|
|
824
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
843
825
|
* @name listDepartmentsData
|
|
844
826
|
* @summary: List company department
|
|
845
827
|
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
|
|
846
828
|
*/
|
|
847
|
-
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
829
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
848
830
|
/**
|
|
849
831
|
* @param {Object} arg - Arg object.
|
|
850
832
|
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
@@ -857,7 +839,7 @@ declare class Catalog {
|
|
|
857
839
|
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
858
840
|
* whether they are active or inactive.
|
|
859
841
|
* @param {string} [arg.slug] - Can filter by slug
|
|
860
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
842
|
+
* @returns {Paginator<CatalogPlatformModel.DepartmentsResponse>}
|
|
861
843
|
* @summary: List company department
|
|
862
844
|
* @description: Allows you to list all departments data for a specific company.
|
|
863
845
|
*/
|
|
@@ -868,67 +850,66 @@ declare class Catalog {
|
|
|
868
850
|
search?: string;
|
|
869
851
|
isActive?: boolean;
|
|
870
852
|
slug?: string;
|
|
871
|
-
}): Paginator<CatalogPlatformModel.
|
|
853
|
+
}): Paginator<CatalogPlatformModel.DepartmentsResponse>;
|
|
872
854
|
/**
|
|
873
855
|
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
874
856
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
875
857
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
876
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
858
|
+
* @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
|
|
877
859
|
* @name listHSNCodes
|
|
878
860
|
* @summary: List HSN codes
|
|
879
861
|
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
880
862
|
*/
|
|
881
|
-
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
863
|
+
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
|
|
882
864
|
/**
|
|
883
865
|
* @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
|
|
884
866
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
885
867
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
886
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
868
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
|
|
887
869
|
* - Success response
|
|
888
870
|
*
|
|
889
871
|
* @name listInventoryExport
|
|
890
872
|
* @summary: List inventory export jobs
|
|
891
873
|
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
892
874
|
*/
|
|
893
|
-
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
875
|
+
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
894
876
|
/**
|
|
895
877
|
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
896
878
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
897
879
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
898
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
880
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
|
|
899
881
|
* @name listProductTemplate
|
|
900
882
|
* @summary: List product templates
|
|
901
883
|
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
902
884
|
*/
|
|
903
|
-
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
885
|
+
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
|
|
904
886
|
/**
|
|
905
887
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
906
888
|
* - Arg object
|
|
907
889
|
*
|
|
908
890
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
909
891
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
910
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
892
|
+
* @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
|
|
911
893
|
* - Success response
|
|
912
894
|
*
|
|
913
895
|
* @name listProductTemplateCategories
|
|
914
896
|
* @summary: List product template categories
|
|
915
897
|
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
916
898
|
*/
|
|
917
|
-
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
899
|
+
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
|
|
918
900
|
/**
|
|
919
901
|
* @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
|
|
920
902
|
* - Arg object
|
|
921
903
|
*
|
|
922
904
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
923
905
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
924
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
925
|
-
*
|
|
926
|
-
*
|
|
906
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
907
|
+
* Success response
|
|
927
908
|
* @name listProductTemplateExportDetails
|
|
928
909
|
* @summary: List export product templates
|
|
929
910
|
* @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
930
911
|
*/
|
|
931
|
-
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
912
|
+
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
932
913
|
/**
|
|
933
914
|
* @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
|
|
934
915
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -954,108 +935,90 @@ declare class Catalog {
|
|
|
954
935
|
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
955
936
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
956
937
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
957
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
958
|
-
* Success response
|
|
938
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
959
939
|
* @name updateInventories
|
|
960
940
|
* @summary: Update inventories
|
|
961
941
|
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
962
942
|
*/
|
|
963
|
-
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
943
|
+
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
964
944
|
/**
|
|
965
945
|
* @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
|
|
966
946
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
967
947
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
968
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
948
|
+
* @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>}
|
|
969
949
|
* - Success response
|
|
970
950
|
*
|
|
971
951
|
* @name updateMarketplaceOptin
|
|
972
952
|
* @summary: Update marketplace optin
|
|
973
953
|
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
|
|
974
954
|
*/
|
|
975
|
-
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
955
|
+
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>;
|
|
976
956
|
/**
|
|
977
957
|
* @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
|
|
978
958
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
979
959
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
980
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
960
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
981
961
|
* - Success response
|
|
982
962
|
*
|
|
983
963
|
* @name updateProductBundle
|
|
984
964
|
* @summary: Update product bundle
|
|
985
965
|
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
986
966
|
*/
|
|
987
|
-
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
967
|
+
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
988
968
|
/**
|
|
989
969
|
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
990
970
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
991
971
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
992
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
993
|
-
* Success response
|
|
972
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
994
973
|
* @name updateRealtimeInventory
|
|
995
974
|
* @summary: Update an inventory
|
|
996
975
|
* @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
997
976
|
*/
|
|
998
|
-
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
977
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
999
978
|
/**
|
|
1000
979
|
* @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
|
|
1001
980
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1002
981
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1003
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
982
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
1004
983
|
* @name updateSizeGuide
|
|
1005
984
|
* @summary: Update size guide
|
|
1006
985
|
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
1007
986
|
*/
|
|
1008
|
-
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
987
|
+
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
1009
988
|
/**
|
|
1010
989
|
* @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
|
|
1011
990
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1012
991
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1013
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
992
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
1014
993
|
* @name uploadBulkProducts
|
|
1015
994
|
* @summary: Upload bulk products
|
|
1016
995
|
* @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
1017
996
|
*/
|
|
1018
|
-
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1019
|
-
/**
|
|
1020
|
-
* @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
|
|
1021
|
-
* - Arg object
|
|
1022
|
-
*
|
|
1023
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1024
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1025
|
-
* @returns {Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>}
|
|
1026
|
-
* - Success response
|
|
1027
|
-
*
|
|
1028
|
-
* @name validateProductGlobalTemplate
|
|
1029
|
-
* @summary: Validate product template
|
|
1030
|
-
* @description: Allows you to list all product templates global validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductGlobalTemplate/).
|
|
1031
|
-
*/
|
|
1032
|
-
validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
|
|
997
|
+
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
1033
998
|
/**
|
|
1034
999
|
* @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
|
|
1035
1000
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1036
1001
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1037
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1002
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
|
|
1003
|
+
* Success response
|
|
1040
1004
|
* @name validateProductTemplate
|
|
1041
1005
|
* @summary: Validate product template
|
|
1042
1006
|
* @description: Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
|
|
1043
1007
|
*/
|
|
1044
|
-
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1008
|
+
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
|
|
1045
1009
|
/**
|
|
1046
1010
|
* @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
|
|
1047
1011
|
* - Arg object
|
|
1048
1012
|
*
|
|
1049
1013
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1050
1014
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1051
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1015
|
+
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
|
|
1016
|
+
* Success response
|
|
1054
1017
|
* @name validateProductTemplateSchema
|
|
1055
1018
|
* @summary: Validate product template schema
|
|
1056
1019
|
* @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1057
1020
|
*/
|
|
1058
|
-
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1021
|
+
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
|
|
1059
1022
|
}
|
|
1060
1023
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
1061
1024
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|