@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
|
@@ -3,990 +3,816 @@ declare class Catalog {
|
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
|
-
* @param {
|
|
7
|
-
* @param {
|
|
8
|
-
* @param {
|
|
9
|
-
* @
|
|
10
|
-
* @
|
|
6
|
+
* @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
|
|
7
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
10
|
+
* @name addInventory
|
|
11
11
|
* @summary: Add Inventory for particular size and store.
|
|
12
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
12
|
+
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
|
|
13
13
|
*/
|
|
14
|
-
addInventory({ itemId, size, body }?: {
|
|
15
|
-
itemId: number;
|
|
16
|
-
size: string;
|
|
17
|
-
body: InventoryRequest;
|
|
18
|
-
}): Promise<SuccessResponse>;
|
|
14
|
+
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
19
15
|
/**
|
|
20
|
-
* @param {
|
|
21
|
-
* @param {
|
|
22
|
-
* @
|
|
16
|
+
* @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
+
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
20
|
+
* @name allSizes
|
|
23
21
|
* @summary: All Sizes for a given Product
|
|
24
|
-
* @description: This API allows to get All Sizes for a given Product.
|
|
22
|
+
* @description: This API allows to get All Sizes for a given Product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
|
|
25
23
|
*/
|
|
26
|
-
allSizes({ itemId }?: {
|
|
27
|
-
itemId: number;
|
|
28
|
-
}): Promise<GetAllSizes>;
|
|
24
|
+
allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
|
|
29
25
|
/**
|
|
30
|
-
* @param {
|
|
31
|
-
* @param {
|
|
32
|
-
* @
|
|
26
|
+
* @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
|
|
27
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
+
* @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
|
|
30
|
+
* @name bulkHsnCode
|
|
33
31
|
* @summary: Bulk Create or Update Hsn Code.
|
|
34
|
-
* @description: Bulk Create or Update Hsn Code.
|
|
32
|
+
* @description: Bulk Create or Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
|
|
35
33
|
*/
|
|
36
|
-
bulkHsnCode({ body }?: {
|
|
37
|
-
body: BulkHsnUpsert;
|
|
38
|
-
}): Promise<BulkHsnResponse>;
|
|
34
|
+
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponse>;
|
|
39
35
|
/**
|
|
40
|
-
* @param {
|
|
41
|
-
* @param {
|
|
42
|
-
* @param {
|
|
43
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
36
|
+
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
40
|
+
* @name createBulkInventory
|
|
44
41
|
* @summary: Create products in bulk associated with given batch Id.
|
|
45
|
-
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
42
|
+
* @description: This API helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
|
|
46
43
|
*/
|
|
47
|
-
createBulkInventory({ batchId, body }?: {
|
|
48
|
-
batchId: string;
|
|
49
|
-
body: InventoryBulkRequest;
|
|
50
|
-
}): Promise<SuccessResponse>;
|
|
44
|
+
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
51
45
|
/**
|
|
52
|
-
* @param {
|
|
53
|
-
* @param {
|
|
54
|
-
* @
|
|
46
|
+
* @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
|
|
47
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
50
|
+
* @name createBulkInventoryJob
|
|
55
51
|
* @summary: Create a Bulk Inventory upload Job.
|
|
56
|
-
* @description: This API helps to create a bulk Inventory upload job.
|
|
52
|
+
* @description: This API helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
57
53
|
*/
|
|
58
|
-
createBulkInventoryJob({ body }?: {
|
|
59
|
-
body: BulkJob;
|
|
60
|
-
}): Promise<BulkResponse>;
|
|
54
|
+
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
61
55
|
/**
|
|
62
|
-
* @param {
|
|
63
|
-
* @param {
|
|
64
|
-
* @
|
|
56
|
+
* @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
|
|
57
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
60
|
+
* @name createBulkProductUploadJob
|
|
65
61
|
* @summary: Create a Bulk product to upload job.
|
|
66
|
-
* @description: This API helps to create a bulk products upload job.
|
|
62
|
+
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
|
|
67
63
|
*/
|
|
68
|
-
createBulkProductUploadJob({ body }?: {
|
|
69
|
-
body: BulkJob;
|
|
70
|
-
}): Promise<BulkResponse>;
|
|
64
|
+
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
71
65
|
/**
|
|
72
|
-
* @param {
|
|
73
|
-
* @param {
|
|
74
|
-
* @
|
|
66
|
+
* @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
|
|
67
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
+
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
70
|
+
* @name createCategories
|
|
75
71
|
* @summary: Create product categories
|
|
76
|
-
* @description: This API lets user create product categories
|
|
72
|
+
* @description: This API lets user create product categories - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
77
73
|
*/
|
|
78
|
-
createCategories({ body }?: {
|
|
79
|
-
body: CategoryRequestBody;
|
|
80
|
-
}): Promise<CategoryCreateResponse>;
|
|
74
|
+
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
81
75
|
/**
|
|
82
|
-
* @param {
|
|
83
|
-
* @param {
|
|
84
|
-
* @
|
|
76
|
+
* @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
|
|
77
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
78
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
80
|
+
* Success response
|
|
81
|
+
* @name createDepartments
|
|
85
82
|
* @summary: Create the department.
|
|
86
|
-
* @description: Create departments using the API.
|
|
83
|
+
* @description: Create departments using the API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
87
84
|
*/
|
|
88
|
-
createDepartments({ body }?: {
|
|
89
|
-
body: DepartmentCreateUpdate;
|
|
90
|
-
}): Promise<DepartmentCreateResponse>;
|
|
85
|
+
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
91
86
|
/**
|
|
92
|
-
* @param {
|
|
93
|
-
* @param {
|
|
94
|
-
* @
|
|
87
|
+
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
88
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
89
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
91
|
+
* @name createInventoryExport
|
|
95
92
|
* @summary: Create an inventory export job.
|
|
96
|
-
* @description: This API helps to create a Inventory export job.
|
|
93
|
+
* @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
97
94
|
*/
|
|
98
|
-
createInventoryExport({ body }?: {
|
|
99
|
-
body: InventoryCreateRequest;
|
|
100
|
-
}): Promise<InventoryExportResponse>;
|
|
95
|
+
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
101
96
|
/**
|
|
102
|
-
* @param {
|
|
103
|
-
* @param {
|
|
104
|
-
* @
|
|
97
|
+
* @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
101
|
+
* @name createInventoryExportJob
|
|
105
102
|
* @summary: Create a Inventory export Job.
|
|
106
|
-
* @description: This API helps to create a Inventory export job.
|
|
103
|
+
* @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
107
104
|
*/
|
|
108
|
-
createInventoryExportJob({ body }?: {
|
|
109
|
-
body: InventoryExportRequest;
|
|
110
|
-
}): Promise<InventoryExportResponse>;
|
|
105
|
+
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
111
106
|
/**
|
|
112
|
-
* @param {
|
|
113
|
-
* @param {
|
|
114
|
-
*
|
|
115
|
-
* @
|
|
116
|
-
* @
|
|
107
|
+
* @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
|
|
108
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
|
+
* @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
|
|
111
|
+
* @name createMarketplaceOptin
|
|
117
112
|
* @summary: Create/Update opt-in infomation.
|
|
118
|
-
* @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema`
|
|
113
|
+
* @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
|
|
119
114
|
*/
|
|
120
|
-
createMarketplaceOptin({ marketplace, body }?: {
|
|
121
|
-
marketplace: string;
|
|
122
|
-
body: OptInPostRequest;
|
|
123
|
-
}): Promise<UpdatedResponse>;
|
|
115
|
+
createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
|
|
124
116
|
/**
|
|
125
|
-
* @param {
|
|
126
|
-
* @param {
|
|
127
|
-
* @
|
|
117
|
+
* @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
|
|
118
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
119
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
121
|
+
* @name createProduct
|
|
128
122
|
* @summary: Create a product.
|
|
129
|
-
* @description: This API allows to create product.
|
|
123
|
+
* @description: This API allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
|
|
130
124
|
*/
|
|
131
|
-
createProduct({ body }?: {
|
|
132
|
-
body: ProductCreateUpdateSchemaV2;
|
|
133
|
-
}): Promise<SuccessResponse>;
|
|
125
|
+
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
134
126
|
/**
|
|
135
|
-
* @param {
|
|
136
|
-
* @param {
|
|
137
|
-
* @
|
|
127
|
+
* @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
|
|
128
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
129
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
131
|
+
* @name createProductAssetsInBulk
|
|
138
132
|
* @summary: Create a Bulk asset upload Job.
|
|
139
|
-
* @description: This API helps to create a bulk asset upload job.
|
|
133
|
+
* @description: This API helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
140
134
|
*/
|
|
141
|
-
createProductAssetsInBulk({ body }?: {
|
|
142
|
-
body: ProductBulkAssets;
|
|
143
|
-
}): Promise<SuccessResponse>;
|
|
135
|
+
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
144
136
|
/**
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
147
|
-
* @
|
|
137
|
+
* @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
|
|
138
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
139
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
140
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
141
|
+
* - Success response
|
|
142
|
+
*
|
|
143
|
+
* @name createProductBundle
|
|
148
144
|
* @summary: Create Product Bundle
|
|
149
|
-
* @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id
|
|
145
|
+
* @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
150
146
|
*/
|
|
151
|
-
createProductBundle({ body }?: {
|
|
152
|
-
body: ProductBundleRequest;
|
|
153
|
-
}): Promise<GetProductBundleCreateResponse>;
|
|
147
|
+
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
154
148
|
/**
|
|
155
|
-
* @param {
|
|
156
|
-
* @param {
|
|
157
|
-
* @
|
|
149
|
+
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
150
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
151
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
152
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
153
|
+
* Success response
|
|
154
|
+
* @name createProductExportJob
|
|
158
155
|
* @summary: Create a product export job.
|
|
159
|
-
* @description: This API helps to create a Inventory export job.
|
|
156
|
+
* @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
160
157
|
*/
|
|
161
|
-
createProductExportJob({ body }?: {
|
|
162
|
-
body: ProductTemplateDownloadsExport;
|
|
163
|
-
}): Promise<ProductDownloadsResponse>;
|
|
158
|
+
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
164
159
|
/**
|
|
165
|
-
* @param {
|
|
166
|
-
* @param {
|
|
167
|
-
* @param {
|
|
168
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
160
|
+
* @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
|
|
161
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
164
|
+
* @name createProductsInBulk
|
|
169
165
|
* @summary: Create products in bulk associated with given batch Id.
|
|
170
|
-
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
166
|
+
* @description: This API helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
|
|
171
167
|
*/
|
|
172
|
-
createProductsInBulk({ batchId, body }?: {
|
|
173
|
-
batchId: string;
|
|
174
|
-
body: BulkProductRequest;
|
|
175
|
-
}): Promise<SuccessResponse>;
|
|
168
|
+
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
176
169
|
/**
|
|
177
|
-
* @param {
|
|
178
|
-
* @param {
|
|
179
|
-
* @
|
|
170
|
+
* @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
|
|
171
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
174
|
+
* @name createSizeGuide
|
|
180
175
|
* @summary: Create a size guide.
|
|
181
|
-
* @description: This API allows to create a size guide associated to a brand.
|
|
176
|
+
* @description: This API allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
182
177
|
*/
|
|
183
|
-
createSizeGuide({ body }?: {
|
|
184
|
-
body: ValidateSizeGuide;
|
|
185
|
-
}): Promise<SuccessResponse>;
|
|
178
|
+
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
186
179
|
/**
|
|
187
|
-
* @param {
|
|
188
|
-
* @param {
|
|
189
|
-
* @
|
|
180
|
+
* @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
|
|
181
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
182
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
184
|
+
* @name deleteBulkInventoryJob
|
|
190
185
|
* @summary: Delete Bulk Inventory job.
|
|
191
|
-
* @description: This API allows to delete bulk Inventory job associated with company.
|
|
192
|
-
*/
|
|
193
|
-
deleteBulkInventoryJob({ batchId }?: {
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
* @param {
|
|
198
|
-
* @
|
|
199
|
-
* @
|
|
200
|
-
* to be deleted.
|
|
201
|
-
* @param {number} arg.locationId - Location ID of store of which inventory
|
|
202
|
-
* is to be deleted.
|
|
203
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
186
|
+
* @description: This API allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
187
|
+
*/
|
|
188
|
+
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
189
|
+
/**
|
|
190
|
+
* @param {CatalogPlatformValidator.DeleteInventoryParam} arg - Arg object
|
|
191
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
192
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
193
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
194
|
+
* @name deleteInventory
|
|
204
195
|
* @summary: Delete a Inventory.
|
|
205
|
-
* @description: This API allows to delete inventory of a particular product for particular company.
|
|
196
|
+
* @description: This API allows to delete inventory of a particular product for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteInventory/).
|
|
206
197
|
*/
|
|
207
|
-
deleteInventory({ size, itemId, locationId }?: {
|
|
208
|
-
size: string;
|
|
209
|
-
itemId: number;
|
|
210
|
-
locationId: number;
|
|
211
|
-
}): Promise<SuccessResponse>;
|
|
198
|
+
deleteInventory({ size, itemId, locationId, requestHeaders }?: CatalogPlatformValidator.DeleteInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
212
199
|
/**
|
|
213
|
-
* @param {
|
|
214
|
-
* @param {
|
|
215
|
-
* @
|
|
200
|
+
* @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
|
|
201
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
204
|
+
* @name deleteProduct
|
|
216
205
|
* @summary: Delete a product.
|
|
217
|
-
* @description: This API allows to delete product.
|
|
206
|
+
* @description: This API allows to delete product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
218
207
|
*/
|
|
219
|
-
deleteProduct({ itemId }?: {
|
|
220
|
-
itemId: number;
|
|
221
|
-
}): Promise<SuccessResponse>;
|
|
208
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
222
209
|
/**
|
|
223
|
-
* @param {
|
|
224
|
-
* @param {
|
|
225
|
-
* @
|
|
210
|
+
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
211
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
212
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
213
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
214
|
+
* @name deleteProductBulkJob
|
|
226
215
|
* @summary: Delete Bulk product job.
|
|
227
|
-
* @description: This API allows to delete bulk product job associated with company.
|
|
228
|
-
*/
|
|
229
|
-
deleteProductBulkJob({ batchId }?: {
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
* @param {
|
|
234
|
-
* @
|
|
235
|
-
* @
|
|
236
|
-
* or Primary Identifier) of which inventory is to get.
|
|
237
|
-
* @param {InventoryRequestSchemaV2} arg.body
|
|
238
|
-
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
216
|
+
* @description: This API allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
217
|
+
*/
|
|
218
|
+
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
219
|
+
/**
|
|
220
|
+
* @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
|
|
221
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
222
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
223
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
224
|
+
* @name deleteRealtimeInventory
|
|
239
225
|
* @summary: Add Inventory for particular size and store.
|
|
240
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
241
|
-
*/
|
|
242
|
-
deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
*
|
|
249
|
-
* @
|
|
250
|
-
* to be deleted.
|
|
251
|
-
* @param {string} arg.size - Size to be deleted.
|
|
252
|
-
* @returns {Promise<ProductSizeDeleteResponse>} - Success response
|
|
226
|
+
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
227
|
+
*/
|
|
228
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
229
|
+
/**
|
|
230
|
+
* @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
|
|
231
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
232
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
233
|
+
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
|
|
234
|
+
* Success response
|
|
235
|
+
* @name deleteSize
|
|
253
236
|
* @summary: Delete a Size associated with product.
|
|
254
|
-
* @description: This API allows to delete size associated with product.
|
|
237
|
+
* @description: This API allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
255
238
|
*/
|
|
256
|
-
deleteSize({ itemId, size }?: {
|
|
257
|
-
itemId: number;
|
|
258
|
-
size: string;
|
|
259
|
-
}): Promise<ProductSizeDeleteResponse>;
|
|
239
|
+
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
|
|
260
240
|
/**
|
|
261
|
-
* @param {
|
|
262
|
-
*
|
|
241
|
+
* @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
|
|
242
|
+
* - Arg object
|
|
243
|
+
*
|
|
244
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
245
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
263
246
|
* @returns {Promise<string>} - Success response
|
|
247
|
+
* @name downloadInventoryTemplateView
|
|
264
248
|
* @summary: Download Product Template View
|
|
265
|
-
* @description: Allows you to download product template data
|
|
249
|
+
* @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
266
250
|
*/
|
|
267
|
-
downloadInventoryTemplateView({ itemType }?: {
|
|
268
|
-
itemType: string;
|
|
269
|
-
}): Promise<string>;
|
|
251
|
+
downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
270
252
|
/**
|
|
271
|
-
* @param {
|
|
272
|
-
*
|
|
273
|
-
*
|
|
253
|
+
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
254
|
+
* - Arg object
|
|
255
|
+
*
|
|
256
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
274
258
|
* @returns {Promise<string>} - Success response
|
|
259
|
+
* @name downloadProductTemplateViews
|
|
275
260
|
* @summary: Download Product Template View
|
|
276
|
-
* @description: Allows you to download product template data
|
|
261
|
+
* @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
277
262
|
*/
|
|
278
|
-
downloadProductTemplateViews({ slug }?: {
|
|
279
|
-
slug: string;
|
|
280
|
-
}): Promise<string>;
|
|
263
|
+
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
281
264
|
/**
|
|
282
|
-
* @param {
|
|
283
|
-
* @param {
|
|
284
|
-
* @param {
|
|
285
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
265
|
+
* @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
|
|
266
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
267
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
268
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
269
|
+
* @name editProduct
|
|
286
270
|
* @summary: Edit a product.
|
|
287
|
-
* @description: This API allows to edit product.
|
|
271
|
+
* @description: This API allows to edit product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
|
|
288
272
|
*/
|
|
289
|
-
editProduct({ itemId, body }?: {
|
|
290
|
-
itemId: number;
|
|
291
|
-
body: ProductCreateUpdateSchemaV2;
|
|
292
|
-
}): Promise<SuccessResponse>;
|
|
273
|
+
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
293
274
|
/**
|
|
294
|
-
* @param {
|
|
295
|
-
* @param {
|
|
296
|
-
*
|
|
297
|
-
* @returns {Promise<InventoryConfig>} - Success response
|
|
275
|
+
* @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
|
|
276
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
277
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
278
|
+
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
279
|
+
* @name exportInventoryConfig
|
|
298
280
|
* @summary: Get List of different filters for inventory export
|
|
299
|
-
* @description: This API allows get List of different filters like brand, store, and type for inventory export.
|
|
300
|
-
*/
|
|
301
|
-
exportInventoryConfig({ filterType }?: {
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
* @param {
|
|
306
|
-
* @
|
|
307
|
-
*
|
|
308
|
-
*
|
|
309
|
-
* @
|
|
310
|
-
* @returns {Promise<HsnCodesListingResponseSchemaV2>} - Success response
|
|
281
|
+
* @description: This API allows get List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportInventoryConfig/).
|
|
282
|
+
*/
|
|
283
|
+
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
284
|
+
/**
|
|
285
|
+
* @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
|
|
286
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
287
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
288
|
+
* @returns {Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>}
|
|
289
|
+
* - Success response
|
|
290
|
+
*
|
|
291
|
+
* @name getAllProductHsnCodes
|
|
311
292
|
* @summary: Hsn Code List.
|
|
312
|
-
* @description: Hsn Code List.
|
|
313
|
-
*/
|
|
314
|
-
getAllProductHsnCodes({ pageNo, pageSize, q, type }?: {
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
* @param {Object} arg - Arg object.
|
|
322
|
-
* @param {string} arg.uid - Category unique id
|
|
323
|
-
* @returns {Promise<SingleCategoryResponse>} - Success response
|
|
293
|
+
* @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
294
|
+
*/
|
|
295
|
+
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
296
|
+
/**
|
|
297
|
+
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
298
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
299
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
300
|
+
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
|
|
301
|
+
* @name getCategoryData
|
|
324
302
|
* @summary: Get product category by uid
|
|
325
|
-
* @description: This API gets meta associated to product categories.
|
|
326
|
-
*/
|
|
327
|
-
getCategoryData({ uid }?: {
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
* @param {
|
|
332
|
-
* @
|
|
333
|
-
*
|
|
334
|
-
* @
|
|
335
|
-
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
336
|
-
* the page for the company id.
|
|
337
|
-
* @param {string} [arg.marketplace] - The marketplace platform associated
|
|
338
|
-
* with the company id.
|
|
339
|
-
* @returns {Promise<OptinCompanyBrandDetailsView>} - Success response
|
|
303
|
+
* @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
304
|
+
*/
|
|
305
|
+
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
|
|
306
|
+
/**
|
|
307
|
+
* @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
|
|
308
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
309
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
310
|
+
* @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
|
|
311
|
+
* Success response
|
|
312
|
+
* @name getCompanyBrandDetail
|
|
340
313
|
* @summary: Get the Company Brand details of Optin.
|
|
341
|
-
* @description: Get the details of the Brands associated with the given company_id passed.
|
|
342
|
-
*/
|
|
343
|
-
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, }?: {
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
/**
|
|
351
|
-
* @param {Object} arg - Arg object.
|
|
352
|
-
* @returns {Promise<OptinCompanyDetail>} - Success response
|
|
314
|
+
* @description: Get the details of the Brands associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
|
|
315
|
+
*/
|
|
316
|
+
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
317
|
+
/**
|
|
318
|
+
* @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
|
|
319
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
320
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
321
|
+
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
322
|
+
* @name getCompanyDetail
|
|
353
323
|
* @summary: Get the Company details.
|
|
354
|
-
* @description: Get the details of the company associated with the given company_id passed.
|
|
324
|
+
* @description: Get the details of the company associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
|
|
355
325
|
*/
|
|
356
|
-
getCompanyDetail({}?: any): Promise<OptinCompanyDetail>;
|
|
326
|
+
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
357
327
|
/**
|
|
358
|
-
* @param {
|
|
359
|
-
* @
|
|
328
|
+
* @param {CatalogPlatformValidator.GetCompanyMetricsParam} arg - Arg object
|
|
329
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
331
|
+
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
332
|
+
* @name getCompanyMetrics
|
|
360
333
|
* @summary: Get the Company metrics
|
|
361
|
-
* @description: Get the Company metrics associated with the company ID passed.
|
|
334
|
+
* @description: Get the Company metrics associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
|
|
362
335
|
*/
|
|
363
|
-
getCompanyMetrics({}?: any): Promise<OptinCompanyMetrics>;
|
|
336
|
+
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
364
337
|
/**
|
|
365
|
-
* @param {
|
|
366
|
-
* @param {
|
|
367
|
-
* @
|
|
338
|
+
* @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
|
|
339
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
340
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
341
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
342
|
+
* @name getDepartmentData
|
|
368
343
|
* @summary: Get specific departments details by passing in unique id of the department.
|
|
369
|
-
* @description: Allows you to get department data, by uid.
|
|
344
|
+
* @description: Allows you to get department data, by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
370
345
|
*/
|
|
371
|
-
getDepartmentData({ uid }?: {
|
|
372
|
-
uid: string;
|
|
373
|
-
}): Promise<DepartmentsResponse>;
|
|
346
|
+
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
374
347
|
/**
|
|
375
|
-
* @param {
|
|
376
|
-
* @param {
|
|
377
|
-
*
|
|
378
|
-
* @returns {Promise<GenderDetail>} - Success response
|
|
348
|
+
* @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
|
|
349
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
350
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
351
|
+
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
352
|
+
* @name getGenderAttribute
|
|
379
353
|
* @summary: Get gender attribute details
|
|
380
|
-
* @description: This API allows to view the gender attribute details.
|
|
354
|
+
* @description: This API allows to view the gender attribute details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
381
355
|
*/
|
|
382
|
-
getGenderAttribute({ attributeSlug }?: {
|
|
383
|
-
attributeSlug: string;
|
|
384
|
-
}): Promise<GenderDetail>;
|
|
356
|
+
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
385
357
|
/**
|
|
386
|
-
* @param {
|
|
387
|
-
* @param {
|
|
388
|
-
* @
|
|
358
|
+
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
359
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
360
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
361
|
+
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
362
|
+
* @name getHsnCode
|
|
389
363
|
* @summary: Fetch Hsn Code.
|
|
390
|
-
* @description: Fetch Hsn Code.
|
|
391
|
-
*/
|
|
392
|
-
getHsnCode({ id }?: {
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
* @param {
|
|
397
|
-
* @
|
|
398
|
-
* @
|
|
399
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
400
|
-
* given set of results
|
|
401
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
402
|
-
* page. Default is 12.
|
|
403
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
404
|
-
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
405
|
-
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
406
|
-
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
407
|
-
* or Primary Identifier) of which inventory is to get.
|
|
408
|
-
* @returns {Promise<GetInventoriesResponse>} - Success response
|
|
364
|
+
* @description: Fetch Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
|
|
365
|
+
*/
|
|
366
|
+
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
367
|
+
/**
|
|
368
|
+
* @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
|
|
369
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
370
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
371
|
+
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
|
|
372
|
+
* @name getInventories
|
|
409
373
|
* @summary: Get Inventory for company
|
|
410
|
-
* @description: This API allows get Inventories data for particular company.
|
|
411
|
-
*/
|
|
412
|
-
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
}): Promise<GetInventoriesResponse>;
|
|
422
|
-
/**
|
|
423
|
-
* @param {Object} arg - Arg object.
|
|
424
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
425
|
-
* given set of results
|
|
426
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
427
|
-
* page. Default is 12.
|
|
428
|
-
* @returns {Promise<BulkInventoryGet>} - Success response
|
|
374
|
+
* @description: This API allows get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
375
|
+
*/
|
|
376
|
+
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
|
|
377
|
+
/**
|
|
378
|
+
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
379
|
+
* - Arg object
|
|
380
|
+
*
|
|
381
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
382
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
383
|
+
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
384
|
+
* @name getInventoryBulkUploadHistory
|
|
429
385
|
* @summary: Get a list of all bulk Inventory upload jobs.
|
|
430
|
-
* @description: This API helps to get bulk Inventory upload jobs data.
|
|
431
|
-
*/
|
|
432
|
-
getInventoryBulkUploadHistory({ pageNo, pageSize }?: {
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
* @
|
|
438
|
-
*
|
|
439
|
-
* @
|
|
440
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
441
|
-
* given set of results
|
|
442
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
443
|
-
* page. Default is 12.
|
|
444
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
445
|
-
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
446
|
-
* @returns {Promise<InventoryResponsePaginated>} - Success response
|
|
386
|
+
* @description: This API helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
387
|
+
*/
|
|
388
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
389
|
+
/**
|
|
390
|
+
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
391
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
392
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
393
|
+
* @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
|
|
394
|
+
* Success response
|
|
395
|
+
* @name getInventoryBySize
|
|
447
396
|
* @summary: Get Inventory for company
|
|
448
|
-
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
449
|
-
*/
|
|
450
|
-
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, }?: {
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
*
|
|
460
|
-
* @
|
|
461
|
-
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
462
|
-
* or Primary Identifier) of which inventory is to get.
|
|
463
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
464
|
-
* given set of results
|
|
465
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
466
|
-
* page. Default is 12.
|
|
467
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
468
|
-
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
469
|
-
* @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
|
|
397
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
|
|
398
|
+
*/
|
|
399
|
+
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
400
|
+
/**
|
|
401
|
+
* @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
|
|
402
|
+
* - Arg object
|
|
403
|
+
*
|
|
404
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
405
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
406
|
+
* @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
407
|
+
* - Success response
|
|
408
|
+
*
|
|
409
|
+
* @name getInventoryBySizeIdentifier
|
|
470
410
|
* @summary: Get Inventory for company
|
|
471
|
-
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
472
|
-
*/
|
|
473
|
-
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
}): Promise<InventorySellerIdentifierResponsePaginated>;
|
|
481
|
-
/**
|
|
482
|
-
* @param {Object} arg - Arg object.
|
|
483
|
-
* @returns {Promise<InventoryExportJob>} - Success response
|
|
411
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
412
|
+
*/
|
|
413
|
+
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
414
|
+
/**
|
|
415
|
+
* @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
|
|
416
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
417
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
418
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
419
|
+
* @name getInventoryExport
|
|
484
420
|
* @summary: Get Inventory export history.
|
|
485
|
-
* @description: This API helps to get Inventory export history.
|
|
421
|
+
* @description: This API helps to get Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
|
|
486
422
|
*/
|
|
487
|
-
getInventoryExport({}?: any): Promise<InventoryExportJob>;
|
|
423
|
+
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
488
424
|
/**
|
|
489
|
-
* @param {
|
|
490
|
-
* @
|
|
425
|
+
* @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object
|
|
426
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
427
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
428
|
+
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
429
|
+
* @name getMarketplaceOptinDetail
|
|
491
430
|
* @summary: Get opt-in infomation.
|
|
492
|
-
* @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema`
|
|
431
|
+
* @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
493
432
|
*/
|
|
494
|
-
getMarketplaceOptinDetail({}?: any): Promise<GetOptInPlatform>;
|
|
433
|
+
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
495
434
|
/**
|
|
496
|
-
* @param {
|
|
497
|
-
* @param {
|
|
498
|
-
* @
|
|
435
|
+
* @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
436
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
437
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
438
|
+
* @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
|
|
439
|
+
* @name getOptimalLocations
|
|
499
440
|
* @summary: Location Reassignment
|
|
500
|
-
* @description:
|
|
441
|
+
* @description: Location Reassignment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
501
442
|
*/
|
|
502
|
-
getOptimalLocations({ body }?: {
|
|
503
|
-
body: AssignStore;
|
|
504
|
-
}): Promise<StoreAssignResponse>;
|
|
443
|
+
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
|
|
505
444
|
/**
|
|
506
|
-
* @param {
|
|
507
|
-
* @param {
|
|
508
|
-
* @param {
|
|
509
|
-
* @
|
|
510
|
-
* @
|
|
445
|
+
* @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
|
|
446
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
447
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
|
+
* @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
|
|
449
|
+
* @name getProduct
|
|
511
450
|
* @summary: Get a single product.
|
|
512
|
-
* @description: This API helps to get data associated to a particular product.
|
|
513
|
-
*/
|
|
514
|
-
getProduct({ itemId, brandUid, itemCode }?: {
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
* @
|
|
521
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
522
|
-
* given set of results
|
|
523
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
524
|
-
* page. Default is 12.
|
|
525
|
-
* @returns {Promise<BulkAssetResponse>} - Success response
|
|
451
|
+
* @description: This API helps to get data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
452
|
+
*/
|
|
453
|
+
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
|
|
454
|
+
/**
|
|
455
|
+
* @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
|
|
456
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
457
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
|
+
* @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
|
|
459
|
+
* @name getProductAssetsInBulk
|
|
526
460
|
* @summary: Get a list of all bulk asset jobs.
|
|
527
|
-
* @description: This API helps to get bulk asset jobs data associated to a particular company.
|
|
528
|
-
*/
|
|
529
|
-
getProductAssetsInBulk({ pageNo, pageSize }?: {
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
* @
|
|
535
|
-
*
|
|
536
|
-
* @
|
|
537
|
-
* returns all the attributes
|
|
538
|
-
* @returns {Promise<ProductAttributesResponse>} - Success response
|
|
461
|
+
* @description: This API helps to get bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
462
|
+
*/
|
|
463
|
+
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
|
|
464
|
+
/**
|
|
465
|
+
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
466
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
467
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
468
|
+
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
|
|
469
|
+
* Success response
|
|
470
|
+
* @name getProductAttributes
|
|
539
471
|
* @summary: Get list of all the attributes by their l3_categories
|
|
540
|
-
* @description: This API allows to list all the attributes by their l3_categories.
|
|
541
|
-
*/
|
|
542
|
-
getProductAttributes({ category, filter }?: {
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
* @
|
|
548
|
-
* @
|
|
549
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
550
|
-
* given set of results
|
|
551
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
552
|
-
* page. Default is 12.
|
|
553
|
-
* @returns {Promise<ProductBulkRequestList>} - Success response
|
|
472
|
+
* @description: This API allows to list all the attributes by their l3_categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
473
|
+
*/
|
|
474
|
+
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
|
|
475
|
+
/**
|
|
476
|
+
* @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
|
|
477
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
478
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
479
|
+
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
480
|
+
* @name getProductBulkUploadHistory
|
|
554
481
|
* @summary: Get a list of all bulk product upload jobs.
|
|
555
|
-
* @description: This API helps to get bulk product upload jobs data.
|
|
556
|
-
*/
|
|
557
|
-
getProductBulkUploadHistory({ search, pageNo, pageSize }?: {
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
*
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
* @param {string[]} [arg.slug] - Slugs of bundles to be retrieved.
|
|
567
|
-
* @returns {Promise<GetProductBundleListingResponse>} - Success response
|
|
482
|
+
* @description: This API helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
483
|
+
*/
|
|
484
|
+
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
485
|
+
/**
|
|
486
|
+
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
487
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
488
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
489
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
|
|
490
|
+
* - Success response
|
|
491
|
+
*
|
|
492
|
+
* @name getProductBundle
|
|
568
493
|
* @summary: List all Product Bundles
|
|
569
|
-
* @description: Get all product bundles for a particular company
|
|
494
|
+
* @description: Get all product bundles for a particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
570
495
|
*/
|
|
571
|
-
getProductBundle({ q, slug }?: {
|
|
572
|
-
q?: string;
|
|
573
|
-
slug?: string[];
|
|
574
|
-
}): Promise<GetProductBundleListingResponse>;
|
|
496
|
+
getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
575
497
|
/**
|
|
576
|
-
* @param {
|
|
577
|
-
* @param {
|
|
578
|
-
*
|
|
579
|
-
* @returns {Promise<GetProductBundleResponse>} -
|
|
498
|
+
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
499
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
500
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
501
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
502
|
+
* Success response
|
|
503
|
+
* @name getProductBundleDetail
|
|
580
504
|
* @summary: Get a particular Product Bundle details
|
|
581
|
-
* @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
|
|
582
|
-
*/
|
|
583
|
-
getProductBundleDetail({ id }?: {
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
* @param {
|
|
588
|
-
* @
|
|
589
|
-
*
|
|
590
|
-
* @
|
|
591
|
-
* from the date specified to the current date.
|
|
592
|
-
* @param {string} [arg.toDate] - This is a parameter used to find the job
|
|
593
|
-
* from the from_date specified to the to_date.
|
|
594
|
-
* @param {string} [arg.q] - It is a query parameter to search the export
|
|
595
|
-
* job with the task ID.
|
|
596
|
-
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
505
|
+
* @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
506
|
+
*/
|
|
507
|
+
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
508
|
+
/**
|
|
509
|
+
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
510
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
511
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
512
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
513
|
+
* Success response
|
|
514
|
+
* @name getProductExportJobs
|
|
597
515
|
* @summary: Allows you to list all product templates export list details
|
|
598
|
-
* @description: Can view details including trigger data, task id , etc.
|
|
599
|
-
*/
|
|
600
|
-
getProductExportJobs({ status, fromDate, toDate, q }?: {
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
* @param {Object} arg - Arg object.
|
|
608
|
-
* @param {string} [arg.itemCode] - Item code of the product size.
|
|
609
|
-
* @param {number} arg.itemId - Item Id of the product size.
|
|
610
|
-
* @param {number} [arg.brandUid] - Brand Id of the product size.
|
|
611
|
-
* @param {number} [arg.uid] - Id of the product size.
|
|
612
|
-
* @returns {Promise<ProductListingResponse>} - Success response
|
|
516
|
+
* @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
517
|
+
*/
|
|
518
|
+
getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
519
|
+
/**
|
|
520
|
+
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
521
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
522
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
523
|
+
* @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
|
|
524
|
+
* @name getProductSize
|
|
613
525
|
* @summary: Get a single product size.
|
|
614
|
-
* @description: This API helps to get data associated to a particular product size.
|
|
526
|
+
* @description: This API helps to get data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
615
527
|
*/
|
|
616
|
-
getProductSize({ itemId, itemCode, brandUid, uid }?: {
|
|
617
|
-
itemCode?: string;
|
|
618
|
-
itemId: number;
|
|
619
|
-
brandUid?: number;
|
|
620
|
-
uid?: number;
|
|
621
|
-
}): Promise<ProductListingResponse>;
|
|
528
|
+
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
|
|
622
529
|
/**
|
|
623
|
-
* @param {
|
|
624
|
-
* @
|
|
530
|
+
* @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
|
|
531
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
532
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
533
|
+
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
|
|
534
|
+
* @name getProductTags
|
|
625
535
|
* @summary: Get a list of all tags associated with company.
|
|
626
|
-
* @description: This API helps to get tags data associated to a particular company.
|
|
536
|
+
* @description: This API helps to get tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
627
537
|
*/
|
|
628
|
-
getProductTags({}?: any): Promise<ProductTagsViewResponse>;
|
|
538
|
+
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
|
|
629
539
|
/**
|
|
630
|
-
* @param {
|
|
631
|
-
* @
|
|
540
|
+
* @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
|
|
541
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
542
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
543
|
+
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
544
|
+
* @name getProductValidation
|
|
632
545
|
* @summary: Validate product/size data
|
|
633
|
-
* @description: This API validates product data.
|
|
634
|
-
*/
|
|
635
|
-
getProductValidation({}?: any): Promise<ValidateProduct>;
|
|
636
|
-
/**
|
|
637
|
-
* @param {
|
|
638
|
-
* @param {
|
|
639
|
-
* @param {
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
* @
|
|
643
|
-
* Department Ids
|
|
644
|
-
* @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
|
|
645
|
-
* @param {string} [arg.q] - Get multiple products filtered by q string
|
|
646
|
-
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
647
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
648
|
-
* given set of results
|
|
649
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
650
|
-
* page. Default is 10.
|
|
651
|
-
* @returns {Promise<ProductListingResponseV2>} - Success response
|
|
546
|
+
* @description: This API validates product data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
|
|
547
|
+
*/
|
|
548
|
+
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
549
|
+
/**
|
|
550
|
+
* @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
|
|
551
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
552
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
553
|
+
* @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
|
|
554
|
+
* Success response
|
|
555
|
+
* @name getProducts
|
|
652
556
|
* @summary: Get product list
|
|
653
|
-
* @description: This API gets meta associated to products.
|
|
654
|
-
*/
|
|
655
|
-
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: {
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
tags?: string[];
|
|
663
|
-
pageNo?: number;
|
|
664
|
-
pageSize?: number;
|
|
665
|
-
}): Promise<ProductListingResponseV2>;
|
|
666
|
-
/**
|
|
667
|
-
* @param {Object} arg - Arg object.
|
|
668
|
-
* @param {string} arg.sellerAppId - Id of the seller application which is
|
|
669
|
-
* serving the invetory/catalog of the company
|
|
670
|
-
* @returns {Promise<CrossSellingResponse>} - Success response
|
|
557
|
+
* @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
|
|
558
|
+
*/
|
|
559
|
+
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
560
|
+
/**
|
|
561
|
+
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
562
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
563
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
|
+
* @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
|
|
565
|
+
* @name getSellerInsights
|
|
671
566
|
* @summary: Analytics data of catalog and inventory that are being cross-selled.
|
|
672
|
-
* @description: Analytics data of catalog and inventory that are being cross-selled.
|
|
567
|
+
* @description: Analytics data of catalog and inventory that are being cross-selled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
673
568
|
*/
|
|
674
|
-
getSellerInsights({ sellerAppId }?: {
|
|
675
|
-
sellerAppId: string;
|
|
676
|
-
}): Promise<CrossSellingResponse>;
|
|
569
|
+
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
|
|
677
570
|
/**
|
|
678
|
-
* @param {
|
|
679
|
-
* @param {
|
|
680
|
-
* @
|
|
571
|
+
* @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
|
|
572
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
573
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
574
|
+
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
575
|
+
* @name getSingleProductHSNCode
|
|
681
576
|
* @summary: Hsn Code List.
|
|
682
|
-
* @description: Hsn Code List.
|
|
577
|
+
* @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
683
578
|
*/
|
|
684
|
-
getSingleProductHSNCode({ reportingHsn }?: {
|
|
685
|
-
reportingHsn: string;
|
|
686
|
-
}): Promise<HSNDataInsertV2>;
|
|
579
|
+
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
687
580
|
/**
|
|
688
|
-
* @param {
|
|
689
|
-
* @param {
|
|
690
|
-
* @
|
|
581
|
+
* @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
|
|
582
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
583
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
|
+
* @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
|
|
585
|
+
* @name getSizeGuide
|
|
691
586
|
* @summary: Get a single size guide.
|
|
692
|
-
* @description: This API helps to get data associated to a size guide.
|
|
693
|
-
*/
|
|
694
|
-
getSizeGuide({ id }?: {
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
* @param {
|
|
699
|
-
* @
|
|
700
|
-
* @
|
|
701
|
-
* @param {string} [arg.tag] - To filter size guide on basis of tag.
|
|
702
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
703
|
-
* given set of results
|
|
704
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
705
|
-
* page. Default is 10.
|
|
706
|
-
* @returns {Promise<ListSizeGuide>} - Success response
|
|
587
|
+
* @description: This API helps to get data associated to a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
588
|
+
*/
|
|
589
|
+
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
|
|
590
|
+
/**
|
|
591
|
+
* @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
|
|
592
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
593
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
594
|
+
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
595
|
+
* @name getSizeGuides
|
|
707
596
|
* @summary: Get list of size guides
|
|
708
|
-
* @description: This API allows to view all the size guides associated to the seller.
|
|
709
|
-
*/
|
|
710
|
-
getSizeGuides({ active, q, tag, pageNo, pageSize }?: {
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
/**
|
|
718
|
-
* @param {Object} arg - Arg object.
|
|
719
|
-
* @param {string} [arg.q] - The search related the store for the company id.
|
|
720
|
-
* @param {number} [arg.pageNo] - The number of page for the company id.
|
|
721
|
-
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
722
|
-
* the page for the company id.
|
|
723
|
-
* @returns {Promise<OptinStoreDetails>} - Success response
|
|
597
|
+
* @description: This API allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
|
|
598
|
+
*/
|
|
599
|
+
getSizeGuides({ active, q, tag, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
600
|
+
/**
|
|
601
|
+
* @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
|
|
602
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
603
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
|
+
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
605
|
+
* @name getStoreDetail
|
|
724
606
|
* @summary: Get the Store details.
|
|
725
|
-
* @description: Get the details of the store associated with the company ID passed.
|
|
726
|
-
*/
|
|
727
|
-
getStoreDetail({ q, pageNo, pageSize }?: {
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
* @
|
|
734
|
-
* @param {number} arg.itemId - Get list of variants of item Id
|
|
735
|
-
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
736
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
737
|
-
* given set of results
|
|
738
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
739
|
-
* page. Default is 10.
|
|
740
|
-
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
607
|
+
* @description: Get the details of the store associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
|
|
608
|
+
*/
|
|
609
|
+
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
610
|
+
/**
|
|
611
|
+
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
612
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
613
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
614
|
+
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
|
|
615
|
+
* @name getVariantsOfProducts
|
|
741
616
|
* @summary: Get product list
|
|
742
|
-
* @description: This API gets meta associated to products.
|
|
743
|
-
*/
|
|
744
|
-
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize }?: {
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
* @param {Object} arg - Arg object.
|
|
752
|
-
* @param {string} [arg.level] - Get category for multiple levels
|
|
753
|
-
* @param {string} [arg.departments] - Get category for multiple departments filtered
|
|
754
|
-
* @param {string} [arg.q] - Get multiple categories filtered by search string
|
|
755
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
756
|
-
* given set of results
|
|
757
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
758
|
-
* page. Default is 10.
|
|
759
|
-
* @returns {Promise<CategoryResponse>} - Success response
|
|
617
|
+
* @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
618
|
+
*/
|
|
619
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
|
|
620
|
+
/**
|
|
621
|
+
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
622
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
623
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
624
|
+
* @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
|
|
625
|
+
* @name listCategories
|
|
760
626
|
* @summary: Get product categories list
|
|
761
|
-
* @description: This API gets meta associated to product categories.
|
|
762
|
-
*/
|
|
763
|
-
listCategories({ level, departments, q, pageNo, pageSize }?: {
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
/**
|
|
771
|
-
* @param {Object} arg - Arg object.
|
|
772
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
773
|
-
* given set of results
|
|
774
|
-
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
775
|
-
* set, standard, digital
|
|
776
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
777
|
-
* page. Default is 10.
|
|
778
|
-
* @param {string} [arg.name] - Can search departments by passing name.
|
|
779
|
-
* @param {string} [arg.search] - Can search departments by passing name of
|
|
780
|
-
* the department in search parameter.
|
|
781
|
-
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
782
|
-
* whether they are active or inactive.
|
|
783
|
-
* @returns {Promise<DepartmentsResponse>} - Success response
|
|
627
|
+
* @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
628
|
+
*/
|
|
629
|
+
listCategories({ level, departments, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
|
|
630
|
+
/**
|
|
631
|
+
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
632
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
633
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
634
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
635
|
+
* @name listDepartmentsData
|
|
784
636
|
* @summary: List all Departments.
|
|
785
|
-
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
786
|
-
*/
|
|
787
|
-
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, }?: {
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
}): Promise<DepartmentsResponse>;
|
|
795
|
-
/**
|
|
796
|
-
* @param {Object} arg - Arg object.
|
|
797
|
-
* @returns {Promise<HSNCodesResponse>} - Success response
|
|
637
|
+
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
|
|
638
|
+
*/
|
|
639
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, requestHeaders }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
640
|
+
/**
|
|
641
|
+
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
642
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
643
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
644
|
+
* @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
|
|
645
|
+
* @name listHSNCodes
|
|
798
646
|
* @summary: List HSN Codes
|
|
799
|
-
* @description: Allows you to list all hsn Codes
|
|
800
|
-
*/
|
|
801
|
-
listHSNCodes({}?: any): Promise<HSNCodesResponse>;
|
|
802
|
-
/**
|
|
803
|
-
* @param {
|
|
804
|
-
* @param {
|
|
805
|
-
* @param {
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
* @
|
|
810
|
-
* @returns {Promise<InventoryExportJobListResponse>} - Success response
|
|
647
|
+
* @description: Allows you to list all hsn Codes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
648
|
+
*/
|
|
649
|
+
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
|
|
650
|
+
/**
|
|
651
|
+
* @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
|
|
652
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
653
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
654
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
|
|
655
|
+
* - Success response
|
|
656
|
+
*
|
|
657
|
+
* @name listInventoryExport
|
|
811
658
|
* @summary: Get the history of the inventory export.
|
|
812
|
-
* @description: This API helps you the get the history of inventory jobs depending on the filtered criteria.
|
|
813
|
-
*/
|
|
814
|
-
listInventoryExport({ status, fromDate, toDate, q }?: {
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
* @param {Object} arg - Arg object.
|
|
822
|
-
* @param {string} arg.department - A `department` is the name of a
|
|
823
|
-
* particular department.
|
|
824
|
-
* @returns {Promise<TemplatesResponse>} - Success response
|
|
659
|
+
* @description: This API helps you the get the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
660
|
+
*/
|
|
661
|
+
listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
662
|
+
/**
|
|
663
|
+
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
664
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
665
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
666
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
|
|
667
|
+
* @name listProductTemplate
|
|
825
668
|
* @summary: List all Templates
|
|
826
|
-
* @description: Allows you to list all product templates, also can filter by department
|
|
827
|
-
*/
|
|
828
|
-
listProductTemplate({ department }?: {
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
*
|
|
833
|
-
* @param {
|
|
834
|
-
*
|
|
835
|
-
* @
|
|
836
|
-
*
|
|
837
|
-
*
|
|
669
|
+
* @description: Allows you to list all product templates, also can filter by department - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
670
|
+
*/
|
|
671
|
+
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
|
|
672
|
+
/**
|
|
673
|
+
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
674
|
+
* - Arg object
|
|
675
|
+
*
|
|
676
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
677
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
678
|
+
* @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
|
|
679
|
+
* - Success response
|
|
680
|
+
*
|
|
681
|
+
* @name listProductTemplateCategories
|
|
838
682
|
* @summary: List Department specifiec product categories
|
|
839
|
-
* @description: Allows you to list all product categories values for the departments specified
|
|
683
|
+
* @description: Allows you to list all product categories values for the departments specified - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
684
|
+
*/
|
|
685
|
+
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
|
|
686
|
+
/**
|
|
687
|
+
* @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
|
|
688
|
+
* - Arg object
|
|
689
|
+
*
|
|
690
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
691
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
692
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
693
|
+
* Success response
|
|
694
|
+
* @name listProductTemplateExportDetails
|
|
695
|
+
* @summary: Allows you to list all product templates export list details
|
|
696
|
+
* @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
840
697
|
*/
|
|
841
|
-
|
|
842
|
-
departments: string;
|
|
843
|
-
itemType: string;
|
|
844
|
-
}): Promise<ProdcutTemplateCategoriesResponse>;
|
|
698
|
+
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
845
699
|
/**
|
|
846
|
-
* @param {
|
|
847
|
-
* @
|
|
848
|
-
* @
|
|
849
|
-
* @
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
/**
|
|
853
|
-
* @param {Object} arg - Arg object.
|
|
854
|
-
* @param {string} arg.filter - A `filter` is the unique identifier of the
|
|
855
|
-
* type of value required.
|
|
856
|
-
* @param {string} [arg.templateTag] - A `template_tag` is the identifier of
|
|
857
|
-
* the type of template required.
|
|
858
|
-
* @param {string} [arg.itemType] - A `item_type` is the identifier of the
|
|
859
|
-
* type of template required.
|
|
860
|
-
* @returns {Promise<ProductConfigurationDownloads>} - Success response
|
|
700
|
+
* @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
|
|
701
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
702
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
703
|
+
* @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
|
|
704
|
+
* Success response
|
|
705
|
+
* @name listTemplateBrandTypeValues
|
|
861
706
|
* @summary: Allows you to list all values for Templates, Brands or Type
|
|
862
|
-
* @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
|
|
863
|
-
*/
|
|
864
|
-
listTemplateBrandTypeValues({ filter, templateTag, itemType }?: {
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
* @
|
|
871
|
-
* @param {string} arg.uid - Category unique id
|
|
872
|
-
* @param {CategoryRequestBody} arg.body
|
|
873
|
-
* @returns {Promise<CategoryUpdateResponse>} - Success response
|
|
707
|
+
* @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
708
|
+
*/
|
|
709
|
+
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
710
|
+
/**
|
|
711
|
+
* @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
|
|
712
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
713
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
714
|
+
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
715
|
+
* @name updateCategory
|
|
874
716
|
* @summary: Update product categories
|
|
875
|
-
* @description: Update a product category using this api
|
|
717
|
+
* @description: Update a product category using this api - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
876
718
|
*/
|
|
877
|
-
updateCategory({ uid, body }?: {
|
|
878
|
-
uid: string;
|
|
879
|
-
body: CategoryRequestBody;
|
|
880
|
-
}): Promise<CategoryUpdateResponse>;
|
|
719
|
+
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
881
720
|
/**
|
|
882
|
-
* @param {
|
|
883
|
-
* @param {
|
|
884
|
-
* @param {
|
|
885
|
-
* @returns {Promise<DepartmentModel>} - Success response
|
|
721
|
+
* @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
|
|
722
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
723
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
724
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
725
|
+
* @name updateDepartment
|
|
886
726
|
* @summary: Update the department by their uid.
|
|
887
|
-
* @description: Update the department by their uid using this API.
|
|
727
|
+
* @description: Update the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
888
728
|
*/
|
|
889
|
-
updateDepartment({ uid, body }?: {
|
|
890
|
-
uid: string;
|
|
891
|
-
body: DepartmentCreateUpdate;
|
|
892
|
-
}): Promise<DepartmentModel>;
|
|
729
|
+
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
893
730
|
/**
|
|
894
|
-
* @param {
|
|
895
|
-
* @param {
|
|
896
|
-
* @param {
|
|
897
|
-
* @returns {Promise<HsnCode>} - Success response
|
|
731
|
+
* @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
|
|
732
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
733
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
734
|
+
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
735
|
+
* @name updateHsnCode
|
|
898
736
|
* @summary: Update Hsn Code.
|
|
899
|
-
* @description: Update Hsn Code.
|
|
737
|
+
* @description: Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
|
|
900
738
|
*/
|
|
901
|
-
updateHsnCode({ id, body }?: {
|
|
902
|
-
id: string;
|
|
903
|
-
body: HsnUpsert;
|
|
904
|
-
}): Promise<HsnCode>;
|
|
739
|
+
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
905
740
|
/**
|
|
906
|
-
* @param {
|
|
907
|
-
* @param {
|
|
908
|
-
* @
|
|
741
|
+
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
742
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
743
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
744
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
745
|
+
* @name updateInventories
|
|
909
746
|
* @summary: Add Inventory for particular size and store.
|
|
910
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
747
|
+
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
911
748
|
*/
|
|
912
|
-
updateInventories({ body }?: {
|
|
913
|
-
body: InventoryRequestSchemaV2;
|
|
914
|
-
}): Promise<InventoryUpdateResponse>;
|
|
749
|
+
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
915
750
|
/**
|
|
916
|
-
* @param {
|
|
917
|
-
* @param {
|
|
918
|
-
*
|
|
919
|
-
* @
|
|
920
|
-
*
|
|
751
|
+
* @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
|
|
752
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
753
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
754
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
755
|
+
* - Success response
|
|
756
|
+
*
|
|
757
|
+
* @name updateProductBundle
|
|
921
758
|
* @summary: Update a Product Bundle
|
|
922
|
-
* @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
|
|
923
|
-
*/
|
|
924
|
-
updateProductBundle({ id, body }?: {
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
* @
|
|
930
|
-
* @
|
|
931
|
-
* @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
|
|
932
|
-
* or Primary Identifier) of which inventory is to get.
|
|
933
|
-
* @param {InventoryRequestSchemaV2} arg.body
|
|
934
|
-
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
759
|
+
* @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
760
|
+
*/
|
|
761
|
+
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
762
|
+
/**
|
|
763
|
+
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
764
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
765
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
766
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
767
|
+
* @name updateRealtimeInventory
|
|
935
768
|
* @summary: Add Inventory for particular size and store.
|
|
936
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
937
|
-
*/
|
|
938
|
-
updateRealtimeInventory({ itemId, sellerIdentifier, body }?: {
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
* @
|
|
945
|
-
* @param {string} arg.id - Mongo id of the size guide to be edited
|
|
946
|
-
* @param {ValidateSizeGuide} arg.body
|
|
947
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
769
|
+
* @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
770
|
+
*/
|
|
771
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
772
|
+
/**
|
|
773
|
+
* @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
|
|
774
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
775
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
776
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
777
|
+
* @name updateSizeGuide
|
|
948
778
|
* @summary: Edit a size guide.
|
|
949
|
-
* @description: This API allows to edit a size guide.
|
|
950
|
-
*/
|
|
951
|
-
updateSizeGuide({ id, body }?: {
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
* @
|
|
957
|
-
* @
|
|
958
|
-
* @param {string} arg.productType - Product type of the product to be
|
|
959
|
-
* uploaded i.e. set, standard , digital.
|
|
960
|
-
* @param {BulkJob} arg.body
|
|
961
|
-
* @returns {Promise<BulkResponse>} - Success response
|
|
779
|
+
* @description: This API allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
780
|
+
*/
|
|
781
|
+
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
782
|
+
/**
|
|
783
|
+
* @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
|
|
784
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
785
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
786
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
787
|
+
* @name uploadBulkProducts
|
|
962
788
|
* @summary: Create a Bulk product to upload job.
|
|
963
|
-
* @description: This API helps to create a bulk products upload job.
|
|
964
|
-
*/
|
|
965
|
-
uploadBulkProducts({ department, productType, body }?: {
|
|
966
|
-
department: string;
|
|
967
|
-
productType: string;
|
|
968
|
-
body: BulkJob;
|
|
969
|
-
}): Promise<BulkResponse>;
|
|
970
|
-
/**
|
|
971
|
-
* @param {Object} arg - Arg object.
|
|
972
|
-
* @param {string} arg.slug - A `slug` is a unique identifier for a
|
|
973
|
-
* particular template.
|
|
974
|
-
* @returns {Promise<TemplatesValidationResponse>} - Success response
|
|
975
|
-
* @summary: Validate Product Template Schema
|
|
976
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
789
|
+
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
977
790
|
*/
|
|
978
|
-
|
|
979
|
-
slug: string;
|
|
980
|
-
}): Promise<TemplatesValidationResponse>;
|
|
791
|
+
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
981
792
|
/**
|
|
982
|
-
* @param {
|
|
983
|
-
* @param {
|
|
984
|
-
*
|
|
985
|
-
* @returns {Promise<
|
|
793
|
+
* @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
|
|
794
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
795
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
796
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
|
|
797
|
+
* Success response
|
|
798
|
+
* @name validateProductTemplate
|
|
799
|
+
* @summary: Validate Product Template Schema
|
|
800
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
|
|
801
|
+
*/
|
|
802
|
+
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
|
|
803
|
+
/**
|
|
804
|
+
* @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
|
|
805
|
+
* - Arg object
|
|
806
|
+
*
|
|
807
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
808
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
809
|
+
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
|
|
810
|
+
* Success response
|
|
811
|
+
* @name validateProductTemplateSchema
|
|
986
812
|
* @summary: Validate Product Template Schema
|
|
987
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
813
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
988
814
|
*/
|
|
989
|
-
validateProductTemplateSchema({ itemType }?: {
|
|
990
|
-
itemType: string;
|
|
991
|
-
}): Promise<InventoryValidationResponse>;
|
|
815
|
+
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
|
|
992
816
|
}
|
|
817
|
+
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
818
|
+
import CatalogPlatformModel = require("./CatalogPlatformModel");
|