@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +14 -14
- package/sdk/application/Cart/CartApplicationClient.js +14 -14
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationClient.js +53 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +136 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +46 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +41 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
- package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +417 -3811
- package/sdk/platform/Billing/BillingPlatformModel.js +292 -2544
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +34 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +363 -29
- package/sdk/platform/Cart/CartPlatformModel.js +203 -31
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +220 -200
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +121 -91
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +58 -46
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
- package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +22 -228
- package/sdk/platform/Catalog/CatalogPlatformModel.js +12 -163
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +4 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +10 -14
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +94 -30
- package/sdk/platform/Communication/CommunicationPlatformModel.js +110 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +33 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +62 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +11 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +12 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +12 -10
- package/sdk/platform/Content/ContentPlatformModel.d.ts +42 -12
- package/sdk/platform/Content/ContentPlatformModel.js +43 -13
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Order/OrderPlatformClient.d.ts +21 -21
- package/sdk/platform/Order/OrderPlatformClient.js +21 -21
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1010 -80
- package/sdk/platform/Order/OrderPlatformModel.js +665 -70
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +31 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +11 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +6 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +24 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +194 -23
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +116 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +23 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +16 -0
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +10 -12
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +45 -49
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +12 -12
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -297,34 +297,6 @@ export = CatalogPlatformApplicationValidator;
|
|
|
297
297
|
* @property {string} [q] - Search with Item Code, Name, Slug or Identifier.
|
|
298
298
|
*/
|
|
299
299
|
/** @typedef GetAppReturnConfigurationParam */
|
|
300
|
-
/**
|
|
301
|
-
* @typedef GetAppicationProductsParam
|
|
302
|
-
* @property {string} [q] - The search query. This can be a partial or complete
|
|
303
|
-
* name of a either a product, brand or category
|
|
304
|
-
* @property {string} [f] - The search filter parameters. All the parameter
|
|
305
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
306
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
307
|
-
* @property {string} [c] - The search filter parameters for collection items.
|
|
308
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
309
|
-
* parameter in this format.
|
|
310
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
311
|
-
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
312
|
-
* details. This flag is used to fetch all filters
|
|
313
|
-
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
314
|
-
* dependent products in the listing.
|
|
315
|
-
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
316
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
317
|
-
* either ascending or descending order. See the supported values below.
|
|
318
|
-
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
319
|
-
* which should be sent back to make pagination work.
|
|
320
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
321
|
-
* Default is 12.
|
|
322
|
-
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
323
|
-
* page items. Default is 1.
|
|
324
|
-
* @property {string} [pageType] - For pagination type should be cursor or
|
|
325
|
-
* number. Default is cursor.
|
|
326
|
-
* @property {string[]} [itemIds] - Item Ids of product
|
|
327
|
-
*/
|
|
328
300
|
/**
|
|
329
301
|
* @typedef GetApplicationBrandListingParam
|
|
330
302
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -392,6 +364,34 @@ export = CatalogPlatformApplicationValidator;
|
|
|
392
364
|
* Default is 10.
|
|
393
365
|
* @property {string} [q] - Get Values filtered by q string
|
|
394
366
|
*/
|
|
367
|
+
/**
|
|
368
|
+
* @typedef GetApplicationProductsParam
|
|
369
|
+
* @property {string} [q] - The search query. This can be a partial or complete
|
|
370
|
+
* name of a either a product, brand or category
|
|
371
|
+
* @property {string} [f] - The search filter parameters. All the parameter
|
|
372
|
+
* filtered from filter parameters will be passed in **f** parameter in this
|
|
373
|
+
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
374
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
375
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
376
|
+
* parameter in this format.
|
|
377
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
378
|
+
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
379
|
+
* details. This flag is used to fetch all filters
|
|
380
|
+
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
381
|
+
* dependent products in the listing.
|
|
382
|
+
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
383
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
384
|
+
* either ascending or descending order. See the supported values below.
|
|
385
|
+
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
386
|
+
* which should be sent back to make pagination work.
|
|
387
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
388
|
+
* Default is 12.
|
|
389
|
+
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
390
|
+
* page items. Default is 1.
|
|
391
|
+
* @property {string} [pageType] - For pagination type should be cursor or
|
|
392
|
+
* number. Default is cursor.
|
|
393
|
+
* @property {string[]} [itemIds] - Item Ids of product
|
|
394
|
+
*/
|
|
395
395
|
/**
|
|
396
396
|
* @typedef GetAutocompleteConfigParam
|
|
397
397
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -585,6 +585,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
585
585
|
/**
|
|
586
586
|
* @typedef PollPriceFactoryJobsParam
|
|
587
587
|
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
588
|
+
* @property {string} [startDate] - Date that filters the jobs created after this date
|
|
589
|
+
* @property {string} [endDate] - Date that filters the jobs created before this date
|
|
590
|
+
* @property {string[]} [stage] - Filter jobs by the stage
|
|
591
|
+
* @property {boolean} [isActive] - Filter active or inactive jobs
|
|
592
|
+
* @property {string} [q] - Pass unique identifier for a particular job to poll
|
|
593
|
+
* @property {string[]} [type] - Pass type for a particular job to poll
|
|
588
594
|
*/
|
|
589
595
|
/**
|
|
590
596
|
* @typedef PollProductPriceFactoryBulkJobParam
|
|
@@ -851,8 +857,6 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
851
857
|
static getAppProducts(): GetAppProductsParam;
|
|
852
858
|
/** @returns {GetAppReturnConfigurationParam} */
|
|
853
859
|
static getAppReturnConfiguration(): any;
|
|
854
|
-
/** @returns {GetAppicationProductsParam} */
|
|
855
|
-
static getAppicationProducts(): GetAppicationProductsParam;
|
|
856
860
|
/** @returns {GetApplicationBrandListingParam} */
|
|
857
861
|
static getApplicationBrandListing(): GetApplicationBrandListingParam;
|
|
858
862
|
/** @returns {GetApplicationBrandsParam} */
|
|
@@ -865,6 +869,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
865
869
|
static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
|
|
866
870
|
/** @returns {GetApplicationFilterValuesParam} */
|
|
867
871
|
static getApplicationFilterValues(): GetApplicationFilterValuesParam;
|
|
872
|
+
/** @returns {GetApplicationProductsParam} */
|
|
873
|
+
static getApplicationProducts(): GetApplicationProductsParam;
|
|
868
874
|
/** @returns {GetAutocompleteConfigParam} */
|
|
869
875
|
static getAutocompleteConfig(): GetAutocompleteConfigParam;
|
|
870
876
|
/** @returns {GetAutocompleteKeywordDetailParam} */
|
|
@@ -997,7 +1003,7 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
997
1003
|
static validateProductPriceFactoryBulkJob(): ValidateProductPriceFactoryBulkJobParam;
|
|
998
1004
|
}
|
|
999
1005
|
declare namespace CatalogPlatformApplicationValidator {
|
|
1000
|
-
export { AddCollectionItemsParam, AddProductsInPriceFactoryByZoneIdParam, ClearCollectionItemsPriorityParam, CreateAppCategoryReturnConfigurationParam, CreateAppPriceFactoryParam, CreateAppReturnConfigurationParam, CreateAutocompleteSettingsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateMerchandisingRuleBoostActionParam, CreateMerchandisingRuleBuryActionParam, CreateMerchandisingRuleHideActionParam, CreateMerchandisingRulePinActionParam, CreateMerchandisingRuleQueryParam, CreateProductPriceFactoryBulkJobParam, CreateSearchConfigurationParam, CreateSearchRerankParam, CreateSynonymsParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteMerchandisingRuleParam, DeleteMerchandisingRulesPreviewParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, DeleteSearchRerankConfigurationParam, DeleteSynonymParam, EditAppPriceFactoryParam, ExportProductsInPriceFactoryParam, ExportSynonymsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppPriceByIdParam, GetAppPriceFactoriesParam, GetAppPriceFactoryParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam,
|
|
1006
|
+
export { AddCollectionItemsParam, AddProductsInPriceFactoryByZoneIdParam, ClearCollectionItemsPriorityParam, CreateAppCategoryReturnConfigurationParam, CreateAppPriceFactoryParam, CreateAppReturnConfigurationParam, CreateAutocompleteSettingsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateMerchandisingRuleBoostActionParam, CreateMerchandisingRuleBuryActionParam, CreateMerchandisingRuleHideActionParam, CreateMerchandisingRulePinActionParam, CreateMerchandisingRuleQueryParam, CreateProductPriceFactoryBulkJobParam, CreateSearchConfigurationParam, CreateSearchRerankParam, CreateSynonymsParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteMerchandisingRuleParam, DeleteMerchandisingRulesPreviewParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, DeleteSearchRerankConfigurationParam, DeleteSynonymParam, EditAppPriceFactoryParam, ExportProductsInPriceFactoryParam, ExportSynonymsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppPriceByIdParam, GetAppPriceFactoriesParam, GetAppPriceFactoryParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetAutocompletePreviewParam, GetAutocompleteSettingsParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetConfigurationsFilterMetadataParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetLivePreviewParam, GetMerchandisingQueryParam, GetMerchandisingRuleBoostActionParam, GetMerchandisingRuleBuryActionParam, GetMerchandisingRuleHideActionParam, GetMerchandisingRulePinActionParam, GetMerchandisingRulesParam, GetProductDetailBySlugParam, GetProductsInPriceFactoryByZoneIdParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, GetSearchRerankParam, GetSearchRerankDetailParam, GetSynonymsParam, PollBulkSynonymsParam, PollPriceFactoryJobsParam, PollProductPriceFactoryBulkJobParam, ProcessBulkSynonymsParam, ProcessProductPriceFactoryBulkJobParam, SampleBulkSynonymsFileParam, SaveMerchandisingRulesParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateAutocompleteSettingsParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateMerchandisingRuleBoostActionParam, UpdateMerchandisingRuleBuryActionParam, UpdateMerchandisingRuleHideActionParam, UpdateMerchandisingRulePinActionParam, UpdateMerchandisingRuleQueryParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam, UpdateSearchRerankConfigurationParam, UpdateSynonymsParam, UploadSynonymsParam, ValidateBulkSynonymsParam, ValidateProductPriceFactoryBulkJobParam };
|
|
1001
1007
|
}
|
|
1002
1008
|
type AddCollectionItemsParam = {
|
|
1003
1009
|
/**
|
|
@@ -1494,66 +1500,6 @@ type GetAppProductsParam = {
|
|
|
1494
1500
|
*/
|
|
1495
1501
|
q?: string;
|
|
1496
1502
|
};
|
|
1497
|
-
type GetAppicationProductsParam = {
|
|
1498
|
-
/**
|
|
1499
|
-
* - The search query. This can be a partial or complete
|
|
1500
|
-
* name of a either a product, brand or category
|
|
1501
|
-
*/
|
|
1502
|
-
q?: string;
|
|
1503
|
-
/**
|
|
1504
|
-
* - The search filter parameters. All the parameter
|
|
1505
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
1506
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
1507
|
-
*/
|
|
1508
|
-
f?: string;
|
|
1509
|
-
/**
|
|
1510
|
-
* - The search filter parameters for collection items.
|
|
1511
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1512
|
-
* parameter in this format.
|
|
1513
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1514
|
-
*/
|
|
1515
|
-
c?: string;
|
|
1516
|
-
/**
|
|
1517
|
-
* - Pass `filters` parameter to fetch the filter
|
|
1518
|
-
* details. This flag is used to fetch all filters
|
|
1519
|
-
*/
|
|
1520
|
-
filters?: boolean;
|
|
1521
|
-
/**
|
|
1522
|
-
* - This query parameter is used to get the
|
|
1523
|
-
* dependent products in the listing.
|
|
1524
|
-
*/
|
|
1525
|
-
isDependent?: boolean;
|
|
1526
|
-
/**
|
|
1527
|
-
* - The order to sort the list of products on. The
|
|
1528
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
1529
|
-
* either ascending or descending order. See the supported values below.
|
|
1530
|
-
*/
|
|
1531
|
-
sortOn?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* - Each response will contain **page_id** param,
|
|
1534
|
-
* which should be sent back to make pagination work.
|
|
1535
|
-
*/
|
|
1536
|
-
pageId?: string;
|
|
1537
|
-
/**
|
|
1538
|
-
* - Number of items to retrieve in each page.
|
|
1539
|
-
* Default is 12.
|
|
1540
|
-
*/
|
|
1541
|
-
pageSize?: number;
|
|
1542
|
-
/**
|
|
1543
|
-
* - If page_type is number then pass it to fetch
|
|
1544
|
-
* page items. Default is 1.
|
|
1545
|
-
*/
|
|
1546
|
-
pageNo?: number;
|
|
1547
|
-
/**
|
|
1548
|
-
* - For pagination type should be cursor or
|
|
1549
|
-
* number. Default is cursor.
|
|
1550
|
-
*/
|
|
1551
|
-
pageType?: string;
|
|
1552
|
-
/**
|
|
1553
|
-
* - Item Ids of product
|
|
1554
|
-
*/
|
|
1555
|
-
itemIds?: string[];
|
|
1556
|
-
};
|
|
1557
1503
|
type GetApplicationBrandListingParam = {
|
|
1558
1504
|
/**
|
|
1559
1505
|
* - The page number to navigate through the given
|
|
@@ -1681,6 +1627,66 @@ type GetApplicationFilterValuesParam = {
|
|
|
1681
1627
|
*/
|
|
1682
1628
|
q?: string;
|
|
1683
1629
|
};
|
|
1630
|
+
type GetApplicationProductsParam = {
|
|
1631
|
+
/**
|
|
1632
|
+
* - The search query. This can be a partial or complete
|
|
1633
|
+
* name of a either a product, brand or category
|
|
1634
|
+
*/
|
|
1635
|
+
q?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* - The search filter parameters. All the parameter
|
|
1638
|
+
* filtered from filter parameters will be passed in **f** parameter in this
|
|
1639
|
+
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
1640
|
+
*/
|
|
1641
|
+
f?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* - The search filter parameters for collection items.
|
|
1644
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1645
|
+
* parameter in this format.
|
|
1646
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1647
|
+
*/
|
|
1648
|
+
c?: string;
|
|
1649
|
+
/**
|
|
1650
|
+
* - Pass `filters` parameter to fetch the filter
|
|
1651
|
+
* details. This flag is used to fetch all filters
|
|
1652
|
+
*/
|
|
1653
|
+
filters?: boolean;
|
|
1654
|
+
/**
|
|
1655
|
+
* - This query parameter is used to get the
|
|
1656
|
+
* dependent products in the listing.
|
|
1657
|
+
*/
|
|
1658
|
+
isDependent?: boolean;
|
|
1659
|
+
/**
|
|
1660
|
+
* - The order to sort the list of products on. The
|
|
1661
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
1662
|
+
* either ascending or descending order. See the supported values below.
|
|
1663
|
+
*/
|
|
1664
|
+
sortOn?: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* - Each response will contain **page_id** param,
|
|
1667
|
+
* which should be sent back to make pagination work.
|
|
1668
|
+
*/
|
|
1669
|
+
pageId?: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* - Number of items to retrieve in each page.
|
|
1672
|
+
* Default is 12.
|
|
1673
|
+
*/
|
|
1674
|
+
pageSize?: number;
|
|
1675
|
+
/**
|
|
1676
|
+
* - If page_type is number then pass it to fetch
|
|
1677
|
+
* page items. Default is 1.
|
|
1678
|
+
*/
|
|
1679
|
+
pageNo?: number;
|
|
1680
|
+
/**
|
|
1681
|
+
* - For pagination type should be cursor or
|
|
1682
|
+
* number. Default is cursor.
|
|
1683
|
+
*/
|
|
1684
|
+
pageType?: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* - Item Ids of product
|
|
1687
|
+
*/
|
|
1688
|
+
itemIds?: string[];
|
|
1689
|
+
};
|
|
1684
1690
|
type GetAutocompleteConfigParam = {
|
|
1685
1691
|
/**
|
|
1686
1692
|
* - The page number to navigate through the given
|
|
@@ -2029,6 +2035,30 @@ type PollPriceFactoryJobsParam = {
|
|
|
2029
2035
|
* - An `id` is a unique identifier for a particular price factory.
|
|
2030
2036
|
*/
|
|
2031
2037
|
id: string;
|
|
2038
|
+
/**
|
|
2039
|
+
* - Date that filters the jobs created after this date
|
|
2040
|
+
*/
|
|
2041
|
+
startDate?: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* - Date that filters the jobs created before this date
|
|
2044
|
+
*/
|
|
2045
|
+
endDate?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* - Filter jobs by the stage
|
|
2048
|
+
*/
|
|
2049
|
+
stage?: string[];
|
|
2050
|
+
/**
|
|
2051
|
+
* - Filter active or inactive jobs
|
|
2052
|
+
*/
|
|
2053
|
+
isActive?: boolean;
|
|
2054
|
+
/**
|
|
2055
|
+
* - Pass unique identifier for a particular job to poll
|
|
2056
|
+
*/
|
|
2057
|
+
q?: string;
|
|
2058
|
+
/**
|
|
2059
|
+
* - Pass type for a particular job to poll
|
|
2060
|
+
*/
|
|
2061
|
+
type?: string[];
|
|
2032
2062
|
};
|
|
2033
2063
|
type PollProductPriceFactoryBulkJobParam = {
|
|
2034
2064
|
/**
|
|
@@ -349,35 +349,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
349
349
|
|
|
350
350
|
/** @typedef GetAppReturnConfigurationParam */
|
|
351
351
|
|
|
352
|
-
/**
|
|
353
|
-
* @typedef GetAppicationProductsParam
|
|
354
|
-
* @property {string} [q] - The search query. This can be a partial or complete
|
|
355
|
-
* name of a either a product, brand or category
|
|
356
|
-
* @property {string} [f] - The search filter parameters. All the parameter
|
|
357
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
358
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
359
|
-
* @property {string} [c] - The search filter parameters for collection items.
|
|
360
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
361
|
-
* parameter in this format.
|
|
362
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
363
|
-
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
364
|
-
* details. This flag is used to fetch all filters
|
|
365
|
-
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
366
|
-
* dependent products in the listing.
|
|
367
|
-
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
368
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
369
|
-
* either ascending or descending order. See the supported values below.
|
|
370
|
-
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
371
|
-
* which should be sent back to make pagination work.
|
|
372
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
373
|
-
* Default is 12.
|
|
374
|
-
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
375
|
-
* page items. Default is 1.
|
|
376
|
-
* @property {string} [pageType] - For pagination type should be cursor or
|
|
377
|
-
* number. Default is cursor.
|
|
378
|
-
* @property {string[]} [itemIds] - Item Ids of product
|
|
379
|
-
*/
|
|
380
|
-
|
|
381
352
|
/**
|
|
382
353
|
* @typedef GetApplicationBrandListingParam
|
|
383
354
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -451,6 +422,35 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
451
422
|
* @property {string} [q] - Get Values filtered by q string
|
|
452
423
|
*/
|
|
453
424
|
|
|
425
|
+
/**
|
|
426
|
+
* @typedef GetApplicationProductsParam
|
|
427
|
+
* @property {string} [q] - The search query. This can be a partial or complete
|
|
428
|
+
* name of a either a product, brand or category
|
|
429
|
+
* @property {string} [f] - The search filter parameters. All the parameter
|
|
430
|
+
* filtered from filter parameters will be passed in **f** parameter in this
|
|
431
|
+
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
432
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
433
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
434
|
+
* parameter in this format.
|
|
435
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
436
|
+
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
437
|
+
* details. This flag is used to fetch all filters
|
|
438
|
+
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
439
|
+
* dependent products in the listing.
|
|
440
|
+
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
441
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
442
|
+
* either ascending or descending order. See the supported values below.
|
|
443
|
+
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
444
|
+
* which should be sent back to make pagination work.
|
|
445
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
446
|
+
* Default is 12.
|
|
447
|
+
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
448
|
+
* page items. Default is 1.
|
|
449
|
+
* @property {string} [pageType] - For pagination type should be cursor or
|
|
450
|
+
* number. Default is cursor.
|
|
451
|
+
* @property {string[]} [itemIds] - Item Ids of product
|
|
452
|
+
*/
|
|
453
|
+
|
|
454
454
|
/**
|
|
455
455
|
* @typedef GetAutocompleteConfigParam
|
|
456
456
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -677,6 +677,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
677
677
|
/**
|
|
678
678
|
* @typedef PollPriceFactoryJobsParam
|
|
679
679
|
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
680
|
+
* @property {string} [startDate] - Date that filters the jobs created after this date
|
|
681
|
+
* @property {string} [endDate] - Date that filters the jobs created before this date
|
|
682
|
+
* @property {string[]} [stage] - Filter jobs by the stage
|
|
683
|
+
* @property {boolean} [isActive] - Filter active or inactive jobs
|
|
684
|
+
* @property {string} [q] - Pass unique identifier for a particular job to poll
|
|
685
|
+
* @property {string[]} [type] - Pass type for a particular job to poll
|
|
680
686
|
*/
|
|
681
687
|
|
|
682
688
|
/**
|
|
@@ -1275,23 +1281,6 @@ class CatalogPlatformApplicationValidator {
|
|
|
1275
1281
|
return Joi.object({}).required();
|
|
1276
1282
|
}
|
|
1277
1283
|
|
|
1278
|
-
/** @returns {GetAppicationProductsParam} */
|
|
1279
|
-
static getAppicationProducts() {
|
|
1280
|
-
return Joi.object({
|
|
1281
|
-
q: Joi.string().allow(""),
|
|
1282
|
-
f: Joi.string().allow(""),
|
|
1283
|
-
c: Joi.string().allow(""),
|
|
1284
|
-
filters: Joi.boolean(),
|
|
1285
|
-
isDependent: Joi.boolean(),
|
|
1286
|
-
sortOn: Joi.string().allow(""),
|
|
1287
|
-
pageId: Joi.string().allow(""),
|
|
1288
|
-
pageSize: Joi.number(),
|
|
1289
|
-
pageNo: Joi.number(),
|
|
1290
|
-
pageType: Joi.string().allow(""),
|
|
1291
|
-
itemIds: Joi.array().items(Joi.string().allow("")),
|
|
1292
|
-
}).required();
|
|
1293
|
-
}
|
|
1294
|
-
|
|
1295
1284
|
/** @returns {GetApplicationBrandListingParam} */
|
|
1296
1285
|
static getApplicationBrandListing() {
|
|
1297
1286
|
return Joi.object({
|
|
@@ -1350,6 +1339,23 @@ class CatalogPlatformApplicationValidator {
|
|
|
1350
1339
|
}).required();
|
|
1351
1340
|
}
|
|
1352
1341
|
|
|
1342
|
+
/** @returns {GetApplicationProductsParam} */
|
|
1343
|
+
static getApplicationProducts() {
|
|
1344
|
+
return Joi.object({
|
|
1345
|
+
q: Joi.string().allow(""),
|
|
1346
|
+
f: Joi.string().allow(""),
|
|
1347
|
+
c: Joi.string().allow(""),
|
|
1348
|
+
filters: Joi.boolean(),
|
|
1349
|
+
isDependent: Joi.boolean(),
|
|
1350
|
+
sortOn: Joi.string().allow(""),
|
|
1351
|
+
pageId: Joi.string().allow(""),
|
|
1352
|
+
pageSize: Joi.number(),
|
|
1353
|
+
pageNo: Joi.number(),
|
|
1354
|
+
pageType: Joi.string().allow(""),
|
|
1355
|
+
itemIds: Joi.array().items(Joi.string().allow("")),
|
|
1356
|
+
}).required();
|
|
1357
|
+
}
|
|
1358
|
+
|
|
1353
1359
|
/** @returns {GetAutocompleteConfigParam} */
|
|
1354
1360
|
static getAutocompleteConfig() {
|
|
1355
1361
|
return Joi.object({
|
|
@@ -1607,6 +1613,12 @@ class CatalogPlatformApplicationValidator {
|
|
|
1607
1613
|
static pollPriceFactoryJobs() {
|
|
1608
1614
|
return Joi.object({
|
|
1609
1615
|
id: Joi.string().allow("").required(),
|
|
1616
|
+
startDate: Joi.string().allow(""),
|
|
1617
|
+
endDate: Joi.string().allow(""),
|
|
1618
|
+
stage: Joi.array().items(Joi.string().allow("")),
|
|
1619
|
+
isActive: Joi.boolean(),
|
|
1620
|
+
q: Joi.string().allow(""),
|
|
1621
|
+
type: Joi.array().items(Joi.string().allow("")),
|
|
1610
1622
|
}).required();
|
|
1611
1623
|
}
|
|
1612
1624
|
|
|
@@ -42,27 +42,6 @@ declare class Catalog {
|
|
|
42
42
|
* @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/).
|
|
43
43
|
*/
|
|
44
44
|
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
|
|
45
|
-
/**
|
|
46
|
-
* @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
|
|
47
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
50
|
-
* @name createCategories
|
|
51
|
-
* @summary: Create categories.
|
|
52
|
-
* @description: Lets user create product categories on for the seller on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
53
|
-
*/
|
|
54
|
-
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
55
|
-
/**
|
|
56
|
-
* @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
|
|
57
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
60
|
-
* Success response
|
|
61
|
-
* @name createDepartments
|
|
62
|
-
* @summary: Create departments.
|
|
63
|
-
* @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
64
|
-
*/
|
|
65
|
-
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
66
45
|
/**
|
|
67
46
|
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
68
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -266,6 +245,16 @@ declare class Catalog {
|
|
|
266
245
|
* @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
267
246
|
*/
|
|
268
247
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
248
|
+
/**
|
|
249
|
+
* @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
|
|
250
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
251
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
252
|
+
* @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
|
|
253
|
+
* @name getAttribute
|
|
254
|
+
* @summary: Get attribute detail by slug
|
|
255
|
+
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAttribute/).
|
|
256
|
+
*/
|
|
257
|
+
getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
|
|
269
258
|
/**
|
|
270
259
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
271
260
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -339,16 +328,6 @@ declare class Catalog {
|
|
|
339
328
|
* @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
340
329
|
*/
|
|
341
330
|
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
342
|
-
/**
|
|
343
|
-
* @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
|
|
344
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
-
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
347
|
-
* @name getGenderAttribute
|
|
348
|
-
* @summary: Get gender attribute.
|
|
349
|
-
* @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
350
|
-
*/
|
|
351
|
-
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
352
331
|
/**
|
|
353
332
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
354
333
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -771,26 +750,6 @@ declare class Catalog {
|
|
|
771
750
|
* @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchProductExportDetail/).
|
|
772
751
|
*/
|
|
773
752
|
patchProductExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PatchProductDownloadsResponse>;
|
|
774
|
-
/**
|
|
775
|
-
* @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
|
|
776
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
777
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
778
|
-
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
779
|
-
* @name updateCategory
|
|
780
|
-
* @summary: Update category data.
|
|
781
|
-
* @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
782
|
-
*/
|
|
783
|
-
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
784
|
-
/**
|
|
785
|
-
* @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
|
|
786
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
787
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
788
|
-
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
789
|
-
* @name updateDepartment
|
|
790
|
-
* @summary: Update department data.
|
|
791
|
-
* @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
792
|
-
*/
|
|
793
|
-
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
794
753
|
/**
|
|
795
754
|
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
796
755
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|