@gofynd/fdk-client-javascript 1.4.3 → 1.4.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 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +1 -1
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -87,8 +87,8 @@ class Catalog {
|
|
|
87
87
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
88
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
89
89
|
* @name followById
|
|
90
|
-
* @summary:
|
|
91
|
-
* @description: Adds a product, brand, or item to the user's followed list by
|
|
90
|
+
* @summary: Create item, brand, product
|
|
91
|
+
* @description: Adds 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/).
|
|
92
92
|
*/
|
|
93
93
|
async followById(
|
|
94
94
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -165,7 +165,7 @@ class Catalog {
|
|
|
165
165
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
166
166
|
* @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
|
|
167
167
|
* @name getBrandDetailBySlug
|
|
168
|
-
* @summary:
|
|
168
|
+
* @summary: Get a brand
|
|
169
169
|
* @description: Retrieve 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/).
|
|
170
170
|
*/
|
|
171
171
|
async getBrandDetailBySlug(
|
|
@@ -245,8 +245,8 @@ class Catalog {
|
|
|
245
245
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
246
246
|
* @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
|
|
247
247
|
* @name getBrands
|
|
248
|
-
* @summary:
|
|
249
|
-
* @description: Retrieves a
|
|
248
|
+
* @summary: List brands
|
|
249
|
+
* @description: Retrieves a list of all the availabe brands. Filtering can be applied on department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
250
250
|
*/
|
|
251
251
|
async getBrands(
|
|
252
252
|
{ department, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -328,8 +328,8 @@ class Catalog {
|
|
|
328
328
|
* from the endpoint /service/application/catalog/v1.0/departments/
|
|
329
329
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
330
330
|
* @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
|
|
331
|
-
* @summary:
|
|
332
|
-
* @description: Retrieves a
|
|
331
|
+
* @summary: List brands
|
|
332
|
+
* @description: Retrieves a list of all the availabe brands. Filtering can be applied on department.
|
|
333
333
|
*/
|
|
334
334
|
getBrandsPaginator({ department, pageSize } = {}) {
|
|
335
335
|
const paginator = new Paginator();
|
|
@@ -359,8 +359,8 @@ class Catalog {
|
|
|
359
359
|
* @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
|
|
360
360
|
* Success response
|
|
361
361
|
* @name getCategories
|
|
362
|
-
* @summary:
|
|
363
|
-
* @description: Retrieves a list of all available product categories. Also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
362
|
+
* @summary: List product categories
|
|
363
|
+
* @description: Retrieves a list of all available product categories. Also user can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
364
364
|
*/
|
|
365
365
|
async getCategories(
|
|
366
366
|
{ department, requestHeaders } = { requestHeaders: {} },
|
|
@@ -438,7 +438,7 @@ class Catalog {
|
|
|
438
438
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
439
439
|
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
|
|
440
440
|
* @name getCategoryDetailBySlug
|
|
441
|
-
* @summary:
|
|
441
|
+
* @summary: Get category by slug
|
|
442
442
|
* @description: Retrieve detailed information about a specific product category using its slug and Retrieve 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/).
|
|
443
443
|
*/
|
|
444
444
|
async getCategoryDetailBySlug(
|
|
@@ -521,7 +521,7 @@ class Catalog {
|
|
|
521
521
|
* @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
|
|
522
522
|
* Success response
|
|
523
523
|
* @name getCollectionDetailBySlug
|
|
524
|
-
* @summary:
|
|
524
|
+
* @summary: Get a collection
|
|
525
525
|
* @description: Retrieve detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
526
526
|
*/
|
|
527
527
|
async getCollectionDetailBySlug(
|
|
@@ -603,8 +603,8 @@ class Catalog {
|
|
|
603
603
|
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
604
604
|
* Success response
|
|
605
605
|
* @name getCollectionItemsBySlug
|
|
606
|
-
* @summary: Lists items
|
|
607
|
-
* @description:
|
|
606
|
+
* @summary: Lists items of collection
|
|
607
|
+
* @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/).
|
|
608
608
|
*/
|
|
609
609
|
async getCollectionItemsBySlug(
|
|
610
610
|
{
|
|
@@ -714,8 +714,8 @@ class Catalog {
|
|
|
714
714
|
* either ascending or descending order. See the supported values below.
|
|
715
715
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
716
716
|
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
717
|
-
* @summary: Lists items
|
|
718
|
-
* @description:
|
|
717
|
+
* @summary: Lists items of collection
|
|
718
|
+
* @description: Fetch items within a particular collection identified by its slug.
|
|
719
719
|
*/
|
|
720
720
|
getCollectionItemsBySlugPaginator({
|
|
721
721
|
slug,
|
|
@@ -759,8 +759,8 @@ class Catalog {
|
|
|
759
759
|
* - Success response
|
|
760
760
|
*
|
|
761
761
|
* @name getCollections
|
|
762
|
-
* @summary:
|
|
763
|
-
* @description:
|
|
762
|
+
* @summary: List Collection
|
|
763
|
+
* @description: Retrieve a 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/).
|
|
764
764
|
*/
|
|
765
765
|
async getCollections(
|
|
766
766
|
{ pageNo, pageSize, tag, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -841,8 +841,8 @@ class Catalog {
|
|
|
841
841
|
* @param {string[]} [arg.tag] - List of tags to filter collections
|
|
842
842
|
* @param {string} [arg.q] - Name of the collection to filter collection
|
|
843
843
|
* @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
844
|
-
* @summary:
|
|
845
|
-
* @description:
|
|
844
|
+
* @summary: List Collection
|
|
845
|
+
* @description: Retrieve a list of curated product collections with filtering options based on tags and collection names.
|
|
846
846
|
*/
|
|
847
847
|
getCollectionsPaginator({ pageSize, tag, q } = {}) {
|
|
848
848
|
const paginator = new Paginator();
|
|
@@ -876,7 +876,7 @@ class Catalog {
|
|
|
876
876
|
* - Success response
|
|
877
877
|
*
|
|
878
878
|
* @name getComparedFrequentlyProductBySlug
|
|
879
|
-
* @summary:
|
|
879
|
+
* @summary: List frequent products
|
|
880
880
|
* @description: Retrieve 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/).
|
|
881
881
|
*/
|
|
882
882
|
async getComparedFrequentlyProductBySlug(
|
|
@@ -956,8 +956,8 @@ class Catalog {
|
|
|
956
956
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
957
957
|
* @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
|
|
958
958
|
* @name getDepartments
|
|
959
|
-
* @summary:
|
|
960
|
-
* @description:
|
|
959
|
+
* @summary: List departments
|
|
960
|
+
* @description: Retrieve a list of all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
961
961
|
*/
|
|
962
962
|
async getDepartments(
|
|
963
963
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1034,8 +1034,8 @@ class Catalog {
|
|
|
1034
1034
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1035
1035
|
* @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
|
|
1036
1036
|
* @name getFollowIds
|
|
1037
|
-
* @summary:
|
|
1038
|
-
* @description: Retrieves the IDs of all items the user is currently following like Products, Brands and Collections
|
|
1037
|
+
* @summary: List Ids of followed item, brand, product
|
|
1038
|
+
* @description: Retrieves the IDs of all items the user is currently following like Products, Brands and Collections - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
1039
1039
|
*/
|
|
1040
1040
|
async getFollowIds(
|
|
1041
1041
|
{ collectionType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1114,7 +1114,7 @@ class Catalog {
|
|
|
1114
1114
|
* @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
|
|
1115
1115
|
* Success response
|
|
1116
1116
|
* @name getFollowedListing
|
|
1117
|
-
* @summary:
|
|
1117
|
+
* @summary: List followed products/brands
|
|
1118
1118
|
* @description: Retrieve a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
1119
1119
|
*/
|
|
1120
1120
|
async getFollowedListing(
|
|
@@ -1196,7 +1196,7 @@ class Catalog {
|
|
|
1196
1196
|
* products, brands, or collections.
|
|
1197
1197
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
1198
1198
|
* @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
|
|
1199
|
-
* @summary:
|
|
1199
|
+
* @summary: List followed products/brands
|
|
1200
1200
|
* @description: Retrieve a list of products or brands the user is following.
|
|
1201
1201
|
*/
|
|
1202
1202
|
getFollowedListingPaginator({ collectionType, pageSize } = {}) {
|
|
@@ -1227,8 +1227,8 @@ class Catalog {
|
|
|
1227
1227
|
* @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
|
|
1228
1228
|
* Success response
|
|
1229
1229
|
* @name getFollowerCountById
|
|
1230
|
-
* @summary:
|
|
1231
|
-
* @description: Retrieves the total number of followers for a specific item by its
|
|
1230
|
+
* @summary: Get follower count
|
|
1231
|
+
* @description: Retrieves 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/).
|
|
1232
1232
|
*/
|
|
1233
1233
|
async getFollowerCountById(
|
|
1234
1234
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1307,7 +1307,7 @@ class Catalog {
|
|
|
1307
1307
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1308
1308
|
* @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
|
|
1309
1309
|
* @name getHomeProducts
|
|
1310
|
-
* @summary:
|
|
1310
|
+
* @summary: List homepage-featured products
|
|
1311
1311
|
* @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/).
|
|
1312
1312
|
*/
|
|
1313
1313
|
async getHomeProducts(
|
|
@@ -1389,7 +1389,7 @@ class Catalog {
|
|
|
1389
1389
|
* either ascending or descending order.
|
|
1390
1390
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1391
1391
|
* @returns {Paginator<CatalogApplicationModel.HomeListingResponse>}
|
|
1392
|
-
* @summary:
|
|
1392
|
+
* @summary: List homepage-featured products
|
|
1393
1393
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
1394
1394
|
*/
|
|
1395
1395
|
getHomeProductsPaginator({ sortOn, pageSize } = {}) {
|
|
@@ -1420,8 +1420,8 @@ class Catalog {
|
|
|
1420
1420
|
* @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
|
|
1421
1421
|
* Success response
|
|
1422
1422
|
* @name getInStockLocations
|
|
1423
|
-
* @summary:
|
|
1424
|
-
* @description: Lists
|
|
1423
|
+
* @summary: List stores with inventory
|
|
1424
|
+
* @description: Lists stores where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
1425
1425
|
*/
|
|
1426
1426
|
async getInStockLocations(
|
|
1427
1427
|
{
|
|
@@ -1522,8 +1522,8 @@ class Catalog {
|
|
|
1522
1522
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
1523
1523
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
1524
1524
|
* @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
|
|
1525
|
-
* @summary:
|
|
1526
|
-
* @description: Lists
|
|
1525
|
+
* @summary: List stores with inventory
|
|
1526
|
+
* @description: Lists stores where specified products are currently in stock.
|
|
1527
1527
|
*/
|
|
1528
1528
|
getInStockLocationsPaginator({
|
|
1529
1529
|
pageSize,
|
|
@@ -1563,8 +1563,8 @@ class Catalog {
|
|
|
1563
1563
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1564
1564
|
* @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
|
|
1565
1565
|
* @name getLocationDetailsById
|
|
1566
|
-
* @summary:
|
|
1567
|
-
* @description:
|
|
1566
|
+
* @summary: Get selling location
|
|
1567
|
+
* @description: This API retrieves comprehensive details about a store based on its location Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
1568
1568
|
*/
|
|
1569
1569
|
async getLocationDetailsById(
|
|
1570
1570
|
{ locationId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1643,7 +1643,7 @@ class Catalog {
|
|
|
1643
1643
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1644
1644
|
* @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
|
|
1645
1645
|
* @name getProductBundlesBySlug
|
|
1646
|
-
* @summary:
|
|
1646
|
+
* @summary: List product bundles
|
|
1647
1647
|
* @description: Retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
1648
1648
|
*/
|
|
1649
1649
|
async getProductBundlesBySlug(
|
|
@@ -1728,8 +1728,8 @@ class Catalog {
|
|
|
1728
1728
|
* @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
|
|
1729
1729
|
* Success response
|
|
1730
1730
|
* @name getProductComparisonBySlugs
|
|
1731
|
-
* @summary:
|
|
1732
|
-
* @description:
|
|
1731
|
+
* @summary: List products for comparison
|
|
1732
|
+
* @description: Retrives all the products that have same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
1733
1733
|
*/
|
|
1734
1734
|
async getProductComparisonBySlugs(
|
|
1735
1735
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1809,8 +1809,8 @@ class Catalog {
|
|
|
1809
1809
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1810
1810
|
* @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
|
|
1811
1811
|
* @name getProductDetailBySlug
|
|
1812
|
-
* @summary:
|
|
1813
|
-
* @description:
|
|
1812
|
+
* @summary: Get a product
|
|
1813
|
+
* @description: Fetches properties related to Product such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
1814
1814
|
*/
|
|
1815
1815
|
async getProductDetailBySlug(
|
|
1816
1816
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1890,7 +1890,7 @@ class Catalog {
|
|
|
1890
1890
|
* @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
|
|
1891
1891
|
* Success response
|
|
1892
1892
|
* @name getProductPriceBySlug
|
|
1893
|
-
* @summary:
|
|
1893
|
+
* @summary: Get product price
|
|
1894
1894
|
* @description: Retrieve the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
|
|
1895
1895
|
*/
|
|
1896
1896
|
async getProductPriceBySlug(
|
|
@@ -1974,8 +1974,8 @@ class Catalog {
|
|
|
1974
1974
|
* - Success response
|
|
1975
1975
|
*
|
|
1976
1976
|
* @name getProductSellersBySlug
|
|
1977
|
-
* @summary:
|
|
1978
|
-
* @description: Retrieve a list of all sellers offering a specific product identified by its slug
|
|
1977
|
+
* @summary: List sellers
|
|
1978
|
+
* @description: Retrieve a list of all sellers offering a specific product identified by its slug and size - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
1979
1979
|
*/
|
|
1980
1980
|
async getProductSellersBySlug(
|
|
1981
1981
|
{ slug, size, strategy, pageNo, pageSize, requestHeaders } = {
|
|
@@ -2065,8 +2065,8 @@ class Catalog {
|
|
|
2065
2065
|
* eg, fast-delivery, low-price, optimal.
|
|
2066
2066
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
2067
2067
|
* @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
2068
|
-
* @summary:
|
|
2069
|
-
* @description: Retrieve a list of all sellers offering a specific product identified by its slug
|
|
2068
|
+
* @summary: List sellers
|
|
2069
|
+
* @description: Retrieve a list of all sellers offering a specific product identified by its slug and size
|
|
2070
2070
|
*/
|
|
2071
2071
|
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize } = {}) {
|
|
2072
2072
|
const paginator = new Paginator();
|
|
@@ -2097,8 +2097,8 @@ class Catalog {
|
|
|
2097
2097
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2098
2098
|
* @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
|
|
2099
2099
|
* @name getProductSizesBySlug
|
|
2100
|
-
* @summary:
|
|
2101
|
-
* @description:
|
|
2100
|
+
* @summary: List sizes
|
|
2101
|
+
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
|
|
2102
2102
|
*/
|
|
2103
2103
|
async getProductSizesBySlug(
|
|
2104
2104
|
{ slug, storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2179,8 +2179,8 @@ class Catalog {
|
|
|
2179
2179
|
* @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
|
|
2180
2180
|
* Success response
|
|
2181
2181
|
* @name getProductStockByIds
|
|
2182
|
-
* @summary:
|
|
2183
|
-
* @description: Retrieves the current stock status for products identified by their IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
2182
|
+
* @summary: Get product stocks
|
|
2183
|
+
* @description: Retrieves 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/).
|
|
2184
2184
|
*/
|
|
2185
2185
|
async getProductStockByIds(
|
|
2186
2186
|
{ itemId, alu, skuCode, ean, upc, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2266,8 +2266,8 @@ class Catalog {
|
|
|
2266
2266
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2267
2267
|
* @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
|
|
2268
2268
|
* @name getProductStockForTimeByIds
|
|
2269
|
-
* @summary:
|
|
2270
|
-
* @description:
|
|
2269
|
+
* @summary: List future stock
|
|
2270
|
+
* @description: Retrives the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
2271
2271
|
*/
|
|
2272
2272
|
async getProductStockForTimeByIds(
|
|
2273
2273
|
{ timestamp, pageSize, pageId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2348,8 +2348,8 @@ class Catalog {
|
|
|
2348
2348
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
2349
2349
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
2350
2350
|
* @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
|
|
2351
|
-
* @summary:
|
|
2352
|
-
* @description:
|
|
2351
|
+
* @summary: List future stock
|
|
2352
|
+
* @description: Retrives the available stock levels for all products associated with a particular sales channel at a specified future time.
|
|
2353
2353
|
*/
|
|
2354
2354
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize } = {}) {
|
|
2355
2355
|
const paginator = new Paginator();
|
|
@@ -2380,7 +2380,7 @@ class Catalog {
|
|
|
2380
2380
|
* @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
|
|
2381
2381
|
* Success response
|
|
2382
2382
|
* @name getProductVariantsBySlug
|
|
2383
|
-
* @summary:
|
|
2383
|
+
* @summary: List product variant
|
|
2384
2384
|
* @description: Retrieves 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/).
|
|
2385
2385
|
*/
|
|
2386
2386
|
async getProductVariantsBySlug(
|
|
@@ -2461,8 +2461,8 @@ class Catalog {
|
|
|
2461
2461
|
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
2462
2462
|
* Success response
|
|
2463
2463
|
* @name getProducts
|
|
2464
|
-
* @summary:
|
|
2465
|
-
* @description: Retrieves a list of all products in the catalog.
|
|
2464
|
+
* @summary: List products
|
|
2465
|
+
* @description: Retrieves a list of 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/).
|
|
2466
2466
|
*/
|
|
2467
2467
|
async getProducts(
|
|
2468
2468
|
{
|
|
@@ -2566,8 +2566,8 @@ class Catalog {
|
|
|
2566
2566
|
* either ascending or descending order. See the supported values below.
|
|
2567
2567
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
2568
2568
|
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
2569
|
-
* @summary:
|
|
2570
|
-
* @description: Retrieves a list of all products in the catalog.
|
|
2569
|
+
* @summary: List products
|
|
2570
|
+
* @description: Retrieves a list of 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.
|
|
2571
2571
|
*/
|
|
2572
2572
|
getProductsPaginator({ q, f, filters, sortOn, pageSize } = {}) {
|
|
2573
2573
|
const paginator = new Paginator();
|
|
@@ -2601,8 +2601,8 @@ class Catalog {
|
|
|
2601
2601
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2602
2602
|
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
|
|
2603
2603
|
* @name getSearchResults
|
|
2604
|
-
* @summary:
|
|
2605
|
-
* @description:
|
|
2604
|
+
* @summary: List product, brand, category
|
|
2605
|
+
* @description: Retrieve 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/).
|
|
2606
2606
|
*/
|
|
2607
2607
|
async getSearchResults(
|
|
2608
2608
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2683,8 +2683,8 @@ class Catalog {
|
|
|
2683
2683
|
* @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
|
|
2684
2684
|
* Success response
|
|
2685
2685
|
* @name getSimilarComparisonProductBySlug
|
|
2686
|
-
* @summary:
|
|
2687
|
-
* @description:
|
|
2686
|
+
* @summary: List similar products
|
|
2687
|
+
* @description: Retrives 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/).
|
|
2688
2688
|
*/
|
|
2689
2689
|
async getSimilarComparisonProductBySlug(
|
|
2690
2690
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2763,8 +2763,8 @@ class Catalog {
|
|
|
2763
2763
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2764
2764
|
* @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
|
|
2765
2765
|
* @name getStores
|
|
2766
|
-
* @summary:
|
|
2767
|
-
* @description: Retrieves a list of all
|
|
2766
|
+
* @summary: List available stores
|
|
2767
|
+
* @description: Retrieves a list of all stores associated with sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
2768
2768
|
*/
|
|
2769
2769
|
async getStores(
|
|
2770
2770
|
{
|
|
@@ -2866,8 +2866,8 @@ class Catalog {
|
|
|
2866
2866
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
2867
2867
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
2868
2868
|
* @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
|
|
2869
|
-
* @summary:
|
|
2870
|
-
* @description: Retrieves a list of all
|
|
2869
|
+
* @summary: List available stores
|
|
2870
|
+
* @description: Retrieves a list of all stores associated with sales channel
|
|
2871
2871
|
*/
|
|
2872
2872
|
getStoresPaginator({
|
|
2873
2873
|
pageSize,
|
|
@@ -2909,8 +2909,8 @@ class Catalog {
|
|
|
2909
2909
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2910
2910
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
2911
2911
|
* @name unfollowById
|
|
2912
|
-
* @summary:
|
|
2913
|
-
* @description: Removes a followed item, brand, or product
|
|
2912
|
+
* @summary: Delete item, brand, product
|
|
2913
|
+
* @description: Removes a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
2914
2914
|
*/
|
|
2915
2915
|
async unfollowById(
|
|
2916
2916
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -14,8 +14,8 @@ declare class Common {
|
|
|
14
14
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
15
15
|
* @returns {Promise<CommonApplicationModel.Locations>} - Success response
|
|
16
16
|
* @name getLocations
|
|
17
|
-
* @summary:
|
|
18
|
-
* @description: Retrieves
|
|
17
|
+
* @summary: Get a location
|
|
18
|
+
* @description: Retrieves countries , state , cities data associated with the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
|
|
19
19
|
*/
|
|
20
20
|
getLocations({ locationType, id, requestHeaders }?: CommonApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonApplicationModel.Locations>;
|
|
21
21
|
/**
|
|
@@ -24,10 +24,10 @@ declare class Common {
|
|
|
24
24
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
25
25
|
* @returns {Promise<CommonApplicationModel.ApplicationResponse>} - Success response
|
|
26
26
|
* @name searchApplication
|
|
27
|
-
* @summary:
|
|
28
|
-
* @description:
|
|
27
|
+
* @summary: Get sales channel
|
|
28
|
+
* @description: Retrieves 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/).
|
|
29
29
|
*/
|
|
30
30
|
searchApplication({ authorization, query, requestHeaders }?: CommonApplicationValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonApplicationModel.ApplicationResponse>;
|
|
31
31
|
}
|
|
32
|
-
import CommonApplicationValidator = require("
|
|
33
|
-
import CommonApplicationModel = require("
|
|
32
|
+
import CommonApplicationValidator = require("sdk/output/javascript/code/sdk/application/Common/CommonApplicationValidator");
|
|
33
|
+
import CommonApplicationModel = require("sdk/output/javascript/code/sdk/application/Common/CommonApplicationModel");
|
|
@@ -40,8 +40,8 @@ class Common {
|
|
|
40
40
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
41
41
|
* @returns {Promise<CommonApplicationModel.Locations>} - Success response
|
|
42
42
|
* @name getLocations
|
|
43
|
-
* @summary:
|
|
44
|
-
* @description: Retrieves
|
|
43
|
+
* @summary: Get a location
|
|
44
|
+
* @description: Retrieves countries , state , cities data associated with the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
|
|
45
45
|
*/
|
|
46
46
|
async getLocations(
|
|
47
47
|
{ locationType, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -120,8 +120,8 @@ class Common {
|
|
|
120
120
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
121
121
|
* @returns {Promise<CommonApplicationModel.ApplicationResponse>} - Success response
|
|
122
122
|
* @name searchApplication
|
|
123
|
-
* @summary:
|
|
124
|
-
* @description:
|
|
123
|
+
* @summary: Get sales channel
|
|
124
|
+
* @description: Retrieves 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/).
|
|
125
125
|
*/
|
|
126
126
|
async searchApplication(
|
|
127
127
|
{ authorization, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -18,8 +18,8 @@ declare class Communication {
|
|
|
18
18
|
* @returns {Promise<CommunicationApplicationModel.CommunicationConsent>} -
|
|
19
19
|
* Success response
|
|
20
20
|
* @name getCommunicationConsent
|
|
21
|
-
* @summary:
|
|
22
|
-
* @description: Retrieve the consent provided by the user for receiving communication
|
|
21
|
+
* @summary: Retrieve consent status
|
|
22
|
+
* @description: Retrieve the consent provided by the user for receiving communication - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
|
|
23
23
|
*/
|
|
24
24
|
getCommunicationConsent({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationApplicationModel.CommunicationConsent>;
|
|
25
25
|
/**
|
|
@@ -29,8 +29,8 @@ declare class Communication {
|
|
|
29
29
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<CommunicationApplicationModel.PushtokenRes>} - Success response
|
|
31
31
|
* @name upsertAppPushtoken
|
|
32
|
-
* @summary:
|
|
33
|
-
* @description: Update the push token of the user.
|
|
32
|
+
* @summary: Update or adds app push token
|
|
33
|
+
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
|
|
34
34
|
*/
|
|
35
35
|
upsertAppPushtoken({ body, requestHeaders }?: CommunicationApplicationValidator.UpsertAppPushtokenParam, { responseHeaders }?: object): Promise<CommunicationApplicationModel.PushtokenRes>;
|
|
36
36
|
/**
|
|
@@ -43,10 +43,10 @@ declare class Communication {
|
|
|
43
43
|
* - Success response
|
|
44
44
|
*
|
|
45
45
|
* @name upsertCommunicationConsent
|
|
46
|
-
* @summary:
|
|
47
|
-
* @description: Update
|
|
46
|
+
* @summary: Update or adds consent settings
|
|
47
|
+
* @description: Update or inserts the consent provided by the user for receiving communication messages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
|
|
48
48
|
*/
|
|
49
49
|
upsertCommunicationConsent({ body, requestHeaders }?: CommunicationApplicationValidator.UpsertCommunicationConsentParam, { responseHeaders }?: object): Promise<CommunicationApplicationModel.CommunicationConsentRes>;
|
|
50
50
|
}
|
|
51
|
-
import CommunicationApplicationModel = require("
|
|
52
|
-
import CommunicationApplicationValidator = require("
|
|
51
|
+
import CommunicationApplicationModel = require("sdk/output/javascript/code/sdk/application/Communication/CommunicationApplicationModel");
|
|
52
|
+
import CommunicationApplicationValidator = require("sdk/output/javascript/code/sdk/application/Communication/CommunicationApplicationValidator");
|
|
@@ -45,8 +45,8 @@ class Communication {
|
|
|
45
45
|
* @returns {Promise<CommunicationApplicationModel.CommunicationConsent>} -
|
|
46
46
|
* Success response
|
|
47
47
|
* @name getCommunicationConsent
|
|
48
|
-
* @summary:
|
|
49
|
-
* @description: Retrieve the consent provided by the user for receiving communication
|
|
48
|
+
* @summary: Retrieve consent status
|
|
49
|
+
* @description: Retrieve the consent provided by the user for receiving communication - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
|
|
50
50
|
*/
|
|
51
51
|
async getCommunicationConsent(
|
|
52
52
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -126,8 +126,8 @@ class Communication {
|
|
|
126
126
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
127
127
|
* @returns {Promise<CommunicationApplicationModel.PushtokenRes>} - Success response
|
|
128
128
|
* @name upsertAppPushtoken
|
|
129
|
-
* @summary:
|
|
130
|
-
* @description: Update the push token of the user.
|
|
129
|
+
* @summary: Update or adds app push token
|
|
130
|
+
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
|
|
131
131
|
*/
|
|
132
132
|
async upsertAppPushtoken(
|
|
133
133
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -210,8 +210,8 @@ class Communication {
|
|
|
210
210
|
* - Success response
|
|
211
211
|
*
|
|
212
212
|
* @name upsertCommunicationConsent
|
|
213
|
-
* @summary:
|
|
214
|
-
* @description: Update
|
|
213
|
+
* @summary: Update or adds consent settings
|
|
214
|
+
* @description: Update or inserts the consent provided by the user for receiving communication messages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
|
|
215
215
|
*/
|
|
216
216
|
async upsertCommunicationConsent(
|
|
217
217
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -26,4 +26,4 @@ type UpsertCommunicationConsentParam = {
|
|
|
26
26
|
body: CommunicationApplicationModel.CommunicationConsentReq;
|
|
27
27
|
};
|
|
28
28
|
type GetCommunicationConsentParam = any;
|
|
29
|
-
import CommunicationApplicationModel = require("
|
|
29
|
+
import CommunicationApplicationModel = require("sdk/output/javascript/code/sdk/application/Communication/CommunicationApplicationModel");
|