@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-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 -19
- package/sdk/application/Content/ContentApplicationClient.js +54 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -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 -89
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -47
- 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/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -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/OAuthClient.js +1 -0
- 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 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- 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 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- 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 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -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 +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -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 +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- 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 +5 -791
- 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 -105
|
@@ -76,7 +76,7 @@ class Catalog {
|
|
|
76
76
|
/**
|
|
77
77
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
78
78
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
79
|
-
* @returns {Promise<
|
|
79
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
80
80
|
* @name followById
|
|
81
81
|
* @summary: Create item, brand, product
|
|
82
82
|
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
@@ -113,7 +113,7 @@ class Catalog {
|
|
|
113
113
|
/**
|
|
114
114
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
115
115
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
116
|
-
* @returns {Promise<
|
|
116
|
+
* @returns {Promise<BrandDetailResponse>} - Success response
|
|
117
117
|
* @name getBrandDetailBySlug
|
|
118
118
|
* @summary: Get a brand
|
|
119
119
|
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrandDetailBySlug/).
|
|
@@ -150,7 +150,7 @@ class Catalog {
|
|
|
150
150
|
/**
|
|
151
151
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
152
152
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
153
|
-
* @returns {Promise<
|
|
153
|
+
* @returns {Promise<BrandListingResponse>} - Success response
|
|
154
154
|
* @name getBrands
|
|
155
155
|
* @summary: List brands
|
|
156
156
|
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
@@ -194,7 +194,7 @@ class Catalog {
|
|
|
194
194
|
* of available departments below. Also, you can get available departments
|
|
195
195
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
196
196
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
197
|
-
* @returns {Paginator<
|
|
197
|
+
* @returns {Paginator<BrandListingResponse>}
|
|
198
198
|
* @summary: List brands
|
|
199
199
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
200
200
|
*/
|
|
@@ -222,7 +222,7 @@ class Catalog {
|
|
|
222
222
|
/**
|
|
223
223
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
224
224
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
225
|
-
* @returns {Promise<
|
|
225
|
+
* @returns {Promise<CategoryListingResponse>} - Success response
|
|
226
226
|
* @name getCategories
|
|
227
227
|
* @summary: List product categories
|
|
228
228
|
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
@@ -260,7 +260,7 @@ class Catalog {
|
|
|
260
260
|
/**
|
|
261
261
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
262
262
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
263
|
-
* @returns {Promise<
|
|
263
|
+
* @returns {Promise<CategoryMetaResponse>} - Success response
|
|
264
264
|
* @name getCategoryDetailBySlug
|
|
265
265
|
* @summary: Get category by slug
|
|
266
266
|
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
@@ -297,7 +297,7 @@ class Catalog {
|
|
|
297
297
|
/**
|
|
298
298
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
299
299
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
300
|
-
* @returns {Promise<
|
|
300
|
+
* @returns {Promise<CollectionDetailResponse>} - Success response
|
|
301
301
|
* @name getCollectionDetailBySlug
|
|
302
302
|
* @summary: Get a collection
|
|
303
303
|
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
@@ -334,7 +334,7 @@ class Catalog {
|
|
|
334
334
|
/**
|
|
335
335
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
336
336
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
337
|
-
* @returns {Promise<
|
|
337
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
338
338
|
* @name getCollectionItemsBySlug
|
|
339
339
|
* @summary: Lists items of collection
|
|
340
340
|
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
@@ -404,7 +404,7 @@ class Catalog {
|
|
|
404
404
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
405
405
|
* either ascending or descending order. See the supported values below.
|
|
406
406
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
407
|
-
* @returns {Paginator<
|
|
407
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
408
408
|
* @summary: Lists items of collection
|
|
409
409
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
410
410
|
*/
|
|
@@ -445,7 +445,7 @@ class Catalog {
|
|
|
445
445
|
/**
|
|
446
446
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
447
447
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
448
|
-
* @returns {Promise<
|
|
448
|
+
* @returns {Promise<GetCollectionListingResponse>} - Success response
|
|
449
449
|
* @name getCollections
|
|
450
450
|
* @summary: List collections
|
|
451
451
|
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
@@ -488,7 +488,7 @@ class Catalog {
|
|
|
488
488
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
489
489
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
490
490
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
491
|
-
* @returns {Paginator<
|
|
491
|
+
* @returns {Paginator<GetCollectionListingResponse>}
|
|
492
492
|
* @summary: List collections
|
|
493
493
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
494
494
|
*/
|
|
@@ -517,8 +517,7 @@ class Catalog {
|
|
|
517
517
|
/**
|
|
518
518
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
519
519
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
520
|
-
* @returns {Promise<
|
|
521
|
-
* Success response
|
|
520
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
|
|
522
521
|
* @name getComparedFrequentlyProductBySlug
|
|
523
522
|
* @summary: List frequent products
|
|
524
523
|
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
@@ -555,7 +554,7 @@ class Catalog {
|
|
|
555
554
|
/**
|
|
556
555
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
557
556
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
558
|
-
* @returns {Promise<
|
|
557
|
+
* @returns {Promise<DepartmentResponse>} - Success response
|
|
559
558
|
* @name getDepartments
|
|
560
559
|
* @summary: List departments
|
|
561
560
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
@@ -592,7 +591,7 @@ class Catalog {
|
|
|
592
591
|
/**
|
|
593
592
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
594
593
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
595
|
-
* @returns {Promise<
|
|
594
|
+
* @returns {Promise<FollowIdsResponse>} - Success response
|
|
596
595
|
* @name getFollowIds
|
|
597
596
|
* @summary: List Ids of followed item, brand, product
|
|
598
597
|
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
@@ -630,7 +629,7 @@ class Catalog {
|
|
|
630
629
|
/**
|
|
631
630
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
632
631
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
633
|
-
* @returns {Promise<
|
|
632
|
+
* @returns {Promise<GetFollowListingResponse>} - Success response
|
|
634
633
|
* @name getFollowedListing
|
|
635
634
|
* @summary: List followed products, brands
|
|
636
635
|
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
@@ -673,7 +672,7 @@ class Catalog {
|
|
|
673
672
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
674
673
|
* products, brands, or collections.
|
|
675
674
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
676
|
-
* @returns {Paginator<
|
|
675
|
+
* @returns {Paginator<GetFollowListingResponse>}
|
|
677
676
|
* @summary: List followed products, brands
|
|
678
677
|
* @description: Get a list of products or brands the user is following.
|
|
679
678
|
*/
|
|
@@ -701,7 +700,7 @@ class Catalog {
|
|
|
701
700
|
/**
|
|
702
701
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
703
702
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
704
|
-
* @returns {Promise<
|
|
703
|
+
* @returns {Promise<FollowerCountResponse>} - Success response
|
|
705
704
|
* @name getFollowerCountById
|
|
706
705
|
* @summary: Get follower count
|
|
707
706
|
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
|
|
@@ -738,7 +737,7 @@ class Catalog {
|
|
|
738
737
|
/**
|
|
739
738
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
740
739
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
741
|
-
* @returns {Promise<
|
|
740
|
+
* @returns {Promise<HomeListingResponse>} - Success response
|
|
742
741
|
* @name getHomeProducts
|
|
743
742
|
* @summary: List homepage-featured products
|
|
744
743
|
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getHomeProducts/).
|
|
@@ -781,7 +780,7 @@ class Catalog {
|
|
|
781
780
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
782
781
|
* either ascending or descending order.
|
|
783
782
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
784
|
-
* @returns {Paginator<
|
|
783
|
+
* @returns {Paginator<HomeListingResponse>}
|
|
785
784
|
* @summary: List homepage-featured products
|
|
786
785
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
787
786
|
*/
|
|
@@ -985,7 +984,7 @@ class Catalog {
|
|
|
985
984
|
/**
|
|
986
985
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
987
986
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
988
|
-
* @returns {Promise<
|
|
987
|
+
* @returns {Promise<ProductsComparisonResponse>} - Success response
|
|
989
988
|
* @name getProductComparisonBySlugs
|
|
990
989
|
* @summary: List products for comparison
|
|
991
990
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
@@ -1217,7 +1216,7 @@ class Catalog {
|
|
|
1217
1216
|
/**
|
|
1218
1217
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1219
1218
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1220
|
-
* @returns {Promise<
|
|
1219
|
+
* @returns {Promise<ProductStockStatusResponse>} - Success response
|
|
1221
1220
|
* @name getProductStockByIds
|
|
1222
1221
|
* @summary: Get product stocks
|
|
1223
1222
|
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
@@ -1328,7 +1327,7 @@ class Catalog {
|
|
|
1328
1327
|
/**
|
|
1329
1328
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1330
1329
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1331
|
-
* @returns {Promise<
|
|
1330
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
1332
1331
|
* @name getProductVariantsBySlug
|
|
1333
1332
|
* @summary: List product variants
|
|
1334
1333
|
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
|
|
@@ -1365,7 +1364,7 @@ class Catalog {
|
|
|
1365
1364
|
/**
|
|
1366
1365
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1367
1366
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1368
|
-
* @returns {Promise<
|
|
1367
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
1369
1368
|
* @name getProducts
|
|
1370
1369
|
* @summary: List products
|
|
1371
1370
|
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
@@ -1431,7 +1430,7 @@ class Catalog {
|
|
|
1431
1430
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
1432
1431
|
* either ascending or descending order. See the supported values below.
|
|
1433
1432
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1434
|
-
* @returns {Paginator<
|
|
1433
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
1435
1434
|
* @summary: List products
|
|
1436
1435
|
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
|
|
1437
1436
|
*/
|
|
@@ -1464,7 +1463,7 @@ class Catalog {
|
|
|
1464
1463
|
/**
|
|
1465
1464
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1466
1465
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1467
|
-
* @returns {Promise<
|
|
1466
|
+
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
1468
1467
|
* @name getSearchResults
|
|
1469
1468
|
* @summary: List product, brand, category
|
|
1470
1469
|
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
@@ -1502,7 +1501,7 @@ class Catalog {
|
|
|
1502
1501
|
/**
|
|
1503
1502
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1504
1503
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1505
|
-
* @returns {Promise<
|
|
1504
|
+
* @returns {Promise<ProductCompareResponse>} - Success response
|
|
1506
1505
|
* @name getSimilarComparisonProductBySlug
|
|
1507
1506
|
* @summary: List similar products
|
|
1508
1507
|
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
@@ -1539,7 +1538,7 @@ class Catalog {
|
|
|
1539
1538
|
/**
|
|
1540
1539
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1541
1540
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1542
|
-
* @returns {Promise<
|
|
1541
|
+
* @returns {Promise<StoreListingResponse>} - Success response
|
|
1543
1542
|
* @name getStores
|
|
1544
1543
|
* @summary: List available stores
|
|
1545
1544
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
@@ -1603,7 +1602,7 @@ class Catalog {
|
|
|
1603
1602
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
1604
1603
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
1605
1604
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
1606
|
-
* @returns {Paginator<
|
|
1605
|
+
* @returns {Paginator<StoreListingResponse>}
|
|
1607
1606
|
* @summary: List available stores
|
|
1608
1607
|
* @description: List all stores associated with the sales channel.
|
|
1609
1608
|
*/
|
|
@@ -1644,7 +1643,7 @@ class Catalog {
|
|
|
1644
1643
|
/**
|
|
1645
1644
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1646
1645
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1647
|
-
* @returns {Promise<
|
|
1646
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
1648
1647
|
* @name unfollowById
|
|
1649
1648
|
* @summary: Delete item, brand, product
|
|
1650
1649
|
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
@@ -20,10 +20,10 @@ declare class Common {
|
|
|
20
20
|
/**
|
|
21
21
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
22
22
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
23
|
-
* @returns {Promise<
|
|
23
|
+
* @returns {Promise<ApplicationResponse>} - Success response
|
|
24
24
|
* @name searchApplication
|
|
25
25
|
* @summary: Get sales channel
|
|
26
26
|
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
|
|
27
27
|
*/
|
|
28
|
-
searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
28
|
+
searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponse>;
|
|
29
29
|
}
|
|
@@ -68,7 +68,7 @@ class Common {
|
|
|
68
68
|
/**
|
|
69
69
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
70
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
71
|
-
* @returns {Promise<
|
|
71
|
+
* @returns {Promise<ApplicationResponse>} - Success response
|
|
72
72
|
* @name searchApplication
|
|
73
73
|
* @summary: Get sales channel
|
|
74
74
|
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
|
|
@@ -25,30 +25,30 @@ declare class Configuration {
|
|
|
25
25
|
/**
|
|
26
26
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
27
27
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
28
|
-
* @returns {Promise<
|
|
28
|
+
* @returns {Promise<AppCurrencyResponse>} - Success response
|
|
29
29
|
* @name getAppCurrencies
|
|
30
30
|
* @summary: Get currency configuration
|
|
31
31
|
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
|
|
32
32
|
*/
|
|
33
|
-
getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
33
|
+
getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppCurrencyResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
36
36
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
37
|
-
* @returns {Promise<
|
|
37
|
+
* @returns {Promise<AppStaffListResponse>} - Success response
|
|
38
38
|
* @name getAppStaffList
|
|
39
39
|
* @summary: List staff members
|
|
40
40
|
* @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
|
|
41
41
|
*/
|
|
42
|
-
getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
42
|
+
getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponse>;
|
|
43
43
|
/**
|
|
44
44
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
45
45
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
46
|
-
* @returns {Promise<
|
|
46
|
+
* @returns {Promise<AppStaffResponse>} - Success response
|
|
47
47
|
* @name getAppStaffs
|
|
48
48
|
* @summary: Get staff member
|
|
49
49
|
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
|
|
50
50
|
*/
|
|
51
|
-
getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
51
|
+
getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffResponse>;
|
|
52
52
|
/**
|
|
53
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -79,12 +79,12 @@ declare class Configuration {
|
|
|
79
79
|
/**
|
|
80
80
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
81
81
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
82
|
-
* @returns {Promise<
|
|
82
|
+
* @returns {Promise<CurrenciesResponse>} - Success response
|
|
83
83
|
* @name getCurrencies
|
|
84
84
|
* @summary: List currencies
|
|
85
85
|
* @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
|
|
86
86
|
*/
|
|
87
|
-
getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
87
|
+
getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CurrenciesResponse>;
|
|
88
88
|
/**
|
|
89
89
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
90
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -97,39 +97,39 @@ declare class Configuration {
|
|
|
97
97
|
/**
|
|
98
98
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
99
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
100
|
-
* @returns {Promise<
|
|
100
|
+
* @returns {Promise<AppFeatureResponse>} - Success response
|
|
101
101
|
* @name getFeatures
|
|
102
102
|
* @summary: Get sales channel features
|
|
103
103
|
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
|
|
104
104
|
*/
|
|
105
|
-
getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
105
|
+
getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppFeatureResponse>;
|
|
106
106
|
/**
|
|
107
107
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
108
108
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
109
|
-
* @returns {Promise<
|
|
109
|
+
* @returns {Promise<AppTokenResponse>} - Success response
|
|
110
110
|
* @name getIntegrationTokens
|
|
111
111
|
* @summary: Get API tokens
|
|
112
112
|
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
|
|
113
113
|
*/
|
|
114
|
-
getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
114
|
+
getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppTokenResponse>;
|
|
115
115
|
/**
|
|
116
116
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
117
117
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
118
|
-
* @returns {Promise<
|
|
118
|
+
* @returns {Promise<LanguageResponse>} - Success response
|
|
119
119
|
* @name getLanguages
|
|
120
120
|
* @summary: List languages
|
|
121
121
|
* @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
|
|
122
122
|
*/
|
|
123
|
-
getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
123
|
+
getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LanguageResponse>;
|
|
124
124
|
/**
|
|
125
125
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
126
126
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
127
|
-
* @returns {Promise<
|
|
127
|
+
* @returns {Promise<SuccessMessageResponse>} - Success response
|
|
128
128
|
* @name getOrderingStoreCookie
|
|
129
129
|
* @summary: Create cookies
|
|
130
130
|
* @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
|
|
131
131
|
*/
|
|
132
|
-
getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
132
|
+
getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponse>;
|
|
133
133
|
/**
|
|
134
134
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
135
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -142,12 +142,12 @@ declare class Configuration {
|
|
|
142
142
|
/**
|
|
143
143
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
144
144
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
145
|
-
* @returns {Promise<
|
|
145
|
+
* @returns {Promise<ApplicationAboutResponse>} - Success response
|
|
146
146
|
* @name getOwnerInfo
|
|
147
147
|
* @summary: Get sales channel owner
|
|
148
148
|
* @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
|
|
149
149
|
*/
|
|
150
|
-
getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
150
|
+
getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationAboutResponse>;
|
|
151
151
|
/**
|
|
152
152
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
153
153
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -160,10 +160,10 @@ declare class Configuration {
|
|
|
160
160
|
/**
|
|
161
161
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
162
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<
|
|
163
|
+
* @returns {Promise<SuccessMessageResponse>} - Success response
|
|
164
164
|
* @name removeOrderingStoreCookie
|
|
165
165
|
* @summary: Delete store cookie
|
|
166
166
|
* @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
167
167
|
*/
|
|
168
|
-
removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
168
|
+
removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponse>;
|
|
169
169
|
}
|
|
@@ -46,7 +46,7 @@ class Configuration {
|
|
|
46
46
|
/**
|
|
47
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
48
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<
|
|
49
|
+
* @returns {Promise<AppCurrencyResponse>} - Success response
|
|
50
50
|
* @name getAppCurrencies
|
|
51
51
|
* @summary: Get currency configuration
|
|
52
52
|
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
|
|
@@ -83,7 +83,7 @@ class Configuration {
|
|
|
83
83
|
/**
|
|
84
84
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
85
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<
|
|
86
|
+
* @returns {Promise<AppStaffListResponse>} - Success response
|
|
87
87
|
* @name getAppStaffList
|
|
88
88
|
* @summary: List staff members
|
|
89
89
|
* @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
|
|
@@ -134,7 +134,7 @@ class Configuration {
|
|
|
134
134
|
/**
|
|
135
135
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
136
136
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
137
|
-
* @returns {Promise<
|
|
137
|
+
* @returns {Promise<AppStaffResponse>} - Success response
|
|
138
138
|
* @name getAppStaffs
|
|
139
139
|
* @summary: Get staff member
|
|
140
140
|
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
|
|
@@ -287,7 +287,7 @@ class Configuration {
|
|
|
287
287
|
/**
|
|
288
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
289
289
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
290
|
-
* @returns {Promise<
|
|
290
|
+
* @returns {Promise<CurrenciesResponse>} - Success response
|
|
291
291
|
* @name getCurrencies
|
|
292
292
|
* @summary: List currencies
|
|
293
293
|
* @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
|
|
@@ -361,7 +361,7 @@ class Configuration {
|
|
|
361
361
|
/**
|
|
362
362
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
363
363
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
364
|
-
* @returns {Promise<
|
|
364
|
+
* @returns {Promise<AppFeatureResponse>} - Success response
|
|
365
365
|
* @name getFeatures
|
|
366
366
|
* @summary: Get sales channel features
|
|
367
367
|
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
|
|
@@ -398,7 +398,7 @@ class Configuration {
|
|
|
398
398
|
/**
|
|
399
399
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
400
400
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
401
|
-
* @returns {Promise<
|
|
401
|
+
* @returns {Promise<AppTokenResponse>} - Success response
|
|
402
402
|
* @name getIntegrationTokens
|
|
403
403
|
* @summary: Get API tokens
|
|
404
404
|
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
|
|
@@ -435,7 +435,7 @@ class Configuration {
|
|
|
435
435
|
/**
|
|
436
436
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
437
437
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
438
|
-
* @returns {Promise<
|
|
438
|
+
* @returns {Promise<LanguageResponse>} - Success response
|
|
439
439
|
* @name getLanguages
|
|
440
440
|
* @summary: List languages
|
|
441
441
|
* @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
|
|
@@ -472,7 +472,7 @@ class Configuration {
|
|
|
472
472
|
/**
|
|
473
473
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
474
474
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
475
|
-
* @returns {Promise<
|
|
475
|
+
* @returns {Promise<SuccessMessageResponse>} - Success response
|
|
476
476
|
* @name getOrderingStoreCookie
|
|
477
477
|
* @summary: Create cookies
|
|
478
478
|
* @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
|
|
@@ -549,7 +549,7 @@ class Configuration {
|
|
|
549
549
|
/**
|
|
550
550
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
551
551
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
552
|
-
* @returns {Promise<
|
|
552
|
+
* @returns {Promise<ApplicationAboutResponse>} - Success response
|
|
553
553
|
* @name getOwnerInfo
|
|
554
554
|
* @summary: Get sales channel owner
|
|
555
555
|
* @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
|
|
@@ -623,7 +623,7 @@ class Configuration {
|
|
|
623
623
|
/**
|
|
624
624
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
625
625
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
626
|
-
* @returns {Promise<
|
|
626
|
+
* @returns {Promise<SuccessMessageResponse>} - Success response
|
|
627
627
|
* @name removeOrderingStoreCookie
|
|
628
628
|
* @summary: Delete store cookie
|
|
629
629
|
* @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
@@ -6,8 +6,8 @@ declare class Content {
|
|
|
6
6
|
getAnnouncements: string;
|
|
7
7
|
getBlog: string;
|
|
8
8
|
getBlogs: string;
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
getCustomFields: string;
|
|
10
|
+
getCustomObject: string;
|
|
11
11
|
getDataLoaders: string;
|
|
12
12
|
getFaqBySlug: string;
|
|
13
13
|
getFaqCategories: string;
|
|
@@ -45,34 +45,34 @@ declare class Content {
|
|
|
45
45
|
* @summary: Get a blog
|
|
46
46
|
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
|
|
47
47
|
*/
|
|
48
|
-
getBlog({ slug, rootId,
|
|
48
|
+
getBlog({ slug, rootId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogSchema>;
|
|
49
49
|
/**
|
|
50
50
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
51
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<
|
|
52
|
+
* @returns {Promise<BlogGetResponse>} - Success response
|
|
53
53
|
* @name getBlogs
|
|
54
54
|
* @summary: List blogs
|
|
55
55
|
* @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
56
56
|
*/
|
|
57
|
-
getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
57
|
+
getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetResponse>;
|
|
58
58
|
/**
|
|
59
59
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
60
60
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
61
|
* @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
|
|
62
|
-
* @name
|
|
63
|
-
* @summary: Get list of custom fields
|
|
64
|
-
* @description:
|
|
62
|
+
* @name getCustomFields
|
|
63
|
+
* @summary: Get list of custom fields
|
|
64
|
+
* @description: List custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
|
|
65
65
|
*/
|
|
66
|
-
|
|
66
|
+
getCustomFields({ resource, resourceId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldsResponseByResourceIdSchema>;
|
|
67
67
|
/**
|
|
68
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
69
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
70
70
|
* @returns {Promise<CustomObjectByIdSchema>} - Success response
|
|
71
|
-
* @name
|
|
72
|
-
* @summary: Get custom object
|
|
73
|
-
* @description:
|
|
71
|
+
* @name getCustomObject
|
|
72
|
+
* @summary: Get custom object
|
|
73
|
+
* @description: Get details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
|
|
74
74
|
*/
|
|
75
|
-
|
|
75
|
+
getCustomObject({ metaobjectId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomObjectByIdSchema>;
|
|
76
76
|
/**
|
|
77
77
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
78
78
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -148,12 +148,12 @@ declare class Content {
|
|
|
148
148
|
/**
|
|
149
149
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
150
150
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
151
|
-
* @returns {Promise<
|
|
151
|
+
* @returns {Promise<NavigationGetResponse>} - Success response
|
|
152
152
|
* @name getNavigations
|
|
153
153
|
* @summary: List navigation items
|
|
154
154
|
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
|
|
155
155
|
*/
|
|
156
|
-
getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
156
|
+
getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<NavigationGetResponse>;
|
|
157
157
|
/**
|
|
158
158
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
159
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -166,12 +166,12 @@ declare class Content {
|
|
|
166
166
|
/**
|
|
167
167
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
168
168
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
169
|
-
* @returns {Promise<
|
|
169
|
+
* @returns {Promise<PageGetResponse>} - Success response
|
|
170
170
|
* @name getPages
|
|
171
171
|
* @summary: Lists pages
|
|
172
172
|
* @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
173
173
|
*/
|
|
174
|
-
getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
174
|
+
getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageGetResponse>;
|
|
175
175
|
/**
|
|
176
176
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
177
177
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -202,12 +202,22 @@ declare class Content {
|
|
|
202
202
|
/**
|
|
203
203
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
204
204
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
205
|
-
* @returns {Promise<
|
|
205
|
+
* @returns {Promise<SlideshowGetResponse>} - Success response
|
|
206
206
|
* @name getSlideshows
|
|
207
207
|
* @summary: List Slideshows
|
|
208
208
|
* @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
|
|
209
209
|
*/
|
|
210
|
-
getSlideshows({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
210
|
+
getSlideshows({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SlideshowGetResponse>;
|
|
211
|
+
/**
|
|
212
|
+
* @param {Object} arg - Arg object.
|
|
213
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
214
|
+
* @returns {Paginator<SlideshowGetResponse>}
|
|
215
|
+
* @summary: List Slideshows
|
|
216
|
+
* @description: List slideshows along with their details.
|
|
217
|
+
*/
|
|
218
|
+
getSlideshowsPaginator({ pageSize }?: {
|
|
219
|
+
pageSize?: number;
|
|
220
|
+
}): Paginator<SlideshowGetResponse>;
|
|
211
221
|
/**
|
|
212
222
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
213
223
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -227,3 +237,4 @@ declare class Content {
|
|
|
227
237
|
*/
|
|
228
238
|
getTags({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TagsSchema>;
|
|
229
239
|
}
|
|
240
|
+
import Paginator = require("../../common/Paginator");
|