@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- 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 +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- 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 +4 -2
- 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 +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- 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 +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- 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 +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- 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 +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- 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 +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- 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/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -82,7 +82,7 @@ class Catalog {
|
|
|
82
82
|
/**
|
|
83
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
84
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
85
|
-
* @returns {Promise<
|
|
85
|
+
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
86
86
|
* @name followById
|
|
87
87
|
* @summary: Create item, brand, product
|
|
88
88
|
* @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/).
|
|
@@ -131,7 +131,7 @@ class Catalog {
|
|
|
131
131
|
/**
|
|
132
132
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
133
133
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
134
|
-
* @returns {Promise<
|
|
134
|
+
* @returns {Promise<BrandDetailResponseSchema>} - Success response
|
|
135
135
|
* @name getBrandDetailBySlug
|
|
136
136
|
* @summary: Get a brand
|
|
137
137
|
* @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/).
|
|
@@ -177,7 +177,7 @@ class Catalog {
|
|
|
177
177
|
/**
|
|
178
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
179
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<
|
|
180
|
+
* @returns {Promise<BrandListingResponseSchema>} - Success response
|
|
181
181
|
* @name getBrands
|
|
182
182
|
* @summary: List brands
|
|
183
183
|
* @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/).
|
|
@@ -221,7 +221,7 @@ class Catalog {
|
|
|
221
221
|
* of available departments below. Also, you can get available departments
|
|
222
222
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
223
223
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
224
|
-
* @returns {Paginator<
|
|
224
|
+
* @returns {Paginator<BrandListingResponseSchema>}
|
|
225
225
|
* @summary: List brands
|
|
226
226
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
227
227
|
*/
|
|
@@ -249,7 +249,7 @@ class Catalog {
|
|
|
249
249
|
/**
|
|
250
250
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
251
251
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
252
|
-
* @returns {Promise<
|
|
252
|
+
* @returns {Promise<CategoryListingResponseSchema>} - Success response
|
|
253
253
|
* @name getCategories
|
|
254
254
|
* @summary: List product categories
|
|
255
255
|
* @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/).
|
|
@@ -287,7 +287,7 @@ class Catalog {
|
|
|
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<CategoryMetaResponseSchema>} - Success response
|
|
291
291
|
* @name getCategoryDetailBySlug
|
|
292
292
|
* @summary: Get category by slug
|
|
293
293
|
* @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/).
|
|
@@ -333,7 +333,7 @@ class Catalog {
|
|
|
333
333
|
/**
|
|
334
334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
335
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
336
|
-
* @returns {Promise<
|
|
336
|
+
* @returns {Promise<CollectionDetailResponseSchema>} - Success response
|
|
337
337
|
* @name getCollectionDetailBySlug
|
|
338
338
|
* @summary: Get a collection
|
|
339
339
|
* @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/).
|
|
@@ -379,7 +379,7 @@ class Catalog {
|
|
|
379
379
|
/**
|
|
380
380
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
381
381
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
382
|
-
* @returns {Promise<
|
|
382
|
+
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
383
383
|
* @name getCollectionItemsBySlug
|
|
384
384
|
* @summary: Lists items of collection
|
|
385
385
|
* @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/).
|
|
@@ -458,7 +458,7 @@ class Catalog {
|
|
|
458
458
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
459
459
|
* either ascending or descending order. See the supported values below.
|
|
460
460
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
461
|
-
* @returns {Paginator<
|
|
461
|
+
* @returns {Paginator<ProductListingResponseSchema>}
|
|
462
462
|
* @summary: Lists items of collection
|
|
463
463
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
464
464
|
*/
|
|
@@ -499,7 +499,7 @@ class Catalog {
|
|
|
499
499
|
/**
|
|
500
500
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
501
501
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
502
|
-
* @returns {Promise<
|
|
502
|
+
* @returns {Promise<GetCollectionListingResponseSchema>} - Success response
|
|
503
503
|
* @name getCollections
|
|
504
504
|
* @summary: List collections
|
|
505
505
|
* @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/).
|
|
@@ -542,7 +542,7 @@ class Catalog {
|
|
|
542
542
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
543
543
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
544
544
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
545
|
-
* @returns {Paginator<
|
|
545
|
+
* @returns {Paginator<GetCollectionListingResponseSchema>}
|
|
546
546
|
* @summary: List collections
|
|
547
547
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
548
548
|
*/
|
|
@@ -571,7 +571,8 @@ class Catalog {
|
|
|
571
571
|
/**
|
|
572
572
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
573
573
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
574
|
-
* @returns {Promise<
|
|
574
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponseSchema>} -
|
|
575
|
+
* Success response
|
|
575
576
|
* @name getComparedFrequentlyProductBySlug
|
|
576
577
|
* @summary: List frequent products
|
|
577
578
|
* @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/).
|
|
@@ -617,7 +618,7 @@ class Catalog {
|
|
|
617
618
|
/**
|
|
618
619
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
619
620
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
620
|
-
* @returns {Promise<
|
|
621
|
+
* @returns {Promise<DepartmentResponseSchema>} - Success response
|
|
621
622
|
* @name getDepartments
|
|
622
623
|
* @summary: List departments
|
|
623
624
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
@@ -654,7 +655,7 @@ class Catalog {
|
|
|
654
655
|
/**
|
|
655
656
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
656
657
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
657
|
-
* @returns {Promise<
|
|
658
|
+
* @returns {Promise<FollowIdsResponseSchema>} - Success response
|
|
658
659
|
* @name getFollowIds
|
|
659
660
|
* @summary: List Ids of followed item, brand, product
|
|
660
661
|
* @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/).
|
|
@@ -692,7 +693,7 @@ class Catalog {
|
|
|
692
693
|
/**
|
|
693
694
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
694
695
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
695
|
-
* @returns {Promise<
|
|
696
|
+
* @returns {Promise<GetFollowListingResponseSchema>} - Success response
|
|
696
697
|
* @name getFollowedListing
|
|
697
698
|
* @summary: List followed products, brands
|
|
698
699
|
* @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/).
|
|
@@ -744,7 +745,7 @@ class Catalog {
|
|
|
744
745
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
745
746
|
* products, brands, or collections.
|
|
746
747
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
747
|
-
* @returns {Paginator<
|
|
748
|
+
* @returns {Paginator<GetFollowListingResponseSchema>}
|
|
748
749
|
* @summary: List followed products, brands
|
|
749
750
|
* @description: Get a list of products or brands the user is following.
|
|
750
751
|
*/
|
|
@@ -772,7 +773,7 @@ class Catalog {
|
|
|
772
773
|
/**
|
|
773
774
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
774
775
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
775
|
-
* @returns {Promise<
|
|
776
|
+
* @returns {Promise<FollowerCountResponseSchema>} - Success response
|
|
776
777
|
* @name getFollowerCountById
|
|
777
778
|
* @summary: Get follower count
|
|
778
779
|
* @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/).
|
|
@@ -821,7 +822,7 @@ class Catalog {
|
|
|
821
822
|
/**
|
|
822
823
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
823
824
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
824
|
-
* @returns {Promise<
|
|
825
|
+
* @returns {Promise<HomeListingResponseSchema>} - Success response
|
|
825
826
|
* @name getHomeProducts
|
|
826
827
|
* @summary: List homepage-featured products
|
|
827
828
|
* @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/).
|
|
@@ -864,7 +865,7 @@ class Catalog {
|
|
|
864
865
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
865
866
|
* either ascending or descending order.
|
|
866
867
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
867
|
-
* @returns {Paginator<
|
|
868
|
+
* @returns {Paginator<HomeListingResponseSchema>}
|
|
868
869
|
* @summary: List homepage-featured products
|
|
869
870
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
870
871
|
*/
|
|
@@ -1077,7 +1078,7 @@ class Catalog {
|
|
|
1077
1078
|
/**
|
|
1078
1079
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1079
1080
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1080
|
-
* @returns {Promise<
|
|
1081
|
+
* @returns {Promise<ProductsComparisonResponseSchema>} - Success response
|
|
1081
1082
|
* @name getProductComparisonBySlugs
|
|
1082
1083
|
* @summary: List products for comparison
|
|
1083
1084
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
@@ -1345,7 +1346,7 @@ class Catalog {
|
|
|
1345
1346
|
/**
|
|
1346
1347
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1347
1348
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1348
|
-
* @returns {Promise<
|
|
1349
|
+
* @returns {Promise<ProductStockStatusResponseSchema>} - Success response
|
|
1349
1350
|
* @name getProductStockByIds
|
|
1350
1351
|
* @summary: Get product stocks
|
|
1351
1352
|
* @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/).
|
|
@@ -1456,7 +1457,7 @@ class Catalog {
|
|
|
1456
1457
|
/**
|
|
1457
1458
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1458
1459
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1459
|
-
* @returns {Promise<
|
|
1460
|
+
* @returns {Promise<ProductVariantsResponseSchema>} - Success response
|
|
1460
1461
|
* @name getProductVariantsBySlug
|
|
1461
1462
|
* @summary: List product variants
|
|
1462
1463
|
* @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/).
|
|
@@ -1502,7 +1503,7 @@ class Catalog {
|
|
|
1502
1503
|
/**
|
|
1503
1504
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1504
1505
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1505
|
-
* @returns {Promise<
|
|
1506
|
+
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
1506
1507
|
* @name getProducts
|
|
1507
1508
|
* @summary: List products
|
|
1508
1509
|
* @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/).
|
|
@@ -1568,7 +1569,7 @@ class Catalog {
|
|
|
1568
1569
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
1569
1570
|
* either ascending or descending order. See the supported values below.
|
|
1570
1571
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1571
|
-
* @returns {Paginator<
|
|
1572
|
+
* @returns {Paginator<ProductListingResponseSchema>}
|
|
1572
1573
|
* @summary: List products
|
|
1573
1574
|
* @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.
|
|
1574
1575
|
*/
|
|
@@ -1601,7 +1602,7 @@ class Catalog {
|
|
|
1601
1602
|
/**
|
|
1602
1603
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1603
1604
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1604
|
-
* @returns {Promise<
|
|
1605
|
+
* @returns {Promise<AutoCompleteResponseSchema>} - Success response
|
|
1605
1606
|
* @name getSearchResults
|
|
1606
1607
|
* @summary: List product, brand, category
|
|
1607
1608
|
* @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/).
|
|
@@ -1639,7 +1640,7 @@ class Catalog {
|
|
|
1639
1640
|
/**
|
|
1640
1641
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1641
1642
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1642
|
-
* @returns {Promise<
|
|
1643
|
+
* @returns {Promise<ProductCompareResponseSchema>} - Success response
|
|
1643
1644
|
* @name getSimilarComparisonProductBySlug
|
|
1644
1645
|
* @summary: List similar products
|
|
1645
1646
|
* @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/).
|
|
@@ -1685,7 +1686,7 @@ class Catalog {
|
|
|
1685
1686
|
/**
|
|
1686
1687
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1687
1688
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1688
|
-
* @returns {Promise<
|
|
1689
|
+
* @returns {Promise<StoreListingResponseSchema>} - Success response
|
|
1689
1690
|
* @name getStores
|
|
1690
1691
|
* @summary: List available stores
|
|
1691
1692
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
@@ -1749,7 +1750,7 @@ class Catalog {
|
|
|
1749
1750
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
1750
1751
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
1751
1752
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
1752
|
-
* @returns {Paginator<
|
|
1753
|
+
* @returns {Paginator<StoreListingResponseSchema>}
|
|
1753
1754
|
* @summary: List available stores
|
|
1754
1755
|
* @description: List all stores associated with the sales channel.
|
|
1755
1756
|
*/
|
|
@@ -1790,7 +1791,7 @@ class Catalog {
|
|
|
1790
1791
|
/**
|
|
1791
1792
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1792
1793
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1793
|
-
* @returns {Promise<
|
|
1794
|
+
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
1794
1795
|
* @name unfollowById
|
|
1795
1796
|
* @summary: Delete item, brand, product
|
|
1796
1797
|
* @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<ApplicationResponseSchema>} - 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<ApplicationResponseSchema>;
|
|
29
29
|
}
|
|
@@ -74,7 +74,7 @@ class Common {
|
|
|
74
74
|
/**
|
|
75
75
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
76
76
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
77
|
-
* @returns {Promise<
|
|
77
|
+
* @returns {Promise<ApplicationResponseSchema>} - Success response
|
|
78
78
|
* @name searchApplication
|
|
79
79
|
* @summary: Get sales channel
|
|
80
80
|
* @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<AppCurrencyResponseSchema>} - 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<AppCurrencyResponseSchema>;
|
|
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<AppStaffListResponseSchema>} - 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<AppStaffListResponseSchema>;
|
|
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<AppStaffResponseSchema>} - 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<AppStaffResponseSchema>;
|
|
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<CurrenciesResponseSchema>} - 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<CurrenciesResponseSchema>;
|
|
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<AppFeatureResponseSchema>} - 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<AppFeatureResponseSchema>;
|
|
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<AppTokenResponseSchema>} - 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<AppTokenResponseSchema>;
|
|
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<LanguageResponseSchema>} - 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<LanguageResponseSchema>;
|
|
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<SuccessMessageResponseSchema>} - 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<SuccessMessageResponseSchema>;
|
|
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<ApplicationAboutResponseSchema>} - 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<ApplicationAboutResponseSchema>;
|
|
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<SuccessMessageResponseSchema>} - 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<SuccessMessageResponseSchema>;
|
|
169
169
|
}
|
|
@@ -52,7 +52,7 @@ class Configuration {
|
|
|
52
52
|
/**
|
|
53
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
55
|
-
* @returns {Promise<
|
|
55
|
+
* @returns {Promise<AppCurrencyResponseSchema>} - Success response
|
|
56
56
|
* @name getAppCurrencies
|
|
57
57
|
* @summary: Get currency configuration
|
|
58
58
|
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
|
|
@@ -89,7 +89,7 @@ class Configuration {
|
|
|
89
89
|
/**
|
|
90
90
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
91
91
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
92
|
-
* @returns {Promise<
|
|
92
|
+
* @returns {Promise<AppStaffListResponseSchema>} - Success response
|
|
93
93
|
* @name getAppStaffList
|
|
94
94
|
* @summary: List staff members
|
|
95
95
|
* @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
|
|
@@ -140,7 +140,7 @@ class Configuration {
|
|
|
140
140
|
/**
|
|
141
141
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
142
142
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
143
|
-
* @returns {Promise<
|
|
143
|
+
* @returns {Promise<AppStaffResponseSchema>} - Success response
|
|
144
144
|
* @name getAppStaffs
|
|
145
145
|
* @summary: Get staff member
|
|
146
146
|
* @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/).
|
|
@@ -293,7 +293,7 @@ class Configuration {
|
|
|
293
293
|
/**
|
|
294
294
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
295
295
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
296
|
-
* @returns {Promise<
|
|
296
|
+
* @returns {Promise<CurrenciesResponseSchema>} - Success response
|
|
297
297
|
* @name getCurrencies
|
|
298
298
|
* @summary: List currencies
|
|
299
299
|
* @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
|
|
@@ -376,7 +376,7 @@ class Configuration {
|
|
|
376
376
|
/**
|
|
377
377
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
378
378
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
379
|
-
* @returns {Promise<
|
|
379
|
+
* @returns {Promise<AppFeatureResponseSchema>} - Success response
|
|
380
380
|
* @name getFeatures
|
|
381
381
|
* @summary: Get sales channel features
|
|
382
382
|
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
|
|
@@ -413,7 +413,7 @@ class Configuration {
|
|
|
413
413
|
/**
|
|
414
414
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
415
415
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
416
|
-
* @returns {Promise<
|
|
416
|
+
* @returns {Promise<AppTokenResponseSchema>} - Success response
|
|
417
417
|
* @name getIntegrationTokens
|
|
418
418
|
* @summary: Get API tokens
|
|
419
419
|
* @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/).
|
|
@@ -450,7 +450,7 @@ class Configuration {
|
|
|
450
450
|
/**
|
|
451
451
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
452
452
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
453
|
-
* @returns {Promise<
|
|
453
|
+
* @returns {Promise<LanguageResponseSchema>} - Success response
|
|
454
454
|
* @name getLanguages
|
|
455
455
|
* @summary: List languages
|
|
456
456
|
* @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
|
|
@@ -487,7 +487,7 @@ class Configuration {
|
|
|
487
487
|
/**
|
|
488
488
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
489
489
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
490
|
-
* @returns {Promise<
|
|
490
|
+
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
491
491
|
* @name getOrderingStoreCookie
|
|
492
492
|
* @summary: Create cookies
|
|
493
493
|
* @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
|
|
@@ -564,7 +564,7 @@ class Configuration {
|
|
|
564
564
|
/**
|
|
565
565
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
566
566
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
567
|
-
* @returns {Promise<
|
|
567
|
+
* @returns {Promise<ApplicationAboutResponseSchema>} - Success response
|
|
568
568
|
* @name getOwnerInfo
|
|
569
569
|
* @summary: Get sales channel owner
|
|
570
570
|
* @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
|
|
@@ -647,7 +647,7 @@ class Configuration {
|
|
|
647
647
|
/**
|
|
648
648
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
649
649
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
650
|
-
* @returns {Promise<
|
|
650
|
+
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
651
651
|
* @name removeOrderingStoreCookie
|
|
652
652
|
* @summary: Delete store cookie
|
|
653
653
|
* @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
|