@gofynd/fdk-client-javascript 1.1.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -37,48 +37,32 @@ declare class Catalog {
|
|
|
37
37
|
_urls: {};
|
|
38
38
|
updateUrls(urls: any): void;
|
|
39
39
|
/**
|
|
40
|
-
* @param {
|
|
41
|
-
* @param {
|
|
42
|
-
*
|
|
43
|
-
* @
|
|
44
|
-
* @returns {Promise<FollowPostResponse>} - Success response
|
|
40
|
+
* @param {CatalogApplicationValidator.FollowByIdParam} arg - Arg object.
|
|
41
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
|
+
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
43
|
+
* @name followById
|
|
45
44
|
* @summary: Follow an entity (product/brand/collection)
|
|
46
|
-
* @description: Follow a particular entity such as product, brand, collection specified by its ID.
|
|
45
|
+
* @description: Follow a particular entity such as product, brand, collection specified by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
47
46
|
*/
|
|
48
|
-
followById({ collectionType, collectionId }?: {
|
|
49
|
-
collectionType: string;
|
|
50
|
-
collectionId: string;
|
|
51
|
-
}): Promise<FollowPostResponse>;
|
|
47
|
+
followById({ collectionType, collectionId }?: CatalogApplicationValidator.FollowByIdParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
52
48
|
/**
|
|
53
|
-
* @param {
|
|
54
|
-
* @param {
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* @returns {Promise<BrandDetailResponse>} - Success response
|
|
49
|
+
* @param {CatalogApplicationValidator.GetBrandDetailBySlugParam} arg - Arg object.
|
|
50
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
|
+
* @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
|
|
52
|
+
* @name getBrandDetailBySlug
|
|
58
53
|
* @summary: Get metadata of a brand
|
|
59
|
-
* @description: Fetch metadata of a brand such as name, information, logo, banner, etc.
|
|
54
|
+
* @description: Fetch 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/).
|
|
60
55
|
*/
|
|
61
|
-
getBrandDetailBySlug({ slug }?: {
|
|
62
|
-
slug: string;
|
|
63
|
-
}): Promise<BrandDetailResponse>;
|
|
56
|
+
getBrandDetailBySlug({ slug }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.BrandDetailResponse>;
|
|
64
57
|
/**
|
|
65
|
-
* @param {
|
|
66
|
-
* @param {
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* from the endpoint /service/application/catalog/v1.0/departments/
|
|
70
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
71
|
-
* given set of results.
|
|
72
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
73
|
-
* @returns {Promise<BrandListingResponse>} - Success response
|
|
58
|
+
* @param {CatalogApplicationValidator.GetBrandsParam} arg - Arg object.
|
|
59
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
60
|
+
* @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
|
|
61
|
+
* @name getBrands
|
|
74
62
|
* @summary: Get all the brands
|
|
75
|
-
* @description: A brand is the name under which a product is sold. Use this API to list all the brands. You can also filter the brands by department.
|
|
63
|
+
* @description: A brand is the name under which a product is sold. Use this API to list all the brands. You can also filter the brands by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
76
64
|
*/
|
|
77
|
-
getBrands({ department, pageNo, pageSize }?: {
|
|
78
|
-
department?: string;
|
|
79
|
-
pageNo?: number;
|
|
80
|
-
pageSize?: number;
|
|
81
|
-
}): Promise<BrandListingResponse>;
|
|
65
|
+
getBrands({ department, pageNo, pageSize }?: CatalogApplicationValidator.GetBrandsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.BrandListingResponse>;
|
|
82
66
|
/**
|
|
83
67
|
* @param {Object} arg - Arg object.
|
|
84
68
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -86,86 +70,56 @@ declare class Catalog {
|
|
|
86
70
|
* of available departments below. Also, you can get available departments
|
|
87
71
|
* from the endpoint /service/application/catalog/v1.0/departments/
|
|
88
72
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
73
|
+
* @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
|
|
89
74
|
* @summary: Get all the brands
|
|
90
75
|
* @description: A brand is the name under which a product is sold. Use this API to list all the brands. You can also filter the brands by department.
|
|
91
76
|
*/
|
|
92
77
|
getBrandsPaginator({ department, pageSize }?: {
|
|
93
78
|
department?: string;
|
|
94
79
|
pageSize?: number;
|
|
95
|
-
}): Paginator
|
|
80
|
+
}): Paginator<CatalogApplicationModel.BrandListingResponse>;
|
|
96
81
|
/**
|
|
97
|
-
* @param {
|
|
98
|
-
* @param {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
* @returns {Promise<CategoryListingResponse>} - Success response
|
|
82
|
+
* @param {CatalogApplicationValidator.GetCategoriesParam} arg - Arg object.
|
|
83
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
84
|
+
* @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
|
|
85
|
+
* Success response
|
|
86
|
+
* @name getCategories
|
|
103
87
|
* @summary: List all the categories
|
|
104
|
-
* @description: Use this API to list all the categories. You can also filter the categories by department.
|
|
88
|
+
* @description: Use this API to list all the categories. You can also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
105
89
|
*/
|
|
106
|
-
getCategories({ department }?: {
|
|
107
|
-
department?: string;
|
|
108
|
-
}): Promise<CategoryListingResponse>;
|
|
90
|
+
getCategories({ department }?: CatalogApplicationValidator.GetCategoriesParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.CategoryListingResponse>;
|
|
109
91
|
/**
|
|
110
|
-
* @param {
|
|
111
|
-
* @param {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* @returns {Promise<CategoryMetaResponse>} - Success response
|
|
92
|
+
* @param {CatalogApplicationValidator.GetCategoryDetailBySlugParam} arg - Arg object.
|
|
93
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
94
|
+
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
|
|
95
|
+
* @name getCategoryDetailBySlug
|
|
115
96
|
* @summary: Get metadata of a category
|
|
116
|
-
* @description: Fetch metadata of a category such as name, information, logo, banner, etc.
|
|
97
|
+
* @description: Fetch 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/).
|
|
117
98
|
*/
|
|
118
|
-
getCategoryDetailBySlug({ slug }?: {
|
|
119
|
-
slug: string;
|
|
120
|
-
}): Promise<CategoryMetaResponse>;
|
|
99
|
+
getCategoryDetailBySlug({ slug }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.CategoryMetaResponse>;
|
|
121
100
|
/**
|
|
122
|
-
* @param {
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
* @returns {Promise<CollectionDetailResponse>} -
|
|
101
|
+
* @param {CatalogApplicationValidator.GetCollectionDetailBySlugParam} arg
|
|
102
|
+
* - Arg object.
|
|
103
|
+
*
|
|
104
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
105
|
+
* @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
|
|
106
|
+
* Success response
|
|
107
|
+
* @name getCollectionDetailBySlug
|
|
127
108
|
* @summary: Get a particular collection
|
|
128
|
-
* @description: Get the details of a collection by its `slug`.
|
|
109
|
+
* @description: Get the details of a collection by its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
129
110
|
*/
|
|
130
|
-
getCollectionDetailBySlug({ slug }?: {
|
|
131
|
-
slug: string;
|
|
132
|
-
}): Promise<CollectionDetailResponse>;
|
|
111
|
+
getCollectionDetailBySlug({ slug }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.CollectionDetailResponse>;
|
|
133
112
|
/**
|
|
134
|
-
* @param {
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
* Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
|
|
141
|
-
* indicates a new filter paramater applied as an AND condition.
|
|
142
|
-
* @param {string} [arg.q] - The search query for entering partial or full
|
|
143
|
-
* name of product, brand, category, or collection.
|
|
144
|
-
* @param {boolean} [arg.filters] - This is a boolean value, True for
|
|
145
|
-
* fetching all filter parameters and False for disabling the filter parameters.
|
|
146
|
-
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
147
|
-
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
148
|
-
* either ascending or descending order. See the supported values below.
|
|
149
|
-
* @param {string} [arg.pageId] - Page ID to retrieve next set of results.
|
|
150
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
151
|
-
* @param {number} [arg.pageNo] - Page Number to retrieve next set of results.
|
|
152
|
-
* @param {string} [arg.pageType] - Page Type to retrieve set of results can
|
|
153
|
-
* be cursor or number.
|
|
154
|
-
* @returns {Promise<ProductListingResponse>} - Success response
|
|
113
|
+
* @param {CatalogApplicationValidator.GetCollectionItemsBySlugParam} arg -
|
|
114
|
+
* Arg object.
|
|
115
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
116
|
+
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
117
|
+
* Success response
|
|
118
|
+
* @name getCollectionItemsBySlug
|
|
155
119
|
* @summary: Get the items in a collection
|
|
156
|
-
* @description: Get items in a collection specified by its `slug`.
|
|
120
|
+
* @description: Get items in a collection specified by its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
157
121
|
*/
|
|
158
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, }?:
|
|
159
|
-
slug: string;
|
|
160
|
-
f?: string;
|
|
161
|
-
q?: string;
|
|
162
|
-
filters?: boolean;
|
|
163
|
-
sortOn?: string;
|
|
164
|
-
pageId?: string;
|
|
165
|
-
pageSize?: number;
|
|
166
|
-
pageNo?: number;
|
|
167
|
-
pageType?: string;
|
|
168
|
-
}): Promise<ProductListingResponse>;
|
|
122
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
169
123
|
/**
|
|
170
124
|
* @param {Object} arg - Arg object.
|
|
171
125
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -183,6 +137,7 @@ declare class Catalog {
|
|
|
183
137
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
184
138
|
* either ascending or descending order. See the supported values below.
|
|
185
139
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
140
|
+
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
186
141
|
* @summary: Get the items in a collection
|
|
187
142
|
* @description: Get items in a collection specified by its `slug`.
|
|
188
143
|
*/
|
|
@@ -193,29 +148,24 @@ declare class Catalog {
|
|
|
193
148
|
filters?: boolean;
|
|
194
149
|
sortOn?: string;
|
|
195
150
|
pageSize?: number;
|
|
196
|
-
}): Paginator
|
|
197
|
-
/**
|
|
198
|
-
* @param {
|
|
199
|
-
* @param {
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
* @
|
|
204
|
-
* @returns {Promise<GetCollectionListingResponse>} - Success response
|
|
151
|
+
}): Paginator<CatalogApplicationModel.ProductListingResponse>;
|
|
152
|
+
/**
|
|
153
|
+
* @param {CatalogApplicationValidator.GetCollectionsParam} arg - Arg object.
|
|
154
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
155
|
+
* @returns {Promise<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
156
|
+
* - Success response
|
|
157
|
+
*
|
|
158
|
+
* @name getCollections
|
|
205
159
|
* @summary: List all the collections
|
|
206
|
-
* @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
|
|
160
|
+
* @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
207
161
|
*/
|
|
208
|
-
getCollections({ pageNo, pageSize, tag, q }?: {
|
|
209
|
-
pageNo?: number;
|
|
210
|
-
pageSize?: number;
|
|
211
|
-
tag?: string[];
|
|
212
|
-
q?: string;
|
|
213
|
-
}): Promise<GetCollectionListingResponse>;
|
|
162
|
+
getCollections({ pageNo, pageSize, tag, q }?: CatalogApplicationValidator.GetCollectionsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
|
|
214
163
|
/**
|
|
215
164
|
* @param {Object} arg - Arg object.
|
|
216
165
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
217
166
|
* @param {string[]} [arg.tag] - List of tags to filter collections
|
|
218
167
|
* @param {string} [arg.q] - Name of the collection to filter collection
|
|
168
|
+
* @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
219
169
|
* @summary: List all the collections
|
|
220
170
|
* @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
|
|
221
171
|
*/
|
|
@@ -223,132 +173,103 @@ declare class Catalog {
|
|
|
223
173
|
pageSize?: number;
|
|
224
174
|
tag?: string[];
|
|
225
175
|
q?: string;
|
|
226
|
-
}): Paginator
|
|
227
|
-
/**
|
|
228
|
-
* @param {
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
* @returns {Promise<ProductFrequentlyComparedSimilarResponse>}
|
|
176
|
+
}): Paginator<CatalogApplicationModel.GetCollectionListingResponse>;
|
|
177
|
+
/**
|
|
178
|
+
* @param {CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam} arg
|
|
179
|
+
* - Arg object.
|
|
180
|
+
*
|
|
181
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
182
|
+
* @returns {Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>}
|
|
183
|
+
* - Success response
|
|
184
|
+
*
|
|
185
|
+
* @name getComparedFrequentlyProductBySlug
|
|
233
186
|
* @summary: Get comparison between frequently compared products with the given product
|
|
234
|
-
* @description: Use this API to compare a given product automatically with products that are frequently compared with it. Only one slug is needed.
|
|
187
|
+
* @description: Use this API to compare a given product automatically with products that are frequently compared with it. Only one slug is needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
235
188
|
*/
|
|
236
|
-
getComparedFrequentlyProductBySlug({ slug }?: {
|
|
237
|
-
slug: string;
|
|
238
|
-
}): Promise<ProductFrequentlyComparedSimilarResponse>;
|
|
189
|
+
getComparedFrequentlyProductBySlug({ slug }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>;
|
|
239
190
|
/**
|
|
240
|
-
* @param {
|
|
241
|
-
* @returns {Promise<DepartmentResponse>} - Success response
|
|
191
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
192
|
+
* @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
|
|
193
|
+
* @name getDepartments
|
|
242
194
|
* @summary: List all the departments
|
|
243
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
|
|
195
|
+
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
244
196
|
*/
|
|
245
|
-
getDepartments({}?:
|
|
197
|
+
getDepartments({ headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.DepartmentResponse>;
|
|
246
198
|
/**
|
|
247
|
-
* @param {
|
|
248
|
-
* @param {
|
|
249
|
-
*
|
|
250
|
-
* @
|
|
199
|
+
* @param {CatalogApplicationValidator.GetFollowIdsParam} arg - Arg object.
|
|
200
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
201
|
+
* @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
|
|
202
|
+
* @name getFollowIds
|
|
251
203
|
* @summary: Get the IDs of followed products, brands and collections.
|
|
252
|
-
* @description: You can get the IDs of all the followed Products, Brands and Collections. Pass collection_type as query parameter to fetch specific Ids
|
|
204
|
+
* @description: You can get the IDs of all the followed Products, Brands and Collections. Pass collection_type as query parameter to fetch specific Ids - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
253
205
|
*/
|
|
254
|
-
getFollowIds({ collectionType }?: {
|
|
255
|
-
collectionType?: string;
|
|
256
|
-
}): Promise<FollowIdsResponse>;
|
|
206
|
+
getFollowIds({ collectionType }?: CatalogApplicationValidator.GetFollowIdsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.FollowIdsResponse>;
|
|
257
207
|
/**
|
|
258
|
-
* @param {
|
|
259
|
-
* @param {
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* @
|
|
263
|
-
* @returns {Promise<GetFollowListingResponse>} - Success response
|
|
208
|
+
* @param {CatalogApplicationValidator.GetFollowedListingParam} arg - Arg object.
|
|
209
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
210
|
+
* @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
|
|
211
|
+
* Success response
|
|
212
|
+
* @name getFollowedListing
|
|
264
213
|
* @summary: Get a list of followed Products, Brands, Collections
|
|
265
|
-
* @description: Users can follow a product they like. This API retrieves the products the user have followed.
|
|
214
|
+
* @description: Users can follow a product they like. This API retrieves the products the user have followed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
266
215
|
*/
|
|
267
|
-
getFollowedListing({ collectionType, pageId, pageSize }?: {
|
|
268
|
-
collectionType: string;
|
|
269
|
-
pageId?: string;
|
|
270
|
-
pageSize?: number;
|
|
271
|
-
}): Promise<GetFollowListingResponse>;
|
|
216
|
+
getFollowedListing({ collectionType, pageId, pageSize }?: CatalogApplicationValidator.GetFollowedListingParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.GetFollowListingResponse>;
|
|
272
217
|
/**
|
|
273
218
|
* @param {Object} arg - Arg object.
|
|
274
219
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
275
220
|
* products, brands, or collections.
|
|
276
221
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
222
|
+
* @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
|
|
277
223
|
* @summary: Get a list of followed Products, Brands, Collections
|
|
278
224
|
* @description: Users can follow a product they like. This API retrieves the products the user have followed.
|
|
279
225
|
*/
|
|
280
226
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
281
227
|
collectionType: string;
|
|
282
228
|
pageSize?: number;
|
|
283
|
-
}): Paginator
|
|
229
|
+
}): Paginator<CatalogApplicationModel.GetFollowListingResponse>;
|
|
284
230
|
/**
|
|
285
|
-
* @param {
|
|
286
|
-
* @param {
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
* @
|
|
231
|
+
* @param {CatalogApplicationValidator.GetFollowerCountByIdParam} arg - Arg object.
|
|
232
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
233
|
+
* @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
|
|
234
|
+
* Success response
|
|
235
|
+
* @name getFollowerCountById
|
|
290
236
|
* @summary: Get Follow Count
|
|
291
|
-
* @description: Get the total count of followers for a given collection type and collection ID.
|
|
237
|
+
* @description: Get the total count of followers for a given collection type and collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
|
|
292
238
|
*/
|
|
293
|
-
getFollowerCountById({ collectionType, collectionId }?: {
|
|
294
|
-
collectionType: string;
|
|
295
|
-
collectionId: string;
|
|
296
|
-
}): Promise<FollowerCountResponse>;
|
|
239
|
+
getFollowerCountById({ collectionType, collectionId }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.FollowerCountResponse>;
|
|
297
240
|
/**
|
|
298
|
-
* @param {
|
|
299
|
-
* @param {
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
* @param {string} [arg.pageId] - Page ID to retrieve next set of results.
|
|
303
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
304
|
-
* @returns {Promise<HomeListingResponse>} - Success response
|
|
241
|
+
* @param {CatalogApplicationValidator.GetHomeProductsParam} arg - Arg object.
|
|
242
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
243
|
+
* @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
|
|
244
|
+
* @name getHomeProducts
|
|
305
245
|
* @summary: List the products
|
|
306
|
-
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
246
|
+
* @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/).
|
|
307
247
|
*/
|
|
308
|
-
getHomeProducts({ sortOn, pageId, pageSize }?: {
|
|
309
|
-
sortOn?: string;
|
|
310
|
-
pageId?: string;
|
|
311
|
-
pageSize?: number;
|
|
312
|
-
}): Promise<HomeListingResponse>;
|
|
248
|
+
getHomeProducts({ sortOn, pageId, pageSize }?: CatalogApplicationValidator.GetHomeProductsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.HomeListingResponse>;
|
|
313
249
|
/**
|
|
314
250
|
* @param {Object} arg - Arg object.
|
|
315
251
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
316
252
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
317
253
|
* either ascending or descending order.
|
|
318
254
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
255
|
+
* @returns {Paginator<CatalogApplicationModel.HomeListingResponse>}
|
|
319
256
|
* @summary: List the products
|
|
320
257
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
321
258
|
*/
|
|
322
259
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
323
260
|
sortOn?: string;
|
|
324
261
|
pageSize?: number;
|
|
325
|
-
}): Paginator
|
|
262
|
+
}): Paginator<CatalogApplicationModel.HomeListingResponse>;
|
|
326
263
|
/**
|
|
327
|
-
* @param {
|
|
328
|
-
* @param {
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
* @
|
|
332
|
-
* @param {string} [arg.city] - Search stores by the city in which they are situated.
|
|
333
|
-
* @param {number} [arg.range] - Use this to retrieve stores within a
|
|
334
|
-
* particular range in meters, e.g. 10000, to indicate a 10km range
|
|
335
|
-
* @param {number} [arg.latitude] - Latitude of the location from where one
|
|
336
|
-
* wants to retreive the nearest stores, e.g. 72.8691788
|
|
337
|
-
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
338
|
-
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
339
|
-
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
264
|
+
* @param {CatalogApplicationValidator.GetInStockLocationsParam} arg - Arg object.
|
|
265
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
266
|
+
* @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
|
|
267
|
+
* Success response
|
|
268
|
+
* @name getInStockLocations
|
|
340
269
|
* @summary: Get store meta information.
|
|
341
|
-
* @description: Use this API to get a list of stores in a specific application.
|
|
270
|
+
* @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
342
271
|
*/
|
|
343
|
-
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, }?:
|
|
344
|
-
pageNo?: number;
|
|
345
|
-
pageSize?: number;
|
|
346
|
-
q?: string;
|
|
347
|
-
city?: string;
|
|
348
|
-
range?: number;
|
|
349
|
-
latitude?: number;
|
|
350
|
-
longitude?: number;
|
|
351
|
-
}): Promise<ApplicationStoreListing>;
|
|
272
|
+
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude }?: CatalogApplicationValidator.GetInStockLocationsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ApplicationStoreListing>;
|
|
352
273
|
/**
|
|
353
274
|
* @param {Object} arg - Arg object.
|
|
354
275
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -360,6 +281,7 @@ declare class Catalog {
|
|
|
360
281
|
* wants to retreive the nearest stores, e.g. 72.8691788
|
|
361
282
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
362
283
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
284
|
+
* @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
|
|
363
285
|
* @summary: Get store meta information.
|
|
364
286
|
* @description: Use this API to get a list of stores in a specific application.
|
|
365
287
|
*/
|
|
@@ -370,105 +292,67 @@ declare class Catalog {
|
|
|
370
292
|
range?: number;
|
|
371
293
|
latitude?: number;
|
|
372
294
|
longitude?: number;
|
|
373
|
-
}): Paginator
|
|
295
|
+
}): Paginator<CatalogApplicationModel.ApplicationStoreListing>;
|
|
374
296
|
/**
|
|
375
|
-
* @param {
|
|
376
|
-
* @param {
|
|
377
|
-
* @returns {Promise<StoreDetails>} - Success response
|
|
297
|
+
* @param {CatalogApplicationValidator.GetLocationDetailsByIdParam} arg - Arg object.
|
|
298
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
299
|
+
* @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
|
|
300
|
+
* @name getLocationDetailsById
|
|
378
301
|
* @summary: Get store meta information.
|
|
379
|
-
* @description: Use this API to get meta details for a store.
|
|
302
|
+
* @description: Use this API to get meta details for a store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
380
303
|
*/
|
|
381
|
-
getLocationDetailsById({ locationId }?: {
|
|
382
|
-
locationId: number;
|
|
383
|
-
}): Promise<StoreDetails>;
|
|
304
|
+
getLocationDetailsById({ locationId }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.StoreDetails>;
|
|
384
305
|
/**
|
|
385
|
-
* @param {
|
|
386
|
-
* @param {
|
|
387
|
-
* @
|
|
388
|
-
* @
|
|
306
|
+
* @param {CatalogApplicationValidator.GetProductBundlesBySlugParam} arg - Arg object.
|
|
307
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
308
|
+
* @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
|
|
309
|
+
* @name getProductBundlesBySlug
|
|
389
310
|
* @summary: Get product bundles
|
|
390
|
-
* @description: Use this API to retrieve products bundles to the one specified by its slug.
|
|
311
|
+
* @description: Use this API to retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
391
312
|
*/
|
|
392
|
-
getProductBundlesBySlug({ slug, id }?: {
|
|
393
|
-
slug?: string;
|
|
394
|
-
id?: string;
|
|
395
|
-
}): Promise<ProductBundle>;
|
|
313
|
+
getProductBundlesBySlug({ slug, id }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductBundle>;
|
|
396
314
|
/**
|
|
397
|
-
* @param {
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
* @returns {Promise<ProductsComparisonResponse>} -
|
|
315
|
+
* @param {CatalogApplicationValidator.GetProductComparisonBySlugsParam} arg
|
|
316
|
+
* - Arg object.
|
|
317
|
+
*
|
|
318
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
319
|
+
* @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
|
|
320
|
+
* Success response
|
|
321
|
+
* @name getProductComparisonBySlugs
|
|
402
322
|
* @summary: Compare products
|
|
403
|
-
* @description: Use this API to compare the features of products belonging to the same category. Note that at least one slug is mandatory in the request query.
|
|
323
|
+
* @description: Use this API to compare the features of products belonging to the same category. Note that at least one slug is mandatory in the request query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
404
324
|
*/
|
|
405
|
-
getProductComparisonBySlugs({ slug }?: {
|
|
406
|
-
slug: string[];
|
|
407
|
-
}): Promise<ProductsComparisonResponse>;
|
|
325
|
+
getProductComparisonBySlugs({ slug }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductsComparisonResponse>;
|
|
408
326
|
/**
|
|
409
|
-
* @param {
|
|
410
|
-
* @param {
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
* @returns {Promise<ProductDetail>} - Success response
|
|
327
|
+
* @param {CatalogApplicationValidator.GetProductDetailBySlugParam} arg - Arg object.
|
|
328
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
329
|
+
* @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
|
|
330
|
+
* @name getProductDetailBySlug
|
|
414
331
|
* @summary: Get a product
|
|
415
|
-
* @description: Use this API to retrieve a product by its slug value.
|
|
332
|
+
* @description: Use this API to retrieve a product by its slug value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
416
333
|
*/
|
|
417
|
-
getProductDetailBySlug({ slug }?: {
|
|
418
|
-
slug: string;
|
|
419
|
-
}): Promise<ProductDetail>;
|
|
334
|
+
getProductDetailBySlug({ slug }?: CatalogApplicationValidator.GetProductDetailBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductDetail>;
|
|
420
335
|
/**
|
|
421
|
-
* @param {
|
|
422
|
-
* @param {
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
* @
|
|
426
|
-
* e.g. S, M, XL. You can get slug value from the endpoint
|
|
427
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
428
|
-
* @param {number} [arg.storeId] - The ID of the store that is selling the
|
|
429
|
-
* product, e.g. 1,2,3.
|
|
430
|
-
* @param {string} [arg.pincode] - The PIN Code of the area near which the
|
|
431
|
-
* selling locations should be searched, e.g. 400059.
|
|
432
|
-
* @param {number} [arg.moq] - An Integer indication the Minimum Order
|
|
433
|
-
* Quantity of a product, e.g. 100.
|
|
434
|
-
* @returns {Promise<ProductSizePriceResponseV3>} - Success response
|
|
336
|
+
* @param {CatalogApplicationValidator.GetProductPriceBySlugParam} arg - Arg object.
|
|
337
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
338
|
+
* @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
|
|
339
|
+
* Success response
|
|
340
|
+
* @name getProductPriceBySlug
|
|
435
341
|
* @summary: Get the price of a product size at a PIN Code
|
|
436
|
-
* @description: Prices may vary for different sizes of a product. Use this API to retrieve the price of a product size at all the selling locations near to a PIN Code.
|
|
342
|
+
* @description: Prices may vary for different sizes of a product. Use this API to 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/).
|
|
437
343
|
*/
|
|
438
|
-
getProductPriceBySlug({ slug, size, storeId, pincode, moq }?: {
|
|
439
|
-
slug: string;
|
|
440
|
-
size: string;
|
|
441
|
-
storeId?: number;
|
|
442
|
-
pincode?: string;
|
|
443
|
-
moq?: number;
|
|
444
|
-
}): Promise<ProductSizePriceResponseV3>;
|
|
344
|
+
getProductPriceBySlug({ slug, size, storeId, pincode, moq }?: CatalogApplicationValidator.GetProductPriceBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductSizePriceResponseV3>;
|
|
445
345
|
/**
|
|
446
|
-
* @param {
|
|
447
|
-
* @param {
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
453
|
-
* @param {string} [arg.pincode] - The 6-digit PIN Code of the area near
|
|
454
|
-
* which the selling locations should be searched, e.g. 400059
|
|
455
|
-
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
456
|
-
* eg, fast-delivery, low-price, optimal.
|
|
457
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
458
|
-
* given set of results.
|
|
459
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
460
|
-
* @returns {Promise<ProductSizeSellersResponseV3>} - Success response
|
|
346
|
+
* @param {CatalogApplicationValidator.GetProductSellersBySlugParam} arg - Arg object.
|
|
347
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
348
|
+
* @returns {Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
349
|
+
* - Success response
|
|
350
|
+
*
|
|
351
|
+
* @name getProductSellersBySlug
|
|
461
352
|
* @summary: Get the sellers of a product size at a PIN Code
|
|
462
|
-
* @description: A product of a particular size may be sold by multiple sellers. Use this API to fetch the sellers having the stock of a particular size at a given PIN Code.
|
|
353
|
+
* @description: A product of a particular size may be sold by multiple sellers. Use this API to fetch the sellers having the stock of a particular size at a given PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
463
354
|
*/
|
|
464
|
-
getProductSellersBySlug({ slug, size, pincode, strategy, pageNo, pageSize, }?:
|
|
465
|
-
slug: string;
|
|
466
|
-
size: string;
|
|
467
|
-
pincode?: string;
|
|
468
|
-
strategy?: string;
|
|
469
|
-
pageNo?: number;
|
|
470
|
-
pageSize?: number;
|
|
471
|
-
}): Promise<ProductSizeSellersResponseV3>;
|
|
355
|
+
getProductSellersBySlug({ slug, size, pincode, strategy, pageNo, pageSize }?: CatalogApplicationValidator.GetProductSellersBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
472
356
|
/**
|
|
473
357
|
* @param {Object} arg - Arg object.
|
|
474
358
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -482,6 +366,7 @@ declare class Catalog {
|
|
|
482
366
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
483
367
|
* eg, fast-delivery, low-price, optimal.
|
|
484
368
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
369
|
+
* @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
485
370
|
* @summary: Get the sellers of a product size at a PIN Code
|
|
486
371
|
* @description: A product of a particular size may be sold by multiple sellers. Use this API to fetch the sellers having the stock of a particular size at a given PIN Code.
|
|
487
372
|
*/
|
|
@@ -491,113 +376,70 @@ declare class Catalog {
|
|
|
491
376
|
pincode?: string;
|
|
492
377
|
strategy?: string;
|
|
493
378
|
pageSize?: number;
|
|
494
|
-
}): Paginator
|
|
379
|
+
}): Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
495
380
|
/**
|
|
496
|
-
* @param {
|
|
497
|
-
* @param {
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
* @param {number} [arg.storeId] - The ID of the store that is selling the
|
|
501
|
-
* product, e.g. 1,2,3.
|
|
502
|
-
* @returns {Promise<ProductSizes>} - Success response
|
|
381
|
+
* @param {CatalogApplicationValidator.GetProductSizesBySlugParam} arg - Arg object.
|
|
382
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
383
|
+
* @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
|
|
384
|
+
* @name getProductSizesBySlug
|
|
503
385
|
* @summary: Get the sizes of a product
|
|
504
|
-
* @description: A product can have multiple sizes. Use this API to fetch all the available sizes of a product.
|
|
386
|
+
* @description: A product can have multiple sizes. Use this API to fetch all the available sizes of a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
|
|
505
387
|
*/
|
|
506
|
-
getProductSizesBySlug({ slug, storeId }?: {
|
|
507
|
-
slug: string;
|
|
508
|
-
storeId?: number;
|
|
509
|
-
}): Promise<ProductSizes>;
|
|
388
|
+
getProductSizesBySlug({ slug, storeId }?: CatalogApplicationValidator.GetProductSizesBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductSizes>;
|
|
510
389
|
/**
|
|
511
|
-
* @param {
|
|
512
|
-
* @param {
|
|
513
|
-
* @
|
|
514
|
-
*
|
|
515
|
-
* @
|
|
516
|
-
* (limited upto 50 SKU Code in a single request)
|
|
517
|
-
* @param {string} [arg.ean] - European Article Number of the product
|
|
518
|
-
* (limited upto 50 EAN identifier in a single request)
|
|
519
|
-
* @param {string} [arg.upc] - Universal Product Code of the product
|
|
520
|
-
* (limited upto 50 UPC identifier in a single request)
|
|
521
|
-
* @returns {Promise<ProductStockStatusResponse>} - Success response
|
|
390
|
+
* @param {CatalogApplicationValidator.GetProductStockByIdsParam} arg - Arg object.
|
|
391
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
392
|
+
* @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
|
|
393
|
+
* Success response
|
|
394
|
+
* @name getProductStockByIds
|
|
522
395
|
* @summary: Get the stock of a product
|
|
523
|
-
* @description: Retrieve the available stock of the products. Use this API to retrieve stock of multiple products (up to 50) at a time.
|
|
396
|
+
* @description: Retrieve the available stock of the products. Use this API to retrieve stock of multiple products (up to 50) at a time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
524
397
|
*/
|
|
525
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc }?: {
|
|
526
|
-
itemId?: string;
|
|
527
|
-
alu?: string;
|
|
528
|
-
skuCode?: string;
|
|
529
|
-
ean?: string;
|
|
530
|
-
upc?: string;
|
|
531
|
-
}): Promise<ProductStockStatusResponse>;
|
|
398
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc }?: CatalogApplicationValidator.GetProductStockByIdsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductStockStatusResponse>;
|
|
532
399
|
/**
|
|
533
|
-
* @param {
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
* @param {
|
|
537
|
-
* @returns {Promise<ProductStockPolling>} - Success response
|
|
400
|
+
* @param {CatalogApplicationValidator.GetProductStockForTimeByIdsParam} arg
|
|
401
|
+
* - Arg object.
|
|
402
|
+
*
|
|
403
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
404
|
+
* @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
|
|
405
|
+
* @name getProductStockForTimeByIds
|
|
538
406
|
* @summary: Get the stock of a product
|
|
539
|
-
* @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
|
|
407
|
+
* @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
540
408
|
*/
|
|
541
|
-
getProductStockForTimeByIds({ timestamp, pageSize, pageId }?: {
|
|
542
|
-
timestamp: string;
|
|
543
|
-
pageSize?: number;
|
|
544
|
-
pageId?: string;
|
|
545
|
-
}): Promise<ProductStockPolling>;
|
|
409
|
+
getProductStockForTimeByIds({ timestamp, pageSize, pageId }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductStockPolling>;
|
|
546
410
|
/**
|
|
547
411
|
* @param {Object} arg - Arg object.
|
|
548
412
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
549
413
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
414
|
+
* @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
|
|
550
415
|
* @summary: Get the stock of a product
|
|
551
416
|
* @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
|
|
552
417
|
*/
|
|
553
418
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
|
|
554
419
|
timestamp: string;
|
|
555
420
|
pageSize?: number;
|
|
556
|
-
}): Paginator
|
|
557
|
-
/**
|
|
558
|
-
* @param {
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
*
|
|
421
|
+
}): Paginator<CatalogApplicationModel.ProductStockPolling>;
|
|
422
|
+
/**
|
|
423
|
+
* @param {CatalogApplicationValidator.GetProductVariantsBySlugParam} arg -
|
|
424
|
+
* Arg object.
|
|
425
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
426
|
+
* @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
|
|
427
|
+
* Success response
|
|
428
|
+
* @name getProductVariantsBySlug
|
|
563
429
|
* @summary: Get variant of a particular product
|
|
564
|
-
* @description: A product can have a different type of variants such as colour, shade, memory. Use this API to fetch all the available variants of a product using its slug.
|
|
430
|
+
* @description: A product can have a different type of variants such as colour, shade, memory. Use this API to fetch all the available variants of a product using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
|
|
565
431
|
*/
|
|
566
|
-
getProductVariantsBySlug({ slug }?: {
|
|
567
|
-
slug: string;
|
|
568
|
-
}): Promise<ProductVariantsResponse>;
|
|
432
|
+
getProductVariantsBySlug({ slug }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductVariantsResponse>;
|
|
569
433
|
/**
|
|
570
|
-
* @param {
|
|
571
|
-
* @param {
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
*
|
|
575
|
-
* Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
|
|
576
|
-
* indicates a new filter paramater applied as an AND condition.
|
|
577
|
-
* @param {boolean} [arg.filters] - This is a boolean value, True for
|
|
578
|
-
* fetching all filter parameters and False for disabling the filter parameters.
|
|
579
|
-
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
580
|
-
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
581
|
-
* either ascending or descending order. See the supported values below.
|
|
582
|
-
* @param {string} [arg.pageId] - Page ID to retrieve next set of results.
|
|
583
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
584
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
585
|
-
* given set of results.
|
|
586
|
-
* @param {string} [arg.pageType] - Available pagination types are cursor or number.
|
|
587
|
-
* @returns {Promise<ProductListingResponse>} - Success response
|
|
434
|
+
* @param {CatalogApplicationValidator.GetProductsParam} arg - Arg object.
|
|
435
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
436
|
+
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
437
|
+
* Success response
|
|
438
|
+
* @name getProducts
|
|
588
439
|
* @summary: Get all the products
|
|
589
|
-
* @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
|
|
440
|
+
* @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
590
441
|
*/
|
|
591
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, }?:
|
|
592
|
-
q?: string;
|
|
593
|
-
f?: string;
|
|
594
|
-
filters?: boolean;
|
|
595
|
-
sortOn?: string;
|
|
596
|
-
pageId?: string;
|
|
597
|
-
pageSize?: number;
|
|
598
|
-
pageNo?: number;
|
|
599
|
-
pageType?: string;
|
|
600
|
-
}): Promise<ProductListingResponse>;
|
|
442
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType }?: CatalogApplicationValidator.GetProductsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
601
443
|
/**
|
|
602
444
|
* @param {Object} arg - Arg object.
|
|
603
445
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -612,6 +454,7 @@ declare class Catalog {
|
|
|
612
454
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
613
455
|
* either ascending or descending order. See the supported values below.
|
|
614
456
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
457
|
+
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
615
458
|
* @summary: Get all the products
|
|
616
459
|
* @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
|
|
617
460
|
*/
|
|
@@ -621,58 +464,37 @@ declare class Catalog {
|
|
|
621
464
|
filters?: boolean;
|
|
622
465
|
sortOn?: string;
|
|
623
466
|
pageSize?: number;
|
|
624
|
-
}): Paginator
|
|
467
|
+
}): Paginator<CatalogApplicationModel.ProductListingResponse>;
|
|
625
468
|
/**
|
|
626
|
-
* @param {
|
|
627
|
-
* @param {
|
|
628
|
-
*
|
|
629
|
-
*
|
|
630
|
-
* _ski shoes_, __skin cream_ etc.
|
|
631
|
-
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
469
|
+
* @param {CatalogApplicationValidator.GetSearchResultsParam} arg - Arg object.
|
|
470
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
471
|
+
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
|
|
472
|
+
* @name getSearchResults
|
|
632
473
|
* @summary: Get relevant suggestions for a search query
|
|
633
|
-
* @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool.
|
|
474
|
+
* @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
634
475
|
*/
|
|
635
|
-
getSearchResults({ q }?: {
|
|
636
|
-
q: string;
|
|
637
|
-
}): Promise<AutoCompleteResponse>;
|
|
476
|
+
getSearchResults({ q }?: CatalogApplicationValidator.GetSearchResultsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.AutoCompleteResponse>;
|
|
638
477
|
/**
|
|
639
|
-
* @param {
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
* @returns {Promise<ProductCompareResponse>} -
|
|
478
|
+
* @param {CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam} arg
|
|
479
|
+
* - Arg object.
|
|
480
|
+
*
|
|
481
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
482
|
+
* @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
|
|
483
|
+
* Success response
|
|
484
|
+
* @name getSimilarComparisonProductBySlug
|
|
644
485
|
* @summary: Get comparison between similar products
|
|
645
|
-
* @description: Use this API to compare a given product automatically with similar products. Only one slug is needed.
|
|
486
|
+
* @description: Use this API to compare a given product automatically with similar products. Only one slug is needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
646
487
|
*/
|
|
647
|
-
getSimilarComparisonProductBySlug({ slug }?: {
|
|
648
|
-
slug: string;
|
|
649
|
-
}): Promise<ProductCompareResponse>;
|
|
488
|
+
getSimilarComparisonProductBySlug({ slug }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.ProductCompareResponse>;
|
|
650
489
|
/**
|
|
651
|
-
* @param {
|
|
652
|
-
* @param {
|
|
653
|
-
*
|
|
654
|
-
* @
|
|
655
|
-
* @param {string} [arg.q] - Search a store by its name or store_code.
|
|
656
|
-
* @param {string} [arg.city] - Search stores by the city in which they are situated.
|
|
657
|
-
* @param {number} [arg.range] - Use this to retrieve stores within a
|
|
658
|
-
* particular range in meters, e.g. 10000, to indicate a 10km range
|
|
659
|
-
* @param {number} [arg.latitude] - Latitude of the location from where one
|
|
660
|
-
* wants to retreive the nearest stores, e.g. 72.8691788
|
|
661
|
-
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
662
|
-
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
663
|
-
* @returns {Promise<StoreListingResponse>} - Success response
|
|
490
|
+
* @param {CatalogApplicationValidator.GetStoresParam} arg - Arg object.
|
|
491
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
492
|
+
* @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
|
|
493
|
+
* @name getStores
|
|
664
494
|
* @summary: Get store meta information.
|
|
665
|
-
* @description: Use this API to get a list of stores in a specific application.
|
|
495
|
+
* @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
666
496
|
*/
|
|
667
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, }?:
|
|
668
|
-
pageNo?: number;
|
|
669
|
-
pageSize?: number;
|
|
670
|
-
q?: string;
|
|
671
|
-
city?: string;
|
|
672
|
-
range?: number;
|
|
673
|
-
latitude?: number;
|
|
674
|
-
longitude?: number;
|
|
675
|
-
}): Promise<StoreListingResponse>;
|
|
497
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude }?: CatalogApplicationValidator.GetStoresParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.StoreListingResponse>;
|
|
676
498
|
/**
|
|
677
499
|
* @param {Object} arg - Arg object.
|
|
678
500
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -684,6 +506,7 @@ declare class Catalog {
|
|
|
684
506
|
* wants to retreive the nearest stores, e.g. 72.8691788
|
|
685
507
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
686
508
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
509
|
+
* @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
|
|
687
510
|
* @summary: Get store meta information.
|
|
688
511
|
* @description: Use this API to get a list of stores in a specific application.
|
|
689
512
|
*/
|
|
@@ -694,19 +517,17 @@ declare class Catalog {
|
|
|
694
517
|
range?: number;
|
|
695
518
|
latitude?: number;
|
|
696
519
|
longitude?: number;
|
|
697
|
-
}): Paginator
|
|
520
|
+
}): Paginator<CatalogApplicationModel.StoreListingResponse>;
|
|
698
521
|
/**
|
|
699
|
-
* @param {
|
|
700
|
-
* @param {
|
|
701
|
-
*
|
|
702
|
-
* @
|
|
703
|
-
* @returns {Promise<FollowPostResponse>} - Success response
|
|
522
|
+
* @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
|
|
523
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
524
|
+
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
525
|
+
* @name unfollowById
|
|
704
526
|
* @summary: Unfollow an entity (product/brand/collection)
|
|
705
|
-
* @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
|
|
527
|
+
* @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
706
528
|
*/
|
|
707
|
-
unfollowById({ collectionType, collectionId }?: {
|
|
708
|
-
collectionType: string;
|
|
709
|
-
collectionId: string;
|
|
710
|
-
}): Promise<FollowPostResponse>;
|
|
529
|
+
unfollowById({ collectionType, collectionId }?: CatalogApplicationValidator.UnfollowByIdParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
711
530
|
}
|
|
531
|
+
import CatalogApplicationValidator = require("./CatalogApplicationValidator");
|
|
532
|
+
import CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
712
533
|
import Paginator = require("../../common/Paginator");
|