@gofynd/fdk-client-javascript 1.1.6 → 1.3.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 +52 -3
- package/index.js +0 -3
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +12 -3
- package/sdk/application/ApplicationClient.d.ts +36 -6
- package/sdk/application/ApplicationClient.js +30 -43
- package/sdk/application/ApplicationConfig.d.ts +92 -12
- package/sdk/application/ApplicationConfig.js +48 -14
- package/sdk/application/Cart/CartApplicationClient.d.ts +200 -357
- package/sdk/application/Cart/CartApplicationClient.js +711 -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 +274 -422
- package/sdk/application/Catalog/CatalogApplicationClient.js +865 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2320 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1566 -172
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +16 -21
- package/sdk/application/Common/CommonApplicationClient.js +52 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +368 -19
- package/sdk/application/Common/CommonApplicationModel.js +192 -40
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +31 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +86 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +157 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +104 -23
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +149 -118
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +457 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2235 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1113 -193
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +149 -139
- package/sdk/application/Content/ContentApplicationClient.js +489 -278
- package/sdk/application/Content/ContentApplicationModel.d.ts +1010 -105
- package/sdk/application/Content/ContentApplicationModel.js +737 -396
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +23 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +148 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +100 -87
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +57 -53
- package/sdk/application/Lead/LeadApplicationClient.js +188 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +686 -54
- package/sdk/application/Lead/LeadApplicationModel.js +330 -244
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +40 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +131 -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 +93 -133
- package/sdk/application/Order/OrderApplicationClient.js +329 -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 +400 -366
- package/sdk/application/Payment/PaymentApplicationClient.js +1176 -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 +205 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +720 -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 +58 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +187 -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 +52 -50
- package/sdk/application/Share/ShareApplicationClient.js +185 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +198 -15
- package/sdk/application/Share/ShareApplicationModel.js +131 -31
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +30 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +102 -56
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +1291 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +895 -134
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +260 -305
- package/sdk/application/User/UserApplicationClient.js +910 -522
- package/sdk/application/User/UserApplicationModel.d.ts +992 -101
- package/sdk/application/User/UserApplicationModel.js +699 -248
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +7 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +16 -1
- package/sdk/partner/PartnerAPIClient.js +12 -2
- package/sdk/partner/PartnerClient.d.ts +22 -3
- package/sdk/partner/PartnerClient.js +20 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +30 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +104 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +190 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +132 -15
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +52 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +30 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +133 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +561 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1071 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +762 -151
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +175 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +118 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +454 -635
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1646 -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 +3839 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2423 -217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +528 -638
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1600 -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 +652 -826
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1979 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6869 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -351
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1361 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +624 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +16 -21
- package/sdk/platform/Common/CommonPlatformClient.js +50 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +423 -19
- package/sdk/platform/Common/CommonPlatformModel.js +214 -40
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +37 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +20 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +731 -303
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3095 -785
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +699 -41
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +463 -27
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +19 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +59 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1708 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1360 -235
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +127 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +435 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +882 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +666 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +184 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +105 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +327 -240
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +922 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +297 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +191 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +184 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +555 -311
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4337 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2178 -248
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +605 -578
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1996 -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 +1472 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1085 -204
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +85 -82
- package/sdk/platform/Discount/DiscountPlatformClient.js +333 -175
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +281 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +189 -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 +109 -52
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +570 -105
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +141 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +118 -7
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +43 -63
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +153 -135
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +426 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +379 -40
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +106 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +60 -8
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +260 -129
- package/sdk/platform/Finance/FinancePlatformClient.js +1182 -194
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1267 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +1252 -38
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +233 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +229 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +111 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +330 -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 +100 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +372 -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 +89 -104
- package/sdk/platform/Lead/LeadPlatformClient.js +305 -180
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1045 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +504 -142
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +92 -15
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +20 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +58 -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 +437 -556
- package/sdk/platform/Order/OrderPlatformClient.js +1500 -760
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5225 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3473 -260
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +859 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +435 -23
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +16 -42
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +37 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +19 -17
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +78 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +43 -369
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +418 -288
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1509 -505
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +438 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +312 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +83 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +259 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3200 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1334 -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 +31 -12581
- package/sdk/platform/PlatformClient.js +30 -15089
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +96 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +344 -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 +360 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +238 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +159 -92
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +473 -208
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +138 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +100 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +166 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +518 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1408 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1034 -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 +41 -66
- package/sdk/platform/Share/SharePlatformApplicationClient.js +149 -116
- 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 +167 -19
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +229 -193
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +976 -352
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +345 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +206 -14
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1527 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +1099 -118
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +138 -152
- package/sdk/platform/User/UserPlatformApplicationClient.js +470 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +242 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +129 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +653 -101
- package/sdk/platform/User/UserPlatformModel.js +467 -424
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +153 -49
- package/sdk/platform/Webhook/WebhookPlatformClient.js +896 -88
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +632 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +502 -54
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +170 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +157 -7
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +16 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +48 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +370 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +191 -40
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +54 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +161 -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/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +21 -3
- package/sdk/public/PublicClient.js +20 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +16 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +52 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +33 -113
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -3
- package/sdk/application/ApplicationModels.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -145
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -799
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -14
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -87
|
@@ -37,48 +37,35 @@ declare class Catalog {
|
|
|
37
37
|
_urls: {};
|
|
38
38
|
updateUrls(urls: any): void;
|
|
39
39
|
/**
|
|
40
|
-
* @param {
|
|
41
|
-
* @param {
|
|
42
|
-
*
|
|
43
|
-
* @
|
|
44
|
-
* @
|
|
40
|
+
* @param {CatalogApplicationValidator.FollowByIdParam} arg - Arg object.
|
|
41
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
43
|
+
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
44
|
+
* @name followById
|
|
45
45
|
* @summary: Follow an entity (product/brand/collection)
|
|
46
|
-
* @description: Follow a particular entity such as product, brand, collection specified by its ID.
|
|
46
|
+
* @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
47
|
*/
|
|
48
|
-
followById({ collectionType, collectionId }?: {
|
|
49
|
-
collectionType: string;
|
|
50
|
-
collectionId: string;
|
|
51
|
-
}): Promise<FollowPostResponse>;
|
|
48
|
+
followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
52
49
|
/**
|
|
53
|
-
* @param {
|
|
54
|
-
* @param {
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* @
|
|
50
|
+
* @param {CatalogApplicationValidator.GetBrandDetailBySlugParam} arg - Arg object.
|
|
51
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
+
* @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
|
|
54
|
+
* @name getBrandDetailBySlug
|
|
58
55
|
* @summary: Get metadata of a brand
|
|
59
|
-
* @description: Fetch metadata of a brand such as name, information, logo, banner, etc.
|
|
56
|
+
* @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
57
|
*/
|
|
61
|
-
getBrandDetailBySlug({ slug }?: {
|
|
62
|
-
slug: string;
|
|
63
|
-
}): Promise<BrandDetailResponse>;
|
|
58
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandDetailResponse>;
|
|
64
59
|
/**
|
|
65
|
-
* @param {
|
|
66
|
-
* @param {
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
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
|
|
60
|
+
* @param {CatalogApplicationValidator.GetBrandsParam} arg - Arg object.
|
|
61
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
63
|
+
* @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
|
|
64
|
+
* @name getBrands
|
|
74
65
|
* @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.
|
|
66
|
+
* @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
67
|
*/
|
|
77
|
-
getBrands({ department, pageNo, pageSize }?: {
|
|
78
|
-
department?: string;
|
|
79
|
-
pageNo?: number;
|
|
80
|
-
pageSize?: number;
|
|
81
|
-
}): Promise<BrandListingResponse>;
|
|
68
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandListingResponse>;
|
|
82
69
|
/**
|
|
83
70
|
* @param {Object} arg - Arg object.
|
|
84
71
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -86,86 +73,60 @@ declare class Catalog {
|
|
|
86
73
|
* of available departments below. Also, you can get available departments
|
|
87
74
|
* from the endpoint /service/application/catalog/v1.0/departments/
|
|
88
75
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
76
|
+
* @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
|
|
89
77
|
* @summary: Get all the brands
|
|
90
78
|
* @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
79
|
*/
|
|
92
80
|
getBrandsPaginator({ department, pageSize }?: {
|
|
93
81
|
department?: string;
|
|
94
82
|
pageSize?: number;
|
|
95
|
-
}): Paginator
|
|
96
|
-
/**
|
|
97
|
-
* @param {
|
|
98
|
-
* @param {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
* @
|
|
83
|
+
}): Paginator<CatalogApplicationModel.BrandListingResponse>;
|
|
84
|
+
/**
|
|
85
|
+
* @param {CatalogApplicationValidator.GetCategoriesParam} arg - Arg object.
|
|
86
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
87
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
|
+
* @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
|
|
89
|
+
* Success response
|
|
90
|
+
* @name getCategories
|
|
103
91
|
* @summary: List all the categories
|
|
104
|
-
* @description: Use this API to list all the categories. You can also filter the categories by department.
|
|
92
|
+
* @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
93
|
*/
|
|
106
|
-
getCategories({ department }?: {
|
|
107
|
-
department?: string;
|
|
108
|
-
}): Promise<CategoryListingResponse>;
|
|
94
|
+
getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryListingResponse>;
|
|
109
95
|
/**
|
|
110
|
-
* @param {
|
|
111
|
-
* @param {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* @
|
|
96
|
+
* @param {CatalogApplicationValidator.GetCategoryDetailBySlugParam} arg - Arg object.
|
|
97
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
98
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
|
+
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
|
|
100
|
+
* @name getCategoryDetailBySlug
|
|
115
101
|
* @summary: Get metadata of a category
|
|
116
|
-
* @description: Fetch metadata of a category such as name, information, logo, banner, etc.
|
|
117
|
-
*/
|
|
118
|
-
getCategoryDetailBySlug({ slug }?: {
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
*
|
|
123
|
-
* @param {
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
102
|
+
* @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/).
|
|
103
|
+
*/
|
|
104
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryMetaResponse>;
|
|
105
|
+
/**
|
|
106
|
+
* @param {CatalogApplicationValidator.GetCollectionDetailBySlugParam} arg
|
|
107
|
+
* - Arg object.
|
|
108
|
+
*
|
|
109
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
111
|
+
* @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
|
|
112
|
+
* Success response
|
|
113
|
+
* @name getCollectionDetailBySlug
|
|
127
114
|
* @summary: Get a particular collection
|
|
128
|
-
* @description: Get the details of a collection by its `slug`.
|
|
115
|
+
* @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
116
|
*/
|
|
130
|
-
getCollectionDetailBySlug({ slug }?: {
|
|
131
|
-
slug: string;
|
|
132
|
-
}): Promise<CollectionDetailResponse>;
|
|
117
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CollectionDetailResponse>;
|
|
133
118
|
/**
|
|
134
|
-
* @param {
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
* @
|
|
139
|
-
*
|
|
140
|
-
*
|
|
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
|
|
119
|
+
* @param {CatalogApplicationValidator.GetCollectionItemsBySlugParam} arg -
|
|
120
|
+
* Arg object.
|
|
121
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
123
|
+
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
124
|
+
* Success response
|
|
125
|
+
* @name getCollectionItemsBySlug
|
|
155
126
|
* @summary: Get the items in a collection
|
|
156
|
-
* @description: Get items in a collection specified by its `slug`.
|
|
127
|
+
* @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
128
|
*/
|
|
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>;
|
|
129
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
169
130
|
/**
|
|
170
131
|
* @param {Object} arg - Arg object.
|
|
171
132
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -183,6 +144,7 @@ declare class Catalog {
|
|
|
183
144
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
184
145
|
* either ascending or descending order. See the supported values below.
|
|
185
146
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
147
|
+
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
186
148
|
* @summary: Get the items in a collection
|
|
187
149
|
* @description: Get items in a collection specified by its `slug`.
|
|
188
150
|
*/
|
|
@@ -193,29 +155,25 @@ declare class Catalog {
|
|
|
193
155
|
filters?: boolean;
|
|
194
156
|
sortOn?: string;
|
|
195
157
|
pageSize?: number;
|
|
196
|
-
}): Paginator
|
|
197
|
-
/**
|
|
198
|
-
* @param {
|
|
199
|
-
* @param {
|
|
200
|
-
*
|
|
201
|
-
* @
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
* @
|
|
158
|
+
}): Paginator<CatalogApplicationModel.ProductListingResponse>;
|
|
159
|
+
/**
|
|
160
|
+
* @param {CatalogApplicationValidator.GetCollectionsParam} arg - Arg object.
|
|
161
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
163
|
+
* @returns {Promise<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
164
|
+
* - Success response
|
|
165
|
+
*
|
|
166
|
+
* @name getCollections
|
|
205
167
|
* @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.
|
|
168
|
+
* @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
169
|
*/
|
|
208
|
-
getCollections({ pageNo, pageSize, tag, q }?: {
|
|
209
|
-
pageNo?: number;
|
|
210
|
-
pageSize?: number;
|
|
211
|
-
tag?: string[];
|
|
212
|
-
q?: string;
|
|
213
|
-
}): Promise<GetCollectionListingResponse>;
|
|
170
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
|
|
214
171
|
/**
|
|
215
172
|
* @param {Object} arg - Arg object.
|
|
216
173
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
217
174
|
* @param {string[]} [arg.tag] - List of tags to filter collections
|
|
218
175
|
* @param {string} [arg.q] - Name of the collection to filter collection
|
|
176
|
+
* @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
219
177
|
* @summary: List all the collections
|
|
220
178
|
* @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
|
|
221
179
|
*/
|
|
@@ -223,132 +181,111 @@ declare class Catalog {
|
|
|
223
181
|
pageSize?: number;
|
|
224
182
|
tag?: string[];
|
|
225
183
|
q?: string;
|
|
226
|
-
}): Paginator
|
|
227
|
-
/**
|
|
228
|
-
* @param {
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
* @
|
|
184
|
+
}): Paginator<CatalogApplicationModel.GetCollectionListingResponse>;
|
|
185
|
+
/**
|
|
186
|
+
* @param {CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam} arg
|
|
187
|
+
* - Arg object.
|
|
188
|
+
*
|
|
189
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
190
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
191
|
+
* @returns {Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>}
|
|
192
|
+
* - Success response
|
|
193
|
+
*
|
|
194
|
+
* @name getComparedFrequentlyProductBySlug
|
|
233
195
|
* @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.
|
|
196
|
+
* @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
197
|
*/
|
|
236
|
-
getComparedFrequentlyProductBySlug({ slug }?: {
|
|
237
|
-
slug: string;
|
|
238
|
-
}): Promise<ProductFrequentlyComparedSimilarResponse>;
|
|
198
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>;
|
|
239
199
|
/**
|
|
240
|
-
* @param {
|
|
241
|
-
* @
|
|
200
|
+
* @param {CatalogApplicationValidator.GetDepartmentsParam} arg - Arg object.
|
|
201
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
|
+
* @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
|
|
204
|
+
* @name getDepartments
|
|
242
205
|
* @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`
|
|
206
|
+
* @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
207
|
*/
|
|
245
|
-
getDepartments({}?: any): Promise<DepartmentResponse>;
|
|
208
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogApplicationModel.DepartmentResponse>;
|
|
246
209
|
/**
|
|
247
|
-
* @param {
|
|
248
|
-
* @param {
|
|
249
|
-
*
|
|
250
|
-
* @returns {Promise<FollowIdsResponse>} - Success response
|
|
210
|
+
* @param {CatalogApplicationValidator.GetFollowIdsParam} arg - Arg object.
|
|
211
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
212
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
|
+
* @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
|
|
214
|
+
* @name getFollowIds
|
|
251
215
|
* @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
|
|
216
|
+
* @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
217
|
*/
|
|
254
|
-
getFollowIds({ collectionType }?: {
|
|
255
|
-
collectionType?: string;
|
|
256
|
-
}): Promise<FollowIdsResponse>;
|
|
218
|
+
getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowIdsResponse>;
|
|
257
219
|
/**
|
|
258
|
-
* @param {
|
|
259
|
-
* @param {
|
|
260
|
-
*
|
|
261
|
-
* @
|
|
262
|
-
*
|
|
263
|
-
* @
|
|
220
|
+
* @param {CatalogApplicationValidator.GetFollowedListingParam} arg - Arg object.
|
|
221
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
222
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
223
|
+
* @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
|
|
224
|
+
* Success response
|
|
225
|
+
* @name getFollowedListing
|
|
264
226
|
* @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.
|
|
227
|
+
* @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
228
|
*/
|
|
267
|
-
getFollowedListing({ collectionType, pageId, pageSize }?: {
|
|
268
|
-
collectionType: string;
|
|
269
|
-
pageId?: string;
|
|
270
|
-
pageSize?: number;
|
|
271
|
-
}): Promise<GetFollowListingResponse>;
|
|
229
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponse>;
|
|
272
230
|
/**
|
|
273
231
|
* @param {Object} arg - Arg object.
|
|
274
232
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
275
233
|
* products, brands, or collections.
|
|
276
234
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
235
|
+
* @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
|
|
277
236
|
* @summary: Get a list of followed Products, Brands, Collections
|
|
278
237
|
* @description: Users can follow a product they like. This API retrieves the products the user have followed.
|
|
279
238
|
*/
|
|
280
239
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
281
240
|
collectionType: string;
|
|
282
241
|
pageSize?: number;
|
|
283
|
-
}): Paginator
|
|
284
|
-
/**
|
|
285
|
-
* @param {
|
|
286
|
-
* @param {
|
|
287
|
-
*
|
|
288
|
-
* @
|
|
289
|
-
*
|
|
242
|
+
}): Paginator<CatalogApplicationModel.GetFollowListingResponse>;
|
|
243
|
+
/**
|
|
244
|
+
* @param {CatalogApplicationValidator.GetFollowerCountByIdParam} arg - Arg object.
|
|
245
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
246
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
247
|
+
* @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
|
|
248
|
+
* Success response
|
|
249
|
+
* @name getFollowerCountById
|
|
290
250
|
* @summary: Get Follow Count
|
|
291
|
-
* @description: Get the total count of followers for a given collection type and collection ID.
|
|
251
|
+
* @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
252
|
*/
|
|
293
|
-
getFollowerCountById({ collectionType, collectionId }?: {
|
|
294
|
-
collectionType: string;
|
|
295
|
-
collectionId: string;
|
|
296
|
-
}): Promise<FollowerCountResponse>;
|
|
253
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowerCountResponse>;
|
|
297
254
|
/**
|
|
298
|
-
* @param {
|
|
299
|
-
* @param {
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
* @
|
|
303
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
304
|
-
* @returns {Promise<HomeListingResponse>} - Success response
|
|
255
|
+
* @param {CatalogApplicationValidator.GetHomeProductsParam} arg - Arg object.
|
|
256
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
258
|
+
* @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
|
|
259
|
+
* @name getHomeProducts
|
|
305
260
|
* @summary: List the products
|
|
306
|
-
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
261
|
+
* @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
262
|
*/
|
|
308
|
-
getHomeProducts({ sortOn, pageId, pageSize }?: {
|
|
309
|
-
sortOn?: string;
|
|
310
|
-
pageId?: string;
|
|
311
|
-
pageSize?: number;
|
|
312
|
-
}): Promise<HomeListingResponse>;
|
|
263
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetHomeProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.HomeListingResponse>;
|
|
313
264
|
/**
|
|
314
265
|
* @param {Object} arg - Arg object.
|
|
315
266
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
316
267
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
317
268
|
* either ascending or descending order.
|
|
318
269
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
270
|
+
* @returns {Paginator<CatalogApplicationModel.HomeListingResponse>}
|
|
319
271
|
* @summary: List the products
|
|
320
272
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
321
273
|
*/
|
|
322
274
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
323
275
|
sortOn?: string;
|
|
324
276
|
pageSize?: number;
|
|
325
|
-
}): Paginator
|
|
326
|
-
/**
|
|
327
|
-
* @param {
|
|
328
|
-
* @param {
|
|
329
|
-
*
|
|
330
|
-
* @
|
|
331
|
-
*
|
|
332
|
-
* @
|
|
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
|
|
277
|
+
}): Paginator<CatalogApplicationModel.HomeListingResponse>;
|
|
278
|
+
/**
|
|
279
|
+
* @param {CatalogApplicationValidator.GetInStockLocationsParam} arg - Arg object.
|
|
280
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
281
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
282
|
+
* @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
|
|
283
|
+
* Success response
|
|
284
|
+
* @name getInStockLocations
|
|
340
285
|
* @summary: Get store meta information.
|
|
341
|
-
* @description: Use this API to get a list of stores in a specific application.
|
|
286
|
+
* @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
287
|
*/
|
|
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>;
|
|
288
|
+
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetInStockLocationsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ApplicationStoreListing>;
|
|
352
289
|
/**
|
|
353
290
|
* @param {Object} arg - Arg object.
|
|
354
291
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -360,6 +297,7 @@ declare class Catalog {
|
|
|
360
297
|
* wants to retreive the nearest stores, e.g. 72.8691788
|
|
361
298
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
362
299
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
300
|
+
* @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
|
|
363
301
|
* @summary: Get store meta information.
|
|
364
302
|
* @description: Use this API to get a list of stores in a specific application.
|
|
365
303
|
*/
|
|
@@ -370,105 +308,73 @@ declare class Catalog {
|
|
|
370
308
|
range?: number;
|
|
371
309
|
latitude?: number;
|
|
372
310
|
longitude?: number;
|
|
373
|
-
}): Paginator
|
|
311
|
+
}): Paginator<CatalogApplicationModel.ApplicationStoreListing>;
|
|
374
312
|
/**
|
|
375
|
-
* @param {
|
|
376
|
-
* @param {
|
|
377
|
-
* @
|
|
313
|
+
* @param {CatalogApplicationValidator.GetLocationDetailsByIdParam} arg - Arg object.
|
|
314
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
316
|
+
* @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
|
|
317
|
+
* @name getLocationDetailsById
|
|
378
318
|
* @summary: Get store meta information.
|
|
379
|
-
* @description: Use this API to get meta details for a store.
|
|
319
|
+
* @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
320
|
*/
|
|
381
|
-
getLocationDetailsById({ locationId }?: {
|
|
382
|
-
locationId: number;
|
|
383
|
-
}): Promise<StoreDetails>;
|
|
321
|
+
getLocationDetailsById({ locationId, requestHeaders }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreDetails>;
|
|
384
322
|
/**
|
|
385
|
-
* @param {
|
|
386
|
-
* @param {
|
|
387
|
-
* @param {
|
|
388
|
-
* @returns {Promise<ProductBundle>} - Success response
|
|
323
|
+
* @param {CatalogApplicationValidator.GetProductBundlesBySlugParam} arg - Arg object.
|
|
324
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
326
|
+
* @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
|
|
327
|
+
* @name getProductBundlesBySlug
|
|
389
328
|
* @summary: Get product bundles
|
|
390
|
-
* @description: Use this API to retrieve products bundles to the one specified by its slug.
|
|
391
|
-
*/
|
|
392
|
-
getProductBundlesBySlug({ slug, id }?: {
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
* @param {
|
|
398
|
-
* @param {
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
* @
|
|
329
|
+
* @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/).
|
|
330
|
+
*/
|
|
331
|
+
getProductBundlesBySlug({ slug, id, requestHeaders }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductBundle>;
|
|
332
|
+
/**
|
|
333
|
+
* @param {CatalogApplicationValidator.GetProductComparisonBySlugsParam} arg
|
|
334
|
+
* - Arg object.
|
|
335
|
+
*
|
|
336
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
338
|
+
* @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
|
|
339
|
+
* Success response
|
|
340
|
+
* @name getProductComparisonBySlugs
|
|
402
341
|
* @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.
|
|
342
|
+
* @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
343
|
*/
|
|
405
|
-
getProductComparisonBySlugs({ slug }?: {
|
|
406
|
-
slug: string[];
|
|
407
|
-
}): Promise<ProductsComparisonResponse>;
|
|
344
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductsComparisonResponse>;
|
|
408
345
|
/**
|
|
409
|
-
* @param {
|
|
410
|
-
* @param {
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
* @
|
|
346
|
+
* @param {CatalogApplicationValidator.GetProductDetailBySlugParam} arg - Arg object.
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
349
|
+
* @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
|
|
350
|
+
* @name getProductDetailBySlug
|
|
414
351
|
* @summary: Get a product
|
|
415
|
-
* @description: Use this API to retrieve a product by its slug value.
|
|
352
|
+
* @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
353
|
*/
|
|
417
|
-
getProductDetailBySlug({ slug }?: {
|
|
418
|
-
slug: string;
|
|
419
|
-
}): Promise<ProductDetail>;
|
|
354
|
+
getProductDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductDetail>;
|
|
420
355
|
/**
|
|
421
|
-
* @param {
|
|
422
|
-
* @param {
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
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
|
|
356
|
+
* @param {CatalogApplicationValidator.GetProductPriceBySlugParam} arg - Arg object.
|
|
357
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
358
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
359
|
+
* @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
|
|
360
|
+
* Success response
|
|
361
|
+
* @name getProductPriceBySlug
|
|
435
362
|
* @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.
|
|
363
|
+
* @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
364
|
*/
|
|
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>;
|
|
365
|
+
getProductPriceBySlug({ slug, size, storeId, pincode, moq, requestHeaders }?: CatalogApplicationValidator.GetProductPriceBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizePriceResponseV3>;
|
|
445
366
|
/**
|
|
446
|
-
* @param {
|
|
447
|
-
* @param {
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
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
|
|
367
|
+
* @param {CatalogApplicationValidator.GetProductSellersBySlugParam} arg - Arg object.
|
|
368
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
369
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
370
|
+
* @returns {Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
371
|
+
* - Success response
|
|
372
|
+
*
|
|
373
|
+
* @name getProductSellersBySlug
|
|
461
374
|
* @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.
|
|
375
|
+
* @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
376
|
*/
|
|
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>;
|
|
377
|
+
getProductSellersBySlug({ slug, size, pincode, strategy, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetProductSellersBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
472
378
|
/**
|
|
473
379
|
* @param {Object} arg - Arg object.
|
|
474
380
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -482,6 +388,7 @@ declare class Catalog {
|
|
|
482
388
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
483
389
|
* eg, fast-delivery, low-price, optimal.
|
|
484
390
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
391
|
+
* @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
485
392
|
* @summary: Get the sellers of a product size at a PIN Code
|
|
486
393
|
* @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
394
|
*/
|
|
@@ -491,113 +398,75 @@ declare class Catalog {
|
|
|
491
398
|
pincode?: string;
|
|
492
399
|
strategy?: string;
|
|
493
400
|
pageSize?: number;
|
|
494
|
-
}): Paginator
|
|
401
|
+
}): Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
495
402
|
/**
|
|
496
|
-
* @param {
|
|
497
|
-
* @param {
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
* @
|
|
501
|
-
* product, e.g. 1,2,3.
|
|
502
|
-
* @returns {Promise<ProductSizes>} - Success response
|
|
403
|
+
* @param {CatalogApplicationValidator.GetProductSizesBySlugParam} arg - Arg object.
|
|
404
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
405
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
406
|
+
* @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
|
|
407
|
+
* @name getProductSizesBySlug
|
|
503
408
|
* @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.
|
|
409
|
+
* @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
410
|
*/
|
|
506
|
-
getProductSizesBySlug({ slug, storeId }?: {
|
|
507
|
-
slug: string;
|
|
508
|
-
storeId?: number;
|
|
509
|
-
}): Promise<ProductSizes>;
|
|
411
|
+
getProductSizesBySlug({ slug, storeId, requestHeaders }?: CatalogApplicationValidator.GetProductSizesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizes>;
|
|
510
412
|
/**
|
|
511
|
-
* @param {
|
|
512
|
-
* @param {
|
|
513
|
-
* @param {
|
|
514
|
-
*
|
|
515
|
-
*
|
|
516
|
-
*
|
|
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
|
|
413
|
+
* @param {CatalogApplicationValidator.GetProductStockByIdsParam} arg - Arg object.
|
|
414
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
415
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
416
|
+
* @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
|
|
417
|
+
* Success response
|
|
418
|
+
* @name getProductStockByIds
|
|
522
419
|
* @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.
|
|
420
|
+
* @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
421
|
*/
|
|
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>;
|
|
422
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockStatusResponse>;
|
|
532
423
|
/**
|
|
533
|
-
* @param {
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
* @param {
|
|
537
|
-
* @
|
|
424
|
+
* @param {CatalogApplicationValidator.GetProductStockForTimeByIdsParam} arg
|
|
425
|
+
* - Arg object.
|
|
426
|
+
*
|
|
427
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
428
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
429
|
+
* @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
|
|
430
|
+
* @name getProductStockForTimeByIds
|
|
538
431
|
* @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
|
|
432
|
+
* @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
433
|
*/
|
|
541
|
-
getProductStockForTimeByIds({ timestamp, pageSize, pageId }?: {
|
|
542
|
-
timestamp: string;
|
|
543
|
-
pageSize?: number;
|
|
544
|
-
pageId?: string;
|
|
545
|
-
}): Promise<ProductStockPolling>;
|
|
434
|
+
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockPolling>;
|
|
546
435
|
/**
|
|
547
436
|
* @param {Object} arg - Arg object.
|
|
548
437
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
549
438
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
439
|
+
* @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
|
|
550
440
|
* @summary: Get the stock of a product
|
|
551
441
|
* @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
442
|
*/
|
|
553
443
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
|
|
554
444
|
timestamp: string;
|
|
555
445
|
pageSize?: number;
|
|
556
|
-
}): Paginator
|
|
557
|
-
/**
|
|
558
|
-
* @param {
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
* @returns {Promise<ProductVariantsResponse>} -
|
|
446
|
+
}): Paginator<CatalogApplicationModel.ProductStockPolling>;
|
|
447
|
+
/**
|
|
448
|
+
* @param {CatalogApplicationValidator.GetProductVariantsBySlugParam} arg -
|
|
449
|
+
* Arg object.
|
|
450
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
452
|
+
* @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
|
|
453
|
+
* Success response
|
|
454
|
+
* @name getProductVariantsBySlug
|
|
563
455
|
* @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.
|
|
456
|
+
* @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
457
|
*/
|
|
566
|
-
getProductVariantsBySlug({ slug }?: {
|
|
567
|
-
slug: string;
|
|
568
|
-
}): Promise<ProductVariantsResponse>;
|
|
458
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponse>;
|
|
569
459
|
/**
|
|
570
|
-
* @param {
|
|
571
|
-
* @param {
|
|
572
|
-
*
|
|
573
|
-
* @
|
|
574
|
-
*
|
|
575
|
-
*
|
|
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
|
|
460
|
+
* @param {CatalogApplicationValidator.GetProductsParam} arg - Arg object.
|
|
461
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
462
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
463
|
+
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
464
|
+
* Success response
|
|
465
|
+
* @name getProducts
|
|
588
466
|
* @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.
|
|
467
|
+
* @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
468
|
*/
|
|
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>;
|
|
469
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
601
470
|
/**
|
|
602
471
|
* @param {Object} arg - Arg object.
|
|
603
472
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -612,6 +481,7 @@ declare class Catalog {
|
|
|
612
481
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
613
482
|
* either ascending or descending order. See the supported values below.
|
|
614
483
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
484
|
+
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
615
485
|
* @summary: Get all the products
|
|
616
486
|
* @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
487
|
*/
|
|
@@ -621,58 +491,40 @@ declare class Catalog {
|
|
|
621
491
|
filters?: boolean;
|
|
622
492
|
sortOn?: string;
|
|
623
493
|
pageSize?: number;
|
|
624
|
-
}): Paginator
|
|
494
|
+
}): Paginator<CatalogApplicationModel.ProductListingResponse>;
|
|
625
495
|
/**
|
|
626
|
-
* @param {
|
|
627
|
-
* @param {
|
|
628
|
-
*
|
|
629
|
-
*
|
|
630
|
-
*
|
|
631
|
-
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
496
|
+
* @param {CatalogApplicationValidator.GetSearchResultsParam} arg - Arg object.
|
|
497
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
498
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
499
|
+
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
|
|
500
|
+
* @name getSearchResults
|
|
632
501
|
* @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.
|
|
634
|
-
*/
|
|
635
|
-
getSearchResults({ q }?: {
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
*
|
|
640
|
-
* @param {
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
502
|
+
* @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/).
|
|
503
|
+
*/
|
|
504
|
+
getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.AutoCompleteResponse>;
|
|
505
|
+
/**
|
|
506
|
+
* @param {CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam} arg
|
|
507
|
+
* - Arg object.
|
|
508
|
+
*
|
|
509
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
510
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
511
|
+
* @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
|
|
512
|
+
* Success response
|
|
513
|
+
* @name getSimilarComparisonProductBySlug
|
|
644
514
|
* @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.
|
|
515
|
+
* @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
516
|
*/
|
|
647
|
-
getSimilarComparisonProductBySlug({ slug }?: {
|
|
648
|
-
slug: string;
|
|
649
|
-
}): Promise<ProductCompareResponse>;
|
|
517
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductCompareResponse>;
|
|
650
518
|
/**
|
|
651
|
-
* @param {
|
|
652
|
-
* @param {
|
|
653
|
-
*
|
|
654
|
-
* @
|
|
655
|
-
* @
|
|
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
|
|
519
|
+
* @param {CatalogApplicationValidator.GetStoresParam} arg - Arg object.
|
|
520
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
521
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
522
|
+
* @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
|
|
523
|
+
* @name getStores
|
|
664
524
|
* @summary: Get store meta information.
|
|
665
|
-
* @description: Use this API to get a list of stores in a specific application.
|
|
525
|
+
* @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
526
|
*/
|
|
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>;
|
|
527
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponse>;
|
|
676
528
|
/**
|
|
677
529
|
* @param {Object} arg - Arg object.
|
|
678
530
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -684,6 +536,7 @@ declare class Catalog {
|
|
|
684
536
|
* wants to retreive the nearest stores, e.g. 72.8691788
|
|
685
537
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
686
538
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
539
|
+
* @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
|
|
687
540
|
* @summary: Get store meta information.
|
|
688
541
|
* @description: Use this API to get a list of stores in a specific application.
|
|
689
542
|
*/
|
|
@@ -694,19 +547,18 @@ declare class Catalog {
|
|
|
694
547
|
range?: number;
|
|
695
548
|
latitude?: number;
|
|
696
549
|
longitude?: number;
|
|
697
|
-
}): Paginator
|
|
550
|
+
}): Paginator<CatalogApplicationModel.StoreListingResponse>;
|
|
698
551
|
/**
|
|
699
|
-
* @param {
|
|
700
|
-
* @param {
|
|
701
|
-
*
|
|
702
|
-
* @
|
|
703
|
-
* @
|
|
552
|
+
* @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
|
|
553
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
554
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
555
|
+
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
556
|
+
* @name unfollowById
|
|
704
557
|
* @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_.
|
|
558
|
+
* @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
559
|
*/
|
|
707
|
-
unfollowById({ collectionType, collectionId }?: {
|
|
708
|
-
collectionType: string;
|
|
709
|
-
collectionId: string;
|
|
710
|
-
}): Promise<FollowPostResponse>;
|
|
560
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
711
561
|
}
|
|
562
|
+
import CatalogApplicationValidator = require("./CatalogApplicationValidator");
|
|
563
|
+
import CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
712
564
|
import Paginator = require("../../common/Paginator");
|