@gofynd/fdk-client-javascript 1.3.5-beta.3 → 1.3.5
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/CartApplicationModel.js +7 -7
- package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
- package/sdk/application/Order/OrderApplicationModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +2 -0
- package/sdk/platform/Cart/CartPlatformModel.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +97 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +123 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformClient.js +4 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +38 -7
- package/sdk/platform/Order/OrderPlatformModel.js +40 -6
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +2 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +14 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +8 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationClient.js +5 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +16 -3
- package/sdk/platform/User/UserPlatformModel.js +18 -2
package/README.md
CHANGED
|
@@ -214,7 +214,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
214
214
|
The above code will log the curl command in the console
|
|
215
215
|
|
|
216
216
|
```bash
|
|
217
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.5
|
|
217
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.5' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
218
218
|
Active Theme: Emerge
|
|
219
219
|
```
|
|
220
220
|
|
package/package.json
CHANGED
|
@@ -1129,23 +1129,23 @@ class CartApplicationModel {
|
|
|
1129
1129
|
aggregator: Joi.string().allow(""),
|
|
1130
1130
|
billing_address: Joi.any(),
|
|
1131
1131
|
billing_address_id: Joi.string().allow(""),
|
|
1132
|
-
callback_url: Joi.string().allow("")
|
|
1132
|
+
callback_url: Joi.string().allow(""),
|
|
1133
1133
|
custom_meta: Joi.array().items(
|
|
1134
1134
|
CartApplicationModel.CartCheckoutCustomMeta()
|
|
1135
1135
|
),
|
|
1136
|
-
customer_details: Joi.any()
|
|
1136
|
+
customer_details: Joi.any(),
|
|
1137
1137
|
delivery_address: Joi.any(),
|
|
1138
1138
|
extra_meta: Joi.any(),
|
|
1139
|
-
id: Joi.string().allow("")
|
|
1139
|
+
id: Joi.string().allow(""),
|
|
1140
1140
|
merchant_code: Joi.string().allow(""),
|
|
1141
1141
|
meta: Joi.any(),
|
|
1142
1142
|
order_type: Joi.string().allow(""),
|
|
1143
|
-
ordering_store: Joi.number()
|
|
1143
|
+
ordering_store: Joi.number(),
|
|
1144
1144
|
payment_auto_confirm: Joi.boolean(),
|
|
1145
1145
|
payment_extra_identifiers: Joi.any(),
|
|
1146
|
-
payment_identifier: Joi.string().allow("")
|
|
1146
|
+
payment_identifier: Joi.string().allow(""),
|
|
1147
1147
|
payment_mode: Joi.string().allow("").required(),
|
|
1148
|
-
payment_params: Joi.any()
|
|
1148
|
+
payment_params: Joi.any(),
|
|
1149
1149
|
staff: CartApplicationModel.StaffCheckout(),
|
|
1150
1150
|
});
|
|
1151
1151
|
}
|
|
@@ -1452,7 +1452,7 @@ class CartApplicationModel {
|
|
|
1452
1452
|
/** @returns {CustomerDetails} */
|
|
1453
1453
|
static CustomerDetails() {
|
|
1454
1454
|
return Joi.object({
|
|
1455
|
-
email: Joi.string().allow("")
|
|
1455
|
+
email: Joi.string().allow(""),
|
|
1456
1456
|
mobile: Joi.string().allow("").required(),
|
|
1457
1457
|
name: Joi.string().allow(""),
|
|
1458
1458
|
});
|
|
@@ -200,6 +200,7 @@ export = OrderApplicationModel;
|
|
|
200
200
|
*/
|
|
201
201
|
/**
|
|
202
202
|
* @typedef Item
|
|
203
|
+
* @property {Object} [attributes]
|
|
203
204
|
* @property {ItemBrand} [brand]
|
|
204
205
|
* @property {string} [code]
|
|
205
206
|
* @property {number} [id]
|
|
@@ -744,6 +745,7 @@ type Invoice = {
|
|
|
744
745
|
/** @returns {Item} */
|
|
745
746
|
declare function Item(): Item;
|
|
746
747
|
type Item = {
|
|
748
|
+
attributes?: any;
|
|
747
749
|
brand?: ItemBrand;
|
|
748
750
|
code?: string;
|
|
749
751
|
id?: number;
|
|
@@ -223,6 +223,7 @@ const Joi = require("joi");
|
|
|
223
223
|
|
|
224
224
|
/**
|
|
225
225
|
* @typedef Item
|
|
226
|
+
* @property {Object} [attributes]
|
|
226
227
|
* @property {ItemBrand} [brand]
|
|
227
228
|
* @property {string} [code]
|
|
228
229
|
* @property {number} [id]
|
|
@@ -853,6 +854,7 @@ class OrderApplicationModel {
|
|
|
853
854
|
/** @returns {Item} */
|
|
854
855
|
static Item() {
|
|
855
856
|
return Joi.object({
|
|
857
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
856
858
|
brand: OrderApplicationModel.ItemBrand(),
|
|
857
859
|
code: Joi.string().allow(""),
|
|
858
860
|
id: Joi.number(),
|
|
@@ -899,6 +899,7 @@ export = CartPlatformModel;
|
|
|
899
899
|
* @property {number} [pincode]
|
|
900
900
|
* @property {string} [state]
|
|
901
901
|
* @property {string} [store_code]
|
|
902
|
+
* @property {string} [store_manager_name]
|
|
902
903
|
* @property {number} [uid]
|
|
903
904
|
*/
|
|
904
905
|
/**
|
|
@@ -2857,6 +2858,7 @@ type PickupStoreDetail = {
|
|
|
2857
2858
|
pincode?: number;
|
|
2858
2859
|
state?: string;
|
|
2859
2860
|
store_code?: string;
|
|
2861
|
+
store_manager_name?: string;
|
|
2860
2862
|
uid?: number;
|
|
2861
2863
|
};
|
|
2862
2864
|
/** @returns {PlatformAddCartRequest} */
|
|
@@ -1000,6 +1000,7 @@ const Joi = require("joi");
|
|
|
1000
1000
|
* @property {number} [pincode]
|
|
1001
1001
|
* @property {string} [state]
|
|
1002
1002
|
* @property {string} [store_code]
|
|
1003
|
+
* @property {string} [store_manager_name]
|
|
1003
1004
|
* @property {number} [uid]
|
|
1004
1005
|
*/
|
|
1005
1006
|
|
|
@@ -3024,6 +3025,7 @@ class CartPlatformModel {
|
|
|
3024
3025
|
pincode: Joi.number(),
|
|
3025
3026
|
state: Joi.string().allow(""),
|
|
3026
3027
|
store_code: Joi.string().allow(""),
|
|
3028
|
+
store_manager_name: Joi.string().allow(""),
|
|
3027
3029
|
uid: Joi.number(),
|
|
3028
3030
|
});
|
|
3029
3031
|
}
|
|
@@ -114,6 +114,8 @@ export = CatalogPlatformModel;
|
|
|
114
114
|
* @property {ApplicationItemMOQ} [moq] - Minimum Order Quantity information for the item
|
|
115
115
|
* @property {ApplicationItemSEO} [seo] - Search Engine Optimization information
|
|
116
116
|
* for the item
|
|
117
|
+
* @property {SizePromotionThreshold} [size_promotion_threshold] - Size level
|
|
118
|
+
* promotion limitation information for item
|
|
117
119
|
*/
|
|
118
120
|
/**
|
|
119
121
|
* @typedef ApplicationItemMOQ
|
|
@@ -127,6 +129,26 @@ export = CatalogPlatformModel;
|
|
|
127
129
|
* @property {string} [description] - The SEO description of the item
|
|
128
130
|
* @property {string} [title] - The SEO title of the item
|
|
129
131
|
*/
|
|
132
|
+
/**
|
|
133
|
+
* @typedef ApplicationItemSeoAction
|
|
134
|
+
* @property {Object} [page]
|
|
135
|
+
* @property {string} [type]
|
|
136
|
+
*/
|
|
137
|
+
/**
|
|
138
|
+
* @typedef ApplicationItemSeoBreadcrumbs
|
|
139
|
+
* @property {ApplicationItemSeoAction[]} [action]
|
|
140
|
+
* @property {string} [url]
|
|
141
|
+
*/
|
|
142
|
+
/**
|
|
143
|
+
* @typedef ApplicationItemSeoMetaTagItem
|
|
144
|
+
* @property {string} [key]
|
|
145
|
+
* @property {string} [value]
|
|
146
|
+
*/
|
|
147
|
+
/**
|
|
148
|
+
* @typedef ApplicationItemSeoMetaTags
|
|
149
|
+
* @property {ApplicationItemSeoMetaTagItem[]} [items]
|
|
150
|
+
* @property {string} [title]
|
|
151
|
+
*/
|
|
130
152
|
/**
|
|
131
153
|
* @typedef ApplicationProductListingResponse
|
|
132
154
|
* @property {ProductFilters[]} [filters]
|
|
@@ -1832,6 +1854,11 @@ export = CatalogPlatformModel;
|
|
|
1832
1854
|
* @property {string} value - The value of the metadata. Should be a non-empty
|
|
1833
1855
|
* string and length should not exceed 100 characters.
|
|
1834
1856
|
*/
|
|
1857
|
+
/**
|
|
1858
|
+
* @typedef Metatags
|
|
1859
|
+
* @property {ApplicationItemSeoMetaTags[]} [items]
|
|
1860
|
+
* @property {string} [title]
|
|
1861
|
+
*/
|
|
1835
1862
|
/**
|
|
1836
1863
|
* @typedef MOQData
|
|
1837
1864
|
* @property {number} [increment_unit]
|
|
@@ -2633,12 +2660,18 @@ export = CatalogPlatformModel;
|
|
|
2633
2660
|
*/
|
|
2634
2661
|
/**
|
|
2635
2662
|
* @typedef SEOData
|
|
2663
|
+
* @property {ApplicationItemSeoBreadcrumbs[]} [breadcrumbs]
|
|
2636
2664
|
* @property {string} [description]
|
|
2665
|
+
* @property {Metatags[]} [meta_tags]
|
|
2666
|
+
* @property {Sitemap} [sitemap]
|
|
2637
2667
|
* @property {string} [title]
|
|
2638
2668
|
*/
|
|
2639
2669
|
/**
|
|
2640
2670
|
* @typedef SeoDetail
|
|
2671
|
+
* @property {ApplicationItemSeoBreadcrumbs[]} [breadcrumbs]
|
|
2641
2672
|
* @property {string} [description]
|
|
2673
|
+
* @property {Metatags[]} [meta_tags]
|
|
2674
|
+
* @property {Object} [sitemap]
|
|
2642
2675
|
* @property {string} [title]
|
|
2643
2676
|
*/
|
|
2644
2677
|
/**
|
|
@@ -2654,6 +2687,11 @@ export = CatalogPlatformModel;
|
|
|
2654
2687
|
* @typedef SingleProductResponse
|
|
2655
2688
|
* @property {ProductSchemaV2} [data]
|
|
2656
2689
|
*/
|
|
2690
|
+
/**
|
|
2691
|
+
* @typedef Sitemap
|
|
2692
|
+
* @property {string} [frequency]
|
|
2693
|
+
* @property {number} [priority]
|
|
2694
|
+
*/
|
|
2657
2695
|
/**
|
|
2658
2696
|
* @typedef Size
|
|
2659
2697
|
* @property {string} [display]
|
|
@@ -2681,6 +2719,11 @@ export = CatalogPlatformModel;
|
|
|
2681
2719
|
* @property {string} [tag]
|
|
2682
2720
|
* @property {string} [title]
|
|
2683
2721
|
*/
|
|
2722
|
+
/**
|
|
2723
|
+
* @typedef SizePromotionThreshold
|
|
2724
|
+
* @property {string} [threshold_type]
|
|
2725
|
+
* @property {number} [threshold_value]
|
|
2726
|
+
*/
|
|
2684
2727
|
/**
|
|
2685
2728
|
* @typedef StoreAssignResponse
|
|
2686
2729
|
* @property {string} [_id]
|
|
@@ -3015,7 +3058,7 @@ export = CatalogPlatformModel;
|
|
|
3015
3058
|
declare class CatalogPlatformModel {
|
|
3016
3059
|
}
|
|
3017
3060
|
declare namespace CatalogPlatformModel {
|
|
3018
|
-
export { Action, ActionPage, AllowSingleRequest, AllSizes, AppCatalogConfiguration, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMeta, ApplicationItemMOQ, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutocompleteAction, AutoCompleteMedia, AutocompletePageAction, AutocompleteResult, BannerImage, Brand, BrandItem, BrandListingResponse, BrandMeta, BrandMeta1, BulkAssetResponse, BulkHsnResponse, BulkHsnUpsert, BulkInventoryGet, BulkInventoryGetItems, BulkJob, BulkProductRequest, BulkResponse, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponse, CategoriesResponse, Category, CategoryCreateResponse, CategoryItems, CategoryListingResponse, CategoryMapping, CategoryMappingValues, CategoryRequestBody, CategoryResponse, CategoryUpdateResponse, Child, CollectionBadge, CollectionBanner, CollectionCreateResponse, CollectionDetailResponse, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, CompanyMeta1, CompanyOptIn, ConfigErrorResponse, ConfigSuccessResponse, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponse, CreateCollection, CreateSearchConfigurationRequest, CreateSearchConfigurationResponse, CreateSearchKeyword, CrossSellingData, CrossSellingResponse, CustomOrder, DateMeta, DefaultKeyRequest, DeleteResponse, DeleteSearchConfigurationResponse, Department, DepartmentCategoryTree, DepartmentCreateErrorResponse, DepartmentCreateResponse, DepartmentCreateUpdate, DepartmentErrorResponse, DepartmentIdentifier, DepartmentModel, DepartmentResponse, DepartmentsResponse, DimensionResponse, DimensionResponse1, Document, EntityConfiguration, ErrorResponse, FilerList, GenderDetail, GetAddressSerializer, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponse, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponse, GetCollectionListingResponse, GetCollectionQueryOptionResponse, GetCompanySerializer, GetConfigMetadataResponse, GetConfigResponse, GetDepartment, GetInventories, GetInventoriesResponse, GetLocationSerializer, GetOptInPlatform, GetProductBundleCreateResponse, GetProductBundleListingResponse, GetProductBundleResponse, GetProducts, GetSearchConfigurationResponse, GetSearchWordsData, GetSearchWordsDetailResponse, GetSearchWordsResponse, GlobalValidation, GTIN, Guide, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HSNCodesResponse, HSNData, HSNDataInsertV2, HsnUpsert, Image, ImageUrls, InventoryBulkRequest, InventoryConfig, InventoryCreateRequest, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponse, InventoryExportQuantityFilter, InventoryExportRequest, InventoryExportResponse, InventoryFailedReason, InventoryJobDetailResponse, InventoryJobFilters, InventoryJobPayload, InventoryPage, InventoryPayload, InventoryRequest, InventoryRequestSchemaV2, InventoryResponse, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, InventorySellerResponse, InventorySet, InventoryStockResponse, InventoryUpdateResponse, InventoryValidationResponse, InvoiceCredSerializer, InvoiceDetailsSerializer, InvSize, ItemQuery, Items, LimitedProductData, ListSizeGuide, LocationDayWiseSerializer, LocationIntegrationType, LocationListSerializer, LocationManagerSerializer, LocationTimingSerializer, Logo, ManufacturerResponse, ManufacturerResponse1, Media, Media1, Media2, Meta, MetaDataListingFilterMetaResponse, MetaDataListingFilterResponse, MetaDataListingResponse, MetaDataListingSortMetaResponse, MetaDataListingSortResponse, MetaFields, MOQData, NetQuantity, NetQuantityResponse, NextSchedule, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptInPostRequest, OptinStoreDetails, OwnerAppItemResponse, Page, PageResponse, PageResponseType, Price, Price1, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponse, Product, ProductAttributesResponse, ProductBrand, ProductBulkAssets, ProductBulkRequest, ProductBulkRequestList, ProductBundleItem, ProductBundleRequest, ProductBundleUpdateRequest, ProductConfigurationDownloads, ProductCreateUpdateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponse, ProductFilters, ProductFiltersKey, ProductFiltersValue, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductListingResponseV2, ProductPublish, ProductPublish1, ProductPublished, ProductReturnConfigSerializer, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponse, ProductSizeDeleteResponse, ProductSortOn, ProductTagsViewResponse, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequest, ProductTemplateExportResponse, ProductVariants, ProductVariantsResponse, Properties, PTErrorResponse, Quantities, QuantitiesArticle, Quantity, QuantityBase, RawProduct, RawProductListingResponse, ReturnConfig, ReturnConfig1, ReturnConfig2, ReturnConfigResponse, SearchableAttribute, SearchKeywordResult, SecondLevelChild, SellerPhoneNumber, SEOData, SeoDetail, SetSize, SingleCategoryResponse, SingleProductResponse, Size, SizeDistribution, SizeGuideResponse, StoreAssignResponse, StoreDetail, StoreMeta, SuccessResponse, SuccessResponse1, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplatesResponse, TemplatesValidationResponse, TemplateValidationData, ThirdLevelChild, Trader, Trader1, Trader2, UpdateCollection, UpdatedResponse, UpdateSearchConfigurationRequest, UpdateSearchConfigurationResponse, UserCommon, UserDetail, UserDetail1, UserInfo, UserInfo1, UserSerializer, UserSerializer1, UserSerializer2, UserSerializer3, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponse, WeightResponse1, PageType };
|
|
3061
|
+
export { Action, ActionPage, AllowSingleRequest, AllSizes, AppCatalogConfiguration, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMeta, ApplicationItemMOQ, ApplicationItemSEO, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, ApplicationProductListingResponse, ApplicationStoreJson, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutocompleteAction, AutoCompleteMedia, AutocompletePageAction, AutocompleteResult, BannerImage, Brand, BrandItem, BrandListingResponse, BrandMeta, BrandMeta1, BulkAssetResponse, BulkHsnResponse, BulkHsnUpsert, BulkInventoryGet, BulkInventoryGetItems, BulkJob, BulkProductRequest, BulkResponse, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponse, CategoriesResponse, Category, CategoryCreateResponse, CategoryItems, CategoryListingResponse, CategoryMapping, CategoryMappingValues, CategoryRequestBody, CategoryResponse, CategoryUpdateResponse, Child, CollectionBadge, CollectionBanner, CollectionCreateResponse, CollectionDetailResponse, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, CompanyMeta1, CompanyOptIn, ConfigErrorResponse, ConfigSuccessResponse, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponse, CreateCollection, CreateSearchConfigurationRequest, CreateSearchConfigurationResponse, CreateSearchKeyword, CrossSellingData, CrossSellingResponse, CustomOrder, DateMeta, DefaultKeyRequest, DeleteResponse, DeleteSearchConfigurationResponse, Department, DepartmentCategoryTree, DepartmentCreateErrorResponse, DepartmentCreateResponse, DepartmentCreateUpdate, DepartmentErrorResponse, DepartmentIdentifier, DepartmentModel, DepartmentResponse, DepartmentsResponse, DimensionResponse, DimensionResponse1, Document, EntityConfiguration, ErrorResponse, FilerList, GenderDetail, GetAddressSerializer, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponse, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponse, GetCollectionListingResponse, GetCollectionQueryOptionResponse, GetCompanySerializer, GetConfigMetadataResponse, GetConfigResponse, GetDepartment, GetInventories, GetInventoriesResponse, GetLocationSerializer, GetOptInPlatform, GetProductBundleCreateResponse, GetProductBundleListingResponse, GetProductBundleResponse, GetProducts, GetSearchConfigurationResponse, GetSearchWordsData, GetSearchWordsDetailResponse, GetSearchWordsResponse, GlobalValidation, GTIN, Guide, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HSNCodesResponse, HSNData, HSNDataInsertV2, HsnUpsert, Image, ImageUrls, InventoryBulkRequest, InventoryConfig, InventoryCreateRequest, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponse, InventoryExportQuantityFilter, InventoryExportRequest, InventoryExportResponse, InventoryFailedReason, InventoryJobDetailResponse, InventoryJobFilters, InventoryJobPayload, InventoryPage, InventoryPayload, InventoryRequest, InventoryRequestSchemaV2, InventoryResponse, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, InventorySellerResponse, InventorySet, InventoryStockResponse, InventoryUpdateResponse, InventoryValidationResponse, InvoiceCredSerializer, InvoiceDetailsSerializer, InvSize, ItemQuery, Items, LimitedProductData, ListSizeGuide, LocationDayWiseSerializer, LocationIntegrationType, LocationListSerializer, LocationManagerSerializer, LocationTimingSerializer, Logo, ManufacturerResponse, ManufacturerResponse1, Media, Media1, Media2, Meta, MetaDataListingFilterMetaResponse, MetaDataListingFilterResponse, MetaDataListingResponse, MetaDataListingSortMetaResponse, MetaDataListingSortResponse, MetaFields, Metatags, MOQData, NetQuantity, NetQuantityResponse, NextSchedule, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptInPostRequest, OptinStoreDetails, OwnerAppItemResponse, Page, PageResponse, PageResponseType, Price, Price1, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponse, Product, ProductAttributesResponse, ProductBrand, ProductBulkAssets, ProductBulkRequest, ProductBulkRequestList, ProductBundleItem, ProductBundleRequest, ProductBundleUpdateRequest, ProductConfigurationDownloads, ProductCreateUpdateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponse, ProductFilters, ProductFiltersKey, ProductFiltersValue, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductListingResponseV2, ProductPublish, ProductPublish1, ProductPublished, ProductReturnConfigSerializer, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponse, ProductSizeDeleteResponse, ProductSortOn, ProductTagsViewResponse, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequest, ProductTemplateExportResponse, ProductVariants, ProductVariantsResponse, Properties, PTErrorResponse, Quantities, QuantitiesArticle, Quantity, QuantityBase, RawProduct, RawProductListingResponse, ReturnConfig, ReturnConfig1, ReturnConfig2, ReturnConfigResponse, SearchableAttribute, SearchKeywordResult, SecondLevelChild, SellerPhoneNumber, SEOData, SeoDetail, SetSize, SingleCategoryResponse, SingleProductResponse, Sitemap, Size, SizeDistribution, SizeGuideResponse, SizePromotionThreshold, StoreAssignResponse, StoreDetail, StoreMeta, SuccessResponse, SuccessResponse1, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplatesResponse, TemplatesValidationResponse, TemplateValidationData, ThirdLevelChild, Trader, Trader1, Trader2, UpdateCollection, UpdatedResponse, UpdateSearchConfigurationRequest, UpdateSearchConfigurationResponse, UserCommon, UserDetail, UserDetail1, UserInfo, UserInfo1, UserSerializer, UserSerializer1, UserSerializer2, UserSerializer3, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponse, WeightResponse1, PageType };
|
|
3019
3062
|
}
|
|
3020
3063
|
/** @returns {Action} */
|
|
3021
3064
|
declare function Action(): Action;
|
|
@@ -3167,6 +3210,11 @@ type ApplicationItemMeta = {
|
|
|
3167
3210
|
* for the item
|
|
3168
3211
|
*/
|
|
3169
3212
|
seo?: ApplicationItemSEO;
|
|
3213
|
+
/**
|
|
3214
|
+
* - Size level
|
|
3215
|
+
* promotion limitation information for item
|
|
3216
|
+
*/
|
|
3217
|
+
size_promotion_threshold?: SizePromotionThreshold;
|
|
3170
3218
|
};
|
|
3171
3219
|
/** @returns {ApplicationItemMOQ} */
|
|
3172
3220
|
declare function ApplicationItemMOQ(): ApplicationItemMOQ;
|
|
@@ -3197,6 +3245,30 @@ type ApplicationItemSEO = {
|
|
|
3197
3245
|
*/
|
|
3198
3246
|
title?: string;
|
|
3199
3247
|
};
|
|
3248
|
+
/** @returns {ApplicationItemSeoAction} */
|
|
3249
|
+
declare function ApplicationItemSeoAction(): ApplicationItemSeoAction;
|
|
3250
|
+
type ApplicationItemSeoAction = {
|
|
3251
|
+
page?: any;
|
|
3252
|
+
type?: string;
|
|
3253
|
+
};
|
|
3254
|
+
/** @returns {ApplicationItemSeoBreadcrumbs} */
|
|
3255
|
+
declare function ApplicationItemSeoBreadcrumbs(): ApplicationItemSeoBreadcrumbs;
|
|
3256
|
+
type ApplicationItemSeoBreadcrumbs = {
|
|
3257
|
+
action?: ApplicationItemSeoAction[];
|
|
3258
|
+
url?: string;
|
|
3259
|
+
};
|
|
3260
|
+
/** @returns {ApplicationItemSeoMetaTagItem} */
|
|
3261
|
+
declare function ApplicationItemSeoMetaTagItem(): ApplicationItemSeoMetaTagItem;
|
|
3262
|
+
type ApplicationItemSeoMetaTagItem = {
|
|
3263
|
+
key?: string;
|
|
3264
|
+
value?: string;
|
|
3265
|
+
};
|
|
3266
|
+
/** @returns {ApplicationItemSeoMetaTags} */
|
|
3267
|
+
declare function ApplicationItemSeoMetaTags(): ApplicationItemSeoMetaTags;
|
|
3268
|
+
type ApplicationItemSeoMetaTags = {
|
|
3269
|
+
items?: ApplicationItemSeoMetaTagItem[];
|
|
3270
|
+
title?: string;
|
|
3271
|
+
};
|
|
3200
3272
|
/** @returns {ApplicationProductListingResponse} */
|
|
3201
3273
|
declare function ApplicationProductListingResponse(): ApplicationProductListingResponse;
|
|
3202
3274
|
type ApplicationProductListingResponse = {
|
|
@@ -5848,6 +5920,12 @@ type MetaFields = {
|
|
|
5848
5920
|
*/
|
|
5849
5921
|
value: string;
|
|
5850
5922
|
};
|
|
5923
|
+
/** @returns {Metatags} */
|
|
5924
|
+
declare function Metatags(): Metatags;
|
|
5925
|
+
type Metatags = {
|
|
5926
|
+
items?: ApplicationItemSeoMetaTags[];
|
|
5927
|
+
title?: string;
|
|
5928
|
+
};
|
|
5851
5929
|
/** @returns {MOQData} */
|
|
5852
5930
|
declare function MOQData(): MOQData;
|
|
5853
5931
|
type MOQData = {
|
|
@@ -6836,13 +6914,19 @@ type SellerPhoneNumber = {
|
|
|
6836
6914
|
/** @returns {SEOData} */
|
|
6837
6915
|
declare function SEOData(): SEOData;
|
|
6838
6916
|
type SEOData = {
|
|
6917
|
+
breadcrumbs?: ApplicationItemSeoBreadcrumbs[];
|
|
6839
6918
|
description?: string;
|
|
6919
|
+
meta_tags?: Metatags[];
|
|
6920
|
+
sitemap?: Sitemap;
|
|
6840
6921
|
title?: string;
|
|
6841
6922
|
};
|
|
6842
6923
|
/** @returns {SeoDetail} */
|
|
6843
6924
|
declare function SeoDetail(): SeoDetail;
|
|
6844
6925
|
type SeoDetail = {
|
|
6926
|
+
breadcrumbs?: ApplicationItemSeoBreadcrumbs[];
|
|
6845
6927
|
description?: string;
|
|
6928
|
+
meta_tags?: Metatags[];
|
|
6929
|
+
sitemap?: any;
|
|
6846
6930
|
title?: string;
|
|
6847
6931
|
};
|
|
6848
6932
|
/** @returns {SetSize} */
|
|
@@ -6861,6 +6945,12 @@ declare function SingleProductResponse(): SingleProductResponse;
|
|
|
6861
6945
|
type SingleProductResponse = {
|
|
6862
6946
|
data?: ProductSchemaV2;
|
|
6863
6947
|
};
|
|
6948
|
+
/** @returns {Sitemap} */
|
|
6949
|
+
declare function Sitemap(): Sitemap;
|
|
6950
|
+
type Sitemap = {
|
|
6951
|
+
frequency?: string;
|
|
6952
|
+
priority?: number;
|
|
6953
|
+
};
|
|
6864
6954
|
/** @returns {Size} */
|
|
6865
6955
|
declare function Size(): Size;
|
|
6866
6956
|
type Size = {
|
|
@@ -6891,6 +6981,12 @@ type SizeGuideResponse = {
|
|
|
6891
6981
|
tag?: string;
|
|
6892
6982
|
title?: string;
|
|
6893
6983
|
};
|
|
6984
|
+
/** @returns {SizePromotionThreshold} */
|
|
6985
|
+
declare function SizePromotionThreshold(): SizePromotionThreshold;
|
|
6986
|
+
type SizePromotionThreshold = {
|
|
6987
|
+
threshold_type?: string;
|
|
6988
|
+
threshold_value?: number;
|
|
6989
|
+
};
|
|
6894
6990
|
/** @returns {StoreAssignResponse} */
|
|
6895
6991
|
declare function StoreAssignResponse(): StoreAssignResponse;
|
|
6896
6992
|
type StoreAssignResponse = {
|
|
@@ -128,6 +128,8 @@ const Joi = require("joi");
|
|
|
128
128
|
* @property {ApplicationItemMOQ} [moq] - Minimum Order Quantity information for the item
|
|
129
129
|
* @property {ApplicationItemSEO} [seo] - Search Engine Optimization information
|
|
130
130
|
* for the item
|
|
131
|
+
* @property {SizePromotionThreshold} [size_promotion_threshold] - Size level
|
|
132
|
+
* promotion limitation information for item
|
|
131
133
|
*/
|
|
132
134
|
|
|
133
135
|
/**
|
|
@@ -144,6 +146,30 @@ const Joi = require("joi");
|
|
|
144
146
|
* @property {string} [title] - The SEO title of the item
|
|
145
147
|
*/
|
|
146
148
|
|
|
149
|
+
/**
|
|
150
|
+
* @typedef ApplicationItemSeoAction
|
|
151
|
+
* @property {Object} [page]
|
|
152
|
+
* @property {string} [type]
|
|
153
|
+
*/
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* @typedef ApplicationItemSeoBreadcrumbs
|
|
157
|
+
* @property {ApplicationItemSeoAction[]} [action]
|
|
158
|
+
* @property {string} [url]
|
|
159
|
+
*/
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* @typedef ApplicationItemSeoMetaTagItem
|
|
163
|
+
* @property {string} [key]
|
|
164
|
+
* @property {string} [value]
|
|
165
|
+
*/
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* @typedef ApplicationItemSeoMetaTags
|
|
169
|
+
* @property {ApplicationItemSeoMetaTagItem[]} [items]
|
|
170
|
+
* @property {string} [title]
|
|
171
|
+
*/
|
|
172
|
+
|
|
147
173
|
/**
|
|
148
174
|
* @typedef ApplicationProductListingResponse
|
|
149
175
|
* @property {ProductFilters[]} [filters]
|
|
@@ -2051,6 +2077,12 @@ const Joi = require("joi");
|
|
|
2051
2077
|
* string and length should not exceed 100 characters.
|
|
2052
2078
|
*/
|
|
2053
2079
|
|
|
2080
|
+
/**
|
|
2081
|
+
* @typedef Metatags
|
|
2082
|
+
* @property {ApplicationItemSeoMetaTags[]} [items]
|
|
2083
|
+
* @property {string} [title]
|
|
2084
|
+
*/
|
|
2085
|
+
|
|
2054
2086
|
/**
|
|
2055
2087
|
* @typedef MOQData
|
|
2056
2088
|
* @property {number} [increment_unit]
|
|
@@ -2924,13 +2956,19 @@ const Joi = require("joi");
|
|
|
2924
2956
|
|
|
2925
2957
|
/**
|
|
2926
2958
|
* @typedef SEOData
|
|
2959
|
+
* @property {ApplicationItemSeoBreadcrumbs[]} [breadcrumbs]
|
|
2927
2960
|
* @property {string} [description]
|
|
2961
|
+
* @property {Metatags[]} [meta_tags]
|
|
2962
|
+
* @property {Sitemap} [sitemap]
|
|
2928
2963
|
* @property {string} [title]
|
|
2929
2964
|
*/
|
|
2930
2965
|
|
|
2931
2966
|
/**
|
|
2932
2967
|
* @typedef SeoDetail
|
|
2968
|
+
* @property {ApplicationItemSeoBreadcrumbs[]} [breadcrumbs]
|
|
2933
2969
|
* @property {string} [description]
|
|
2970
|
+
* @property {Metatags[]} [meta_tags]
|
|
2971
|
+
* @property {Object} [sitemap]
|
|
2934
2972
|
* @property {string} [title]
|
|
2935
2973
|
*/
|
|
2936
2974
|
|
|
@@ -2950,6 +2988,12 @@ const Joi = require("joi");
|
|
|
2950
2988
|
* @property {ProductSchemaV2} [data]
|
|
2951
2989
|
*/
|
|
2952
2990
|
|
|
2991
|
+
/**
|
|
2992
|
+
* @typedef Sitemap
|
|
2993
|
+
* @property {string} [frequency]
|
|
2994
|
+
* @property {number} [priority]
|
|
2995
|
+
*/
|
|
2996
|
+
|
|
2953
2997
|
/**
|
|
2954
2998
|
* @typedef Size
|
|
2955
2999
|
* @property {string} [display]
|
|
@@ -2980,6 +3024,12 @@ const Joi = require("joi");
|
|
|
2980
3024
|
* @property {string} [title]
|
|
2981
3025
|
*/
|
|
2982
3026
|
|
|
3027
|
+
/**
|
|
3028
|
+
* @typedef SizePromotionThreshold
|
|
3029
|
+
* @property {string} [threshold_type]
|
|
3030
|
+
* @property {number} [threshold_value]
|
|
3031
|
+
*/
|
|
3032
|
+
|
|
2983
3033
|
/**
|
|
2984
3034
|
* @typedef StoreAssignResponse
|
|
2985
3035
|
* @property {string} [_id]
|
|
@@ -3509,6 +3559,7 @@ class CatalogPlatformModel {
|
|
|
3509
3559
|
is_gift: Joi.boolean(),
|
|
3510
3560
|
moq: CatalogPlatformModel.ApplicationItemMOQ(),
|
|
3511
3561
|
seo: CatalogPlatformModel.ApplicationItemSEO(),
|
|
3562
|
+
size_promotion_threshold: CatalogPlatformModel.SizePromotionThreshold(),
|
|
3512
3563
|
});
|
|
3513
3564
|
}
|
|
3514
3565
|
|
|
@@ -3529,6 +3580,42 @@ class CatalogPlatformModel {
|
|
|
3529
3580
|
});
|
|
3530
3581
|
}
|
|
3531
3582
|
|
|
3583
|
+
/** @returns {ApplicationItemSeoAction} */
|
|
3584
|
+
static ApplicationItemSeoAction() {
|
|
3585
|
+
return Joi.object({
|
|
3586
|
+
page: Joi.any(),
|
|
3587
|
+
type: Joi.string().allow(""),
|
|
3588
|
+
});
|
|
3589
|
+
}
|
|
3590
|
+
|
|
3591
|
+
/** @returns {ApplicationItemSeoBreadcrumbs} */
|
|
3592
|
+
static ApplicationItemSeoBreadcrumbs() {
|
|
3593
|
+
return Joi.object({
|
|
3594
|
+
action: Joi.array().items(
|
|
3595
|
+
CatalogPlatformModel.ApplicationItemSeoAction()
|
|
3596
|
+
),
|
|
3597
|
+
url: Joi.string().allow(""),
|
|
3598
|
+
});
|
|
3599
|
+
}
|
|
3600
|
+
|
|
3601
|
+
/** @returns {ApplicationItemSeoMetaTagItem} */
|
|
3602
|
+
static ApplicationItemSeoMetaTagItem() {
|
|
3603
|
+
return Joi.object({
|
|
3604
|
+
key: Joi.string().allow(""),
|
|
3605
|
+
value: Joi.string().allow(""),
|
|
3606
|
+
});
|
|
3607
|
+
}
|
|
3608
|
+
|
|
3609
|
+
/** @returns {ApplicationItemSeoMetaTags} */
|
|
3610
|
+
static ApplicationItemSeoMetaTags() {
|
|
3611
|
+
return Joi.object({
|
|
3612
|
+
items: Joi.array().items(
|
|
3613
|
+
CatalogPlatformModel.ApplicationItemSeoMetaTagItem()
|
|
3614
|
+
),
|
|
3615
|
+
title: Joi.string().allow(""),
|
|
3616
|
+
});
|
|
3617
|
+
}
|
|
3618
|
+
|
|
3532
3619
|
/** @returns {ApplicationProductListingResponse} */
|
|
3533
3620
|
static ApplicationProductListingResponse() {
|
|
3534
3621
|
return Joi.object({
|
|
@@ -5814,6 +5901,16 @@ class CatalogPlatformModel {
|
|
|
5814
5901
|
});
|
|
5815
5902
|
}
|
|
5816
5903
|
|
|
5904
|
+
/** @returns {Metatags} */
|
|
5905
|
+
static Metatags() {
|
|
5906
|
+
return Joi.object({
|
|
5907
|
+
items: Joi.array().items(
|
|
5908
|
+
CatalogPlatformModel.ApplicationItemSeoMetaTags()
|
|
5909
|
+
),
|
|
5910
|
+
title: Joi.string().allow(""),
|
|
5911
|
+
});
|
|
5912
|
+
}
|
|
5913
|
+
|
|
5817
5914
|
/** @returns {MOQData} */
|
|
5818
5915
|
static MOQData() {
|
|
5819
5916
|
return Joi.object({
|
|
@@ -6835,7 +6932,12 @@ class CatalogPlatformModel {
|
|
|
6835
6932
|
/** @returns {SEOData} */
|
|
6836
6933
|
static SEOData() {
|
|
6837
6934
|
return Joi.object({
|
|
6935
|
+
breadcrumbs: Joi.array().items(
|
|
6936
|
+
CatalogPlatformModel.ApplicationItemSeoBreadcrumbs()
|
|
6937
|
+
),
|
|
6838
6938
|
description: Joi.string().allow(""),
|
|
6939
|
+
meta_tags: Joi.array().items(CatalogPlatformModel.Metatags()),
|
|
6940
|
+
sitemap: CatalogPlatformModel.Sitemap(),
|
|
6839
6941
|
title: Joi.string().allow(""),
|
|
6840
6942
|
});
|
|
6841
6943
|
}
|
|
@@ -6843,7 +6945,12 @@ class CatalogPlatformModel {
|
|
|
6843
6945
|
/** @returns {SeoDetail} */
|
|
6844
6946
|
static SeoDetail() {
|
|
6845
6947
|
return Joi.object({
|
|
6948
|
+
breadcrumbs: Joi.array().items(
|
|
6949
|
+
CatalogPlatformModel.ApplicationItemSeoBreadcrumbs()
|
|
6950
|
+
),
|
|
6846
6951
|
description: Joi.string().allow(""),
|
|
6952
|
+
meta_tags: Joi.array().items(CatalogPlatformModel.Metatags()),
|
|
6953
|
+
sitemap: Joi.any(),
|
|
6847
6954
|
title: Joi.string().allow(""),
|
|
6848
6955
|
});
|
|
6849
6956
|
}
|
|
@@ -6870,6 +6977,14 @@ class CatalogPlatformModel {
|
|
|
6870
6977
|
});
|
|
6871
6978
|
}
|
|
6872
6979
|
|
|
6980
|
+
/** @returns {Sitemap} */
|
|
6981
|
+
static Sitemap() {
|
|
6982
|
+
return Joi.object({
|
|
6983
|
+
frequency: Joi.string().allow(""),
|
|
6984
|
+
priority: Joi.number(),
|
|
6985
|
+
});
|
|
6986
|
+
}
|
|
6987
|
+
|
|
6873
6988
|
/** @returns {Size} */
|
|
6874
6989
|
static Size() {
|
|
6875
6990
|
return Joi.object({
|
|
@@ -6906,6 +7021,14 @@ class CatalogPlatformModel {
|
|
|
6906
7021
|
});
|
|
6907
7022
|
}
|
|
6908
7023
|
|
|
7024
|
+
/** @returns {SizePromotionThreshold} */
|
|
7025
|
+
static SizePromotionThreshold() {
|
|
7026
|
+
return Joi.object({
|
|
7027
|
+
threshold_type: Joi.string().allow(""),
|
|
7028
|
+
threshold_value: Joi.number(),
|
|
7029
|
+
});
|
|
7030
|
+
}
|
|
7031
|
+
|
|
6909
7032
|
/** @returns {StoreAssignResponse} */
|
|
6910
7033
|
static StoreAssignResponse() {
|
|
6911
7034
|
return Joi.object({
|
|
@@ -94,6 +94,7 @@ export = DiscountPlatformModel;
|
|
|
94
94
|
* @property {Object} [body]
|
|
95
95
|
* @property {number} company_id
|
|
96
96
|
* @property {number} failed
|
|
97
|
+
* @property {string} file_path
|
|
97
98
|
* @property {string} file_type
|
|
98
99
|
* @property {string} stage
|
|
99
100
|
* @property {number} total
|
|
@@ -246,6 +247,7 @@ type FileJobResponse = {
|
|
|
246
247
|
body?: any;
|
|
247
248
|
company_id: number;
|
|
248
249
|
failed: number;
|
|
250
|
+
file_path: string;
|
|
249
251
|
file_type: string;
|
|
250
252
|
stage: string;
|
|
251
253
|
total: number;
|
|
@@ -104,6 +104,7 @@ const Joi = require("joi");
|
|
|
104
104
|
* @property {Object} [body]
|
|
105
105
|
* @property {number} company_id
|
|
106
106
|
* @property {number} failed
|
|
107
|
+
* @property {string} file_path
|
|
107
108
|
* @property {string} file_type
|
|
108
109
|
* @property {string} stage
|
|
109
110
|
* @property {number} total
|
|
@@ -262,6 +263,7 @@ class DiscountPlatformModel {
|
|
|
262
263
|
body: Joi.any(),
|
|
263
264
|
company_id: Joi.number().required(),
|
|
264
265
|
failed: Joi.number().required(),
|
|
266
|
+
file_path: Joi.string().allow("").required(),
|
|
265
267
|
file_type: Joi.string().allow("").required(),
|
|
266
268
|
stage: Joi.string().allow("").required(),
|
|
267
269
|
total: Joi.number().required(),
|
|
@@ -221,7 +221,7 @@ declare class Order {
|
|
|
221
221
|
* @summary:
|
|
222
222
|
* @description: Get Order Details by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
223
223
|
*/
|
|
224
|
-
getOrderById({ orderId, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
224
|
+
getOrderById({ orderId, myOrders, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
225
225
|
/**
|
|
226
226
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
227
227
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1711,12 +1711,13 @@ class Order {
|
|
|
1711
1711
|
* @description: Get Order Details by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
1712
1712
|
*/
|
|
1713
1713
|
async getOrderById(
|
|
1714
|
-
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
1714
|
+
{ orderId, myOrders, requestHeaders } = { requestHeaders: {} },
|
|
1715
1715
|
{ responseHeaders } = { responseHeaders: false }
|
|
1716
1716
|
) {
|
|
1717
1717
|
const { error } = OrderPlatformValidator.getOrderById().validate(
|
|
1718
1718
|
{
|
|
1719
1719
|
orderId,
|
|
1720
|
+
myOrders,
|
|
1720
1721
|
},
|
|
1721
1722
|
{ abortEarly: false, allowUnknown: true }
|
|
1722
1723
|
);
|
|
@@ -1728,6 +1729,7 @@ class Order {
|
|
|
1728
1729
|
const { error: warrning } = OrderPlatformValidator.getOrderById().validate(
|
|
1729
1730
|
{
|
|
1730
1731
|
orderId,
|
|
1732
|
+
myOrders,
|
|
1731
1733
|
},
|
|
1732
1734
|
{ abortEarly: false, allowUnknown: false }
|
|
1733
1735
|
);
|
|
@@ -1740,6 +1742,7 @@ class Order {
|
|
|
1740
1742
|
|
|
1741
1743
|
const query_params = {};
|
|
1742
1744
|
query_params["order_id"] = orderId;
|
|
1745
|
+
query_params["my_orders"] = myOrders;
|
|
1743
1746
|
|
|
1744
1747
|
const xHeaders = {};
|
|
1745
1748
|
|
|
@@ -282,7 +282,7 @@ export = OrderPlatformModel;
|
|
|
282
282
|
* @property {Item} [item]
|
|
283
283
|
* @property {string} [journey_type]
|
|
284
284
|
* @property {number} [line_number]
|
|
285
|
-
* @property {
|
|
285
|
+
* @property {Object} [meta]
|
|
286
286
|
* @property {number} [no_of_bags_order]
|
|
287
287
|
* @property {string} [operational_status]
|
|
288
288
|
* @property {string} [order_integration_id]
|
|
@@ -660,6 +660,7 @@ export = OrderPlatformModel;
|
|
|
660
660
|
* @property {Shipment[]} shipments
|
|
661
661
|
* @property {ShippingInfo} shipping_info
|
|
662
662
|
* @property {TaxInfo} [tax_info]
|
|
663
|
+
* @property {UserInfo} [user_info]
|
|
663
664
|
*/
|
|
664
665
|
/**
|
|
665
666
|
* @typedef CreateOrderErrorReponse
|
|
@@ -1214,7 +1215,7 @@ export = OrderPlatformModel;
|
|
|
1214
1215
|
* @property {string} [affiliate_id]
|
|
1215
1216
|
* @property {string} [cod_charges]
|
|
1216
1217
|
* @property {string} fynd_order_id
|
|
1217
|
-
* @property {
|
|
1218
|
+
* @property {Object} [meta]
|
|
1218
1219
|
* @property {string} [order_date]
|
|
1219
1220
|
* @property {string} [order_value]
|
|
1220
1221
|
* @property {string} [ordering_channel]
|
|
@@ -1508,7 +1509,7 @@ export = OrderPlatformModel;
|
|
|
1508
1509
|
* @property {boolean} [is_self_ship]
|
|
1509
1510
|
* @property {string} [journey_type]
|
|
1510
1511
|
* @property {boolean} [lock_status]
|
|
1511
|
-
* @property {
|
|
1512
|
+
* @property {Object} [meta]
|
|
1512
1513
|
* @property {string} [mode_of_payment]
|
|
1513
1514
|
* @property {string} [operational_status]
|
|
1514
1515
|
* @property {OrderDetailsData} [order]
|
|
@@ -1761,6 +1762,7 @@ export = OrderPlatformModel;
|
|
|
1761
1762
|
* @property {LineItem[]} line_items
|
|
1762
1763
|
* @property {number} location_id
|
|
1763
1764
|
* @property {Object} [meta]
|
|
1765
|
+
* @property {string} [order_type]
|
|
1764
1766
|
* @property {number} [priority]
|
|
1765
1767
|
* @property {ProcessingDates} [processing_dates]
|
|
1766
1768
|
*/
|
|
@@ -2008,6 +2010,7 @@ export = OrderPlatformModel;
|
|
|
2008
2010
|
* @typedef ShipmentStatusData
|
|
2009
2011
|
* @property {string[]} [bag_list]
|
|
2010
2012
|
* @property {string} [created_at]
|
|
2013
|
+
* @property {string} [current_shipment_status]
|
|
2011
2014
|
* @property {string} [display_name]
|
|
2012
2015
|
* @property {number} [id]
|
|
2013
2016
|
* @property {Object} [meta]
|
|
@@ -2303,6 +2306,7 @@ export = OrderPlatformModel;
|
|
|
2303
2306
|
* @typedef UserDataInfo
|
|
2304
2307
|
* @property {string} [avis_user_id]
|
|
2305
2308
|
* @property {string} [email]
|
|
2309
|
+
* @property {string} [external_customer_id]
|
|
2306
2310
|
* @property {string} [first_name]
|
|
2307
2311
|
* @property {string} [gender]
|
|
2308
2312
|
* @property {boolean} [is_anonymous_user]
|
|
@@ -2310,6 +2314,7 @@ export = OrderPlatformModel;
|
|
|
2310
2314
|
* @property {string} [mobile]
|
|
2311
2315
|
* @property {string} [name]
|
|
2312
2316
|
* @property {number} [uid]
|
|
2317
|
+
* @property {string} [user_oid]
|
|
2313
2318
|
*/
|
|
2314
2319
|
/**
|
|
2315
2320
|
* @typedef UserDetailsData
|
|
@@ -2326,6 +2331,16 @@ export = OrderPlatformModel;
|
|
|
2326
2331
|
* @property {string} pincode
|
|
2327
2332
|
* @property {string} state
|
|
2328
2333
|
*/
|
|
2334
|
+
/**
|
|
2335
|
+
* @typedef UserInfo
|
|
2336
|
+
* @property {string} email
|
|
2337
|
+
* @property {string} first_name
|
|
2338
|
+
* @property {string} [gender]
|
|
2339
|
+
* @property {string} [last_name]
|
|
2340
|
+
* @property {string} mobile
|
|
2341
|
+
* @property {string} [user_id]
|
|
2342
|
+
* @property {string} [user_type]
|
|
2343
|
+
*/
|
|
2329
2344
|
/**
|
|
2330
2345
|
* @typedef VerifyMobileOTP
|
|
2331
2346
|
* @property {string} fynd_order_id
|
|
@@ -2360,7 +2375,7 @@ export = OrderPlatformModel;
|
|
|
2360
2375
|
declare class OrderPlatformModel {
|
|
2361
2376
|
}
|
|
2362
2377
|
declare namespace OrderPlatformModel {
|
|
2363
|
-
export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, B2BPODetails, BagConfigs, BagDetailsPlatformResponse, BagGST, BagGSTDetails, BagMeta, BagPaymentMethods, BagReturnableCancelableStatus, BagReturnableCancelableStatus1, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, BillingStaffDetails, Brand, BulkActionTemplate, BulkActionTemplateResponse, BulkReportsDownloadFailedResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, CompanyDetails, ContactDetails, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, CurrentStatus, DataUpdates, Dates, DebugInfo, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EinvoiceInfo, EInvoicePortalDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceRetryShipmentData, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, FiltersInfo, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GiftCard, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceInfo, Item, ItemCriterias, LaneConfigResponse, LineItem, LocationDetails, LockData, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderMeta, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PageDetails, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PlatformUserDetails, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, ReturnConfig1, RoleBaseStateTransitionMapping, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentItemMeta, ShipmentListingBrand, ShipmentListingChannel, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TrackingList, TransactionData, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetailsData, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight };
|
|
2378
|
+
export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, B2BPODetails, BagConfigs, BagDetailsPlatformResponse, BagGST, BagGSTDetails, BagMeta, BagPaymentMethods, BagReturnableCancelableStatus, BagReturnableCancelableStatus1, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, BillingStaffDetails, Brand, BulkActionTemplate, BulkActionTemplateResponse, BulkReportsDownloadFailedResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, CompanyDetails, ContactDetails, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, CurrentStatus, DataUpdates, Dates, DebugInfo, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EinvoiceInfo, EInvoicePortalDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceRetryShipmentData, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, FiltersInfo, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GiftCard, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceInfo, Item, ItemCriterias, LaneConfigResponse, LineItem, LocationDetails, LockData, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderMeta, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PageDetails, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PlatformUserDetails, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, ReturnConfig1, RoleBaseStateTransitionMapping, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentItemMeta, ShipmentListingBrand, ShipmentListingChannel, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TrackingList, TransactionData, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetailsData, UserInfo, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight };
|
|
2364
2379
|
}
|
|
2365
2380
|
/** @returns {ActionInfo} */
|
|
2366
2381
|
declare function ActionInfo(): ActionInfo;
|
|
@@ -2676,7 +2691,7 @@ type BagDetailsPlatformResponse = {
|
|
|
2676
2691
|
item?: Item;
|
|
2677
2692
|
journey_type?: string;
|
|
2678
2693
|
line_number?: number;
|
|
2679
|
-
meta?:
|
|
2694
|
+
meta?: any;
|
|
2680
2695
|
no_of_bags_order?: number;
|
|
2681
2696
|
operational_status?: string;
|
|
2682
2697
|
order_integration_id?: string;
|
|
@@ -3189,6 +3204,7 @@ type CreateOrderAPI = {
|
|
|
3189
3204
|
shipments: Shipment[];
|
|
3190
3205
|
shipping_info: ShippingInfo;
|
|
3191
3206
|
tax_info?: TaxInfo;
|
|
3207
|
+
user_info?: UserInfo;
|
|
3192
3208
|
};
|
|
3193
3209
|
/** @returns {CreateOrderErrorReponse} */
|
|
3194
3210
|
declare function CreateOrderErrorReponse(): CreateOrderErrorReponse;
|
|
@@ -3878,7 +3894,7 @@ type OrderDetailsData = {
|
|
|
3878
3894
|
affiliate_id?: string;
|
|
3879
3895
|
cod_charges?: string;
|
|
3880
3896
|
fynd_order_id: string;
|
|
3881
|
-
meta?:
|
|
3897
|
+
meta?: any;
|
|
3882
3898
|
order_date?: string;
|
|
3883
3899
|
order_value?: string;
|
|
3884
3900
|
ordering_channel?: string;
|
|
@@ -4220,7 +4236,7 @@ type PlatformShipment = {
|
|
|
4220
4236
|
is_self_ship?: boolean;
|
|
4221
4237
|
journey_type?: string;
|
|
4222
4238
|
lock_status?: boolean;
|
|
4223
|
-
meta?:
|
|
4239
|
+
meta?: any;
|
|
4224
4240
|
mode_of_payment?: string;
|
|
4225
4241
|
operational_status?: string;
|
|
4226
4242
|
order?: OrderDetailsData;
|
|
@@ -4537,6 +4553,7 @@ type Shipment = {
|
|
|
4537
4553
|
line_items: LineItem[];
|
|
4538
4554
|
location_id: number;
|
|
4539
4555
|
meta?: any;
|
|
4556
|
+
order_type?: string;
|
|
4540
4557
|
priority?: number;
|
|
4541
4558
|
processing_dates?: ProcessingDates;
|
|
4542
4559
|
};
|
|
@@ -4810,6 +4827,7 @@ declare function ShipmentStatusData(): ShipmentStatusData;
|
|
|
4810
4827
|
type ShipmentStatusData = {
|
|
4811
4828
|
bag_list?: string[];
|
|
4812
4829
|
created_at?: string;
|
|
4830
|
+
current_shipment_status?: string;
|
|
4813
4831
|
display_name?: string;
|
|
4814
4832
|
id?: number;
|
|
4815
4833
|
meta?: any;
|
|
@@ -5198,6 +5216,7 @@ declare function UserDataInfo(): UserDataInfo;
|
|
|
5198
5216
|
type UserDataInfo = {
|
|
5199
5217
|
avis_user_id?: string;
|
|
5200
5218
|
email?: string;
|
|
5219
|
+
external_customer_id?: string;
|
|
5201
5220
|
first_name?: string;
|
|
5202
5221
|
gender?: string;
|
|
5203
5222
|
is_anonymous_user?: boolean;
|
|
@@ -5205,6 +5224,7 @@ type UserDataInfo = {
|
|
|
5205
5224
|
mobile?: string;
|
|
5206
5225
|
name?: string;
|
|
5207
5226
|
uid?: number;
|
|
5227
|
+
user_oid?: string;
|
|
5208
5228
|
};
|
|
5209
5229
|
/** @returns {UserDetailsData} */
|
|
5210
5230
|
declare function UserDetailsData(): UserDetailsData;
|
|
@@ -5222,6 +5242,17 @@ type UserDetailsData = {
|
|
|
5222
5242
|
pincode: string;
|
|
5223
5243
|
state: string;
|
|
5224
5244
|
};
|
|
5245
|
+
/** @returns {UserInfo} */
|
|
5246
|
+
declare function UserInfo(): UserInfo;
|
|
5247
|
+
type UserInfo = {
|
|
5248
|
+
email: string;
|
|
5249
|
+
first_name: string;
|
|
5250
|
+
gender?: string;
|
|
5251
|
+
last_name?: string;
|
|
5252
|
+
mobile: string;
|
|
5253
|
+
user_id?: string;
|
|
5254
|
+
user_type?: string;
|
|
5255
|
+
};
|
|
5225
5256
|
/** @returns {VerifyMobileOTP} */
|
|
5226
5257
|
declare function VerifyMobileOTP(): VerifyMobileOTP;
|
|
5227
5258
|
type VerifyMobileOTP = {
|
|
@@ -313,7 +313,7 @@ const Joi = require("joi");
|
|
|
313
313
|
* @property {Item} [item]
|
|
314
314
|
* @property {string} [journey_type]
|
|
315
315
|
* @property {number} [line_number]
|
|
316
|
-
* @property {
|
|
316
|
+
* @property {Object} [meta]
|
|
317
317
|
* @property {number} [no_of_bags_order]
|
|
318
318
|
* @property {string} [operational_status]
|
|
319
319
|
* @property {string} [order_integration_id]
|
|
@@ -727,6 +727,7 @@ const Joi = require("joi");
|
|
|
727
727
|
* @property {Shipment[]} shipments
|
|
728
728
|
* @property {ShippingInfo} shipping_info
|
|
729
729
|
* @property {TaxInfo} [tax_info]
|
|
730
|
+
* @property {UserInfo} [user_info]
|
|
730
731
|
*/
|
|
731
732
|
|
|
732
733
|
/**
|
|
@@ -1347,7 +1348,7 @@ const Joi = require("joi");
|
|
|
1347
1348
|
* @property {string} [affiliate_id]
|
|
1348
1349
|
* @property {string} [cod_charges]
|
|
1349
1350
|
* @property {string} fynd_order_id
|
|
1350
|
-
* @property {
|
|
1351
|
+
* @property {Object} [meta]
|
|
1351
1352
|
* @property {string} [order_date]
|
|
1352
1353
|
* @property {string} [order_value]
|
|
1353
1354
|
* @property {string} [ordering_channel]
|
|
@@ -1668,7 +1669,7 @@ const Joi = require("joi");
|
|
|
1668
1669
|
* @property {boolean} [is_self_ship]
|
|
1669
1670
|
* @property {string} [journey_type]
|
|
1670
1671
|
* @property {boolean} [lock_status]
|
|
1671
|
-
* @property {
|
|
1672
|
+
* @property {Object} [meta]
|
|
1672
1673
|
* @property {string} [mode_of_payment]
|
|
1673
1674
|
* @property {string} [operational_status]
|
|
1674
1675
|
* @property {OrderDetailsData} [order]
|
|
@@ -1955,6 +1956,7 @@ const Joi = require("joi");
|
|
|
1955
1956
|
* @property {LineItem[]} line_items
|
|
1956
1957
|
* @property {number} location_id
|
|
1957
1958
|
* @property {Object} [meta]
|
|
1959
|
+
* @property {string} [order_type]
|
|
1958
1960
|
* @property {number} [priority]
|
|
1959
1961
|
* @property {ProcessingDates} [processing_dates]
|
|
1960
1962
|
*/
|
|
@@ -2222,6 +2224,7 @@ const Joi = require("joi");
|
|
|
2222
2224
|
* @typedef ShipmentStatusData
|
|
2223
2225
|
* @property {string[]} [bag_list]
|
|
2224
2226
|
* @property {string} [created_at]
|
|
2227
|
+
* @property {string} [current_shipment_status]
|
|
2225
2228
|
* @property {string} [display_name]
|
|
2226
2229
|
* @property {number} [id]
|
|
2227
2230
|
* @property {Object} [meta]
|
|
@@ -2550,6 +2553,7 @@ const Joi = require("joi");
|
|
|
2550
2553
|
* @typedef UserDataInfo
|
|
2551
2554
|
* @property {string} [avis_user_id]
|
|
2552
2555
|
* @property {string} [email]
|
|
2556
|
+
* @property {string} [external_customer_id]
|
|
2553
2557
|
* @property {string} [first_name]
|
|
2554
2558
|
* @property {string} [gender]
|
|
2555
2559
|
* @property {boolean} [is_anonymous_user]
|
|
@@ -2557,6 +2561,7 @@ const Joi = require("joi");
|
|
|
2557
2561
|
* @property {string} [mobile]
|
|
2558
2562
|
* @property {string} [name]
|
|
2559
2563
|
* @property {number} [uid]
|
|
2564
|
+
* @property {string} [user_oid]
|
|
2560
2565
|
*/
|
|
2561
2566
|
|
|
2562
2567
|
/**
|
|
@@ -2575,6 +2580,17 @@ const Joi = require("joi");
|
|
|
2575
2580
|
* @property {string} state
|
|
2576
2581
|
*/
|
|
2577
2582
|
|
|
2583
|
+
/**
|
|
2584
|
+
* @typedef UserInfo
|
|
2585
|
+
* @property {string} email
|
|
2586
|
+
* @property {string} first_name
|
|
2587
|
+
* @property {string} [gender]
|
|
2588
|
+
* @property {string} [last_name]
|
|
2589
|
+
* @property {string} mobile
|
|
2590
|
+
* @property {string} [user_id]
|
|
2591
|
+
* @property {string} [user_type]
|
|
2592
|
+
*/
|
|
2593
|
+
|
|
2578
2594
|
/**
|
|
2579
2595
|
* @typedef VerifyMobileOTP
|
|
2580
2596
|
* @property {string} fynd_order_id
|
|
@@ -2990,7 +3006,7 @@ class OrderPlatformModel {
|
|
|
2990
3006
|
item: OrderPlatformModel.Item(),
|
|
2991
3007
|
journey_type: Joi.string().allow("").allow(null),
|
|
2992
3008
|
line_number: Joi.number().allow(null),
|
|
2993
|
-
meta:
|
|
3009
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
2994
3010
|
no_of_bags_order: Joi.number().allow(null),
|
|
2995
3011
|
operational_status: Joi.string().allow("").allow(null),
|
|
2996
3012
|
order_integration_id: Joi.string().allow("").allow(null),
|
|
@@ -3475,6 +3491,7 @@ class OrderPlatformModel {
|
|
|
3475
3491
|
shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
|
|
3476
3492
|
shipping_info: OrderPlatformModel.ShippingInfo().required(),
|
|
3477
3493
|
tax_info: OrderPlatformModel.TaxInfo(),
|
|
3494
|
+
user_info: OrderPlatformModel.UserInfo(),
|
|
3478
3495
|
});
|
|
3479
3496
|
}
|
|
3480
3497
|
|
|
@@ -4235,7 +4252,7 @@ class OrderPlatformModel {
|
|
|
4235
4252
|
affiliate_id: Joi.string().allow("").allow(null),
|
|
4236
4253
|
cod_charges: Joi.string().allow("").allow(null),
|
|
4237
4254
|
fynd_order_id: Joi.string().allow("").required(),
|
|
4238
|
-
meta:
|
|
4255
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4239
4256
|
order_date: Joi.string().allow("").allow(null),
|
|
4240
4257
|
order_value: Joi.string().allow("").allow(null),
|
|
4241
4258
|
ordering_channel: Joi.string().allow("").allow(null),
|
|
@@ -4613,7 +4630,7 @@ class OrderPlatformModel {
|
|
|
4613
4630
|
is_self_ship: Joi.boolean().allow(null),
|
|
4614
4631
|
journey_type: Joi.string().allow("").allow(null),
|
|
4615
4632
|
lock_status: Joi.boolean().allow(null),
|
|
4616
|
-
meta:
|
|
4633
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4617
4634
|
mode_of_payment: Joi.string().allow("").allow(null),
|
|
4618
4635
|
operational_status: Joi.string().allow("").allow(null),
|
|
4619
4636
|
order: OrderPlatformModel.OrderDetailsData(),
|
|
@@ -4969,6 +4986,7 @@ class OrderPlatformModel {
|
|
|
4969
4986
|
line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
|
|
4970
4987
|
location_id: Joi.number().required(),
|
|
4971
4988
|
meta: Joi.any(),
|
|
4989
|
+
order_type: Joi.string().allow(""),
|
|
4972
4990
|
priority: Joi.number(),
|
|
4973
4991
|
processing_dates: OrderPlatformModel.ProcessingDates(),
|
|
4974
4992
|
});
|
|
@@ -5284,6 +5302,7 @@ class OrderPlatformModel {
|
|
|
5284
5302
|
return Joi.object({
|
|
5285
5303
|
bag_list: Joi.array().items(Joi.string().allow("")),
|
|
5286
5304
|
created_at: Joi.string().allow("").allow(null),
|
|
5305
|
+
current_shipment_status: Joi.string().allow("").allow(null),
|
|
5287
5306
|
display_name: Joi.string().allow("").allow(null),
|
|
5288
5307
|
id: Joi.number().allow(null),
|
|
5289
5308
|
meta: Joi.any().allow(null),
|
|
@@ -5674,6 +5693,7 @@ class OrderPlatformModel {
|
|
|
5674
5693
|
return Joi.object({
|
|
5675
5694
|
avis_user_id: Joi.string().allow("").allow(null),
|
|
5676
5695
|
email: Joi.string().allow("").allow(null),
|
|
5696
|
+
external_customer_id: Joi.string().allow("").allow(null),
|
|
5677
5697
|
first_name: Joi.string().allow("").allow(null),
|
|
5678
5698
|
gender: Joi.string().allow("").allow(null),
|
|
5679
5699
|
is_anonymous_user: Joi.boolean().allow(null),
|
|
@@ -5681,6 +5701,7 @@ class OrderPlatformModel {
|
|
|
5681
5701
|
mobile: Joi.string().allow("").allow(null),
|
|
5682
5702
|
name: Joi.string().allow("").allow(null),
|
|
5683
5703
|
uid: Joi.number().allow(null),
|
|
5704
|
+
user_oid: Joi.string().allow("").allow(null),
|
|
5684
5705
|
});
|
|
5685
5706
|
}
|
|
5686
5707
|
|
|
@@ -5702,6 +5723,19 @@ class OrderPlatformModel {
|
|
|
5702
5723
|
});
|
|
5703
5724
|
}
|
|
5704
5725
|
|
|
5726
|
+
/** @returns {UserInfo} */
|
|
5727
|
+
static UserInfo() {
|
|
5728
|
+
return Joi.object({
|
|
5729
|
+
email: Joi.string().allow("").required(),
|
|
5730
|
+
first_name: Joi.string().allow("").required(),
|
|
5731
|
+
gender: Joi.string().allow(""),
|
|
5732
|
+
last_name: Joi.string().allow(""),
|
|
5733
|
+
mobile: Joi.string().allow("").required(),
|
|
5734
|
+
user_id: Joi.string().allow(""),
|
|
5735
|
+
user_type: Joi.string().allow(""),
|
|
5736
|
+
});
|
|
5737
|
+
}
|
|
5738
|
+
|
|
5705
5739
|
/** @returns {VerifyMobileOTP} */
|
|
5706
5740
|
static VerifyMobileOTP() {
|
|
5707
5741
|
return Joi.object({
|
|
@@ -122,6 +122,7 @@ export = OrderPlatformValidator;
|
|
|
122
122
|
/**
|
|
123
123
|
* @typedef GetOrderByIdParam
|
|
124
124
|
* @property {string} orderId
|
|
125
|
+
* @property {boolean} [myOrders]
|
|
125
126
|
*/
|
|
126
127
|
/**
|
|
127
128
|
* @typedef GetOrdersParam
|
|
@@ -600,6 +601,7 @@ type GetLaneConfigParam = {
|
|
|
600
601
|
};
|
|
601
602
|
type GetOrderByIdParam = {
|
|
602
603
|
orderId: string;
|
|
604
|
+
myOrders?: boolean;
|
|
603
605
|
};
|
|
604
606
|
type GetOrdersParam = {
|
|
605
607
|
/**
|
|
@@ -145,6 +145,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
145
145
|
/**
|
|
146
146
|
* @typedef GetOrderByIdParam
|
|
147
147
|
* @property {string} orderId
|
|
148
|
+
* @property {boolean} [myOrders]
|
|
148
149
|
*/
|
|
149
150
|
|
|
150
151
|
/**
|
|
@@ -517,6 +518,7 @@ class OrderPlatformValidator {
|
|
|
517
518
|
static getOrderById() {
|
|
518
519
|
return Joi.object({
|
|
519
520
|
orderId: Joi.string().allow("").required(),
|
|
521
|
+
myOrders: Joi.boolean(),
|
|
520
522
|
}).required();
|
|
521
523
|
}
|
|
522
524
|
|
|
@@ -521,7 +521,7 @@ export = PaymentPlatformModel;
|
|
|
521
521
|
* @property {number} amount_captured - Amount which is captured or credited to
|
|
522
522
|
* merchant account
|
|
523
523
|
* @property {number} [amount_refunded]
|
|
524
|
-
* @property {AddressDetail} billing_address - Billing address
|
|
524
|
+
* @property {AddressDetail} [billing_address] - Billing address
|
|
525
525
|
* @property {string} cancel_url - Cancel url sent by Fynd platform at the time
|
|
526
526
|
* of payment creation
|
|
527
527
|
* @property {boolean} [captured] - Whether the payment is captured (credited to
|
|
@@ -541,7 +541,7 @@ export = PaymentPlatformModel;
|
|
|
541
541
|
* that actual payment is not created.
|
|
542
542
|
* @property {string} payment_id - Unique transaction id generated by payment gateway
|
|
543
543
|
* @property {Object[]} payment_methods - Method of payment
|
|
544
|
-
* @property {AddressDetail} shipping_address - Shipping address
|
|
544
|
+
* @property {AddressDetail} [shipping_address] - Shipping address
|
|
545
545
|
* @property {string} status - Stautus of the payment
|
|
546
546
|
* @property {string} success_url - Success url sent by Fynd platform at the
|
|
547
547
|
* time of payment creation
|
|
@@ -552,6 +552,7 @@ export = PaymentPlatformModel;
|
|
|
552
552
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
553
553
|
* etc.) against which payment_session was initiated. This is generated by
|
|
554
554
|
* Fynd payments platform and is unique.
|
|
555
|
+
* @property {Object} [meta] - Meta
|
|
555
556
|
* @property {OrderDetail} order_details - The details of the order.
|
|
556
557
|
* @property {PaymentSessionDetail[]} payment_details - The payment details with
|
|
557
558
|
* the schema `PaymentSessionDetail`.
|
|
@@ -746,6 +747,7 @@ export = PaymentPlatformModel;
|
|
|
746
747
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
747
748
|
* etc.) against which payment_session was initiated. This is generated by
|
|
748
749
|
* Fynd payments platform and is unique.
|
|
750
|
+
* @property {Object} [meta] - Meta
|
|
749
751
|
* @property {PaymentSessionDetail} payment_details - Details of the payment
|
|
750
752
|
* @property {RefundSessionDetail[]} [refund_details] - Details of the refund
|
|
751
753
|
* @property {string} status - The status of the refund.
|
|
@@ -2300,7 +2302,7 @@ type PaymentSessionDetail = {
|
|
|
2300
2302
|
/**
|
|
2301
2303
|
* - Billing address
|
|
2302
2304
|
*/
|
|
2303
|
-
billing_address
|
|
2305
|
+
billing_address?: AddressDetail;
|
|
2304
2306
|
/**
|
|
2305
2307
|
* - Cancel url sent by Fynd platform at the time
|
|
2306
2308
|
* of payment creation
|
|
@@ -2359,7 +2361,7 @@ type PaymentSessionDetail = {
|
|
|
2359
2361
|
/**
|
|
2360
2362
|
* - Shipping address
|
|
2361
2363
|
*/
|
|
2362
|
-
shipping_address
|
|
2364
|
+
shipping_address?: AddressDetail;
|
|
2363
2365
|
/**
|
|
2364
2366
|
* - Stautus of the payment
|
|
2365
2367
|
*/
|
|
@@ -2383,6 +2385,10 @@ type PaymentSessionRequestSerializer = {
|
|
|
2383
2385
|
* Fynd payments platform and is unique.
|
|
2384
2386
|
*/
|
|
2385
2387
|
gid: string;
|
|
2388
|
+
/**
|
|
2389
|
+
* - Meta
|
|
2390
|
+
*/
|
|
2391
|
+
meta?: any;
|
|
2386
2392
|
/**
|
|
2387
2393
|
* - The details of the order.
|
|
2388
2394
|
*/
|
|
@@ -2913,6 +2919,10 @@ type RefundSessionRequestSerializer = {
|
|
|
2913
2919
|
* Fynd payments platform and is unique.
|
|
2914
2920
|
*/
|
|
2915
2921
|
gid: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* - Meta
|
|
2924
|
+
*/
|
|
2925
|
+
meta?: any;
|
|
2916
2926
|
/**
|
|
2917
2927
|
* - Details of the payment
|
|
2918
2928
|
*/
|
|
@@ -584,7 +584,7 @@ const Joi = require("joi");
|
|
|
584
584
|
* @property {number} amount_captured - Amount which is captured or credited to
|
|
585
585
|
* merchant account
|
|
586
586
|
* @property {number} [amount_refunded]
|
|
587
|
-
* @property {AddressDetail} billing_address - Billing address
|
|
587
|
+
* @property {AddressDetail} [billing_address] - Billing address
|
|
588
588
|
* @property {string} cancel_url - Cancel url sent by Fynd platform at the time
|
|
589
589
|
* of payment creation
|
|
590
590
|
* @property {boolean} [captured] - Whether the payment is captured (credited to
|
|
@@ -604,7 +604,7 @@ const Joi = require("joi");
|
|
|
604
604
|
* that actual payment is not created.
|
|
605
605
|
* @property {string} payment_id - Unique transaction id generated by payment gateway
|
|
606
606
|
* @property {Object[]} payment_methods - Method of payment
|
|
607
|
-
* @property {AddressDetail} shipping_address - Shipping address
|
|
607
|
+
* @property {AddressDetail} [shipping_address] - Shipping address
|
|
608
608
|
* @property {string} status - Stautus of the payment
|
|
609
609
|
* @property {string} success_url - Success url sent by Fynd platform at the
|
|
610
610
|
* time of payment creation
|
|
@@ -616,6 +616,7 @@ const Joi = require("joi");
|
|
|
616
616
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
617
617
|
* etc.) against which payment_session was initiated. This is generated by
|
|
618
618
|
* Fynd payments platform and is unique.
|
|
619
|
+
* @property {Object} [meta] - Meta
|
|
619
620
|
* @property {OrderDetail} order_details - The details of the order.
|
|
620
621
|
* @property {PaymentSessionDetail[]} payment_details - The payment details with
|
|
621
622
|
* the schema `PaymentSessionDetail`.
|
|
@@ -831,6 +832,7 @@ const Joi = require("joi");
|
|
|
831
832
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
832
833
|
* etc.) against which payment_session was initiated. This is generated by
|
|
833
834
|
* Fynd payments platform and is unique.
|
|
835
|
+
* @property {Object} [meta] - Meta
|
|
834
836
|
* @property {PaymentSessionDetail} payment_details - Details of the payment
|
|
835
837
|
* @property {RefundSessionDetail[]} [refund_details] - Details of the refund
|
|
836
838
|
* @property {string} status - The status of the refund.
|
|
@@ -1706,7 +1708,7 @@ class PaymentPlatformModel {
|
|
|
1706
1708
|
amount: Joi.number().required(),
|
|
1707
1709
|
amount_captured: Joi.number().required(),
|
|
1708
1710
|
amount_refunded: Joi.number(),
|
|
1709
|
-
billing_address: PaymentPlatformModel.AddressDetail()
|
|
1711
|
+
billing_address: PaymentPlatformModel.AddressDetail(),
|
|
1710
1712
|
cancel_url: Joi.string().allow("").required(),
|
|
1711
1713
|
captured: Joi.boolean(),
|
|
1712
1714
|
created: Joi.string().allow(""),
|
|
@@ -1719,7 +1721,7 @@ class PaymentPlatformModel {
|
|
|
1719
1721
|
mode: Joi.string().allow("").required(),
|
|
1720
1722
|
payment_id: Joi.string().allow("").required(),
|
|
1721
1723
|
payment_methods: Joi.array().items(Joi.any()).required(),
|
|
1722
|
-
shipping_address: PaymentPlatformModel.AddressDetail()
|
|
1724
|
+
shipping_address: PaymentPlatformModel.AddressDetail(),
|
|
1723
1725
|
status: Joi.string().allow("").required(),
|
|
1724
1726
|
success_url: Joi.string().allow("").required(),
|
|
1725
1727
|
});
|
|
@@ -1730,6 +1732,7 @@ class PaymentPlatformModel {
|
|
|
1730
1732
|
return Joi.object({
|
|
1731
1733
|
currency: Joi.string().allow("").required(),
|
|
1732
1734
|
gid: Joi.string().allow("").required(),
|
|
1735
|
+
meta: Joi.any(),
|
|
1733
1736
|
order_details: PaymentPlatformModel.OrderDetail().required(),
|
|
1734
1737
|
payment_details: Joi.array()
|
|
1735
1738
|
.items(PaymentPlatformModel.PaymentSessionDetail())
|
|
@@ -1990,6 +1993,7 @@ class PaymentPlatformModel {
|
|
|
1990
1993
|
return Joi.object({
|
|
1991
1994
|
currency: Joi.string().allow("").required(),
|
|
1992
1995
|
gid: Joi.string().allow("").required(),
|
|
1996
|
+
meta: Joi.any(),
|
|
1993
1997
|
payment_details: PaymentPlatformModel.PaymentSessionDetail().required(),
|
|
1994
1998
|
refund_details: Joi.array().items(
|
|
1995
1999
|
PaymentPlatformModel.RefundSessionDetail()
|
|
@@ -60,13 +60,13 @@ declare class User {
|
|
|
60
60
|
*
|
|
61
61
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
62
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
63
|
-
* @returns {Promise<UserPlatformModel.
|
|
63
|
+
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
64
64
|
* Success response
|
|
65
65
|
* @name deleteActiveSessions
|
|
66
66
|
* @summary: Delete a list of all session for a user
|
|
67
67
|
* @description: Use this API to Delete a list of session of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
|
|
68
68
|
*/
|
|
69
|
-
deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
69
|
+
deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionsDeleteResponseSchema>;
|
|
70
70
|
/**
|
|
71
71
|
* @param {UserPlatformApplicationValidator.DeleteSessionParam} arg - Arg object
|
|
72
72
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -390,7 +390,7 @@ class User {
|
|
|
390
390
|
*
|
|
391
391
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
392
392
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
393
|
-
* @returns {Promise<UserPlatformModel.
|
|
393
|
+
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
394
394
|
* Success response
|
|
395
395
|
* @name deleteActiveSessions
|
|
396
396
|
* @summary: Delete a list of all session for a user
|
|
@@ -451,10 +451,10 @@ class User {
|
|
|
451
451
|
|
|
452
452
|
const {
|
|
453
453
|
error: res_error,
|
|
454
|
-
} = UserPlatformModel.
|
|
455
|
-
|
|
456
|
-
allowUnknown: false
|
|
457
|
-
|
|
454
|
+
} = UserPlatformModel.SessionsDeleteResponseSchema().validate(
|
|
455
|
+
responseData,
|
|
456
|
+
{ abortEarly: false, allowUnknown: false }
|
|
457
|
+
);
|
|
458
458
|
|
|
459
459
|
if (res_error) {
|
|
460
460
|
Logger({
|
|
@@ -200,7 +200,8 @@ export = UserPlatformModel;
|
|
|
200
200
|
*/
|
|
201
201
|
/**
|
|
202
202
|
* @typedef SessionDeleteResponseSchema
|
|
203
|
-
* @property {string
|
|
203
|
+
* @property {string} [session_id]
|
|
204
|
+
* @property {string} [user_id]
|
|
204
205
|
*/
|
|
205
206
|
/**
|
|
206
207
|
* @typedef SessionExpiry
|
|
@@ -220,6 +221,11 @@ export = UserPlatformModel;
|
|
|
220
221
|
* @typedef SessionListResponseSchema
|
|
221
222
|
* @property {SessionListResponseInfo[]} [items]
|
|
222
223
|
*/
|
|
224
|
+
/**
|
|
225
|
+
* @typedef SessionsDeleteResponseSchema
|
|
226
|
+
* @property {string[]} [session_ids]
|
|
227
|
+
* @property {string} [user_id]
|
|
228
|
+
*/
|
|
223
229
|
/**
|
|
224
230
|
* @typedef Social
|
|
225
231
|
* @property {boolean} [account_kit]
|
|
@@ -326,7 +332,7 @@ export = UserPlatformModel;
|
|
|
326
332
|
declare class UserPlatformModel {
|
|
327
333
|
}
|
|
328
334
|
declare namespace UserPlatformModel {
|
|
329
|
-
export { Accountkit, ArchiveUserRequestSchema, ArchiveUserSuccess, AuthenticationApiErrorSchema, BlockUserRequestSchema, BlockUserSuccess, CreateUserGroupSchema, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, CustomerListResponseSchema, DeleteAccountConsent, DeleteAccountReasons, Email, Facebook, FlashCard, Google, Login, LookAndFeel, MetaSchema, PaginationSchema, PartialUserGroupUpdateSchema, PhoneNumber, PlatformEmail, PlatformMobile, PlatformSchema, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, RequiredFields, SessionDeleteResponseSchema, SessionExpiry, SessionListResponseInfo, SessionListResponseSchema, Social, SocialTokens, UnDeleteUserRequestSchema, UnDeleteUserSuccess, UpdateUserGroupSchema, UpdateUserRequestSchema, UserEmails, UserGroupListResponseSchema, UserGroupResponseSchema, UserGroupUpdateData, UserPhoneNumbers, UserSchema, UserSearchResponseSchema };
|
|
335
|
+
export { Accountkit, ArchiveUserRequestSchema, ArchiveUserSuccess, AuthenticationApiErrorSchema, BlockUserRequestSchema, BlockUserSuccess, CreateUserGroupSchema, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, CustomerListResponseSchema, DeleteAccountConsent, DeleteAccountReasons, Email, Facebook, FlashCard, Google, Login, LookAndFeel, MetaSchema, PaginationSchema, PartialUserGroupUpdateSchema, PhoneNumber, PlatformEmail, PlatformMobile, PlatformSchema, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, RequiredFields, SessionDeleteResponseSchema, SessionExpiry, SessionListResponseInfo, SessionListResponseSchema, SessionsDeleteResponseSchema, Social, SocialTokens, UnDeleteUserRequestSchema, UnDeleteUserSuccess, UpdateUserGroupSchema, UpdateUserRequestSchema, UserEmails, UserGroupListResponseSchema, UserGroupResponseSchema, UserGroupUpdateData, UserPhoneNumbers, UserSchema, UserSearchResponseSchema };
|
|
330
336
|
}
|
|
331
337
|
/** @returns {Accountkit} */
|
|
332
338
|
declare function Accountkit(): Accountkit;
|
|
@@ -570,7 +576,8 @@ type RequiredFields = {
|
|
|
570
576
|
/** @returns {SessionDeleteResponseSchema} */
|
|
571
577
|
declare function SessionDeleteResponseSchema(): SessionDeleteResponseSchema;
|
|
572
578
|
type SessionDeleteResponseSchema = {
|
|
573
|
-
|
|
579
|
+
session_id?: string;
|
|
580
|
+
user_id?: string;
|
|
574
581
|
};
|
|
575
582
|
/** @returns {SessionExpiry} */
|
|
576
583
|
declare function SessionExpiry(): SessionExpiry;
|
|
@@ -593,6 +600,12 @@ declare function SessionListResponseSchema(): SessionListResponseSchema;
|
|
|
593
600
|
type SessionListResponseSchema = {
|
|
594
601
|
items?: SessionListResponseInfo[];
|
|
595
602
|
};
|
|
603
|
+
/** @returns {SessionsDeleteResponseSchema} */
|
|
604
|
+
declare function SessionsDeleteResponseSchema(): SessionsDeleteResponseSchema;
|
|
605
|
+
type SessionsDeleteResponseSchema = {
|
|
606
|
+
session_ids?: string[];
|
|
607
|
+
user_id?: string;
|
|
608
|
+
};
|
|
596
609
|
/** @returns {Social} */
|
|
597
610
|
declare function Social(): Social;
|
|
598
611
|
type Social = {
|
|
@@ -232,7 +232,8 @@ const Joi = require("joi");
|
|
|
232
232
|
|
|
233
233
|
/**
|
|
234
234
|
* @typedef SessionDeleteResponseSchema
|
|
235
|
-
* @property {string
|
|
235
|
+
* @property {string} [session_id]
|
|
236
|
+
* @property {string} [user_id]
|
|
236
237
|
*/
|
|
237
238
|
|
|
238
239
|
/**
|
|
@@ -256,6 +257,12 @@ const Joi = require("joi");
|
|
|
256
257
|
* @property {SessionListResponseInfo[]} [items]
|
|
257
258
|
*/
|
|
258
259
|
|
|
260
|
+
/**
|
|
261
|
+
* @typedef SessionsDeleteResponseSchema
|
|
262
|
+
* @property {string[]} [session_ids]
|
|
263
|
+
* @property {string} [user_id]
|
|
264
|
+
*/
|
|
265
|
+
|
|
259
266
|
/**
|
|
260
267
|
* @typedef Social
|
|
261
268
|
* @property {boolean} [account_kit]
|
|
@@ -664,7 +671,8 @@ class UserPlatformModel {
|
|
|
664
671
|
/** @returns {SessionDeleteResponseSchema} */
|
|
665
672
|
static SessionDeleteResponseSchema() {
|
|
666
673
|
return Joi.object({
|
|
667
|
-
|
|
674
|
+
session_id: Joi.string().allow(""),
|
|
675
|
+
user_id: Joi.string().allow(""),
|
|
668
676
|
});
|
|
669
677
|
}
|
|
670
678
|
|
|
@@ -695,6 +703,14 @@ class UserPlatformModel {
|
|
|
695
703
|
});
|
|
696
704
|
}
|
|
697
705
|
|
|
706
|
+
/** @returns {SessionsDeleteResponseSchema} */
|
|
707
|
+
static SessionsDeleteResponseSchema() {
|
|
708
|
+
return Joi.object({
|
|
709
|
+
session_ids: Joi.array().items(Joi.string().allow("")),
|
|
710
|
+
user_id: Joi.string().allow(""),
|
|
711
|
+
});
|
|
712
|
+
}
|
|
713
|
+
|
|
698
714
|
/** @returns {Social} */
|
|
699
715
|
static Social() {
|
|
700
716
|
return Joi.object({
|