@gofynd/fdk-client-javascript 1.2.0 → 1.3.0
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 +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -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 +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- 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
|
@@ -7,15 +7,17 @@ declare class Catalog {
|
|
|
7
7
|
* @param {CatalogPlatformApplicationValidator.AddCollectionItemsParam} arg
|
|
8
8
|
* - Arg object
|
|
9
9
|
*
|
|
10
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
10
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
11
12
|
* @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
|
|
12
13
|
* @name addCollectionItems
|
|
13
14
|
* @summary: Add items to a collection
|
|
14
15
|
* @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
|
|
15
16
|
*/
|
|
16
|
-
addCollectionItems({ id, body }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, {
|
|
17
|
+
addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
|
|
17
18
|
/**
|
|
18
19
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
20
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
22
|
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponse>} -
|
|
21
23
|
* Success response
|
|
@@ -23,11 +25,12 @@ declare class Catalog {
|
|
|
23
25
|
* @summary: Add a Collection
|
|
24
26
|
* @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
|
|
25
27
|
*/
|
|
26
|
-
createCollection({ body }?: CatalogPlatformApplicationValidator.CreateCollectionParam, {
|
|
28
|
+
createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponse>;
|
|
27
29
|
/**
|
|
28
30
|
* @param {CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam} arg
|
|
29
31
|
* - Arg object
|
|
30
32
|
*
|
|
33
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
34
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
35
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
33
36
|
* Success response
|
|
@@ -35,11 +38,12 @@ declare class Catalog {
|
|
|
35
38
|
* @summary: Add configuration for categories and brands
|
|
36
39
|
* @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
|
|
37
40
|
*/
|
|
38
|
-
createConfigurationByType({ type, body }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, {
|
|
41
|
+
createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
39
42
|
/**
|
|
40
43
|
* @param {CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam} arg
|
|
41
44
|
* - Arg object
|
|
42
45
|
*
|
|
46
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
43
47
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
48
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
45
49
|
* Success response
|
|
@@ -47,11 +51,12 @@ declare class Catalog {
|
|
|
47
51
|
* @summary: Add configuration for products & listings
|
|
48
52
|
* @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
|
|
49
53
|
*/
|
|
50
|
-
createConfigurationProductListing({ body }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, {
|
|
54
|
+
createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
51
55
|
/**
|
|
52
56
|
* @param {CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam} arg
|
|
53
57
|
* - Arg object
|
|
54
58
|
*
|
|
59
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
55
60
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
56
61
|
* @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>}
|
|
57
62
|
* - Success response
|
|
@@ -60,97 +65,106 @@ declare class Catalog {
|
|
|
60
65
|
* @summary: Add a Custom Autocomplete Keywords
|
|
61
66
|
* @description: Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
|
|
62
67
|
*/
|
|
63
|
-
createCustomAutocompleteRule({ body }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, {
|
|
68
|
+
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
|
|
64
69
|
/**
|
|
65
70
|
* @param {CatalogPlatformApplicationValidator.CreateCustomKeywordParam} arg
|
|
66
71
|
* - Arg object
|
|
67
72
|
*
|
|
73
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
74
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
75
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
70
76
|
* @name createCustomKeyword
|
|
71
77
|
* @summary: Add a Custom Search Keywords
|
|
72
78
|
* @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
|
|
73
79
|
*/
|
|
74
|
-
createCustomKeyword({ body }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, {
|
|
80
|
+
createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|
|
75
81
|
/**
|
|
76
82
|
* @param {CatalogPlatformApplicationValidator.CreateGroupConfigurationParam} arg
|
|
77
83
|
* - Arg object
|
|
78
84
|
*
|
|
85
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
86
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
87
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
81
88
|
* @name createGroupConfiguration
|
|
82
89
|
* @summary: Create configuration for Group config types.
|
|
83
90
|
* @description: Create configuration for Group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
|
|
84
91
|
*/
|
|
85
|
-
createGroupConfiguration({ configType, body }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, {
|
|
92
|
+
createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
86
93
|
/**
|
|
87
94
|
* @param {CatalogPlatformApplicationValidator.CreateListingConfigurationParam} arg
|
|
88
95
|
* - Arg object
|
|
89
96
|
*
|
|
97
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
99
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
92
100
|
* @name createListingConfiguration
|
|
93
101
|
* @summary: Add configuration for listings
|
|
94
102
|
* @description: Add configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
95
103
|
*/
|
|
96
|
-
createListingConfiguration({ configType, body }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, {
|
|
104
|
+
createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
97
105
|
/**
|
|
98
106
|
* @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
|
|
99
107
|
* - Arg object
|
|
100
108
|
*
|
|
109
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
101
110
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
111
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
103
112
|
* @name deleteAutocompleteKeyword
|
|
104
113
|
* @summary: Delete a Autocomplete Keywords
|
|
105
114
|
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
|
|
106
115
|
*/
|
|
107
|
-
deleteAutocompleteKeyword({ id }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, {
|
|
116
|
+
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
108
117
|
/**
|
|
109
118
|
* @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
|
|
119
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
120
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
111
121
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
112
122
|
* @name deleteCollection
|
|
113
123
|
* @summary: Delete a Collection
|
|
114
124
|
* @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteCollection/).
|
|
115
125
|
*/
|
|
116
|
-
deleteCollection({ id }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, {
|
|
126
|
+
deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
117
127
|
/**
|
|
118
128
|
* @param {CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam} arg
|
|
119
129
|
* - Arg object
|
|
120
130
|
*
|
|
131
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
121
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
122
133
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
123
134
|
* @name deleteGroupConfiguration
|
|
124
135
|
* @summary: Delete configuration of the product config type of the application.
|
|
125
136
|
* @description: Delete configuration of the product config type of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
|
|
126
137
|
*/
|
|
127
|
-
deleteGroupConfiguration({ configType, groupSlug }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, {
|
|
138
|
+
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
128
139
|
/**
|
|
129
140
|
* @param {CatalogPlatformApplicationValidator.DeleteListingConfigurationParam} arg
|
|
130
141
|
* - Arg object
|
|
131
142
|
*
|
|
143
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
132
144
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
133
145
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
134
146
|
* @name deleteListingConfiguration
|
|
135
147
|
* @summary: Delete configuration for listings
|
|
136
148
|
* @description: Delete configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
137
149
|
*/
|
|
138
|
-
deleteListingConfiguration({ configType, configId }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, {
|
|
150
|
+
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
139
151
|
/**
|
|
140
152
|
* @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
|
|
141
153
|
* - Arg object
|
|
142
154
|
*
|
|
155
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
156
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
157
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
145
158
|
* @name deleteSearchKeywords
|
|
146
159
|
* @summary: Delete a Search Keywords
|
|
147
160
|
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
|
|
148
161
|
*/
|
|
149
|
-
deleteSearchKeywords({ id }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, {
|
|
162
|
+
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
150
163
|
/**
|
|
151
164
|
* @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
|
|
152
165
|
* - Arg object
|
|
153
166
|
*
|
|
167
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
154
168
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
155
169
|
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
|
|
156
170
|
* Success response
|
|
@@ -158,33 +172,39 @@ declare class Catalog {
|
|
|
158
172
|
* @summary: List all the collections
|
|
159
173
|
* @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
|
|
160
174
|
*/
|
|
161
|
-
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, {
|
|
175
|
+
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
|
|
162
176
|
/**
|
|
177
|
+
* @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
|
|
178
|
+
* - Arg object
|
|
179
|
+
*
|
|
180
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
163
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
164
182
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
|
|
165
183
|
* @name getAllSearchKeyword
|
|
166
184
|
* @summary: List all Search Custom Keyword Listing
|
|
167
185
|
* @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
|
|
168
186
|
*/
|
|
169
|
-
getAllSearchKeyword({
|
|
187
|
+
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
|
|
170
188
|
/**
|
|
171
189
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
190
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
191
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
192
|
* @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
|
|
174
193
|
* @name getAppInventory
|
|
175
194
|
* @summary: Get the stock of a product
|
|
176
195
|
* @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
177
196
|
*/
|
|
178
|
-
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, {
|
|
197
|
+
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
|
|
179
198
|
/**
|
|
180
199
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
200
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
201
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
202
|
* @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
|
|
183
203
|
* @name getAppLocations
|
|
184
204
|
* @summary: Get list of locations
|
|
185
205
|
* @description: This API allows to view all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
|
|
186
206
|
*/
|
|
187
|
-
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, {
|
|
207
|
+
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
|
|
188
208
|
/**
|
|
189
209
|
* @param {Object} arg - Arg object.
|
|
190
210
|
* @param {string} arg.companyId - Id of the company whose locations are to fetched
|
|
@@ -214,26 +234,29 @@ declare class Catalog {
|
|
|
214
234
|
}): Paginator<CatalogPlatformModel.LocationListSerializer>;
|
|
215
235
|
/**
|
|
216
236
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
237
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
217
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
218
239
|
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
219
240
|
* @name getAppProduct
|
|
220
241
|
* @summary: Get company application product data.
|
|
221
242
|
* @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
|
|
222
243
|
*/
|
|
223
|
-
getAppProduct({ itemId }?: CatalogPlatformApplicationValidator.GetAppProductParam, {
|
|
244
|
+
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
|
|
224
245
|
/**
|
|
225
246
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
247
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
226
248
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
249
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
|
|
228
250
|
* @name getAppProducts
|
|
229
251
|
* @summary: Get applicationwise products
|
|
230
252
|
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
|
|
231
253
|
*/
|
|
232
|
-
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, {
|
|
254
|
+
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
|
|
233
255
|
/**
|
|
234
256
|
* @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
|
|
235
257
|
* - Arg object
|
|
236
258
|
*
|
|
259
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
237
260
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
238
261
|
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
239
262
|
* - Success response
|
|
@@ -242,7 +265,7 @@ declare class Catalog {
|
|
|
242
265
|
* @summary: List the products
|
|
243
266
|
* @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
|
|
244
267
|
*/
|
|
245
|
-
getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, {
|
|
268
|
+
getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
246
269
|
/**
|
|
247
270
|
* @param {Object} arg - Arg object.
|
|
248
271
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -289,13 +312,14 @@ declare class Catalog {
|
|
|
289
312
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
290
313
|
* - Arg object
|
|
291
314
|
*
|
|
315
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
292
316
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
293
317
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
294
318
|
* @name getApplicationBrandListing
|
|
295
319
|
* @summary: List all the brands for the application
|
|
296
320
|
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
|
|
297
321
|
*/
|
|
298
|
-
getApplicationBrandListing({ pageNo, pageSize, q }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, {
|
|
322
|
+
getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
299
323
|
/**
|
|
300
324
|
* @param {Object} arg - Arg object.
|
|
301
325
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -320,13 +344,14 @@ declare class Catalog {
|
|
|
320
344
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandsParam} arg
|
|
321
345
|
* - Arg object
|
|
322
346
|
*
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
323
348
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
324
349
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
325
350
|
* @name getApplicationBrands
|
|
326
351
|
* @summary: List all the brands
|
|
327
352
|
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
328
353
|
*/
|
|
329
|
-
getApplicationBrands({ department, pageNo, pageSize, q, brandId }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, {
|
|
354
|
+
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
330
355
|
/**
|
|
331
356
|
* @param {Object} arg - Arg object.
|
|
332
357
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -359,13 +384,14 @@ declare class Catalog {
|
|
|
359
384
|
* @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
|
|
360
385
|
* - Arg object
|
|
361
386
|
*
|
|
387
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
362
388
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
363
389
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
364
390
|
* @name getApplicationCategoryListing
|
|
365
391
|
* @summary: List all the brands for the application
|
|
366
392
|
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
|
|
367
393
|
*/
|
|
368
|
-
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, {
|
|
394
|
+
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
369
395
|
/**
|
|
370
396
|
* @param {Object} arg - Arg object.
|
|
371
397
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -393,6 +419,7 @@ declare class Catalog {
|
|
|
393
419
|
* @param {CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam} arg
|
|
394
420
|
* - Arg object
|
|
395
421
|
*
|
|
422
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
396
423
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
397
424
|
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
398
425
|
* - Success response
|
|
@@ -401,7 +428,7 @@ declare class Catalog {
|
|
|
401
428
|
* @summary: List all the departments for the application
|
|
402
429
|
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
|
|
403
430
|
*/
|
|
404
|
-
getApplicationDepartmentListing({ pageNo, pageSize, q }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, {
|
|
431
|
+
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
405
432
|
/**
|
|
406
433
|
* @param {Object} arg - Arg object.
|
|
407
434
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -423,6 +450,10 @@ declare class Catalog {
|
|
|
423
450
|
q?: string;
|
|
424
451
|
}): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
425
452
|
/**
|
|
453
|
+
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
454
|
+
* - Arg object
|
|
455
|
+
*
|
|
456
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
426
457
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
427
458
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
428
459
|
* Success response
|
|
@@ -430,11 +461,12 @@ declare class Catalog {
|
|
|
430
461
|
* @summary: List all Autocomplete Keyword Listing
|
|
431
462
|
* @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
|
|
432
463
|
*/
|
|
433
|
-
getAutocompleteConfig({
|
|
464
|
+
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
434
465
|
/**
|
|
435
466
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
|
|
436
467
|
* - Arg object
|
|
437
468
|
*
|
|
469
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
438
470
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
439
471
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
440
472
|
* Success response
|
|
@@ -442,8 +474,12 @@ declare class Catalog {
|
|
|
442
474
|
* @summary: Get a Autocomplete Keywords Details
|
|
443
475
|
* @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
444
476
|
*/
|
|
445
|
-
getAutocompleteKeywordDetail({ id }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, {
|
|
477
|
+
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
446
478
|
/**
|
|
479
|
+
* @param {CatalogPlatformApplicationValidator.GetCatalogConfigurationParam} arg
|
|
480
|
+
* - Arg object
|
|
481
|
+
*
|
|
482
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
447
483
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
484
|
* @returns {Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>}
|
|
449
485
|
* - Success response
|
|
@@ -452,31 +488,34 @@ declare class Catalog {
|
|
|
452
488
|
* @summary: Get configuration meta details for catalog for admin panel
|
|
453
489
|
* @description: configuration meta details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
|
|
454
490
|
*/
|
|
455
|
-
getCatalogConfiguration({
|
|
491
|
+
getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
|
|
456
492
|
/**
|
|
457
493
|
* @param {CatalogPlatformApplicationValidator.GetCatalogInsightsParam} arg
|
|
458
494
|
* - Arg object
|
|
459
495
|
*
|
|
496
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
460
497
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
461
498
|
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
462
499
|
* @name getCatalogInsights
|
|
463
500
|
* @summary: Analytics data of catalog and inventory.
|
|
464
501
|
* @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
|
|
465
502
|
*/
|
|
466
|
-
getCatalogInsights({ brand }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, {
|
|
503
|
+
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
|
|
467
504
|
/**
|
|
468
505
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
506
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
469
507
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
470
508
|
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
471
509
|
* @name getCategories
|
|
472
510
|
* @summary: List all the categories
|
|
473
511
|
* @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
|
|
474
512
|
*/
|
|
475
|
-
getCategories({ department }?: CatalogPlatformApplicationValidator.GetCategoriesParam, {
|
|
513
|
+
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
|
|
476
514
|
/**
|
|
477
515
|
* @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
|
|
478
516
|
* - Arg object
|
|
479
517
|
*
|
|
518
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
480
519
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
481
520
|
* @returns {Promise<CatalogPlatformModel.CollectionDetailResponse>} -
|
|
482
521
|
* Success response
|
|
@@ -484,11 +523,12 @@ declare class Catalog {
|
|
|
484
523
|
* @summary: Get a particular collection
|
|
485
524
|
* @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
486
525
|
*/
|
|
487
|
-
getCollectionDetail({ slug }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, {
|
|
526
|
+
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionDetailResponse>;
|
|
488
527
|
/**
|
|
489
528
|
* @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
|
|
490
529
|
* - Arg object
|
|
491
530
|
*
|
|
531
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
492
532
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
493
533
|
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponse>} -
|
|
494
534
|
* Success response
|
|
@@ -496,11 +536,12 @@ declare class Catalog {
|
|
|
496
536
|
* @summary: Get the items for a collection
|
|
497
537
|
* @description: Get items from a collection specified by its `id`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
|
|
498
538
|
*/
|
|
499
|
-
getCollectionItems({ id, sortOn, pageId, pageSize }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, {
|
|
539
|
+
getCollectionItems({ id, sortOn, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponse>;
|
|
500
540
|
/**
|
|
501
541
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
|
|
502
542
|
* - Arg object
|
|
503
543
|
*
|
|
544
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
504
545
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
505
546
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>}
|
|
506
547
|
* - Success response
|
|
@@ -509,11 +550,12 @@ declare class Catalog {
|
|
|
509
550
|
* @summary: Get configured details for catalog
|
|
510
551
|
* @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
|
|
511
552
|
*/
|
|
512
|
-
getConfigurationByType({ type }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, {
|
|
553
|
+
getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
513
554
|
/**
|
|
514
555
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationMetadataParam} arg
|
|
515
556
|
* - Arg object
|
|
516
557
|
*
|
|
558
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
517
559
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
518
560
|
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
519
561
|
* Success response
|
|
@@ -521,8 +563,12 @@ declare class Catalog {
|
|
|
521
563
|
* @summary: Get configuration metadata details for catalog for admin panel
|
|
522
564
|
* @description: Get the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
523
565
|
*/
|
|
524
|
-
getConfigurationMetadata({ configType, templateSlug }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, {
|
|
566
|
+
getConfigurationMetadata({ configType, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
|
|
525
567
|
/**
|
|
568
|
+
* @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
|
|
569
|
+
* - Arg object
|
|
570
|
+
*
|
|
571
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
526
572
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
527
573
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
528
574
|
* Success response
|
|
@@ -530,19 +576,22 @@ declare class Catalog {
|
|
|
530
576
|
* @summary: Get configured details for catalog
|
|
531
577
|
* @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
532
578
|
*/
|
|
533
|
-
getConfigurations({
|
|
579
|
+
getConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
534
580
|
/**
|
|
581
|
+
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
582
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
535
583
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
536
584
|
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
537
585
|
* @name getDepartments
|
|
538
586
|
* @summary: List all the departments
|
|
539
587
|
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
|
|
540
588
|
*/
|
|
541
|
-
getDepartments({
|
|
589
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
|
|
542
590
|
/**
|
|
543
591
|
* @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
|
|
544
592
|
* - Arg object
|
|
545
593
|
*
|
|
594
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
546
595
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
547
596
|
* @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
548
597
|
* - Success response
|
|
@@ -551,41 +600,46 @@ declare class Catalog {
|
|
|
551
600
|
* @summary: Get Inventory for company
|
|
552
601
|
* @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/getDiscountedInventoryBySizeIdentifier/).
|
|
553
602
|
*/
|
|
554
|
-
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, {
|
|
603
|
+
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
555
604
|
/**
|
|
556
605
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
557
606
|
* - Arg object
|
|
558
607
|
*
|
|
608
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
559
609
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
560
610
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
561
611
|
* @name getGroupConfigurations
|
|
562
612
|
* @summary: Get the details of the application configured configurations of group config types.
|
|
563
613
|
* @description: Get the details of the application configured configurations of group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
|
|
564
614
|
*/
|
|
565
|
-
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, {
|
|
615
|
+
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
|
|
566
616
|
/**
|
|
567
617
|
* @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
|
|
568
618
|
* - Arg object
|
|
569
619
|
*
|
|
620
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
570
621
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
571
622
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
572
623
|
* @name getListingConfigurations
|
|
573
624
|
* @summary: Get the details of the application configured configurations of listing config types.
|
|
574
625
|
* @description: Get the details of the application configured configurations of listing config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
|
|
575
626
|
*/
|
|
576
|
-
getListingConfigurations({ configType, pageNo, pageSize, search }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, {
|
|
627
|
+
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
|
|
577
628
|
/**
|
|
578
629
|
* @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
|
|
579
630
|
* - Arg object
|
|
580
631
|
*
|
|
632
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
581
633
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
582
634
|
* @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
|
|
583
635
|
* @name getProductDetailBySlug
|
|
584
636
|
* @summary: Get a product
|
|
585
637
|
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
|
|
586
638
|
*/
|
|
587
|
-
getProductDetailBySlug({ slug }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, {
|
|
639
|
+
getProductDetailBySlug({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDetail>;
|
|
588
640
|
/**
|
|
641
|
+
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
642
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
589
643
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
590
644
|
* @returns {Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>}
|
|
591
645
|
* - Success response
|
|
@@ -594,11 +648,12 @@ declare class Catalog {
|
|
|
594
648
|
* @summary: Get query filters to configure a collection
|
|
595
649
|
* @description: Get query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
596
650
|
*/
|
|
597
|
-
getQueryFilters({
|
|
651
|
+
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>;
|
|
598
652
|
/**
|
|
599
653
|
* @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
|
|
600
654
|
* - Arg object
|
|
601
655
|
*
|
|
656
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
602
657
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
603
658
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
604
659
|
* Success response
|
|
@@ -606,73 +661,80 @@ declare class Catalog {
|
|
|
606
661
|
* @summary: Get a Search Keywords Details
|
|
607
662
|
* @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
|
|
608
663
|
*/
|
|
609
|
-
getSearchKeywords({ id }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, {
|
|
664
|
+
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>;
|
|
610
665
|
/**
|
|
611
666
|
* @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
|
|
612
667
|
* - Arg object
|
|
613
668
|
*
|
|
669
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
614
670
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
615
671
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
616
672
|
* @name updateAllowSingle
|
|
617
673
|
* @summary: Update allow single flag for filters of the application.
|
|
618
674
|
* @description: Update allow single flag for filters of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
|
|
619
675
|
*/
|
|
620
|
-
updateAllowSingle({ body }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, {
|
|
676
|
+
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
621
677
|
/**
|
|
622
678
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
679
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
623
680
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
624
681
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
625
682
|
* @name updateAppBrand
|
|
626
683
|
* @summary: Update a single custom json.
|
|
627
684
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
628
685
|
*/
|
|
629
|
-
updateAppBrand({ brandUid, body }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, {
|
|
686
|
+
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
630
687
|
/**
|
|
631
688
|
* @param {CatalogPlatformApplicationValidator.UpdateAppCategoryParam} arg
|
|
632
689
|
* - Arg object
|
|
633
690
|
*
|
|
691
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
634
692
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
635
693
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
636
694
|
* @name updateAppCategory
|
|
637
695
|
* @summary: Update a single custom json.
|
|
638
696
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
639
697
|
*/
|
|
640
|
-
updateAppCategory({ categoryUid, body }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, {
|
|
698
|
+
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
641
699
|
/**
|
|
642
700
|
* @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
|
|
643
701
|
* - Arg object
|
|
644
702
|
*
|
|
703
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
645
704
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
646
705
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
647
706
|
* @name updateAppDepartment
|
|
648
707
|
* @summary: Update a single custom json.
|
|
649
708
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
650
709
|
*/
|
|
651
|
-
updateAppDepartment({ departmentUid, body }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, {
|
|
710
|
+
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
652
711
|
/**
|
|
653
712
|
* @param {CatalogPlatformApplicationValidator.UpdateAppLocationParam} arg
|
|
654
713
|
* - Arg object
|
|
655
714
|
*
|
|
715
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
656
716
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
657
717
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
658
718
|
* @name updateAppLocation
|
|
659
719
|
* @summary: Update a single custom json.
|
|
660
720
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
661
721
|
*/
|
|
662
|
-
updateAppLocation({ storeUid, body }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, {
|
|
722
|
+
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
663
723
|
/**
|
|
664
724
|
* @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
|
|
725
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
665
726
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
666
727
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
667
728
|
* @name updateAppProduct
|
|
668
729
|
* @summary: Update a single custom meta.
|
|
669
730
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
670
731
|
*/
|
|
671
|
-
updateAppProduct({ itemId, body }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, {
|
|
732
|
+
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
672
733
|
/**
|
|
673
734
|
* @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
|
|
674
735
|
* - Arg object
|
|
675
736
|
*
|
|
737
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
676
738
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
677
739
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
678
740
|
* Success response
|
|
@@ -680,60 +742,65 @@ declare class Catalog {
|
|
|
680
742
|
* @summary: Create & Update Autocomplete Keyword
|
|
681
743
|
* @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
|
|
682
744
|
*/
|
|
683
|
-
updateAutocompleteKeyword({ id, body }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, {
|
|
745
|
+
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
684
746
|
/**
|
|
685
747
|
* @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
|
|
748
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
686
749
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
687
750
|
* @returns {Promise<CatalogPlatformModel.UpdateCollection>} - Success response
|
|
688
751
|
* @name updateCollection
|
|
689
752
|
* @summary: Update a collection
|
|
690
753
|
* @description: Update a collection by it's id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCollection/).
|
|
691
754
|
*/
|
|
692
|
-
updateCollection({ id, body }?: CatalogPlatformApplicationValidator.UpdateCollectionParam, {
|
|
755
|
+
updateCollection({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateCollection>;
|
|
693
756
|
/**
|
|
694
757
|
* @param {CatalogPlatformApplicationValidator.UpdateDefaultSortParam} arg
|
|
695
758
|
* - Arg object
|
|
696
759
|
*
|
|
760
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
697
761
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
698
762
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
699
763
|
* @name updateDefaultSort
|
|
700
764
|
* @summary: Update the default sort key configuration for the application.
|
|
701
765
|
* @description: Update the default sort key configuration for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
|
|
702
766
|
*/
|
|
703
|
-
updateDefaultSort({ body }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, {
|
|
767
|
+
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
704
768
|
/**
|
|
705
769
|
* @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
|
|
706
770
|
* - Arg object
|
|
707
771
|
*
|
|
772
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
708
773
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
709
774
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
710
775
|
* @name updateGroupConfiguration
|
|
711
776
|
* @summary: Update the group configurations for the application.
|
|
712
777
|
* @description: Update the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
|
|
713
778
|
*/
|
|
714
|
-
updateGroupConfiguration({ configType, groupSlug, body }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, {
|
|
779
|
+
updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
715
780
|
/**
|
|
716
781
|
* @param {CatalogPlatformApplicationValidator.UpdateListingConfigurationParam} arg
|
|
717
782
|
* - Arg object
|
|
718
783
|
*
|
|
784
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
719
785
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
720
786
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
721
787
|
* @name updateListingConfiguration
|
|
722
788
|
* @summary: Update configuration for listings
|
|
723
789
|
* @description: Update configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
|
|
724
790
|
*/
|
|
725
|
-
updateListingConfiguration({ configType, configId, body }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, {
|
|
791
|
+
updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
726
792
|
/**
|
|
727
793
|
* @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
|
|
728
794
|
* - Arg object
|
|
729
795
|
*
|
|
796
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
730
797
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
731
798
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
732
799
|
* @name updateSearchKeywords
|
|
733
800
|
* @summary: Update Search Keyword
|
|
734
801
|
* @description: Update Search Keyword by its id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
|
|
735
802
|
*/
|
|
736
|
-
updateSearchKeywords({ id, body }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, {
|
|
803
|
+
updateSearchKeywords({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|
|
737
804
|
}
|
|
738
805
|
import CatalogPlatformApplicationValidator = require("./CatalogPlatformApplicationValidator");
|
|
739
806
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|