@gofynd/fdk-client-javascript 1.4.16-beta.3 → 1.4.16-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -117
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +6 -810
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -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<FollowPostResponse>} - 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<BrandDetailResponse>} - 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<BrandListingResponse>} - 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<BrandListingResponse>}
|
|
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<CategoryListingResponse>} - 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<CategoryMetaResponse>} - 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<CollectionDetailResponse>} - 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<ProductListingResponse>} - 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<ProductListingResponse>}
|
|
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<GetCollectionListingResponse>} - 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<GetCollectionListingResponse>}
|
|
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,8 +571,7 @@ class Catalog {
|
|
|
571
571
|
/**
|
|
572
572
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
573
573
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
574
|
-
* @returns {Promise<
|
|
575
|
-
* Success response
|
|
574
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
|
|
576
575
|
* @name getComparedFrequentlyProductBySlug
|
|
577
576
|
* @summary: List frequent products
|
|
578
577
|
* @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/).
|
|
@@ -618,7 +617,7 @@ class Catalog {
|
|
|
618
617
|
/**
|
|
619
618
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
620
619
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
621
|
-
* @returns {Promise<
|
|
620
|
+
* @returns {Promise<DepartmentResponse>} - Success response
|
|
622
621
|
* @name getDepartments
|
|
623
622
|
* @summary: List departments
|
|
624
623
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
@@ -655,7 +654,7 @@ class Catalog {
|
|
|
655
654
|
/**
|
|
656
655
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
657
656
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
658
|
-
* @returns {Promise<
|
|
657
|
+
* @returns {Promise<FollowIdsResponse>} - Success response
|
|
659
658
|
* @name getFollowIds
|
|
660
659
|
* @summary: List Ids of followed item, brand, product
|
|
661
660
|
* @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/).
|
|
@@ -693,7 +692,7 @@ class Catalog {
|
|
|
693
692
|
/**
|
|
694
693
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
695
694
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
696
|
-
* @returns {Promise<
|
|
695
|
+
* @returns {Promise<GetFollowListingResponse>} - Success response
|
|
697
696
|
* @name getFollowedListing
|
|
698
697
|
* @summary: List followed products, brands
|
|
699
698
|
* @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/).
|
|
@@ -745,7 +744,7 @@ class Catalog {
|
|
|
745
744
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
746
745
|
* products, brands, or collections.
|
|
747
746
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
748
|
-
* @returns {Paginator<
|
|
747
|
+
* @returns {Paginator<GetFollowListingResponse>}
|
|
749
748
|
* @summary: List followed products, brands
|
|
750
749
|
* @description: Get a list of products or brands the user is following.
|
|
751
750
|
*/
|
|
@@ -773,7 +772,7 @@ class Catalog {
|
|
|
773
772
|
/**
|
|
774
773
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
775
774
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
776
|
-
* @returns {Promise<
|
|
775
|
+
* @returns {Promise<FollowerCountResponse>} - Success response
|
|
777
776
|
* @name getFollowerCountById
|
|
778
777
|
* @summary: Get follower count
|
|
779
778
|
* @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/).
|
|
@@ -822,7 +821,7 @@ class Catalog {
|
|
|
822
821
|
/**
|
|
823
822
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
824
823
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
825
|
-
* @returns {Promise<
|
|
824
|
+
* @returns {Promise<HomeListingResponse>} - Success response
|
|
826
825
|
* @name getHomeProducts
|
|
827
826
|
* @summary: List homepage-featured products
|
|
828
827
|
* @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/).
|
|
@@ -865,7 +864,7 @@ class Catalog {
|
|
|
865
864
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
866
865
|
* either ascending or descending order.
|
|
867
866
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
868
|
-
* @returns {Paginator<
|
|
867
|
+
* @returns {Paginator<HomeListingResponse>}
|
|
869
868
|
* @summary: List homepage-featured products
|
|
870
869
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
871
870
|
*/
|
|
@@ -1078,7 +1077,7 @@ class Catalog {
|
|
|
1078
1077
|
/**
|
|
1079
1078
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1080
1079
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1081
|
-
* @returns {Promise<
|
|
1080
|
+
* @returns {Promise<ProductsComparisonResponse>} - Success response
|
|
1082
1081
|
* @name getProductComparisonBySlugs
|
|
1083
1082
|
* @summary: List products for comparison
|
|
1084
1083
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
@@ -1346,7 +1345,7 @@ class Catalog {
|
|
|
1346
1345
|
/**
|
|
1347
1346
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1348
1347
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1349
|
-
* @returns {Promise<
|
|
1348
|
+
* @returns {Promise<ProductStockStatusResponse>} - Success response
|
|
1350
1349
|
* @name getProductStockByIds
|
|
1351
1350
|
* @summary: Get product stocks
|
|
1352
1351
|
* @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/).
|
|
@@ -1457,7 +1456,7 @@ class Catalog {
|
|
|
1457
1456
|
/**
|
|
1458
1457
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1459
1458
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1460
|
-
* @returns {Promise<
|
|
1459
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
1461
1460
|
* @name getProductVariantsBySlug
|
|
1462
1461
|
* @summary: List product variants
|
|
1463
1462
|
* @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/).
|
|
@@ -1503,7 +1502,7 @@ class Catalog {
|
|
|
1503
1502
|
/**
|
|
1504
1503
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1505
1504
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1506
|
-
* @returns {Promise<
|
|
1505
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
1507
1506
|
* @name getProducts
|
|
1508
1507
|
* @summary: List products
|
|
1509
1508
|
* @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/).
|
|
@@ -1569,7 +1568,7 @@ class Catalog {
|
|
|
1569
1568
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
1570
1569
|
* either ascending or descending order. See the supported values below.
|
|
1571
1570
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1572
|
-
* @returns {Paginator<
|
|
1571
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
1573
1572
|
* @summary: List products
|
|
1574
1573
|
* @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.
|
|
1575
1574
|
*/
|
|
@@ -1602,7 +1601,7 @@ class Catalog {
|
|
|
1602
1601
|
/**
|
|
1603
1602
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1604
1603
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1605
|
-
* @returns {Promise<
|
|
1604
|
+
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
1606
1605
|
* @name getSearchResults
|
|
1607
1606
|
* @summary: List product, brand, category
|
|
1608
1607
|
* @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/).
|
|
@@ -1640,7 +1639,7 @@ class Catalog {
|
|
|
1640
1639
|
/**
|
|
1641
1640
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1642
1641
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1643
|
-
* @returns {Promise<
|
|
1642
|
+
* @returns {Promise<ProductCompareResponse>} - Success response
|
|
1644
1643
|
* @name getSimilarComparisonProductBySlug
|
|
1645
1644
|
* @summary: List similar products
|
|
1646
1645
|
* @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/).
|
|
@@ -1686,7 +1685,7 @@ class Catalog {
|
|
|
1686
1685
|
/**
|
|
1687
1686
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1688
1687
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1689
|
-
* @returns {Promise<
|
|
1688
|
+
* @returns {Promise<StoreListingResponse>} - Success response
|
|
1690
1689
|
* @name getStores
|
|
1691
1690
|
* @summary: List available stores
|
|
1692
1691
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
@@ -1750,7 +1749,7 @@ class Catalog {
|
|
|
1750
1749
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
1751
1750
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
1752
1751
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
1753
|
-
* @returns {Paginator<
|
|
1752
|
+
* @returns {Paginator<StoreListingResponse>}
|
|
1754
1753
|
* @summary: List available stores
|
|
1755
1754
|
* @description: List all stores associated with the sales channel.
|
|
1756
1755
|
*/
|
|
@@ -1791,7 +1790,7 @@ class Catalog {
|
|
|
1791
1790
|
/**
|
|
1792
1791
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1793
1792
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1794
|
-
* @returns {Promise<
|
|
1793
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
1795
1794
|
* @name unfollowById
|
|
1796
1795
|
* @summary: Delete item, brand, product
|
|
1797
1796
|
* @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
|
}
|
|
@@ -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<ApplicationResponse>} - 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<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
|
}
|
|
@@ -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<AppCurrencyResponse>} - 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<AppStaffListResponse>} - 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<AppStaffResponse>} - 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<CurrenciesResponse>} - 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<AppFeatureResponse>} - 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<AppTokenResponse>} - 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<LanguageResponse>} - 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<SuccessMessageResponse>} - 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<ApplicationAboutResponse>} - 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<SuccessMessageResponse>} - 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/).
|