@gofynd/fdk-client-javascript 1.3.5-beta.4 → 1.3.6-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +33 -3
- package/sdk/application/Cart/CartApplicationModel.js +38 -2
- 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/OrderPlatformModel.d.ts +20 -14
- package/sdk/platform/Order/OrderPlatformModel.js +20 -14
- 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
|
@@ -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({
|
|
@@ -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,7 +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
|
+
* @property {UserInfo} [user_info]
|
|
664
664
|
*/
|
|
665
665
|
/**
|
|
666
666
|
* @typedef CreateOrderErrorReponse
|
|
@@ -1074,6 +1074,7 @@ export = OrderPlatformModel;
|
|
|
1074
1074
|
* @property {string} [external_invoice_id]
|
|
1075
1075
|
* @property {string} [invoice_url]
|
|
1076
1076
|
* @property {string} [label_url]
|
|
1077
|
+
* @property {Object} [links]
|
|
1077
1078
|
* @property {string} [store_invoice_id]
|
|
1078
1079
|
* @property {string} [updated_date]
|
|
1079
1080
|
*/
|
|
@@ -1171,7 +1172,7 @@ export = OrderPlatformModel;
|
|
|
1171
1172
|
* @property {boolean} [is_parent]
|
|
1172
1173
|
* @property {PlatformItem} [item]
|
|
1173
1174
|
* @property {number} [line_number]
|
|
1174
|
-
* @property {
|
|
1175
|
+
* @property {Object} [meta]
|
|
1175
1176
|
* @property {Object} [parent_promo_bags]
|
|
1176
1177
|
* @property {BagPaymentMethods[]} [payment_methods]
|
|
1177
1178
|
* @property {Prices} [prices]
|
|
@@ -1199,7 +1200,7 @@ export = OrderPlatformModel;
|
|
|
1199
1200
|
/**
|
|
1200
1201
|
* @typedef OrderData
|
|
1201
1202
|
* @property {string} fynd_order_id
|
|
1202
|
-
* @property {
|
|
1203
|
+
* @property {Object} [meta]
|
|
1203
1204
|
* @property {string} order_date
|
|
1204
1205
|
* @property {Object} [payment_methods]
|
|
1205
1206
|
* @property {Prices} [prices]
|
|
@@ -1215,7 +1216,7 @@ export = OrderPlatformModel;
|
|
|
1215
1216
|
* @property {string} [affiliate_id]
|
|
1216
1217
|
* @property {string} [cod_charges]
|
|
1217
1218
|
* @property {string} fynd_order_id
|
|
1218
|
-
* @property {
|
|
1219
|
+
* @property {Object} [meta]
|
|
1219
1220
|
* @property {string} [order_date]
|
|
1220
1221
|
* @property {string} [order_value]
|
|
1221
1222
|
* @property {string} [ordering_channel]
|
|
@@ -1509,7 +1510,7 @@ export = OrderPlatformModel;
|
|
|
1509
1510
|
* @property {boolean} [is_self_ship]
|
|
1510
1511
|
* @property {string} [journey_type]
|
|
1511
1512
|
* @property {boolean} [lock_status]
|
|
1512
|
-
* @property {
|
|
1513
|
+
* @property {Object} [meta]
|
|
1513
1514
|
* @property {string} [mode_of_payment]
|
|
1514
1515
|
* @property {string} [operational_status]
|
|
1515
1516
|
* @property {OrderDetailsData} [order]
|
|
@@ -1835,7 +1836,7 @@ export = OrderPlatformModel;
|
|
|
1835
1836
|
* @property {ShipmentItemFulFillingStore} [fulfilling_store]
|
|
1836
1837
|
* @property {string} [invoice_id]
|
|
1837
1838
|
* @property {boolean} [lock_status]
|
|
1838
|
-
* @property {
|
|
1839
|
+
* @property {Object} [meta]
|
|
1839
1840
|
* @property {string} [mode_of_payment]
|
|
1840
1841
|
* @property {string} [order_date]
|
|
1841
1842
|
* @property {string} order_id
|
|
@@ -2306,6 +2307,7 @@ export = OrderPlatformModel;
|
|
|
2306
2307
|
* @typedef UserDataInfo
|
|
2307
2308
|
* @property {string} [avis_user_id]
|
|
2308
2309
|
* @property {string} [email]
|
|
2310
|
+
* @property {string} [external_customer_id]
|
|
2309
2311
|
* @property {string} [first_name]
|
|
2310
2312
|
* @property {string} [gender]
|
|
2311
2313
|
* @property {boolean} [is_anonymous_user]
|
|
@@ -2313,6 +2315,7 @@ export = OrderPlatformModel;
|
|
|
2313
2315
|
* @property {string} [mobile]
|
|
2314
2316
|
* @property {string} [name]
|
|
2315
2317
|
* @property {number} [uid]
|
|
2318
|
+
* @property {string} [user_oid]
|
|
2316
2319
|
*/
|
|
2317
2320
|
/**
|
|
2318
2321
|
* @typedef UserDetailsData
|
|
@@ -2689,7 +2692,7 @@ type BagDetailsPlatformResponse = {
|
|
|
2689
2692
|
item?: Item;
|
|
2690
2693
|
journey_type?: string;
|
|
2691
2694
|
line_number?: number;
|
|
2692
|
-
meta?:
|
|
2695
|
+
meta?: any;
|
|
2693
2696
|
no_of_bags_order?: number;
|
|
2694
2697
|
operational_status?: string;
|
|
2695
2698
|
order_integration_id?: string;
|
|
@@ -3202,7 +3205,7 @@ type CreateOrderAPI = {
|
|
|
3202
3205
|
shipments: Shipment[];
|
|
3203
3206
|
shipping_info: ShippingInfo;
|
|
3204
3207
|
tax_info?: TaxInfo;
|
|
3205
|
-
user_info
|
|
3208
|
+
user_info?: UserInfo;
|
|
3206
3209
|
};
|
|
3207
3210
|
/** @returns {CreateOrderErrorReponse} */
|
|
3208
3211
|
declare function CreateOrderErrorReponse(): CreateOrderErrorReponse;
|
|
@@ -3736,6 +3739,7 @@ type InvoiceInfo = {
|
|
|
3736
3739
|
external_invoice_id?: string;
|
|
3737
3740
|
invoice_url?: string;
|
|
3738
3741
|
label_url?: string;
|
|
3742
|
+
links?: any;
|
|
3739
3743
|
store_invoice_id?: string;
|
|
3740
3744
|
updated_date?: string;
|
|
3741
3745
|
};
|
|
@@ -3843,7 +3847,7 @@ type OrderBags = {
|
|
|
3843
3847
|
is_parent?: boolean;
|
|
3844
3848
|
item?: PlatformItem;
|
|
3845
3849
|
line_number?: number;
|
|
3846
|
-
meta?:
|
|
3850
|
+
meta?: any;
|
|
3847
3851
|
parent_promo_bags?: any;
|
|
3848
3852
|
payment_methods?: BagPaymentMethods[];
|
|
3849
3853
|
prices?: Prices;
|
|
@@ -3874,7 +3878,7 @@ type OrderConfig = {
|
|
|
3874
3878
|
declare function OrderData(): OrderData;
|
|
3875
3879
|
type OrderData = {
|
|
3876
3880
|
fynd_order_id: string;
|
|
3877
|
-
meta?:
|
|
3881
|
+
meta?: any;
|
|
3878
3882
|
order_date: string;
|
|
3879
3883
|
payment_methods?: any;
|
|
3880
3884
|
prices?: Prices;
|
|
@@ -3892,7 +3896,7 @@ type OrderDetailsData = {
|
|
|
3892
3896
|
affiliate_id?: string;
|
|
3893
3897
|
cod_charges?: string;
|
|
3894
3898
|
fynd_order_id: string;
|
|
3895
|
-
meta?:
|
|
3899
|
+
meta?: any;
|
|
3896
3900
|
order_date?: string;
|
|
3897
3901
|
order_value?: string;
|
|
3898
3902
|
ordering_channel?: string;
|
|
@@ -4234,7 +4238,7 @@ type PlatformShipment = {
|
|
|
4234
4238
|
is_self_ship?: boolean;
|
|
4235
4239
|
journey_type?: string;
|
|
4236
4240
|
lock_status?: boolean;
|
|
4237
|
-
meta?:
|
|
4241
|
+
meta?: any;
|
|
4238
4242
|
mode_of_payment?: string;
|
|
4239
4243
|
operational_status?: string;
|
|
4240
4244
|
order?: OrderDetailsData;
|
|
@@ -4632,7 +4636,7 @@ type ShipmentItem = {
|
|
|
4632
4636
|
fulfilling_store?: ShipmentItemFulFillingStore;
|
|
4633
4637
|
invoice_id?: string;
|
|
4634
4638
|
lock_status?: boolean;
|
|
4635
|
-
meta?:
|
|
4639
|
+
meta?: any;
|
|
4636
4640
|
mode_of_payment?: string;
|
|
4637
4641
|
order_date?: string;
|
|
4638
4642
|
order_id: string;
|
|
@@ -5214,6 +5218,7 @@ declare function UserDataInfo(): UserDataInfo;
|
|
|
5214
5218
|
type UserDataInfo = {
|
|
5215
5219
|
avis_user_id?: string;
|
|
5216
5220
|
email?: string;
|
|
5221
|
+
external_customer_id?: string;
|
|
5217
5222
|
first_name?: string;
|
|
5218
5223
|
gender?: string;
|
|
5219
5224
|
is_anonymous_user?: boolean;
|
|
@@ -5221,6 +5226,7 @@ type UserDataInfo = {
|
|
|
5221
5226
|
mobile?: string;
|
|
5222
5227
|
name?: string;
|
|
5223
5228
|
uid?: number;
|
|
5229
|
+
user_oid?: string;
|
|
5224
5230
|
};
|
|
5225
5231
|
/** @returns {UserDetailsData} */
|
|
5226
5232
|
declare function UserDetailsData(): UserDetailsData;
|
|
@@ -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,7 +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
|
+
* @property {UserInfo} [user_info]
|
|
731
731
|
*/
|
|
732
732
|
|
|
733
733
|
/**
|
|
@@ -1192,6 +1192,7 @@ const Joi = require("joi");
|
|
|
1192
1192
|
* @property {string} [external_invoice_id]
|
|
1193
1193
|
* @property {string} [invoice_url]
|
|
1194
1194
|
* @property {string} [label_url]
|
|
1195
|
+
* @property {Object} [links]
|
|
1195
1196
|
* @property {string} [store_invoice_id]
|
|
1196
1197
|
* @property {string} [updated_date]
|
|
1197
1198
|
*/
|
|
@@ -1299,7 +1300,7 @@ const Joi = require("joi");
|
|
|
1299
1300
|
* @property {boolean} [is_parent]
|
|
1300
1301
|
* @property {PlatformItem} [item]
|
|
1301
1302
|
* @property {number} [line_number]
|
|
1302
|
-
* @property {
|
|
1303
|
+
* @property {Object} [meta]
|
|
1303
1304
|
* @property {Object} [parent_promo_bags]
|
|
1304
1305
|
* @property {BagPaymentMethods[]} [payment_methods]
|
|
1305
1306
|
* @property {Prices} [prices]
|
|
@@ -1330,7 +1331,7 @@ const Joi = require("joi");
|
|
|
1330
1331
|
/**
|
|
1331
1332
|
* @typedef OrderData
|
|
1332
1333
|
* @property {string} fynd_order_id
|
|
1333
|
-
* @property {
|
|
1334
|
+
* @property {Object} [meta]
|
|
1334
1335
|
* @property {string} order_date
|
|
1335
1336
|
* @property {Object} [payment_methods]
|
|
1336
1337
|
* @property {Prices} [prices]
|
|
@@ -1348,7 +1349,7 @@ const Joi = require("joi");
|
|
|
1348
1349
|
* @property {string} [affiliate_id]
|
|
1349
1350
|
* @property {string} [cod_charges]
|
|
1350
1351
|
* @property {string} fynd_order_id
|
|
1351
|
-
* @property {
|
|
1352
|
+
* @property {Object} [meta]
|
|
1352
1353
|
* @property {string} [order_date]
|
|
1353
1354
|
* @property {string} [order_value]
|
|
1354
1355
|
* @property {string} [ordering_channel]
|
|
@@ -1669,7 +1670,7 @@ const Joi = require("joi");
|
|
|
1669
1670
|
* @property {boolean} [is_self_ship]
|
|
1670
1671
|
* @property {string} [journey_type]
|
|
1671
1672
|
* @property {boolean} [lock_status]
|
|
1672
|
-
* @property {
|
|
1673
|
+
* @property {Object} [meta]
|
|
1673
1674
|
* @property {string} [mode_of_payment]
|
|
1674
1675
|
* @property {string} [operational_status]
|
|
1675
1676
|
* @property {OrderDetailsData} [order]
|
|
@@ -2037,7 +2038,7 @@ const Joi = require("joi");
|
|
|
2037
2038
|
* @property {ShipmentItemFulFillingStore} [fulfilling_store]
|
|
2038
2039
|
* @property {string} [invoice_id]
|
|
2039
2040
|
* @property {boolean} [lock_status]
|
|
2040
|
-
* @property {
|
|
2041
|
+
* @property {Object} [meta]
|
|
2041
2042
|
* @property {string} [mode_of_payment]
|
|
2042
2043
|
* @property {string} [order_date]
|
|
2043
2044
|
* @property {string} order_id
|
|
@@ -2553,6 +2554,7 @@ const Joi = require("joi");
|
|
|
2553
2554
|
* @typedef UserDataInfo
|
|
2554
2555
|
* @property {string} [avis_user_id]
|
|
2555
2556
|
* @property {string} [email]
|
|
2557
|
+
* @property {string} [external_customer_id]
|
|
2556
2558
|
* @property {string} [first_name]
|
|
2557
2559
|
* @property {string} [gender]
|
|
2558
2560
|
* @property {boolean} [is_anonymous_user]
|
|
@@ -2560,6 +2562,7 @@ const Joi = require("joi");
|
|
|
2560
2562
|
* @property {string} [mobile]
|
|
2561
2563
|
* @property {string} [name]
|
|
2562
2564
|
* @property {number} [uid]
|
|
2565
|
+
* @property {string} [user_oid]
|
|
2563
2566
|
*/
|
|
2564
2567
|
|
|
2565
2568
|
/**
|
|
@@ -3004,7 +3007,7 @@ class OrderPlatformModel {
|
|
|
3004
3007
|
item: OrderPlatformModel.Item(),
|
|
3005
3008
|
journey_type: Joi.string().allow("").allow(null),
|
|
3006
3009
|
line_number: Joi.number().allow(null),
|
|
3007
|
-
meta:
|
|
3010
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
3008
3011
|
no_of_bags_order: Joi.number().allow(null),
|
|
3009
3012
|
operational_status: Joi.string().allow("").allow(null),
|
|
3010
3013
|
order_integration_id: Joi.string().allow("").allow(null),
|
|
@@ -3489,7 +3492,7 @@ class OrderPlatformModel {
|
|
|
3489
3492
|
shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
|
|
3490
3493
|
shipping_info: OrderPlatformModel.ShippingInfo().required(),
|
|
3491
3494
|
tax_info: OrderPlatformModel.TaxInfo(),
|
|
3492
|
-
user_info: OrderPlatformModel.UserInfo()
|
|
3495
|
+
user_info: OrderPlatformModel.UserInfo(),
|
|
3493
3496
|
});
|
|
3494
3497
|
}
|
|
3495
3498
|
|
|
@@ -4058,6 +4061,7 @@ class OrderPlatformModel {
|
|
|
4058
4061
|
external_invoice_id: Joi.string().allow("").allow(null),
|
|
4059
4062
|
invoice_url: Joi.string().allow("").allow(null),
|
|
4060
4063
|
label_url: Joi.string().allow("").allow(null),
|
|
4064
|
+
links: Joi.object().pattern(/\S/, Joi.any()),
|
|
4061
4065
|
store_invoice_id: Joi.string().allow("").allow(null),
|
|
4062
4066
|
updated_date: Joi.string().allow("").allow(null),
|
|
4063
4067
|
});
|
|
@@ -4187,7 +4191,7 @@ class OrderPlatformModel {
|
|
|
4187
4191
|
is_parent: Joi.boolean().allow(null),
|
|
4188
4192
|
item: OrderPlatformModel.PlatformItem(),
|
|
4189
4193
|
line_number: Joi.number().allow(null),
|
|
4190
|
-
meta:
|
|
4194
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4191
4195
|
parent_promo_bags: Joi.any().allow(null),
|
|
4192
4196
|
payment_methods: Joi.array().items(
|
|
4193
4197
|
OrderPlatformModel.BagPaymentMethods()
|
|
@@ -4228,7 +4232,7 @@ class OrderPlatformModel {
|
|
|
4228
4232
|
static OrderData() {
|
|
4229
4233
|
return Joi.object({
|
|
4230
4234
|
fynd_order_id: Joi.string().allow("").required(),
|
|
4231
|
-
meta:
|
|
4235
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4232
4236
|
order_date: Joi.string().allow("").required(),
|
|
4233
4237
|
payment_methods: Joi.any().allow(null),
|
|
4234
4238
|
prices: OrderPlatformModel.Prices(),
|
|
@@ -4250,7 +4254,7 @@ class OrderPlatformModel {
|
|
|
4250
4254
|
affiliate_id: Joi.string().allow("").allow(null),
|
|
4251
4255
|
cod_charges: Joi.string().allow("").allow(null),
|
|
4252
4256
|
fynd_order_id: Joi.string().allow("").required(),
|
|
4253
|
-
meta:
|
|
4257
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4254
4258
|
order_date: Joi.string().allow("").allow(null),
|
|
4255
4259
|
order_value: Joi.string().allow("").allow(null),
|
|
4256
4260
|
ordering_channel: Joi.string().allow("").allow(null),
|
|
@@ -4628,7 +4632,7 @@ class OrderPlatformModel {
|
|
|
4628
4632
|
is_self_ship: Joi.boolean().allow(null),
|
|
4629
4633
|
journey_type: Joi.string().allow("").allow(null),
|
|
4630
4634
|
lock_status: Joi.boolean().allow(null),
|
|
4631
|
-
meta:
|
|
4635
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4632
4636
|
mode_of_payment: Joi.string().allow("").allow(null),
|
|
4633
4637
|
operational_status: Joi.string().allow("").allow(null),
|
|
4634
4638
|
order: OrderPlatformModel.OrderDetailsData(),
|
|
@@ -5087,7 +5091,7 @@ class OrderPlatformModel {
|
|
|
5087
5091
|
fulfilling_store: OrderPlatformModel.ShipmentItemFulFillingStore(),
|
|
5088
5092
|
invoice_id: Joi.string().allow("").allow(null),
|
|
5089
5093
|
lock_status: Joi.boolean().allow(null),
|
|
5090
|
-
meta:
|
|
5094
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
5091
5095
|
mode_of_payment: Joi.string().allow(""),
|
|
5092
5096
|
order_date: Joi.string().allow("").allow(null),
|
|
5093
5097
|
order_id: Joi.string().allow("").required(),
|
|
@@ -5691,6 +5695,7 @@ class OrderPlatformModel {
|
|
|
5691
5695
|
return Joi.object({
|
|
5692
5696
|
avis_user_id: Joi.string().allow("").allow(null),
|
|
5693
5697
|
email: Joi.string().allow("").allow(null),
|
|
5698
|
+
external_customer_id: Joi.string().allow("").allow(null),
|
|
5694
5699
|
first_name: Joi.string().allow("").allow(null),
|
|
5695
5700
|
gender: Joi.string().allow("").allow(null),
|
|
5696
5701
|
is_anonymous_user: Joi.boolean().allow(null),
|
|
@@ -5698,6 +5703,7 @@ class OrderPlatformModel {
|
|
|
5698
5703
|
mobile: Joi.string().allow("").allow(null),
|
|
5699
5704
|
name: Joi.string().allow("").allow(null),
|
|
5700
5705
|
uid: Joi.number().allow(null),
|
|
5706
|
+
user_oid: Joi.string().allow("").allow(null),
|
|
5701
5707
|
});
|
|
5702
5708
|
}
|
|
5703
5709
|
|
|
@@ -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 = {
|