@gofynd/fdk-client-javascript 1.3.5 → 1.3.6-beta.2
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 +2 -2
- package/sdk/application/Cart/CartApplicationModel.d.ts +33 -3
- package/sdk/application/Cart/CartApplicationModel.js +38 -2
- package/sdk/common/AxiosHelper.js +3 -3
- package/sdk/common/BaseOAuthClient.js +1 -1
- package/sdk/partner/OAuthClient.d.ts +5 -4
- package/sdk/partner/OAuthClient.js +78 -9
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +86 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +533 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +54 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +74 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +212 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +166 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformClient.js +77 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +52 -11
- package/sdk/platform/Order/OrderPlatformModel.js +60 -10
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +20 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -0
|
@@ -47,6 +47,22 @@ const Joi = require("joi");
|
|
|
47
47
|
* @property {string} [type]
|
|
48
48
|
*/
|
|
49
49
|
|
|
50
|
+
/**
|
|
51
|
+
* @typedef AppCategoryReturnConfig
|
|
52
|
+
* @property {number} category_id - Unique identifier for L3 category
|
|
53
|
+
* @property {ProductReturnConfigBaseSerializer} return_config - Return
|
|
54
|
+
* configuration details
|
|
55
|
+
*/
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* @typedef AppCategoryReturnConfigResponse
|
|
59
|
+
* @property {string} [app_id] - Channel identifier
|
|
60
|
+
* @property {number} [category_id] - Unique identifer of L3 category
|
|
61
|
+
* @property {string} [logo]
|
|
62
|
+
* @property {string} [name] - Name of L3 category
|
|
63
|
+
* @property {ProductReturnConfigBaseSerializer} [return_config]
|
|
64
|
+
*/
|
|
65
|
+
|
|
50
66
|
/**
|
|
51
67
|
* @typedef AppConfiguration
|
|
52
68
|
* @property {string} app_id
|
|
@@ -184,6 +200,19 @@ const Joi = require("joi");
|
|
|
184
200
|
* @property {Object} _custom_json
|
|
185
201
|
*/
|
|
186
202
|
|
|
203
|
+
/**
|
|
204
|
+
* @typedef AppReturnConfigResponse
|
|
205
|
+
* @property {string} [app_id] - Channel identifier
|
|
206
|
+
* @property {number} [category_count] - Count of L3 category return config set
|
|
207
|
+
* for application
|
|
208
|
+
* @property {number} [company_id] - Unique identifer of company
|
|
209
|
+
* @property {Object} [created_by] - User details
|
|
210
|
+
* @property {Object} [modified_by] - User details
|
|
211
|
+
* @property {string} [modified_on] - Modification date
|
|
212
|
+
* @property {string} [return_config_level] - Configuration level of return
|
|
213
|
+
* window category|product|no-return
|
|
214
|
+
*/
|
|
215
|
+
|
|
187
216
|
/**
|
|
188
217
|
* @typedef ArticleAssignment
|
|
189
218
|
* @property {string} [level]
|
|
@@ -342,6 +371,19 @@ const Joi = require("joi");
|
|
|
342
371
|
* @property {string} [url]
|
|
343
372
|
*/
|
|
344
373
|
|
|
374
|
+
/**
|
|
375
|
+
* @typedef BaseAppCategoryReturnConfig
|
|
376
|
+
* @property {string} app_id - Channel identifier
|
|
377
|
+
* @property {number} company_id - Unique identifer of company
|
|
378
|
+
* @property {AppCategoryReturnConfig[]} data - Category level return config details
|
|
379
|
+
*/
|
|
380
|
+
|
|
381
|
+
/**
|
|
382
|
+
* @typedef BaseAppCategoryReturnConfigResponse
|
|
383
|
+
* @property {AppCategoryReturnConfigResponse[]} [data]
|
|
384
|
+
* @property {PageResponse} [page]
|
|
385
|
+
*/
|
|
386
|
+
|
|
345
387
|
/**
|
|
346
388
|
* @typedef Brand
|
|
347
389
|
* @property {Logo} [logo]
|
|
@@ -934,6 +976,14 @@ const Joi = require("joi");
|
|
|
934
976
|
* @property {string[]} [words]
|
|
935
977
|
*/
|
|
936
978
|
|
|
979
|
+
/**
|
|
980
|
+
* @typedef CreateUpdateAppReturnConfig
|
|
981
|
+
* @property {string} app_id - Channel identifier
|
|
982
|
+
* @property {number} company_id - Unique identifer of company
|
|
983
|
+
* @property {string} return_config_level - Return configurtion Level
|
|
984
|
+
* category|product|no-return
|
|
985
|
+
*/
|
|
986
|
+
|
|
937
987
|
/**
|
|
938
988
|
* @typedef CrossSellingData
|
|
939
989
|
* @property {number} [articles]
|
|
@@ -966,6 +1016,13 @@ const Joi = require("joi");
|
|
|
966
1016
|
* @property {string} default_key
|
|
967
1017
|
*/
|
|
968
1018
|
|
|
1019
|
+
/**
|
|
1020
|
+
* @typedef DeleteAppCategoryReturnConfig
|
|
1021
|
+
* @property {string} app_id - Channel identifier
|
|
1022
|
+
* @property {number[]} category_ids - List of category_ids to be deleted.
|
|
1023
|
+
* @property {number} company_id - Unique identifer of company
|
|
1024
|
+
*/
|
|
1025
|
+
|
|
969
1026
|
/**
|
|
970
1027
|
* @typedef DeleteResponse
|
|
971
1028
|
* @property {string} [message]
|
|
@@ -2177,6 +2234,16 @@ const Joi = require("joi");
|
|
|
2177
2234
|
* @property {number} [size] - It is the size of each page.
|
|
2178
2235
|
*/
|
|
2179
2236
|
|
|
2237
|
+
/**
|
|
2238
|
+
* @typedef PageResponse1
|
|
2239
|
+
* @property {number} [current]
|
|
2240
|
+
* @property {boolean} [has_next]
|
|
2241
|
+
* @property {boolean} [has_previous]
|
|
2242
|
+
* @property {number} [item_total]
|
|
2243
|
+
* @property {number} [size]
|
|
2244
|
+
* @property {string} [type]
|
|
2245
|
+
*/
|
|
2246
|
+
|
|
2180
2247
|
/**
|
|
2181
2248
|
* @typedef PageResponseType
|
|
2182
2249
|
* @property {number} current
|
|
@@ -2578,6 +2645,13 @@ const Joi = require("joi");
|
|
|
2578
2645
|
* @property {number} [product_online_date]
|
|
2579
2646
|
*/
|
|
2580
2647
|
|
|
2648
|
+
/**
|
|
2649
|
+
* @typedef ProductReturnConfigBaseSerializer
|
|
2650
|
+
* @property {boolean} returnable - Boolean Flag for item returnable
|
|
2651
|
+
* @property {number} time - Valid return time for an item
|
|
2652
|
+
* @property {string} unit - Unit of return config days|hours
|
|
2653
|
+
*/
|
|
2654
|
+
|
|
2581
2655
|
/**
|
|
2582
2656
|
* @typedef ProductReturnConfigSerializer
|
|
2583
2657
|
* @property {boolean} [on_same_store]
|
|
@@ -3461,6 +3535,25 @@ class CatalogPlatformModel {
|
|
|
3461
3535
|
});
|
|
3462
3536
|
}
|
|
3463
3537
|
|
|
3538
|
+
/** @returns {AppCategoryReturnConfig} */
|
|
3539
|
+
static AppCategoryReturnConfig() {
|
|
3540
|
+
return Joi.object({
|
|
3541
|
+
category_id: Joi.number().required(),
|
|
3542
|
+
return_config: CatalogPlatformModel.ProductReturnConfigBaseSerializer().required(),
|
|
3543
|
+
});
|
|
3544
|
+
}
|
|
3545
|
+
|
|
3546
|
+
/** @returns {AppCategoryReturnConfigResponse} */
|
|
3547
|
+
static AppCategoryReturnConfigResponse() {
|
|
3548
|
+
return Joi.object({
|
|
3549
|
+
app_id: Joi.string().allow(""),
|
|
3550
|
+
category_id: Joi.number(),
|
|
3551
|
+
logo: Joi.string().allow(""),
|
|
3552
|
+
name: Joi.string().allow(""),
|
|
3553
|
+
return_config: CatalogPlatformModel.ProductReturnConfigBaseSerializer(),
|
|
3554
|
+
});
|
|
3555
|
+
}
|
|
3556
|
+
|
|
3464
3557
|
/** @returns {AppConfiguration} */
|
|
3465
3558
|
static AppConfiguration() {
|
|
3466
3559
|
return Joi.object({
|
|
@@ -3634,6 +3727,19 @@ class CatalogPlatformModel {
|
|
|
3634
3727
|
});
|
|
3635
3728
|
}
|
|
3636
3729
|
|
|
3730
|
+
/** @returns {AppReturnConfigResponse} */
|
|
3731
|
+
static AppReturnConfigResponse() {
|
|
3732
|
+
return Joi.object({
|
|
3733
|
+
app_id: Joi.string().allow(""),
|
|
3734
|
+
category_count: Joi.number(),
|
|
3735
|
+
company_id: Joi.number(),
|
|
3736
|
+
created_by: Joi.any(),
|
|
3737
|
+
modified_by: Joi.any(),
|
|
3738
|
+
modified_on: Joi.string().allow(""),
|
|
3739
|
+
return_config_level: Joi.string().allow(""),
|
|
3740
|
+
});
|
|
3741
|
+
}
|
|
3742
|
+
|
|
3637
3743
|
/** @returns {ArticleAssignment} */
|
|
3638
3744
|
static ArticleAssignment() {
|
|
3639
3745
|
return Joi.object({
|
|
@@ -3832,6 +3938,27 @@ class CatalogPlatformModel {
|
|
|
3832
3938
|
});
|
|
3833
3939
|
}
|
|
3834
3940
|
|
|
3941
|
+
/** @returns {BaseAppCategoryReturnConfig} */
|
|
3942
|
+
static BaseAppCategoryReturnConfig() {
|
|
3943
|
+
return Joi.object({
|
|
3944
|
+
app_id: Joi.string().allow("").required(),
|
|
3945
|
+
company_id: Joi.number().required(),
|
|
3946
|
+
data: Joi.array()
|
|
3947
|
+
.items(CatalogPlatformModel.AppCategoryReturnConfig())
|
|
3948
|
+
.required(),
|
|
3949
|
+
});
|
|
3950
|
+
}
|
|
3951
|
+
|
|
3952
|
+
/** @returns {BaseAppCategoryReturnConfigResponse} */
|
|
3953
|
+
static BaseAppCategoryReturnConfigResponse() {
|
|
3954
|
+
return Joi.object({
|
|
3955
|
+
data: Joi.array().items(
|
|
3956
|
+
CatalogPlatformModel.AppCategoryReturnConfigResponse()
|
|
3957
|
+
),
|
|
3958
|
+
page: CatalogPlatformModel.PageResponse(),
|
|
3959
|
+
});
|
|
3960
|
+
}
|
|
3961
|
+
|
|
3835
3962
|
/** @returns {Brand} */
|
|
3836
3963
|
static Brand() {
|
|
3837
3964
|
return Joi.object({
|
|
@@ -4546,6 +4673,15 @@ class CatalogPlatformModel {
|
|
|
4546
4673
|
});
|
|
4547
4674
|
}
|
|
4548
4675
|
|
|
4676
|
+
/** @returns {CreateUpdateAppReturnConfig} */
|
|
4677
|
+
static CreateUpdateAppReturnConfig() {
|
|
4678
|
+
return Joi.object({
|
|
4679
|
+
app_id: Joi.string().allow("").required(),
|
|
4680
|
+
company_id: Joi.number().required(),
|
|
4681
|
+
return_config_level: Joi.string().allow("").required(),
|
|
4682
|
+
});
|
|
4683
|
+
}
|
|
4684
|
+
|
|
4549
4685
|
/** @returns {CrossSellingData} */
|
|
4550
4686
|
static CrossSellingData() {
|
|
4551
4687
|
return Joi.object({
|
|
@@ -4588,6 +4724,15 @@ class CatalogPlatformModel {
|
|
|
4588
4724
|
});
|
|
4589
4725
|
}
|
|
4590
4726
|
|
|
4727
|
+
/** @returns {DeleteAppCategoryReturnConfig} */
|
|
4728
|
+
static DeleteAppCategoryReturnConfig() {
|
|
4729
|
+
return Joi.object({
|
|
4730
|
+
app_id: Joi.string().allow("").required(),
|
|
4731
|
+
category_ids: Joi.array().items(Joi.number()).required(),
|
|
4732
|
+
company_id: Joi.number().required(),
|
|
4733
|
+
});
|
|
4734
|
+
}
|
|
4735
|
+
|
|
4591
4736
|
/** @returns {DeleteResponse} */
|
|
4592
4737
|
static DeleteResponse() {
|
|
4593
4738
|
return Joi.object({
|
|
@@ -6026,6 +6171,18 @@ class CatalogPlatformModel {
|
|
|
6026
6171
|
});
|
|
6027
6172
|
}
|
|
6028
6173
|
|
|
6174
|
+
/** @returns {PageResponse1} */
|
|
6175
|
+
static PageResponse1() {
|
|
6176
|
+
return Joi.object({
|
|
6177
|
+
current: Joi.number(),
|
|
6178
|
+
has_next: Joi.boolean(),
|
|
6179
|
+
has_previous: Joi.boolean(),
|
|
6180
|
+
item_total: Joi.number(),
|
|
6181
|
+
size: Joi.number(),
|
|
6182
|
+
type: Joi.string().allow(""),
|
|
6183
|
+
});
|
|
6184
|
+
}
|
|
6185
|
+
|
|
6029
6186
|
/** @returns {PageResponseType} */
|
|
6030
6187
|
static PageResponseType() {
|
|
6031
6188
|
return Joi.object({
|
|
@@ -6503,6 +6660,15 @@ class CatalogPlatformModel {
|
|
|
6503
6660
|
});
|
|
6504
6661
|
}
|
|
6505
6662
|
|
|
6663
|
+
/** @returns {ProductReturnConfigBaseSerializer} */
|
|
6664
|
+
static ProductReturnConfigBaseSerializer() {
|
|
6665
|
+
return Joi.object({
|
|
6666
|
+
returnable: Joi.boolean().required(),
|
|
6667
|
+
time: Joi.number().required(),
|
|
6668
|
+
unit: Joi.string().allow("").required(),
|
|
6669
|
+
});
|
|
6670
|
+
}
|
|
6671
|
+
|
|
6506
6672
|
/** @returns {ProductReturnConfigSerializer} */
|
|
6507
6673
|
static ProductReturnConfigSerializer() {
|
|
6508
6674
|
return Joi.object({
|
|
@@ -295,6 +295,16 @@ declare class Order {
|
|
|
295
295
|
* @description: Get Role Based Actions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
|
|
296
296
|
*/
|
|
297
297
|
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
|
|
298
|
+
/**
|
|
299
|
+
* @param {OrderPlatformValidator.GetShipmentBagReasonsParam} arg - Arg object
|
|
300
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
301
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
302
|
+
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
303
|
+
* @name getShipmentBagReasons
|
|
304
|
+
* @summary: Get reasons behind full or partial cancellation of a shipment
|
|
305
|
+
* @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
|
|
306
|
+
*/
|
|
307
|
+
getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
|
|
298
308
|
/**
|
|
299
309
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
300
310
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -2092,6 +2092,83 @@ class Order {
|
|
|
2092
2092
|
return response;
|
|
2093
2093
|
}
|
|
2094
2094
|
|
|
2095
|
+
/**
|
|
2096
|
+
* @param {OrderPlatformValidator.GetShipmentBagReasonsParam} arg - Arg object
|
|
2097
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2098
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2099
|
+
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
2100
|
+
* @name getShipmentBagReasons
|
|
2101
|
+
* @summary: Get reasons behind full or partial cancellation of a shipment
|
|
2102
|
+
* @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
|
|
2103
|
+
*/
|
|
2104
|
+
async getShipmentBagReasons(
|
|
2105
|
+
{ shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
|
|
2106
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
2107
|
+
) {
|
|
2108
|
+
const { error } = OrderPlatformValidator.getShipmentBagReasons().validate(
|
|
2109
|
+
{
|
|
2110
|
+
shipmentId,
|
|
2111
|
+
lineNumber,
|
|
2112
|
+
},
|
|
2113
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2114
|
+
);
|
|
2115
|
+
if (error) {
|
|
2116
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
2117
|
+
}
|
|
2118
|
+
|
|
2119
|
+
// Showing warrnings if extra unknown parameters are found
|
|
2120
|
+
const {
|
|
2121
|
+
error: warrning,
|
|
2122
|
+
} = OrderPlatformValidator.getShipmentBagReasons().validate(
|
|
2123
|
+
{
|
|
2124
|
+
shipmentId,
|
|
2125
|
+
lineNumber,
|
|
2126
|
+
},
|
|
2127
|
+
{ abortEarly: false, allowUnknown: false }
|
|
2128
|
+
);
|
|
2129
|
+
if (warrning) {
|
|
2130
|
+
Logger({
|
|
2131
|
+
level: "WARN",
|
|
2132
|
+
message: `Parameter Validation warrnings for platform > Order > getShipmentBagReasons \n ${warrning}`,
|
|
2133
|
+
});
|
|
2134
|
+
}
|
|
2135
|
+
|
|
2136
|
+
const query_params = {};
|
|
2137
|
+
|
|
2138
|
+
const xHeaders = {};
|
|
2139
|
+
|
|
2140
|
+
const response = await PlatformAPIClient.execute(
|
|
2141
|
+
this.config,
|
|
2142
|
+
"get",
|
|
2143
|
+
`/service/platform/order/v1.0/company/${this.config.companyId}/application/<application_id>/orders/shipments/<shipment_id>/line_number/<line_number>/reasons`,
|
|
2144
|
+
query_params,
|
|
2145
|
+
undefined,
|
|
2146
|
+
{ ...xHeaders, ...requestHeaders },
|
|
2147
|
+
{ responseHeaders }
|
|
2148
|
+
);
|
|
2149
|
+
|
|
2150
|
+
let responseData = response;
|
|
2151
|
+
if (responseHeaders) {
|
|
2152
|
+
responseData = response[0];
|
|
2153
|
+
}
|
|
2154
|
+
|
|
2155
|
+
const {
|
|
2156
|
+
error: res_error,
|
|
2157
|
+
} = OrderPlatformModel.ShipmentBagReasons().validate(responseData, {
|
|
2158
|
+
abortEarly: false,
|
|
2159
|
+
allowUnknown: false,
|
|
2160
|
+
});
|
|
2161
|
+
|
|
2162
|
+
if (res_error) {
|
|
2163
|
+
Logger({
|
|
2164
|
+
level: "WARN",
|
|
2165
|
+
message: `Response Validation Warnnings for platform > Order > getShipmentBagReasons \n ${res_error}`,
|
|
2166
|
+
});
|
|
2167
|
+
}
|
|
2168
|
+
|
|
2169
|
+
return response;
|
|
2170
|
+
}
|
|
2171
|
+
|
|
2095
2172
|
/**
|
|
2096
2173
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
2097
2174
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -355,6 +355,19 @@ export = OrderPlatformModel;
|
|
|
355
355
|
* @property {number} [amount]
|
|
356
356
|
* @property {string} [mode]
|
|
357
357
|
*/
|
|
358
|
+
/**
|
|
359
|
+
* @typedef BagReasonMeta
|
|
360
|
+
* @property {boolean} [show_text_area]
|
|
361
|
+
*/
|
|
362
|
+
/**
|
|
363
|
+
* @typedef BagReasons
|
|
364
|
+
* @property {string} [display_name]
|
|
365
|
+
* @property {number} [id]
|
|
366
|
+
* @property {BagReasonMeta} [meta]
|
|
367
|
+
* @property {string[]} [qc_type]
|
|
368
|
+
* @property {QuestionSet[]} [question_set]
|
|
369
|
+
* @property {BagReasons[]} [reasons]
|
|
370
|
+
*/
|
|
358
371
|
/**
|
|
359
372
|
* @typedef BagReturnableCancelableStatus
|
|
360
373
|
* @property {boolean} can_be_cancelled
|
|
@@ -1074,6 +1087,7 @@ export = OrderPlatformModel;
|
|
|
1074
1087
|
* @property {string} [external_invoice_id]
|
|
1075
1088
|
* @property {string} [invoice_url]
|
|
1076
1089
|
* @property {string} [label_url]
|
|
1090
|
+
* @property {Object} [links]
|
|
1077
1091
|
* @property {string} [store_invoice_id]
|
|
1078
1092
|
* @property {string} [updated_date]
|
|
1079
1093
|
*/
|
|
@@ -1171,7 +1185,7 @@ export = OrderPlatformModel;
|
|
|
1171
1185
|
* @property {boolean} [is_parent]
|
|
1172
1186
|
* @property {PlatformItem} [item]
|
|
1173
1187
|
* @property {number} [line_number]
|
|
1174
|
-
* @property {
|
|
1188
|
+
* @property {Object} [meta]
|
|
1175
1189
|
* @property {Object} [parent_promo_bags]
|
|
1176
1190
|
* @property {BagPaymentMethods[]} [payment_methods]
|
|
1177
1191
|
* @property {Prices} [prices]
|
|
@@ -1199,7 +1213,7 @@ export = OrderPlatformModel;
|
|
|
1199
1213
|
/**
|
|
1200
1214
|
* @typedef OrderData
|
|
1201
1215
|
* @property {string} fynd_order_id
|
|
1202
|
-
* @property {
|
|
1216
|
+
* @property {Object} [meta]
|
|
1203
1217
|
* @property {string} order_date
|
|
1204
1218
|
* @property {Object} [payment_methods]
|
|
1205
1219
|
* @property {Prices} [prices]
|
|
@@ -1766,6 +1780,11 @@ export = OrderPlatformModel;
|
|
|
1766
1780
|
* @property {number} [priority]
|
|
1767
1781
|
* @property {ProcessingDates} [processing_dates]
|
|
1768
1782
|
*/
|
|
1783
|
+
/**
|
|
1784
|
+
* @typedef ShipmentBagReasons
|
|
1785
|
+
* @property {BagReasons[]} [reasons]
|
|
1786
|
+
* @property {boolean} [success]
|
|
1787
|
+
*/
|
|
1769
1788
|
/**
|
|
1770
1789
|
* @typedef ShipmentConfig
|
|
1771
1790
|
* @property {string} action
|
|
@@ -1835,7 +1854,7 @@ export = OrderPlatformModel;
|
|
|
1835
1854
|
* @property {ShipmentItemFulFillingStore} [fulfilling_store]
|
|
1836
1855
|
* @property {string} [invoice_id]
|
|
1837
1856
|
* @property {boolean} [lock_status]
|
|
1838
|
-
* @property {
|
|
1857
|
+
* @property {Object} [meta]
|
|
1839
1858
|
* @property {string} [mode_of_payment]
|
|
1840
1859
|
* @property {string} [order_date]
|
|
1841
1860
|
* @property {string} order_id
|
|
@@ -2333,11 +2352,11 @@ export = OrderPlatformModel;
|
|
|
2333
2352
|
*/
|
|
2334
2353
|
/**
|
|
2335
2354
|
* @typedef UserInfo
|
|
2336
|
-
* @property {string} email
|
|
2337
2355
|
* @property {string} first_name
|
|
2338
2356
|
* @property {string} [gender]
|
|
2339
2357
|
* @property {string} [last_name]
|
|
2340
|
-
* @property {string}
|
|
2358
|
+
* @property {string} primary_email
|
|
2359
|
+
* @property {string} primary_mobile_number
|
|
2341
2360
|
* @property {string} [user_id]
|
|
2342
2361
|
* @property {string} [user_type]
|
|
2343
2362
|
*/
|
|
@@ -2375,7 +2394,7 @@ export = OrderPlatformModel;
|
|
|
2375
2394
|
declare class OrderPlatformModel {
|
|
2376
2395
|
}
|
|
2377
2396
|
declare namespace OrderPlatformModel {
|
|
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 };
|
|
2397
|
+
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, BagReasonMeta, BagReasons, 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, ShipmentBagReasons, 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 };
|
|
2379
2398
|
}
|
|
2380
2399
|
/** @returns {ActionInfo} */
|
|
2381
2400
|
declare function ActionInfo(): ActionInfo;
|
|
@@ -2768,6 +2787,21 @@ type BagPaymentMethods = {
|
|
|
2768
2787
|
amount?: number;
|
|
2769
2788
|
mode?: string;
|
|
2770
2789
|
};
|
|
2790
|
+
/** @returns {BagReasonMeta} */
|
|
2791
|
+
declare function BagReasonMeta(): BagReasonMeta;
|
|
2792
|
+
type BagReasonMeta = {
|
|
2793
|
+
show_text_area?: boolean;
|
|
2794
|
+
};
|
|
2795
|
+
/** @returns {BagReasons} */
|
|
2796
|
+
declare function BagReasons(): BagReasons;
|
|
2797
|
+
type BagReasons = {
|
|
2798
|
+
display_name?: string;
|
|
2799
|
+
id?: number;
|
|
2800
|
+
meta?: BagReasonMeta;
|
|
2801
|
+
qc_type?: string[];
|
|
2802
|
+
question_set?: QuestionSet[];
|
|
2803
|
+
reasons?: BagReasons[];
|
|
2804
|
+
};
|
|
2771
2805
|
/** @returns {BagReturnableCancelableStatus} */
|
|
2772
2806
|
declare function BagReturnableCancelableStatus(): BagReturnableCancelableStatus;
|
|
2773
2807
|
type BagReturnableCancelableStatus = {
|
|
@@ -3738,6 +3772,7 @@ type InvoiceInfo = {
|
|
|
3738
3772
|
external_invoice_id?: string;
|
|
3739
3773
|
invoice_url?: string;
|
|
3740
3774
|
label_url?: string;
|
|
3775
|
+
links?: any;
|
|
3741
3776
|
store_invoice_id?: string;
|
|
3742
3777
|
updated_date?: string;
|
|
3743
3778
|
};
|
|
@@ -3845,7 +3880,7 @@ type OrderBags = {
|
|
|
3845
3880
|
is_parent?: boolean;
|
|
3846
3881
|
item?: PlatformItem;
|
|
3847
3882
|
line_number?: number;
|
|
3848
|
-
meta?:
|
|
3883
|
+
meta?: any;
|
|
3849
3884
|
parent_promo_bags?: any;
|
|
3850
3885
|
payment_methods?: BagPaymentMethods[];
|
|
3851
3886
|
prices?: Prices;
|
|
@@ -3876,7 +3911,7 @@ type OrderConfig = {
|
|
|
3876
3911
|
declare function OrderData(): OrderData;
|
|
3877
3912
|
type OrderData = {
|
|
3878
3913
|
fynd_order_id: string;
|
|
3879
|
-
meta?:
|
|
3914
|
+
meta?: any;
|
|
3880
3915
|
order_date: string;
|
|
3881
3916
|
payment_methods?: any;
|
|
3882
3917
|
prices?: Prices;
|
|
@@ -4557,6 +4592,12 @@ type Shipment = {
|
|
|
4557
4592
|
priority?: number;
|
|
4558
4593
|
processing_dates?: ProcessingDates;
|
|
4559
4594
|
};
|
|
4595
|
+
/** @returns {ShipmentBagReasons} */
|
|
4596
|
+
declare function ShipmentBagReasons(): ShipmentBagReasons;
|
|
4597
|
+
type ShipmentBagReasons = {
|
|
4598
|
+
reasons?: BagReasons[];
|
|
4599
|
+
success?: boolean;
|
|
4600
|
+
};
|
|
4560
4601
|
/** @returns {ShipmentConfig} */
|
|
4561
4602
|
declare function ShipmentConfig(): ShipmentConfig;
|
|
4562
4603
|
type ShipmentConfig = {
|
|
@@ -4634,7 +4675,7 @@ type ShipmentItem = {
|
|
|
4634
4675
|
fulfilling_store?: ShipmentItemFulFillingStore;
|
|
4635
4676
|
invoice_id?: string;
|
|
4636
4677
|
lock_status?: boolean;
|
|
4637
|
-
meta?:
|
|
4678
|
+
meta?: any;
|
|
4638
4679
|
mode_of_payment?: string;
|
|
4639
4680
|
order_date?: string;
|
|
4640
4681
|
order_id: string;
|
|
@@ -5245,11 +5286,11 @@ type UserDetailsData = {
|
|
|
5245
5286
|
/** @returns {UserInfo} */
|
|
5246
5287
|
declare function UserInfo(): UserInfo;
|
|
5247
5288
|
type UserInfo = {
|
|
5248
|
-
email: string;
|
|
5249
5289
|
first_name: string;
|
|
5250
5290
|
gender?: string;
|
|
5251
5291
|
last_name?: string;
|
|
5252
|
-
|
|
5292
|
+
primary_email: string;
|
|
5293
|
+
primary_mobile_number: string;
|
|
5253
5294
|
user_id?: string;
|
|
5254
5295
|
user_type?: string;
|
|
5255
5296
|
};
|