@gofynd/fdk-client-javascript 3.14.0 → 3.16.0
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/OrderApplicationClient.d.ts +11 -1
- package/sdk/application/Order/OrderApplicationClient.js +50 -1
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -20
- package/sdk/application/Payment/PaymentApplicationClient.js +0 -77
- package/sdk/common/Constant.d.ts +13 -4
- package/sdk/common/Constant.js +17 -6
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +5 -4
- package/sdk/partner/Theme/ThemePartnerModel.js +9 -6
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +95 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +47 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +29 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +17 -3
- package/sdk/platform/Cart/CartPlatformModel.js +14 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +13 -16
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +17 -20
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +10 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +63 -41
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -34
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformModel.d.ts +7 -6
- package/sdk/platform/Content/ContentPlatformModel.js +10 -7
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformModel.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +0 -23
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +0 -161
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -19
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +0 -24
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1 -159
- package/sdk/platform/Payment/PaymentPlatformModel.js +0 -112
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +67 -49
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +45 -42
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +5 -4
- package/sdk/platform/Theme/ThemePlatformModel.js +9 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +3 -2
- package/sdk/platform/User/UserPlatformApplicationClient.js +5 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +0 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +17 -1
- package/sdk/platform/User/UserPlatformModel.js +15 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
|
@@ -35,7 +35,8 @@ const Joi = require("joi");
|
|
|
35
35
|
* @property {boolean} [is_default] - Whether this is the default fulfillment option.
|
|
36
36
|
* @property {string} [type] - Type of fulfillment option.
|
|
37
37
|
* @property {string} [status] - Status of the fulfillment option.
|
|
38
|
-
* @property {BusinessUnit[]} [business_unit]
|
|
38
|
+
* @property {BusinessUnit[]} [business_unit] - Name of the ordering-channel or
|
|
39
|
+
* business, e.g. storefront, storeos.
|
|
39
40
|
* @property {FulfillmentStores} [fulfillment_stores]
|
|
40
41
|
* @property {FulfillmentProducts} [products]
|
|
41
42
|
* @property {CourierPartnerSchemes} [cp_schemes]
|
|
@@ -298,14 +299,14 @@ const Joi = require("joi");
|
|
|
298
299
|
* @typedef PincodeMopBulkError
|
|
299
300
|
* @property {string} [batch_id] - A unique identifier for the performed batch operation.
|
|
300
301
|
* @property {number} [status_code] - Status code for the error.
|
|
301
|
-
* @property {
|
|
302
|
+
* @property {Error[]} [error] - An array containing error details.
|
|
302
303
|
* @property {boolean} [success] - Whether operation was successful.
|
|
303
304
|
*/
|
|
304
305
|
|
|
305
306
|
/**
|
|
306
307
|
* @typedef CommonError
|
|
307
308
|
* @property {number} [status_code] - Status code for the error.
|
|
308
|
-
* @property {
|
|
309
|
+
* @property {Error[]} [error] - An array containing error details.
|
|
309
310
|
* @property {boolean} [success] - Whether operation was successful.
|
|
310
311
|
*/
|
|
311
312
|
|
|
@@ -545,8 +546,8 @@ const Joi = require("joi");
|
|
|
545
546
|
* @property {string} name - Name for the courier partner rule.
|
|
546
547
|
* @property {string[]} manual_priority - Has the list of courier partner
|
|
547
548
|
* account Ids that are to be given priority.
|
|
548
|
-
* @property {string} filters - Denotes weather specific filters are applied
|
|
549
|
-
* courier partner accounts or all accounts are considered.
|
|
549
|
+
* @property {string} [filters] - Denotes weather specific filters are applied
|
|
550
|
+
* to courier partner accounts or all accounts are considered.
|
|
550
551
|
* @property {CourierPartnerRuleConditions} conditions
|
|
551
552
|
* @property {string[]} sort - Sort Strategy for the courier partners.
|
|
552
553
|
* @property {string} [type] - Denotes the type of the rule.
|
|
@@ -1302,7 +1303,7 @@ const Joi = require("joi");
|
|
|
1302
1303
|
* @typedef PlatformLocationArticles
|
|
1303
1304
|
* @property {PlatformLocationArticle[]} articles - List of articles for this
|
|
1304
1305
|
* fulfillment location.
|
|
1305
|
-
* @property {number}
|
|
1306
|
+
* @property {number} fulfillment_location_id - Unique identifier for the
|
|
1306
1307
|
* fulfillment location.
|
|
1307
1308
|
* @property {string[]} [fulfillment_tags] - Tags associated with the
|
|
1308
1309
|
* fulfillment location.
|
|
@@ -1360,6 +1361,9 @@ const Joi = require("joi");
|
|
|
1360
1361
|
* fulfillment location.
|
|
1361
1362
|
* @property {ShipmentsCourierPartner[]} [courier_partners] - List of courier
|
|
1362
1363
|
* partners handling the shipment.
|
|
1364
|
+
* @property {number} [count] - The number of items in the shipment.
|
|
1365
|
+
* @property {boolean} [is_cod_available] - Flag indicating whether Cash on
|
|
1366
|
+
* Delivery (COD) is available for the shipment.
|
|
1363
1367
|
*/
|
|
1364
1368
|
|
|
1365
1369
|
/**
|
|
@@ -1678,7 +1682,7 @@ const Joi = require("joi");
|
|
|
1678
1682
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1679
1683
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
1680
1684
|
* @property {number} [current] - The current page number.
|
|
1681
|
-
* @property {string} type - The type of the page,
|
|
1685
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
1682
1686
|
* @property {number} [size] - The number of items per page.
|
|
1683
1687
|
* @property {number} [page_size] - The number of items per page.
|
|
1684
1688
|
*/
|
|
@@ -1749,8 +1753,8 @@ const Joi = require("joi");
|
|
|
1749
1753
|
* @property {ListViewProduct} product
|
|
1750
1754
|
* @property {number} company_id - The unique identifier of the company.
|
|
1751
1755
|
* @property {string} application_id - The unique identifier of the application.
|
|
1752
|
-
* @property {CreatedBy} created_by
|
|
1753
|
-
* @property {ModifiedBy} modified_by
|
|
1756
|
+
* @property {CreatedBy} [created_by]
|
|
1757
|
+
* @property {ModifiedBy} [modified_by]
|
|
1754
1758
|
* @property {string} created_on - The timestamp when the record was created.
|
|
1755
1759
|
* @property {string} modified_on - The timestamp when the record last modified.
|
|
1756
1760
|
* @property {string} [stage] - Current stage of the zone.
|
|
@@ -1927,7 +1931,7 @@ const Joi = require("joi");
|
|
|
1927
1931
|
* @property {StringComparisonOperations} [zone_ids]
|
|
1928
1932
|
* @property {IntComparisonOperations} [department_ids]
|
|
1929
1933
|
* @property {IntComparisonOperations} [brand_ids]
|
|
1930
|
-
* @property {
|
|
1934
|
+
* @property {DateOperations} [order_place_date]
|
|
1931
1935
|
* @property {IntComparisonOperations} [store_ids]
|
|
1932
1936
|
* @property {StringComparisonOperations} [store_type]
|
|
1933
1937
|
* @property {StringComparisonOperations} [store_tags]
|
|
@@ -1970,6 +1974,12 @@ const Joi = require("joi");
|
|
|
1970
1974
|
* the comparison.
|
|
1971
1975
|
*/
|
|
1972
1976
|
|
|
1977
|
+
/**
|
|
1978
|
+
* @typedef DateOperations
|
|
1979
|
+
* @property {string} lte - Less than or equal to condition for date.
|
|
1980
|
+
* @property {string} gte - Greater than or equal to condition for date.
|
|
1981
|
+
*/
|
|
1982
|
+
|
|
1973
1983
|
/**
|
|
1974
1984
|
* @typedef ArithmeticOperations
|
|
1975
1985
|
* @property {number} [lt] - Specifies a less than operation, comparing values
|
|
@@ -2276,14 +2286,6 @@ const Joi = require("joi");
|
|
|
2276
2286
|
* @property {number} [gte] - The greater-than-or-equal comparison value for the radius.
|
|
2277
2287
|
*/
|
|
2278
2288
|
|
|
2279
|
-
/**
|
|
2280
|
-
* @typedef DateOperations
|
|
2281
|
-
* @property {string} [lt] - Less than condition for date.
|
|
2282
|
-
* @property {string} [gt] - Greater than condition for date.
|
|
2283
|
-
* @property {string} [lte] - Less than or equal to condition for date.
|
|
2284
|
-
* @property {string} [gte] - Greater than or equal to condition for date.
|
|
2285
|
-
*/
|
|
2286
|
-
|
|
2287
2289
|
/**
|
|
2288
2290
|
* @typedef CourierPartnerSchemeModel
|
|
2289
2291
|
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
@@ -2556,7 +2558,8 @@ const Joi = require("joi");
|
|
|
2556
2558
|
|
|
2557
2559
|
/**
|
|
2558
2560
|
* @typedef ApplicationFields
|
|
2559
|
-
* @property {GetCountryFieldsAddress[]} [address]
|
|
2561
|
+
* @property {GetCountryFieldsAddress[]} [address] - List of address-related
|
|
2562
|
+
* fields for the application.
|
|
2560
2563
|
* @property {string[]} [serviceability_fields] - An array of strings
|
|
2561
2564
|
* representing fields related to the serviceability of the country.
|
|
2562
2565
|
* @property {GetCountryFieldsAddressTemplateApplication} [address_template]
|
|
@@ -3088,7 +3091,7 @@ class ServiceabilityPlatformModel {
|
|
|
3088
3091
|
return Joi.object({
|
|
3089
3092
|
batch_id: Joi.string().allow(""),
|
|
3090
3093
|
status_code: Joi.number(),
|
|
3091
|
-
error: Joi.
|
|
3094
|
+
error: Joi.array().items(ServiceabilityPlatformModel.Error()),
|
|
3092
3095
|
success: Joi.boolean(),
|
|
3093
3096
|
});
|
|
3094
3097
|
}
|
|
@@ -3097,7 +3100,7 @@ class ServiceabilityPlatformModel {
|
|
|
3097
3100
|
static CommonError() {
|
|
3098
3101
|
return Joi.object({
|
|
3099
3102
|
status_code: Joi.number(),
|
|
3100
|
-
error: Joi.
|
|
3103
|
+
error: Joi.array().items(ServiceabilityPlatformModel.Error()),
|
|
3101
3104
|
success: Joi.boolean(),
|
|
3102
3105
|
});
|
|
3103
3106
|
}
|
|
@@ -3336,7 +3339,7 @@ class ServiceabilityPlatformModel {
|
|
|
3336
3339
|
application_id: Joi.string().allow(""),
|
|
3337
3340
|
company_id: Joi.number(),
|
|
3338
3341
|
manual_priority: Joi.array().items(Joi.string().allow("")),
|
|
3339
|
-
filters: Joi.string().allow(""),
|
|
3342
|
+
filters: Joi.string().allow("").allow(null),
|
|
3340
3343
|
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions(),
|
|
3341
3344
|
sort: Joi.array().items(Joi.string().allow("")),
|
|
3342
3345
|
created_by: ServiceabilityPlatformModel.CreatedBy(),
|
|
@@ -3360,7 +3363,7 @@ class ServiceabilityPlatformModel {
|
|
|
3360
3363
|
),
|
|
3361
3364
|
name: Joi.string().allow("").required(),
|
|
3362
3365
|
manual_priority: Joi.array().items(Joi.string().allow("")).required(),
|
|
3363
|
-
filters: Joi.string().allow("").
|
|
3366
|
+
filters: Joi.string().allow("").allow(null),
|
|
3364
3367
|
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
|
|
3365
3368
|
sort: Joi.array().items(Joi.string().allow("")).required(),
|
|
3366
3369
|
type: Joi.string().allow(""),
|
|
@@ -3504,7 +3507,7 @@ class ServiceabilityPlatformModel {
|
|
|
3504
3507
|
manual_priority: Joi.array().items(Joi.number()),
|
|
3505
3508
|
meta_sort_priority: Joi.object().pattern(/\S/, Joi.any()),
|
|
3506
3509
|
meta_conditions: Joi.object().pattern(/\S/, Joi.any()),
|
|
3507
|
-
filters: Joi.string().allow(""),
|
|
3510
|
+
filters: Joi.string().allow("").allow(null),
|
|
3508
3511
|
company_id: Joi.number(),
|
|
3509
3512
|
application_id: Joi.string().allow(""),
|
|
3510
3513
|
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
@@ -3535,7 +3538,7 @@ class ServiceabilityPlatformModel {
|
|
|
3535
3538
|
manual_priority: Joi.array().items(Joi.number()),
|
|
3536
3539
|
meta_sort_priority: Joi.object().pattern(/\S/, Joi.any()),
|
|
3537
3540
|
meta_conditions: Joi.object().pattern(/\S/, Joi.any()),
|
|
3538
|
-
filters: Joi.string().allow(""),
|
|
3541
|
+
filters: Joi.string().allow("").allow(null),
|
|
3539
3542
|
is_active: Joi.boolean(),
|
|
3540
3543
|
conditions: ServiceabilityPlatformModel.StoreRuleConditionSchema(),
|
|
3541
3544
|
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
@@ -3555,7 +3558,7 @@ class ServiceabilityPlatformModel {
|
|
|
3555
3558
|
manual_priority: Joi.array().items(Joi.number()),
|
|
3556
3559
|
meta_sort_priority: Joi.object().pattern(/\S/, Joi.any()),
|
|
3557
3560
|
meta_conditions: Joi.object().pattern(/\S/, Joi.any()),
|
|
3558
|
-
filters: Joi.string().allow(""),
|
|
3561
|
+
filters: Joi.string().allow("").allow(null),
|
|
3559
3562
|
type: Joi.string().allow(""),
|
|
3560
3563
|
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
3561
3564
|
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
@@ -3576,7 +3579,7 @@ class ServiceabilityPlatformModel {
|
|
|
3576
3579
|
manual_priority: Joi.array().items(Joi.number()),
|
|
3577
3580
|
meta_sort_priority: Joi.object().pattern(/\S/, Joi.any()),
|
|
3578
3581
|
meta_conditions: Joi.object().pattern(/\S/, Joi.any()),
|
|
3579
|
-
filters: Joi.string().allow(""),
|
|
3582
|
+
filters: Joi.string().allow("").allow(null),
|
|
3580
3583
|
type: Joi.string().allow(""),
|
|
3581
3584
|
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
3582
3585
|
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
@@ -4137,7 +4140,7 @@ class ServiceabilityPlatformModel {
|
|
|
4137
4140
|
articles: Joi.array()
|
|
4138
4141
|
.items(ServiceabilityPlatformModel.PlatformLocationArticle())
|
|
4139
4142
|
.required(),
|
|
4140
|
-
fulfillment_location_id: Joi.number(),
|
|
4143
|
+
fulfillment_location_id: Joi.number().required(),
|
|
4141
4144
|
fulfillment_tags: Joi.array().items(Joi.string().allow("")),
|
|
4142
4145
|
fulfillment_type: Joi.string().allow("").required(),
|
|
4143
4146
|
});
|
|
@@ -4198,6 +4201,8 @@ class ServiceabilityPlatformModel {
|
|
|
4198
4201
|
courier_partners: Joi.array().items(
|
|
4199
4202
|
ServiceabilityPlatformModel.ShipmentsCourierPartner()
|
|
4200
4203
|
),
|
|
4204
|
+
count: Joi.number(),
|
|
4205
|
+
is_cod_available: Joi.boolean(),
|
|
4201
4206
|
});
|
|
4202
4207
|
}
|
|
4203
4208
|
|
|
@@ -4540,7 +4545,7 @@ class ServiceabilityPlatformModel {
|
|
|
4540
4545
|
is_set: Joi.boolean(),
|
|
4541
4546
|
track_inventory: Joi.boolean(),
|
|
4542
4547
|
identifiers: Joi.array().items(ServiceabilityPlatformModel.Identifier()),
|
|
4543
|
-
_custom_json: Joi.any(),
|
|
4548
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
4544
4549
|
});
|
|
4545
4550
|
}
|
|
4546
4551
|
|
|
@@ -4646,8 +4651,8 @@ class ServiceabilityPlatformModel {
|
|
|
4646
4651
|
product: ServiceabilityPlatformModel.ListViewProduct().required(),
|
|
4647
4652
|
company_id: Joi.number().required(),
|
|
4648
4653
|
application_id: Joi.string().allow("").required(),
|
|
4649
|
-
created_by: ServiceabilityPlatformModel.CreatedBy()
|
|
4650
|
-
modified_by: ServiceabilityPlatformModel.ModifiedBy()
|
|
4654
|
+
created_by: ServiceabilityPlatformModel.CreatedBy(),
|
|
4655
|
+
modified_by: ServiceabilityPlatformModel.ModifiedBy(),
|
|
4651
4656
|
created_on: Joi.string().allow("").required(),
|
|
4652
4657
|
modified_on: Joi.string().allow("").required(),
|
|
4653
4658
|
stage: Joi.string().allow(""),
|
|
@@ -4859,7 +4864,7 @@ class ServiceabilityPlatformModel {
|
|
|
4859
4864
|
zone_ids: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
4860
4865
|
department_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
4861
4866
|
brand_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
4862
|
-
order_place_date: ServiceabilityPlatformModel.
|
|
4867
|
+
order_place_date: ServiceabilityPlatformModel.DateOperations(),
|
|
4863
4868
|
store_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
4864
4869
|
store_type: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
4865
4870
|
store_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
@@ -4907,6 +4912,14 @@ class ServiceabilityPlatformModel {
|
|
|
4907
4912
|
});
|
|
4908
4913
|
}
|
|
4909
4914
|
|
|
4915
|
+
/** @returns {DateOperations} */
|
|
4916
|
+
static DateOperations() {
|
|
4917
|
+
return Joi.object({
|
|
4918
|
+
lte: Joi.string().allow("").required(),
|
|
4919
|
+
gte: Joi.string().allow("").required(),
|
|
4920
|
+
});
|
|
4921
|
+
}
|
|
4922
|
+
|
|
4910
4923
|
/** @returns {ArithmeticOperations} */
|
|
4911
4924
|
static ArithmeticOperations() {
|
|
4912
4925
|
return Joi.object({
|
|
@@ -5220,16 +5233,6 @@ class ServiceabilityPlatformModel {
|
|
|
5220
5233
|
});
|
|
5221
5234
|
}
|
|
5222
5235
|
|
|
5223
|
-
/** @returns {DateOperations} */
|
|
5224
|
-
static DateOperations() {
|
|
5225
|
-
return Joi.object({
|
|
5226
|
-
lt: Joi.string().allow("").allow(null),
|
|
5227
|
-
gt: Joi.string().allow("").allow(null),
|
|
5228
|
-
lte: Joi.string().allow("").allow(null),
|
|
5229
|
-
gte: Joi.string().allow("").allow(null),
|
|
5230
|
-
});
|
|
5231
|
-
}
|
|
5232
|
-
|
|
5233
5236
|
/** @returns {CourierPartnerSchemeModel} */
|
|
5234
5237
|
static CourierPartnerSchemeModel() {
|
|
5235
5238
|
return Joi.object({
|
|
@@ -104,7 +104,7 @@ export = SharePlatformModel;
|
|
|
104
104
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
105
105
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
106
106
|
* @property {number} [current] - The current page number.
|
|
107
|
-
* @property {string} type - The type of the page,
|
|
107
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
108
108
|
* @property {number} [size] - The number of items per page.
|
|
109
109
|
* @property {number} [page_size] - The number of items per page.
|
|
110
110
|
*/
|
|
@@ -283,7 +283,7 @@ type Page = {
|
|
|
283
283
|
*/
|
|
284
284
|
current?: number;
|
|
285
285
|
/**
|
|
286
|
-
* - The type of the page,
|
|
286
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
287
287
|
*/
|
|
288
288
|
type: string;
|
|
289
289
|
/**
|
|
@@ -117,7 +117,7 @@ const Joi = require("joi");
|
|
|
117
117
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
118
118
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
119
119
|
* @property {number} [current] - The current page number.
|
|
120
|
-
* @property {string} type - The type of the page,
|
|
120
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
121
121
|
* @property {number} [size] - The number of items per page.
|
|
122
122
|
* @property {number} [page_size] - The number of items per page.
|
|
123
123
|
*/
|
|
@@ -582,8 +582,8 @@ export = ThemePlatformModel;
|
|
|
582
582
|
* | "profile-order-shipment"
|
|
583
583
|
* | "profile-basic"
|
|
584
584
|
* | "profile-company"
|
|
585
|
-
* | "profile-
|
|
586
|
-
* | "profile-
|
|
585
|
+
* | "profile-email"
|
|
586
|
+
* | "profile-phone"
|
|
587
587
|
* | "rate-us"
|
|
588
588
|
* | "refer-earn"
|
|
589
589
|
* | "settings"
|
|
@@ -602,7 +602,8 @@ export = ThemePlatformModel;
|
|
|
602
602
|
* | "return-policy"
|
|
603
603
|
* | "order-status"
|
|
604
604
|
* | "locate-us"
|
|
605
|
-
* | "single-page-checkout"
|
|
605
|
+
* | "single-page-checkout"
|
|
606
|
+
* | "request-reattempt"} PageType
|
|
606
607
|
*/
|
|
607
608
|
declare class ThemePlatformModel {
|
|
608
609
|
}
|
|
@@ -1665,4 +1666,4 @@ type ActionPage = {
|
|
|
1665
1666
|
* @returns {PageType}
|
|
1666
1667
|
*/
|
|
1667
1668
|
declare function PageType(): PageType;
|
|
1668
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-
|
|
1669
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt";
|
|
@@ -665,8 +665,8 @@ const Joi = require("joi");
|
|
|
665
665
|
* | "profile-order-shipment"
|
|
666
666
|
* | "profile-basic"
|
|
667
667
|
* | "profile-company"
|
|
668
|
-
* | "profile-
|
|
669
|
-
* | "profile-
|
|
668
|
+
* | "profile-email"
|
|
669
|
+
* | "profile-phone"
|
|
670
670
|
* | "rate-us"
|
|
671
671
|
* | "refer-earn"
|
|
672
672
|
* | "settings"
|
|
@@ -685,7 +685,8 @@ const Joi = require("joi");
|
|
|
685
685
|
* | "return-policy"
|
|
686
686
|
* | "order-status"
|
|
687
687
|
* | "locate-us"
|
|
688
|
-
* | "single-page-checkout"
|
|
688
|
+
* | "single-page-checkout"
|
|
689
|
+
* | "request-reattempt"} PageType
|
|
689
690
|
*/
|
|
690
691
|
|
|
691
692
|
class ThemePlatformModel {
|
|
@@ -1555,9 +1556,9 @@ class ThemePlatformModel {
|
|
|
1555
1556
|
|
|
1556
1557
|
"profile-company",
|
|
1557
1558
|
|
|
1558
|
-
"profile-
|
|
1559
|
+
"profile-email",
|
|
1559
1560
|
|
|
1560
|
-
"profile-
|
|
1561
|
+
"profile-phone",
|
|
1561
1562
|
|
|
1562
1563
|
"rate-us",
|
|
1563
1564
|
|
|
@@ -1595,7 +1596,9 @@ class ThemePlatformModel {
|
|
|
1595
1596
|
|
|
1596
1597
|
"locate-us",
|
|
1597
1598
|
|
|
1598
|
-
"single-page-checkout"
|
|
1599
|
+
"single-page-checkout",
|
|
1600
|
+
|
|
1601
|
+
"request-reattempt"
|
|
1599
1602
|
);
|
|
1600
1603
|
}
|
|
1601
1604
|
}
|
|
@@ -259,12 +259,13 @@ declare class User {
|
|
|
259
259
|
*
|
|
260
260
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
-
* @returns {Promise<
|
|
262
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionList>} -
|
|
263
|
+
* Success response
|
|
263
264
|
* @name getUserAttributeDefinitions
|
|
264
265
|
* @summary: Get User Attribute Definitions
|
|
265
266
|
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
|
|
266
267
|
*/
|
|
267
|
-
getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<
|
|
268
|
+
getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionList>;
|
|
268
269
|
/**
|
|
269
270
|
* @param {UserPlatformApplicationValidator.GetUserAttributesForUserParam} arg
|
|
270
271
|
* - Arg object
|
|
@@ -1836,7 +1836,8 @@ class User {
|
|
|
1836
1836
|
*
|
|
1837
1837
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1838
1838
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1839
|
-
* @returns {Promise<
|
|
1839
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionList>} -
|
|
1840
|
+
* Success response
|
|
1840
1841
|
* @name getUserAttributeDefinitions
|
|
1841
1842
|
* @summary: Get User Attribute Definitions
|
|
1842
1843
|
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
|
|
@@ -1934,7 +1935,9 @@ class User {
|
|
|
1934
1935
|
responseData = response[0];
|
|
1935
1936
|
}
|
|
1936
1937
|
|
|
1937
|
-
const {
|
|
1938
|
+
const {
|
|
1939
|
+
error: res_error,
|
|
1940
|
+
} = UserPlatformModel.UserAttributeDefinitionList().validate(responseData, {
|
|
1938
1941
|
abortEarly: false,
|
|
1939
1942
|
allowUnknown: true,
|
|
1940
1943
|
});
|
|
@@ -3,6 +3,12 @@ export = UserPlatformModel;
|
|
|
3
3
|
* @typedef SuccessMessage
|
|
4
4
|
* @property {string} [success]
|
|
5
5
|
*/
|
|
6
|
+
/**
|
|
7
|
+
* @typedef UserAttributeDefinitionList
|
|
8
|
+
* @property {UserAttributeDefinition[]} [items] - Array of user attribute
|
|
9
|
+
* definition objects.
|
|
10
|
+
* @property {PaginationSchema} [page]
|
|
11
|
+
*/
|
|
6
12
|
/**
|
|
7
13
|
* @typedef UserAttributeDefinition
|
|
8
14
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
@@ -691,13 +697,23 @@ export = UserPlatformModel;
|
|
|
691
697
|
declare class UserPlatformModel {
|
|
692
698
|
}
|
|
693
699
|
declare namespace UserPlatformModel {
|
|
694
|
-
export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, PrivacyPolicyConsentSchema };
|
|
700
|
+
export { SuccessMessage, UserAttributeDefinitionList, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, PrivacyPolicyConsentSchema };
|
|
695
701
|
}
|
|
696
702
|
/** @returns {SuccessMessage} */
|
|
697
703
|
declare function SuccessMessage(): SuccessMessage;
|
|
698
704
|
type SuccessMessage = {
|
|
699
705
|
success?: string;
|
|
700
706
|
};
|
|
707
|
+
/** @returns {UserAttributeDefinitionList} */
|
|
708
|
+
declare function UserAttributeDefinitionList(): UserAttributeDefinitionList;
|
|
709
|
+
type UserAttributeDefinitionList = {
|
|
710
|
+
/**
|
|
711
|
+
* - Array of user attribute
|
|
712
|
+
* definition objects.
|
|
713
|
+
*/
|
|
714
|
+
items?: UserAttributeDefinition[];
|
|
715
|
+
page?: PaginationSchema;
|
|
716
|
+
};
|
|
701
717
|
/** @returns {UserAttributeDefinition} */
|
|
702
718
|
declare function UserAttributeDefinition(): UserAttributeDefinition;
|
|
703
719
|
type UserAttributeDefinition = {
|
|
@@ -5,6 +5,13 @@ const Joi = require("joi");
|
|
|
5
5
|
* @property {string} [success]
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
+
/**
|
|
9
|
+
* @typedef UserAttributeDefinitionList
|
|
10
|
+
* @property {UserAttributeDefinition[]} [items] - Array of user attribute
|
|
11
|
+
* definition objects.
|
|
12
|
+
* @property {PaginationSchema} [page]
|
|
13
|
+
*/
|
|
14
|
+
|
|
8
15
|
/**
|
|
9
16
|
* @typedef UserAttributeDefinition
|
|
10
17
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
@@ -780,6 +787,14 @@ class UserPlatformModel {
|
|
|
780
787
|
});
|
|
781
788
|
}
|
|
782
789
|
|
|
790
|
+
/** @returns {UserAttributeDefinitionList} */
|
|
791
|
+
static UserAttributeDefinitionList() {
|
|
792
|
+
return Joi.object({
|
|
793
|
+
items: Joi.array().items(UserPlatformModel.UserAttributeDefinition()),
|
|
794
|
+
page: UserPlatformModel.PaginationSchema(),
|
|
795
|
+
});
|
|
796
|
+
}
|
|
797
|
+
|
|
783
798
|
/** @returns {UserAttributeDefinition} */
|
|
784
799
|
static UserAttributeDefinition() {
|
|
785
800
|
return Joi.object({
|
|
@@ -6,7 +6,7 @@ export = WebhookPlatformModel;
|
|
|
6
6
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
7
7
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
8
8
|
* @property {number} [current] - The current page number.
|
|
9
|
-
* @property {string} type - The type of the page,
|
|
9
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
10
10
|
* @property {number} [size] - The number of items per page.
|
|
11
11
|
* @property {number} [page_size] - The number of items per page.
|
|
12
12
|
*/
|
|
@@ -343,7 +343,7 @@ type Page = {
|
|
|
343
343
|
*/
|
|
344
344
|
current?: number;
|
|
345
345
|
/**
|
|
346
|
-
* - The type of the page,
|
|
346
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
347
347
|
*/
|
|
348
348
|
type: string;
|
|
349
349
|
/**
|
|
@@ -7,7 +7,7 @@ const Joi = require("joi");
|
|
|
7
7
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
8
8
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
9
9
|
* @property {number} [current] - The current page number.
|
|
10
|
-
* @property {string} type - The type of the page,
|
|
10
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
11
11
|
* @property {number} [size] - The number of items per page.
|
|
12
12
|
* @property {number} [page_size] - The number of items per page.
|
|
13
13
|
*/
|