@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.4
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/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +27 -1
- package/sdk/application/Payment/PaymentApplicationModel.js +19 -0
- package/sdk/application/User/UserApplicationClient.d.ts +2 -2
- package/sdk/application/User/UserApplicationClient.js +4 -7
- package/sdk/application/User/UserApplicationModel.d.ts +32 -27
- package/sdk/application/User/UserApplicationModel.js +22 -32
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +26 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +34 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +44 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
- package/sdk/platform/Content/ContentPlatformModel.js +20 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +14 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +12 -0
- package/sdk/platform/Order/OrderPlatformModel.js +12 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +83 -13
- package/sdk/platform/User/UserPlatformModel.js +82 -12
|
@@ -3046,6 +3046,188 @@ class Catalog {
|
|
|
3046
3046
|
return paginator;
|
|
3047
3047
|
}
|
|
3048
3048
|
|
|
3049
|
+
/**
|
|
3050
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
3051
|
+
* - Arg object
|
|
3052
|
+
*
|
|
3053
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3054
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3055
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
|
|
3056
|
+
* Success response
|
|
3057
|
+
* @name getApplicationFilterKeys
|
|
3058
|
+
* @summary: Get filters keys of the filter options.
|
|
3059
|
+
* @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
|
|
3060
|
+
*/
|
|
3061
|
+
async getApplicationFilterKeys(
|
|
3062
|
+
{ c, requestHeaders } = { requestHeaders: {} },
|
|
3063
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3064
|
+
) {
|
|
3065
|
+
const {
|
|
3066
|
+
error,
|
|
3067
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterKeys().validate(
|
|
3068
|
+
{
|
|
3069
|
+
c,
|
|
3070
|
+
},
|
|
3071
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3072
|
+
);
|
|
3073
|
+
if (error) {
|
|
3074
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3075
|
+
}
|
|
3076
|
+
|
|
3077
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3078
|
+
const {
|
|
3079
|
+
error: warrning,
|
|
3080
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterKeys().validate(
|
|
3081
|
+
{
|
|
3082
|
+
c,
|
|
3083
|
+
},
|
|
3084
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3085
|
+
);
|
|
3086
|
+
if (warrning) {
|
|
3087
|
+
Logger({
|
|
3088
|
+
level: "WARN",
|
|
3089
|
+
message: `Parameter Validation warrnings for platform > Catalog > getApplicationFilterKeys \n ${warrning}`,
|
|
3090
|
+
});
|
|
3091
|
+
}
|
|
3092
|
+
|
|
3093
|
+
const query_params = {};
|
|
3094
|
+
query_params["c"] = c;
|
|
3095
|
+
|
|
3096
|
+
const response = await PlatformAPIClient.execute(
|
|
3097
|
+
this.config,
|
|
3098
|
+
"get",
|
|
3099
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/filter-options/keys`,
|
|
3100
|
+
query_params,
|
|
3101
|
+
undefined,
|
|
3102
|
+
requestHeaders,
|
|
3103
|
+
{ responseHeaders }
|
|
3104
|
+
);
|
|
3105
|
+
|
|
3106
|
+
let responseData = response;
|
|
3107
|
+
if (responseHeaders) {
|
|
3108
|
+
responseData = response[0];
|
|
3109
|
+
}
|
|
3110
|
+
|
|
3111
|
+
const {
|
|
3112
|
+
error: res_error,
|
|
3113
|
+
} = CatalogPlatformModel.GetQueryFiltersKeysResponse().validate(
|
|
3114
|
+
responseData,
|
|
3115
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3116
|
+
);
|
|
3117
|
+
|
|
3118
|
+
if (res_error) {
|
|
3119
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3120
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3121
|
+
} else {
|
|
3122
|
+
Logger({
|
|
3123
|
+
level: "WARN",
|
|
3124
|
+
message: `Response Validation Warnings for platform > Catalog > getApplicationFilterKeys \n ${res_error}`,
|
|
3125
|
+
});
|
|
3126
|
+
}
|
|
3127
|
+
}
|
|
3128
|
+
|
|
3129
|
+
return response;
|
|
3130
|
+
}
|
|
3131
|
+
|
|
3132
|
+
/**
|
|
3133
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
|
|
3134
|
+
* - Arg object
|
|
3135
|
+
*
|
|
3136
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3137
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3138
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
|
|
3139
|
+
* Success response
|
|
3140
|
+
* @name getApplicationFilterValues
|
|
3141
|
+
* @summary: Get values of the selected value for the filter options.
|
|
3142
|
+
* @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
|
|
3143
|
+
*/
|
|
3144
|
+
async getApplicationFilterValues(
|
|
3145
|
+
{ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders } = {
|
|
3146
|
+
requestHeaders: {},
|
|
3147
|
+
},
|
|
3148
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3149
|
+
) {
|
|
3150
|
+
const {
|
|
3151
|
+
error,
|
|
3152
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterValues().validate(
|
|
3153
|
+
{
|
|
3154
|
+
filterKey,
|
|
3155
|
+
c,
|
|
3156
|
+
collectionId,
|
|
3157
|
+
pageNo,
|
|
3158
|
+
pageSize,
|
|
3159
|
+
q,
|
|
3160
|
+
},
|
|
3161
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3162
|
+
);
|
|
3163
|
+
if (error) {
|
|
3164
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3165
|
+
}
|
|
3166
|
+
|
|
3167
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3168
|
+
const {
|
|
3169
|
+
error: warrning,
|
|
3170
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterValues().validate(
|
|
3171
|
+
{
|
|
3172
|
+
filterKey,
|
|
3173
|
+
c,
|
|
3174
|
+
collectionId,
|
|
3175
|
+
pageNo,
|
|
3176
|
+
pageSize,
|
|
3177
|
+
q,
|
|
3178
|
+
},
|
|
3179
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3180
|
+
);
|
|
3181
|
+
if (warrning) {
|
|
3182
|
+
Logger({
|
|
3183
|
+
level: "WARN",
|
|
3184
|
+
message: `Parameter Validation warrnings for platform > Catalog > getApplicationFilterValues \n ${warrning}`,
|
|
3185
|
+
});
|
|
3186
|
+
}
|
|
3187
|
+
|
|
3188
|
+
const query_params = {};
|
|
3189
|
+
query_params["c"] = c;
|
|
3190
|
+
query_params["collection_id"] = collectionId;
|
|
3191
|
+
query_params["page_no"] = pageNo;
|
|
3192
|
+
query_params["page_size"] = pageSize;
|
|
3193
|
+
query_params["q"] = q;
|
|
3194
|
+
|
|
3195
|
+
const response = await PlatformAPIClient.execute(
|
|
3196
|
+
this.config,
|
|
3197
|
+
"get",
|
|
3198
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/filter-options/${filterKey}/values`,
|
|
3199
|
+
query_params,
|
|
3200
|
+
undefined,
|
|
3201
|
+
requestHeaders,
|
|
3202
|
+
{ responseHeaders }
|
|
3203
|
+
);
|
|
3204
|
+
|
|
3205
|
+
let responseData = response;
|
|
3206
|
+
if (responseHeaders) {
|
|
3207
|
+
responseData = response[0];
|
|
3208
|
+
}
|
|
3209
|
+
|
|
3210
|
+
const {
|
|
3211
|
+
error: res_error,
|
|
3212
|
+
} = CatalogPlatformModel.GetQueryFiltersValuesResponse().validate(
|
|
3213
|
+
responseData,
|
|
3214
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3215
|
+
);
|
|
3216
|
+
|
|
3217
|
+
if (res_error) {
|
|
3218
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3219
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3220
|
+
} else {
|
|
3221
|
+
Logger({
|
|
3222
|
+
level: "WARN",
|
|
3223
|
+
message: `Response Validation Warnings for platform > Catalog > getApplicationFilterValues \n ${res_error}`,
|
|
3224
|
+
});
|
|
3225
|
+
}
|
|
3226
|
+
}
|
|
3227
|
+
|
|
3228
|
+
return response;
|
|
3229
|
+
}
|
|
3230
|
+
|
|
3049
3231
|
/**
|
|
3050
3232
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
3051
3233
|
* - Arg object
|
|
@@ -212,6 +212,29 @@ export = CatalogPlatformApplicationValidator;
|
|
|
212
212
|
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
213
213
|
* search department by name.
|
|
214
214
|
*/
|
|
215
|
+
/**
|
|
216
|
+
* @typedef GetApplicationFilterKeysParam
|
|
217
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
218
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
219
|
+
* parameter in this format.
|
|
220
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
221
|
+
*/
|
|
222
|
+
/**
|
|
223
|
+
* @typedef GetApplicationFilterValuesParam
|
|
224
|
+
* @property {string} filterKey - A `filter_key` is a filter key for a for which
|
|
225
|
+
* all the available filter values will returned. channel.
|
|
226
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
227
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
228
|
+
* parameter in this format.
|
|
229
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
230
|
+
* @property {string} [collectionId] - A `collection_id` is a unique identifier
|
|
231
|
+
* for a particular collection. channel.
|
|
232
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
233
|
+
* set of results
|
|
234
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
235
|
+
* Default is 10.
|
|
236
|
+
* @property {string} [q] - Get Values filtered by q string
|
|
237
|
+
*/
|
|
215
238
|
/** @typedef GetAutocompleteConfigParam */
|
|
216
239
|
/**
|
|
217
240
|
* @typedef GetAutocompleteKeywordDetailParam
|
|
@@ -452,6 +475,10 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
452
475
|
static getApplicationCategoryListing(): GetApplicationCategoryListingParam;
|
|
453
476
|
/** @returns {GetApplicationDepartmentListingParam} */
|
|
454
477
|
static getApplicationDepartmentListing(): GetApplicationDepartmentListingParam;
|
|
478
|
+
/** @returns {GetApplicationFilterKeysParam} */
|
|
479
|
+
static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
|
|
480
|
+
/** @returns {GetApplicationFilterValuesParam} */
|
|
481
|
+
static getApplicationFilterValues(): GetApplicationFilterValuesParam;
|
|
455
482
|
/** @returns {GetAutocompleteConfigParam} */
|
|
456
483
|
static getAutocompleteConfig(): any;
|
|
457
484
|
/** @returns {GetAutocompleteKeywordDetailParam} */
|
|
@@ -520,7 +547,7 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
520
547
|
static updateSearchKeywords(): UpdateSearchKeywordsParam;
|
|
521
548
|
}
|
|
522
549
|
declare namespace CatalogPlatformApplicationValidator {
|
|
523
|
-
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
550
|
+
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
524
551
|
}
|
|
525
552
|
type AddCollectionItemsParam = {
|
|
526
553
|
/**
|
|
@@ -908,6 +935,48 @@ type GetApplicationDepartmentListingParam = {
|
|
|
908
935
|
*/
|
|
909
936
|
q?: string;
|
|
910
937
|
};
|
|
938
|
+
type GetApplicationFilterKeysParam = {
|
|
939
|
+
/**
|
|
940
|
+
* - The search filter parameters for collection items.
|
|
941
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
942
|
+
* parameter in this format.
|
|
943
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
944
|
+
*/
|
|
945
|
+
c?: string;
|
|
946
|
+
};
|
|
947
|
+
type GetApplicationFilterValuesParam = {
|
|
948
|
+
/**
|
|
949
|
+
* - A `filter_key` is a filter key for a for which
|
|
950
|
+
* all the available filter values will returned. channel.
|
|
951
|
+
*/
|
|
952
|
+
filterKey: string;
|
|
953
|
+
/**
|
|
954
|
+
* - The search filter parameters for collection items.
|
|
955
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
956
|
+
* parameter in this format.
|
|
957
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
958
|
+
*/
|
|
959
|
+
c?: string;
|
|
960
|
+
/**
|
|
961
|
+
* - A `collection_id` is a unique identifier
|
|
962
|
+
* for a particular collection. channel.
|
|
963
|
+
*/
|
|
964
|
+
collectionId?: string;
|
|
965
|
+
/**
|
|
966
|
+
* - The page number to navigate through the given
|
|
967
|
+
* set of results
|
|
968
|
+
*/
|
|
969
|
+
pageNo?: number;
|
|
970
|
+
/**
|
|
971
|
+
* - Number of items to retrieve in each page.
|
|
972
|
+
* Default is 10.
|
|
973
|
+
*/
|
|
974
|
+
pageSize?: number;
|
|
975
|
+
/**
|
|
976
|
+
* - Get Values filtered by q string
|
|
977
|
+
*/
|
|
978
|
+
q?: string;
|
|
979
|
+
};
|
|
911
980
|
type GetAutocompleteKeywordDetailParam = {
|
|
912
981
|
/**
|
|
913
982
|
* - A `id` is a unique identifier for a particular
|
|
@@ -246,6 +246,31 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
246
246
|
* search department by name.
|
|
247
247
|
*/
|
|
248
248
|
|
|
249
|
+
/**
|
|
250
|
+
* @typedef GetApplicationFilterKeysParam
|
|
251
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
252
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
253
|
+
* parameter in this format.
|
|
254
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
255
|
+
*/
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* @typedef GetApplicationFilterValuesParam
|
|
259
|
+
* @property {string} filterKey - A `filter_key` is a filter key for a for which
|
|
260
|
+
* all the available filter values will returned. channel.
|
|
261
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
262
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
263
|
+
* parameter in this format.
|
|
264
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
265
|
+
* @property {string} [collectionId] - A `collection_id` is a unique identifier
|
|
266
|
+
* for a particular collection. channel.
|
|
267
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
268
|
+
* set of results
|
|
269
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
270
|
+
* Default is 10.
|
|
271
|
+
* @property {string} [q] - Get Values filtered by q string
|
|
272
|
+
*/
|
|
273
|
+
|
|
249
274
|
/** @typedef GetAutocompleteConfigParam */
|
|
250
275
|
|
|
251
276
|
/**
|
|
@@ -719,6 +744,25 @@ class CatalogPlatformApplicationValidator {
|
|
|
719
744
|
}).required();
|
|
720
745
|
}
|
|
721
746
|
|
|
747
|
+
/** @returns {GetApplicationFilterKeysParam} */
|
|
748
|
+
static getApplicationFilterKeys() {
|
|
749
|
+
return Joi.object({
|
|
750
|
+
c: Joi.string().allow(""),
|
|
751
|
+
}).required();
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
/** @returns {GetApplicationFilterValuesParam} */
|
|
755
|
+
static getApplicationFilterValues() {
|
|
756
|
+
return Joi.object({
|
|
757
|
+
filterKey: Joi.string().allow("").required(),
|
|
758
|
+
c: Joi.string().allow(""),
|
|
759
|
+
collectionId: Joi.string().allow(""),
|
|
760
|
+
pageNo: Joi.number(),
|
|
761
|
+
pageSize: Joi.number(),
|
|
762
|
+
q: Joi.string().allow(""),
|
|
763
|
+
}).required();
|
|
764
|
+
}
|
|
765
|
+
|
|
722
766
|
/** @returns {GetAutocompleteConfigParam} */
|
|
723
767
|
static getAutocompleteConfig() {
|
|
724
768
|
return Joi.object({}).required();
|
|
@@ -1408,6 +1408,12 @@ export = CatalogPlatformModel;
|
|
|
1408
1408
|
* @typedef CommonResponseSchemaCollection
|
|
1409
1409
|
* @property {string} [message]
|
|
1410
1410
|
*/
|
|
1411
|
+
/**
|
|
1412
|
+
* @typedef GetQueryFiltersKeysResponse
|
|
1413
|
+
* @property {ProductFiltersKeysOnly[]} [filters]
|
|
1414
|
+
* @property {Object} operators
|
|
1415
|
+
* @property {ProductSortOn[]} [sort_on]
|
|
1416
|
+
*/
|
|
1411
1417
|
/**
|
|
1412
1418
|
* @typedef GetQueryFiltersResponse
|
|
1413
1419
|
* @property {ProductFilters[]} [filters]
|
|
@@ -2434,6 +2440,15 @@ export = CatalogPlatformModel;
|
|
|
2434
2440
|
* @property {ProductFiltersKey} key
|
|
2435
2441
|
* @property {ProductFiltersValue[]} values
|
|
2436
2442
|
*/
|
|
2443
|
+
/**
|
|
2444
|
+
* @typedef GetQueryFiltersValuesResponse
|
|
2445
|
+
* @property {ProductFiltersValue[]} values
|
|
2446
|
+
* @property {Page} page
|
|
2447
|
+
*/
|
|
2448
|
+
/**
|
|
2449
|
+
* @typedef ProductFiltersKeysOnly
|
|
2450
|
+
* @property {ProductFiltersKey} key
|
|
2451
|
+
*/
|
|
2437
2452
|
/**
|
|
2438
2453
|
* @typedef ProductFiltersKey
|
|
2439
2454
|
* @property {string} display
|
|
@@ -3264,7 +3279,7 @@ export = CatalogPlatformModel;
|
|
|
3264
3279
|
declare class CatalogPlatformModel {
|
|
3265
3280
|
}
|
|
3266
3281
|
declare namespace CatalogPlatformModel {
|
|
3267
|
-
export { Action, ActionPage, AllSizes, AllowSingleRequest, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponse, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, AppReturnConfigResponse, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponse, 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, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponse, CustomOrder, DateMeta, DefaultKeyRequest, DeleteAppCategoryReturnConfig, DeleteResponse, DeleteSearchConfigurationResponse, Department, DepartmentCategoryTree, DepartmentCreateErrorResponse, DepartmentCreateResponse, DepartmentCreateUpdate, DepartmentErrorResponse, DepartmentIdentifier, DepartmentModel, DepartmentResponse, DepartmentsResponse, DimensionResponse, DimensionResponse1, Document, EntityConfiguration, ErrorResponse, FilerList, RawProduct, RawProductListingResponse, GTIN, 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, GetCollectionDetailResponse, CommonResponseSchemaCollection, GetQueryFiltersResponse, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchemaV2, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponse, GetSearchWordsData, GetSearchWordsDetailResponse, GetSearchWordsResponse, GlobalValidation, Guide, HSNCodesResponse, HSNData, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, 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, ItemQuery, Items, LimitedProductData, ListSizeGuide, LocationDayWiseSerializer, LocationIntegrationType, LocationListSerializer, LocationManagerSerializer, LocationTimingSerializer, Logo, MOQData, ManufacturerResponse, ManufacturerResponse1, Media, Media1, Media2, Meta, MetaDataListingFilterMetaResponse, MetaDataListingFilterResponse, MetaDataListingResponse, MetaDataListingSortMetaResponse, MetaDataListingSortResponse, MetaFields, NetQuantity, NetQuantityResponse, NextSchedule, OptInPostRequest, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponse, PTErrorResponse, Page, PageResponse, PageResponse1, 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, ProductReturnConfigBaseSerializer, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponse, ProductSizeDeleteResponse, ProductSortOn, ProductTagsViewResponse, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequest, ProductTemplateExportResponse, ProductVariants, ProductVariantsResponse, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, ReturnConfig1, ReturnConfig2, ReturnConfigResponse, Sitemap, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, SeoDetail, SetSize, SingleCategoryResponse, SingleProductResponse, Size, SizeDistribution, SizeGuideResponse, StoreAssignResponse, StoreDetail, StoreMeta, SuccessResponse, SuccessResponse1, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateValidationData, TemplatesResponse, TemplatesValidationResponse, ThirdLevelChild, Trader, Trader1, Trader2, UpdateCollection, UpdateSearchConfigurationRequest, UpdateSearchConfigurationResponse, UpdatedResponse, UserCommon, UserDetail, UserDetail1, UserInfo, UserInfo1, UserSerializer, UserSerializer1, UserSerializer2, UserSerializer3, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponse, WeightResponse1, CreatedBy, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequest, UpdateMarketplaceOptinResponse, PageType };
|
|
3282
|
+
export { Action, ActionPage, AllSizes, AllowSingleRequest, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponse, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, AppReturnConfigResponse, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponse, 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, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponse, CustomOrder, DateMeta, DefaultKeyRequest, DeleteAppCategoryReturnConfig, DeleteResponse, DeleteSearchConfigurationResponse, Department, DepartmentCategoryTree, DepartmentCreateErrorResponse, DepartmentCreateResponse, DepartmentCreateUpdate, DepartmentErrorResponse, DepartmentIdentifier, DepartmentModel, DepartmentResponse, DepartmentsResponse, DimensionResponse, DimensionResponse1, Document, EntityConfiguration, ErrorResponse, FilerList, RawProduct, RawProductListingResponse, GTIN, 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, GetCollectionDetailResponse, CommonResponseSchemaCollection, GetQueryFiltersKeysResponse, GetQueryFiltersResponse, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchemaV2, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponse, GetSearchWordsData, GetSearchWordsDetailResponse, GetSearchWordsResponse, GlobalValidation, Guide, HSNCodesResponse, HSNData, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, 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, ItemQuery, Items, LimitedProductData, ListSizeGuide, LocationDayWiseSerializer, LocationIntegrationType, LocationListSerializer, LocationManagerSerializer, LocationTimingSerializer, Logo, MOQData, ManufacturerResponse, ManufacturerResponse1, Media, Media1, Media2, Meta, MetaDataListingFilterMetaResponse, MetaDataListingFilterResponse, MetaDataListingResponse, MetaDataListingSortMetaResponse, MetaDataListingSortResponse, MetaFields, NetQuantity, NetQuantityResponse, NextSchedule, OptInPostRequest, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponse, PTErrorResponse, Page, PageResponse, PageResponse1, PageResponseType, Price, Price1, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponse, Product, ProductAttributesResponse, ProductBrand, ProductBulkAssets, ProductBulkRequest, ProductBulkRequestList, ProductBundleItem, ProductBundleRequest, ProductBundleUpdateRequest, ProductConfigurationDownloads, ProductCreateUpdateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponse, ProductFilters, GetQueryFiltersValuesResponse, ProductFiltersKeysOnly, ProductFiltersKey, ProductFiltersValue, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductListingResponseV2, ProductPublish, ProductPublish1, ProductPublished, ProductReturnConfigSerializer, ProductReturnConfigBaseSerializer, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponse, ProductSizeDeleteResponse, ProductSortOn, ProductTagsViewResponse, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequest, ProductTemplateExportResponse, ProductVariants, ProductVariantsResponse, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, ReturnConfig1, ReturnConfig2, ReturnConfigResponse, Sitemap, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, SeoDetail, SetSize, SingleCategoryResponse, SingleProductResponse, Size, SizeDistribution, SizeGuideResponse, StoreAssignResponse, StoreDetail, StoreMeta, SuccessResponse, SuccessResponse1, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateValidationData, TemplatesResponse, TemplatesValidationResponse, ThirdLevelChild, Trader, Trader1, Trader2, UpdateCollection, UpdateSearchConfigurationRequest, UpdateSearchConfigurationResponse, UpdatedResponse, UserCommon, UserDetail, UserDetail1, UserInfo, UserInfo1, UserSerializer, UserSerializer1, UserSerializer2, UserSerializer3, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponse, WeightResponse1, CreatedBy, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequest, UpdateMarketplaceOptinResponse, PageType };
|
|
3268
3283
|
}
|
|
3269
3284
|
/** @returns {Action} */
|
|
3270
3285
|
declare function Action(): Action;
|
|
@@ -5172,6 +5187,13 @@ declare function CommonResponseSchemaCollection(): CommonResponseSchemaCollectio
|
|
|
5172
5187
|
type CommonResponseSchemaCollection = {
|
|
5173
5188
|
message?: string;
|
|
5174
5189
|
};
|
|
5190
|
+
/** @returns {GetQueryFiltersKeysResponse} */
|
|
5191
|
+
declare function GetQueryFiltersKeysResponse(): GetQueryFiltersKeysResponse;
|
|
5192
|
+
type GetQueryFiltersKeysResponse = {
|
|
5193
|
+
filters?: ProductFiltersKeysOnly[];
|
|
5194
|
+
operators: any;
|
|
5195
|
+
sort_on?: ProductSortOn[];
|
|
5196
|
+
};
|
|
5175
5197
|
/** @returns {GetQueryFiltersResponse} */
|
|
5176
5198
|
declare function GetQueryFiltersResponse(): GetQueryFiltersResponse;
|
|
5177
5199
|
type GetQueryFiltersResponse = {
|
|
@@ -6870,6 +6892,17 @@ type ProductFilters = {
|
|
|
6870
6892
|
key: ProductFiltersKey;
|
|
6871
6893
|
values: ProductFiltersValue[];
|
|
6872
6894
|
};
|
|
6895
|
+
/** @returns {GetQueryFiltersValuesResponse} */
|
|
6896
|
+
declare function GetQueryFiltersValuesResponse(): GetQueryFiltersValuesResponse;
|
|
6897
|
+
type GetQueryFiltersValuesResponse = {
|
|
6898
|
+
values: ProductFiltersValue[];
|
|
6899
|
+
page: Page;
|
|
6900
|
+
};
|
|
6901
|
+
/** @returns {ProductFiltersKeysOnly} */
|
|
6902
|
+
declare function ProductFiltersKeysOnly(): ProductFiltersKeysOnly;
|
|
6903
|
+
type ProductFiltersKeysOnly = {
|
|
6904
|
+
key: ProductFiltersKey;
|
|
6905
|
+
};
|
|
6873
6906
|
/** @returns {ProductFiltersKey} */
|
|
6874
6907
|
declare function ProductFiltersKey(): ProductFiltersKey;
|
|
6875
6908
|
type ProductFiltersKey = {
|
|
@@ -1570,6 +1570,13 @@ const Joi = require("joi");
|
|
|
1570
1570
|
* @property {string} [message]
|
|
1571
1571
|
*/
|
|
1572
1572
|
|
|
1573
|
+
/**
|
|
1574
|
+
* @typedef GetQueryFiltersKeysResponse
|
|
1575
|
+
* @property {ProductFiltersKeysOnly[]} [filters]
|
|
1576
|
+
* @property {Object} operators
|
|
1577
|
+
* @property {ProductSortOn[]} [sort_on]
|
|
1578
|
+
*/
|
|
1579
|
+
|
|
1573
1580
|
/**
|
|
1574
1581
|
* @typedef GetQueryFiltersResponse
|
|
1575
1582
|
* @property {ProductFilters[]} [filters]
|
|
@@ -2707,6 +2714,17 @@ const Joi = require("joi");
|
|
|
2707
2714
|
* @property {ProductFiltersValue[]} values
|
|
2708
2715
|
*/
|
|
2709
2716
|
|
|
2717
|
+
/**
|
|
2718
|
+
* @typedef GetQueryFiltersValuesResponse
|
|
2719
|
+
* @property {ProductFiltersValue[]} values
|
|
2720
|
+
* @property {Page} page
|
|
2721
|
+
*/
|
|
2722
|
+
|
|
2723
|
+
/**
|
|
2724
|
+
* @typedef ProductFiltersKeysOnly
|
|
2725
|
+
* @property {ProductFiltersKey} key
|
|
2726
|
+
*/
|
|
2727
|
+
|
|
2710
2728
|
/**
|
|
2711
2729
|
* @typedef ProductFiltersKey
|
|
2712
2730
|
* @property {string} display
|
|
@@ -5526,6 +5544,15 @@ class CatalogPlatformModel {
|
|
|
5526
5544
|
});
|
|
5527
5545
|
}
|
|
5528
5546
|
|
|
5547
|
+
/** @returns {GetQueryFiltersKeysResponse} */
|
|
5548
|
+
static GetQueryFiltersKeysResponse() {
|
|
5549
|
+
return Joi.object({
|
|
5550
|
+
filters: Joi.array().items(CatalogPlatformModel.ProductFiltersKeysOnly()),
|
|
5551
|
+
operators: Joi.object().pattern(/\S/, Joi.string().allow("")).required(),
|
|
5552
|
+
sort_on: Joi.array().items(CatalogPlatformModel.ProductSortOn()),
|
|
5553
|
+
});
|
|
5554
|
+
}
|
|
5555
|
+
|
|
5529
5556
|
/** @returns {GetQueryFiltersResponse} */
|
|
5530
5557
|
static GetQueryFiltersResponse() {
|
|
5531
5558
|
return Joi.object({
|
|
@@ -6864,6 +6891,23 @@ class CatalogPlatformModel {
|
|
|
6864
6891
|
});
|
|
6865
6892
|
}
|
|
6866
6893
|
|
|
6894
|
+
/** @returns {GetQueryFiltersValuesResponse} */
|
|
6895
|
+
static GetQueryFiltersValuesResponse() {
|
|
6896
|
+
return Joi.object({
|
|
6897
|
+
values: Joi.array()
|
|
6898
|
+
.items(CatalogPlatformModel.ProductFiltersValue())
|
|
6899
|
+
.required(),
|
|
6900
|
+
page: CatalogPlatformModel.Page().required(),
|
|
6901
|
+
});
|
|
6902
|
+
}
|
|
6903
|
+
|
|
6904
|
+
/** @returns {ProductFiltersKeysOnly} */
|
|
6905
|
+
static ProductFiltersKeysOnly() {
|
|
6906
|
+
return Joi.object({
|
|
6907
|
+
key: CatalogPlatformModel.ProductFiltersKey().required(),
|
|
6908
|
+
});
|
|
6909
|
+
}
|
|
6910
|
+
|
|
6867
6911
|
/** @returns {ProductFiltersKey} */
|
|
6868
6912
|
static ProductFiltersKey() {
|
|
6869
6913
|
return Joi.object({
|
|
@@ -310,8 +310,16 @@ export = ContentPlatformModel;
|
|
|
310
310
|
* @property {boolean} [active]
|
|
311
311
|
* @property {string} [display]
|
|
312
312
|
* @property {number} [sort_order]
|
|
313
|
+
* @property {CronBasedScheduleSchema} [schedule]
|
|
313
314
|
* @property {NavigationReference[]} [sub_navigation]
|
|
314
315
|
*/
|
|
316
|
+
/**
|
|
317
|
+
* @typedef CronBasedScheduleSchema
|
|
318
|
+
* @property {boolean} [enabled]
|
|
319
|
+
* @property {string} [cron]
|
|
320
|
+
* @property {string} [start]
|
|
321
|
+
* @property {string} [end]
|
|
322
|
+
*/
|
|
315
323
|
/**
|
|
316
324
|
* @typedef ConfigurationSchema
|
|
317
325
|
* @property {number} [sleep_time]
|
|
@@ -1220,7 +1228,7 @@ export = ContentPlatformModel;
|
|
|
1220
1228
|
declare class ContentPlatformModel {
|
|
1221
1229
|
}
|
|
1222
1230
|
declare namespace ContentPlatformModel {
|
|
1223
|
-
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, ActionPage, NavigationReference, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, CustomObjectJobSchema, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, GenerationEntityType, PageType };
|
|
1231
|
+
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, ActionPage, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, CustomObjectJobSchema, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, GenerationEntityType, PageType };
|
|
1224
1232
|
}
|
|
1225
1233
|
/** @returns {GenerateSEOContent} */
|
|
1226
1234
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
@@ -1576,8 +1584,17 @@ type NavigationReference = {
|
|
|
1576
1584
|
active?: boolean;
|
|
1577
1585
|
display?: string;
|
|
1578
1586
|
sort_order?: number;
|
|
1587
|
+
schedule?: CronBasedScheduleSchema;
|
|
1579
1588
|
sub_navigation?: NavigationReference[];
|
|
1580
1589
|
};
|
|
1590
|
+
/** @returns {CronBasedScheduleSchema} */
|
|
1591
|
+
declare function CronBasedScheduleSchema(): CronBasedScheduleSchema;
|
|
1592
|
+
type CronBasedScheduleSchema = {
|
|
1593
|
+
enabled?: boolean;
|
|
1594
|
+
cron?: string;
|
|
1595
|
+
start?: string;
|
|
1596
|
+
end?: string;
|
|
1597
|
+
};
|
|
1581
1598
|
/** @returns {ConfigurationSchema} */
|
|
1582
1599
|
declare function ConfigurationSchema(): ConfigurationSchema;
|
|
1583
1600
|
type ConfigurationSchema = {
|
|
@@ -353,9 +353,18 @@ const Joi = require("joi");
|
|
|
353
353
|
* @property {boolean} [active]
|
|
354
354
|
* @property {string} [display]
|
|
355
355
|
* @property {number} [sort_order]
|
|
356
|
+
* @property {CronBasedScheduleSchema} [schedule]
|
|
356
357
|
* @property {NavigationReference[]} [sub_navigation]
|
|
357
358
|
*/
|
|
358
359
|
|
|
360
|
+
/**
|
|
361
|
+
* @typedef CronBasedScheduleSchema
|
|
362
|
+
* @property {boolean} [enabled]
|
|
363
|
+
* @property {string} [cron]
|
|
364
|
+
* @property {string} [start]
|
|
365
|
+
* @property {string} [end]
|
|
366
|
+
*/
|
|
367
|
+
|
|
359
368
|
/**
|
|
360
369
|
* @typedef ConfigurationSchema
|
|
361
370
|
* @property {number} [sleep_time]
|
|
@@ -1820,10 +1829,21 @@ class ContentPlatformModel {
|
|
|
1820
1829
|
active: Joi.boolean(),
|
|
1821
1830
|
display: Joi.string().allow(""),
|
|
1822
1831
|
sort_order: Joi.number(),
|
|
1832
|
+
schedule: ContentPlatformModel.CronBasedScheduleSchema(),
|
|
1823
1833
|
sub_navigation: Joi.array().items(Joi.link("#NavigationReference")),
|
|
1824
1834
|
}).id("NavigationReference");
|
|
1825
1835
|
}
|
|
1826
1836
|
|
|
1837
|
+
/** @returns {CronBasedScheduleSchema} */
|
|
1838
|
+
static CronBasedScheduleSchema() {
|
|
1839
|
+
return Joi.object({
|
|
1840
|
+
enabled: Joi.boolean(),
|
|
1841
|
+
cron: Joi.string().allow(""),
|
|
1842
|
+
start: Joi.string().allow(""),
|
|
1843
|
+
end: Joi.string().allow(""),
|
|
1844
|
+
});
|
|
1845
|
+
}
|
|
1846
|
+
|
|
1827
1847
|
/** @returns {ConfigurationSchema} */
|
|
1828
1848
|
static ConfigurationSchema() {
|
|
1829
1849
|
return Joi.object({
|
|
@@ -153,7 +153,7 @@ declare class FileStorage {
|
|
|
153
153
|
* @summary: Get all the supported invoice pdf types
|
|
154
154
|
* @description: Get all the supported invoice pdf types such as Invoice, Label, Delivery challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
155
155
|
*/
|
|
156
|
-
getPdfTypes({ countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
156
|
+
getPdfTypes({ storeOs, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
157
157
|
/**
|
|
158
158
|
* @param {FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam} arg
|
|
159
159
|
* - Arg object
|
|
@@ -836,13 +836,14 @@ class FileStorage {
|
|
|
836
836
|
* @description: Get all the supported invoice pdf types such as Invoice, Label, Delivery challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
837
837
|
*/
|
|
838
838
|
async getPdfTypes(
|
|
839
|
-
{ countryCode, requestHeaders } = { requestHeaders: {} },
|
|
839
|
+
{ storeOs, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
840
840
|
{ responseHeaders } = { responseHeaders: false }
|
|
841
841
|
) {
|
|
842
842
|
const {
|
|
843
843
|
error,
|
|
844
844
|
} = FileStoragePlatformApplicationValidator.getPdfTypes().validate(
|
|
845
845
|
{
|
|
846
|
+
storeOs,
|
|
846
847
|
countryCode,
|
|
847
848
|
},
|
|
848
849
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -856,6 +857,7 @@ class FileStorage {
|
|
|
856
857
|
error: warrning,
|
|
857
858
|
} = FileStoragePlatformApplicationValidator.getPdfTypes().validate(
|
|
858
859
|
{
|
|
860
|
+
storeOs,
|
|
859
861
|
countryCode,
|
|
860
862
|
},
|
|
861
863
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -869,6 +871,7 @@ class FileStorage {
|
|
|
869
871
|
|
|
870
872
|
const query_params = {};
|
|
871
873
|
query_params["country_code"] = countryCode;
|
|
874
|
+
query_params["store_os"] = storeOs;
|
|
872
875
|
|
|
873
876
|
const response = await PlatformAPIClient.execute(
|
|
874
877
|
this.config,
|
|
@@ -65,6 +65,7 @@ export = FileStoragePlatformApplicationValidator;
|
|
|
65
65
|
/**
|
|
66
66
|
* @typedef GetPdfTypesParam
|
|
67
67
|
* @property {string} [countryCode]
|
|
68
|
+
* @property {boolean} storeOs
|
|
68
69
|
*/
|
|
69
70
|
/**
|
|
70
71
|
* @typedef SaveHtmlTemplateParam
|
|
@@ -193,6 +194,7 @@ type GetDefaultPdfTemplateParam = {
|
|
|
193
194
|
};
|
|
194
195
|
type GetPdfTypesParam = {
|
|
195
196
|
countryCode?: string;
|
|
197
|
+
storeOs: boolean;
|
|
196
198
|
};
|
|
197
199
|
type SaveHtmlTemplateParam = {
|
|
198
200
|
body: FileStoragePlatformModel.PdfConfig;
|