@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8-beta.3
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/Content/ContentApplicationModel.d.ts +2 -0
- package/sdk/application/Content/ContentApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
- package/sdk/application/Order/OrderApplicationModel.js +2 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +47 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +52 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -0
- package/sdk/platform/Content/ContentPlatformModel.js +2 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.js +2 -2
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +26 -9
- package/sdk/platform/Finance/FinancePlatformModel.js +32 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -0
- package/sdk/platform/Order/OrderPlatformModel.js +8 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +20 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +22 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +0 -2
- package/sdk/platform/User/UserPlatformModel.js +0 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +26 -26
- package/sdk/platform/Webhook/WebhookPlatformModel.js +26 -26
package/README.md
CHANGED
|
@@ -214,7 +214,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
214
214
|
The above code will log the curl command in the console
|
|
215
215
|
|
|
216
216
|
```bash
|
|
217
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.8-beta.
|
|
217
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.8-beta.3' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
218
218
|
Active Theme: Emerge
|
|
219
219
|
```
|
|
220
220
|
|
package/package.json
CHANGED
|
@@ -424,6 +424,7 @@ export = ContentApplicationModel;
|
|
|
424
424
|
* @property {string} [key]
|
|
425
425
|
* @property {string} [code]
|
|
426
426
|
* @property {string} [number]
|
|
427
|
+
* @property {string} [phone_type]
|
|
427
428
|
*/
|
|
428
429
|
/**
|
|
429
430
|
* @typedef PhoneSchema
|
|
@@ -1075,6 +1076,7 @@ type PhoneProperties = {
|
|
|
1075
1076
|
key?: string;
|
|
1076
1077
|
code?: string;
|
|
1077
1078
|
number?: string;
|
|
1079
|
+
phone_type?: string;
|
|
1078
1080
|
};
|
|
1079
1081
|
/** @returns {PhoneSchema} */
|
|
1080
1082
|
declare function PhoneSchema(): PhoneSchema;
|
|
@@ -480,6 +480,7 @@ const Joi = require("joi");
|
|
|
480
480
|
* @property {string} [key]
|
|
481
481
|
* @property {string} [code]
|
|
482
482
|
* @property {string} [number]
|
|
483
|
+
* @property {string} [phone_type]
|
|
483
484
|
*/
|
|
484
485
|
|
|
485
486
|
/**
|
|
@@ -1251,6 +1252,7 @@ class ContentApplicationModel {
|
|
|
1251
1252
|
key: Joi.string().allow(""),
|
|
1252
1253
|
code: Joi.string().allow(""),
|
|
1253
1254
|
number: Joi.string().allow(""),
|
|
1255
|
+
phone_type: Joi.string().allow(""),
|
|
1254
1256
|
});
|
|
1255
1257
|
}
|
|
1256
1258
|
|
|
@@ -278,6 +278,7 @@ export = OrderApplicationModel;
|
|
|
278
278
|
* containing payment methods used for placing an order. Each object will
|
|
279
279
|
* provide information about corresponding payment method with relevant details."
|
|
280
280
|
* @property {string} [order_type]
|
|
281
|
+
* @property {string} [gstin_code]
|
|
281
282
|
* @property {boolean} [show_download_invoice]
|
|
282
283
|
* @property {boolean} [can_cancel]
|
|
283
284
|
* @property {ShipmentUserInfo} [user_info]
|
|
@@ -887,6 +888,7 @@ type Shipments = {
|
|
|
887
888
|
*/
|
|
888
889
|
payment_info?: ShipmentPaymentInfo[];
|
|
889
890
|
order_type?: string;
|
|
891
|
+
gstin_code?: string;
|
|
890
892
|
show_download_invoice?: boolean;
|
|
891
893
|
can_cancel?: boolean;
|
|
892
894
|
user_info?: ShipmentUserInfo;
|
|
@@ -305,6 +305,7 @@ const Joi = require("joi");
|
|
|
305
305
|
* containing payment methods used for placing an order. Each object will
|
|
306
306
|
* provide information about corresponding payment method with relevant details."
|
|
307
307
|
* @property {string} [order_type]
|
|
308
|
+
* @property {string} [gstin_code]
|
|
308
309
|
* @property {boolean} [show_download_invoice]
|
|
309
310
|
* @property {boolean} [can_cancel]
|
|
310
311
|
* @property {ShipmentUserInfo} [user_info]
|
|
@@ -981,6 +982,7 @@ class OrderApplicationModel {
|
|
|
981
982
|
OrderApplicationModel.ShipmentPaymentInfo()
|
|
982
983
|
),
|
|
983
984
|
order_type: Joi.string().allow("").allow(null),
|
|
985
|
+
gstin_code: Joi.string().allow(""),
|
|
984
986
|
show_download_invoice: Joi.boolean(),
|
|
985
987
|
can_cancel: Joi.boolean(),
|
|
986
988
|
user_info: OrderApplicationModel.ShipmentUserInfo(),
|
|
@@ -76,6 +76,15 @@ export = LogisticsPartnerModel;
|
|
|
76
76
|
* @property {string} stage
|
|
77
77
|
* @property {boolean} is_own_account
|
|
78
78
|
*/
|
|
79
|
+
/**
|
|
80
|
+
* @typedef CourierAccountRequestBody
|
|
81
|
+
* @property {string} extension_id
|
|
82
|
+
* @property {string} [account_id]
|
|
83
|
+
* @property {string} scheme_id
|
|
84
|
+
* @property {boolean} is_self_ship
|
|
85
|
+
* @property {string} stage
|
|
86
|
+
* @property {boolean} is_own_account
|
|
87
|
+
*/
|
|
79
88
|
/**
|
|
80
89
|
* @typedef CourierPartnerAccountFailureResponse
|
|
81
90
|
* @property {boolean} success
|
|
@@ -108,6 +117,19 @@ export = LogisticsPartnerModel;
|
|
|
108
117
|
* @property {string} stage
|
|
109
118
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
110
119
|
*/
|
|
120
|
+
/**
|
|
121
|
+
* @typedef CourierPartnerSchemeRequestModel
|
|
122
|
+
* @property {string} extension_id
|
|
123
|
+
* @property {string} [scheme_id]
|
|
124
|
+
* @property {string} name
|
|
125
|
+
* @property {ArithmeticOperations} weight
|
|
126
|
+
* @property {string} transport_type
|
|
127
|
+
* @property {string} region
|
|
128
|
+
* @property {string} delivery_type
|
|
129
|
+
* @property {string[]} payment_mode
|
|
130
|
+
* @property {string} stage
|
|
131
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
132
|
+
*/
|
|
111
133
|
/**
|
|
112
134
|
* @typedef CourierPartnerSchemeFeatures
|
|
113
135
|
* @property {boolean} [doorstep_qc]
|
|
@@ -175,7 +197,7 @@ export = LogisticsPartnerModel;
|
|
|
175
197
|
declare class LogisticsPartnerModel {
|
|
176
198
|
}
|
|
177
199
|
declare namespace LogisticsPartnerModel {
|
|
178
|
-
export { BulkRegionServiceabilityTatRequest, BulkRegionServiceabilityTatResponseItemData, ErrorResponse, FailureResponse, BulkRegionServiceabilityTatResponse, Page, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, CourierAccount, CourierPartnerAccountFailureResponse, CompanyCourierPartnerAccountListResponse, CourierAccountResponse, CourierPartnerSchemeModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateRequest, GetCountries, GetCountriesItems, HierarchyItems };
|
|
200
|
+
export { BulkRegionServiceabilityTatRequest, BulkRegionServiceabilityTatResponseItemData, ErrorResponse, FailureResponse, BulkRegionServiceabilityTatResponse, Page, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, CourierAccount, CourierAccountRequestBody, CourierPartnerAccountFailureResponse, CompanyCourierPartnerAccountListResponse, CourierAccountResponse, CourierPartnerSchemeModel, CourierPartnerSchemeRequestModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateRequest, GetCountries, GetCountriesItems, HierarchyItems };
|
|
179
201
|
}
|
|
180
202
|
/** @returns {BulkRegionServiceabilityTatRequest} */
|
|
181
203
|
declare function BulkRegionServiceabilityTatRequest(): BulkRegionServiceabilityTatRequest;
|
|
@@ -264,6 +286,16 @@ type CourierAccount = {
|
|
|
264
286
|
stage: string;
|
|
265
287
|
is_own_account: boolean;
|
|
266
288
|
};
|
|
289
|
+
/** @returns {CourierAccountRequestBody} */
|
|
290
|
+
declare function CourierAccountRequestBody(): CourierAccountRequestBody;
|
|
291
|
+
type CourierAccountRequestBody = {
|
|
292
|
+
extension_id: string;
|
|
293
|
+
account_id?: string;
|
|
294
|
+
scheme_id: string;
|
|
295
|
+
is_self_ship: boolean;
|
|
296
|
+
stage: string;
|
|
297
|
+
is_own_account: boolean;
|
|
298
|
+
};
|
|
267
299
|
/** @returns {CourierPartnerAccountFailureResponse} */
|
|
268
300
|
declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
|
|
269
301
|
type CourierPartnerAccountFailureResponse = {
|
|
@@ -300,6 +332,20 @@ type CourierPartnerSchemeModel = {
|
|
|
300
332
|
stage: string;
|
|
301
333
|
feature: CourierPartnerSchemeFeatures;
|
|
302
334
|
};
|
|
335
|
+
/** @returns {CourierPartnerSchemeRequestModel} */
|
|
336
|
+
declare function CourierPartnerSchemeRequestModel(): CourierPartnerSchemeRequestModel;
|
|
337
|
+
type CourierPartnerSchemeRequestModel = {
|
|
338
|
+
extension_id: string;
|
|
339
|
+
scheme_id?: string;
|
|
340
|
+
name: string;
|
|
341
|
+
weight: ArithmeticOperations;
|
|
342
|
+
transport_type: string;
|
|
343
|
+
region: string;
|
|
344
|
+
delivery_type: string;
|
|
345
|
+
payment_mode: string[];
|
|
346
|
+
stage: string;
|
|
347
|
+
feature: CourierPartnerSchemeFeatures;
|
|
348
|
+
};
|
|
303
349
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
304
350
|
declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
|
|
305
351
|
type CourierPartnerSchemeFeatures = {
|
|
@@ -87,6 +87,16 @@ const Joi = require("joi");
|
|
|
87
87
|
* @property {boolean} is_own_account
|
|
88
88
|
*/
|
|
89
89
|
|
|
90
|
+
/**
|
|
91
|
+
* @typedef CourierAccountRequestBody
|
|
92
|
+
* @property {string} extension_id
|
|
93
|
+
* @property {string} [account_id]
|
|
94
|
+
* @property {string} scheme_id
|
|
95
|
+
* @property {boolean} is_self_ship
|
|
96
|
+
* @property {string} stage
|
|
97
|
+
* @property {boolean} is_own_account
|
|
98
|
+
*/
|
|
99
|
+
|
|
90
100
|
/**
|
|
91
101
|
* @typedef CourierPartnerAccountFailureResponse
|
|
92
102
|
* @property {boolean} success
|
|
@@ -123,6 +133,20 @@ const Joi = require("joi");
|
|
|
123
133
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
124
134
|
*/
|
|
125
135
|
|
|
136
|
+
/**
|
|
137
|
+
* @typedef CourierPartnerSchemeRequestModel
|
|
138
|
+
* @property {string} extension_id
|
|
139
|
+
* @property {string} [scheme_id]
|
|
140
|
+
* @property {string} name
|
|
141
|
+
* @property {ArithmeticOperations} weight
|
|
142
|
+
* @property {string} transport_type
|
|
143
|
+
* @property {string} region
|
|
144
|
+
* @property {string} delivery_type
|
|
145
|
+
* @property {string[]} payment_mode
|
|
146
|
+
* @property {string} stage
|
|
147
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
148
|
+
*/
|
|
149
|
+
|
|
126
150
|
/**
|
|
127
151
|
* @typedef CourierPartnerSchemeFeatures
|
|
128
152
|
* @property {boolean} [doorstep_qc]
|
|
@@ -307,6 +331,18 @@ class LogisticsPartnerModel {
|
|
|
307
331
|
});
|
|
308
332
|
}
|
|
309
333
|
|
|
334
|
+
/** @returns {CourierAccountRequestBody} */
|
|
335
|
+
static CourierAccountRequestBody() {
|
|
336
|
+
return Joi.object({
|
|
337
|
+
extension_id: Joi.string().allow("").required(),
|
|
338
|
+
account_id: Joi.string().allow(""),
|
|
339
|
+
scheme_id: Joi.string().allow("").required(),
|
|
340
|
+
is_self_ship: Joi.boolean().required(),
|
|
341
|
+
stage: Joi.string().allow("").required(),
|
|
342
|
+
is_own_account: Joi.boolean().required(),
|
|
343
|
+
});
|
|
344
|
+
}
|
|
345
|
+
|
|
310
346
|
/** @returns {CourierPartnerAccountFailureResponse} */
|
|
311
347
|
static CourierPartnerAccountFailureResponse() {
|
|
312
348
|
return Joi.object({
|
|
@@ -355,6 +391,22 @@ class LogisticsPartnerModel {
|
|
|
355
391
|
});
|
|
356
392
|
}
|
|
357
393
|
|
|
394
|
+
/** @returns {CourierPartnerSchemeRequestModel} */
|
|
395
|
+
static CourierPartnerSchemeRequestModel() {
|
|
396
|
+
return Joi.object({
|
|
397
|
+
extension_id: Joi.string().allow("").required(),
|
|
398
|
+
scheme_id: Joi.string().allow(""),
|
|
399
|
+
name: Joi.string().allow("").required(),
|
|
400
|
+
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
401
|
+
transport_type: Joi.string().allow("").required(),
|
|
402
|
+
region: Joi.string().allow("").required(),
|
|
403
|
+
delivery_type: Joi.string().allow("").required(),
|
|
404
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
405
|
+
stage: Joi.string().allow("").required(),
|
|
406
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
407
|
+
});
|
|
408
|
+
}
|
|
409
|
+
|
|
358
410
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
359
411
|
static CourierPartnerSchemeFeatures() {
|
|
360
412
|
return Joi.object({
|
|
@@ -67,7 +67,7 @@ class LogisticsValidator {
|
|
|
67
67
|
static createCourierPartnerAccount() {
|
|
68
68
|
return Joi.object({
|
|
69
69
|
companyId: Joi.number().required(),
|
|
70
|
-
body: LogisticsModel.
|
|
70
|
+
body: LogisticsModel.CourierAccountRequestBody().required(),
|
|
71
71
|
}).required();
|
|
72
72
|
}
|
|
73
73
|
|
|
@@ -99,7 +99,7 @@ class LogisticsValidator {
|
|
|
99
99
|
|
|
100
100
|
static createCourierPartnerScheme() {
|
|
101
101
|
return Joi.object({
|
|
102
|
-
body: LogisticsModel.
|
|
102
|
+
body: LogisticsModel.CourierPartnerSchemeRequestModel().required(),
|
|
103
103
|
}).required();
|
|
104
104
|
}
|
|
105
105
|
|
|
@@ -305,7 +305,7 @@ declare class Catalog {
|
|
|
305
305
|
* @summary: List sales channel inventory
|
|
306
306
|
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
307
307
|
*/
|
|
308
|
-
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
|
|
308
|
+
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
|
|
309
309
|
/**
|
|
310
310
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
311
311
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1829,6 +1829,11 @@ class Catalog {
|
|
|
1829
1829
|
timestamp,
|
|
1830
1830
|
pageSize,
|
|
1831
1831
|
pageId,
|
|
1832
|
+
qtyGt,
|
|
1833
|
+
qtyLt,
|
|
1834
|
+
qtyType,
|
|
1835
|
+
fromDate,
|
|
1836
|
+
toDate,
|
|
1832
1837
|
requestHeaders,
|
|
1833
1838
|
} = { requestHeaders: {} },
|
|
1834
1839
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -1844,6 +1849,11 @@ class Catalog {
|
|
|
1844
1849
|
timestamp,
|
|
1845
1850
|
pageSize,
|
|
1846
1851
|
pageId,
|
|
1852
|
+
qtyGt,
|
|
1853
|
+
qtyLt,
|
|
1854
|
+
qtyType,
|
|
1855
|
+
fromDate,
|
|
1856
|
+
toDate,
|
|
1847
1857
|
},
|
|
1848
1858
|
{ abortEarly: false, allowUnknown: true }
|
|
1849
1859
|
);
|
|
@@ -1863,6 +1873,11 @@ class Catalog {
|
|
|
1863
1873
|
timestamp,
|
|
1864
1874
|
pageSize,
|
|
1865
1875
|
pageId,
|
|
1876
|
+
qtyGt,
|
|
1877
|
+
qtyLt,
|
|
1878
|
+
qtyType,
|
|
1879
|
+
fromDate,
|
|
1880
|
+
toDate,
|
|
1866
1881
|
},
|
|
1867
1882
|
{ abortEarly: false, allowUnknown: false }
|
|
1868
1883
|
);
|
|
@@ -1881,6 +1896,11 @@ class Catalog {
|
|
|
1881
1896
|
query_params["timestamp"] = timestamp;
|
|
1882
1897
|
query_params["page_size"] = pageSize;
|
|
1883
1898
|
query_params["page_id"] = pageId;
|
|
1899
|
+
query_params["qty_gt"] = qtyGt;
|
|
1900
|
+
query_params["qty_lt"] = qtyLt;
|
|
1901
|
+
query_params["qty_type"] = qtyType;
|
|
1902
|
+
query_params["from_date"] = fromDate;
|
|
1903
|
+
query_params["to_date"] = toDate;
|
|
1884
1904
|
|
|
1885
1905
|
const response = await PlatformAPIClient.execute(
|
|
1886
1906
|
this.config,
|
|
@@ -106,6 +106,17 @@ export = CatalogPlatformApplicationValidator;
|
|
|
106
106
|
* @property {string} [timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
107
107
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
108
108
|
* @property {string} [pageId] - Page ID to retrieve next set of results.
|
|
109
|
+
* @property {number} [qtyGt] - This field allows you to filter for inventories
|
|
110
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
111
|
+
* @property {number} [qtyLt] - This field allows you to filter for inventories
|
|
112
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
113
|
+
* @property {string} [qtyType] - This field provides flexibility in selecting
|
|
114
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
115
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
116
|
+
* @property {string} [fromDate] - Inventory updated on filter to get
|
|
117
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
118
|
+
* @property {string} [toDate] - Inventory updated on filter to get inventories
|
|
119
|
+
* less then or equal to provided date based on qty_type value.
|
|
109
120
|
*/
|
|
110
121
|
/**
|
|
111
122
|
* @typedef GetAppLocationsParam
|
|
@@ -709,6 +720,32 @@ type GetAppInventoryParam = {
|
|
|
709
720
|
* - Page ID to retrieve next set of results.
|
|
710
721
|
*/
|
|
711
722
|
pageId?: string;
|
|
723
|
+
/**
|
|
724
|
+
* - This field allows you to filter for inventories
|
|
725
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
726
|
+
*/
|
|
727
|
+
qtyGt?: number;
|
|
728
|
+
/**
|
|
729
|
+
* - This field allows you to filter for inventories
|
|
730
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
731
|
+
*/
|
|
732
|
+
qtyLt?: number;
|
|
733
|
+
/**
|
|
734
|
+
* - This field provides flexibility in selecting
|
|
735
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
736
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
737
|
+
*/
|
|
738
|
+
qtyType?: string;
|
|
739
|
+
/**
|
|
740
|
+
* - Inventory updated on filter to get
|
|
741
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
742
|
+
*/
|
|
743
|
+
fromDate?: string;
|
|
744
|
+
/**
|
|
745
|
+
* - Inventory updated on filter to get inventories
|
|
746
|
+
* less then or equal to provided date based on qty_type value.
|
|
747
|
+
*/
|
|
748
|
+
toDate?: string;
|
|
712
749
|
};
|
|
713
750
|
type GetAppLocationsParam = {
|
|
714
751
|
/**
|
|
@@ -130,6 +130,17 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
130
130
|
* @property {string} [timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
131
131
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
132
132
|
* @property {string} [pageId] - Page ID to retrieve next set of results.
|
|
133
|
+
* @property {number} [qtyGt] - This field allows you to filter for inventories
|
|
134
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
135
|
+
* @property {number} [qtyLt] - This field allows you to filter for inventories
|
|
136
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
137
|
+
* @property {string} [qtyType] - This field provides flexibility in selecting
|
|
138
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
139
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
140
|
+
* @property {string} [fromDate] - Inventory updated on filter to get
|
|
141
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
142
|
+
* @property {string} [toDate] - Inventory updated on filter to get inventories
|
|
143
|
+
* less then or equal to provided date based on qty_type value.
|
|
133
144
|
*/
|
|
134
145
|
|
|
135
146
|
/**
|
|
@@ -645,6 +656,11 @@ class CatalogPlatformApplicationValidator {
|
|
|
645
656
|
timestamp: Joi.string().allow(""),
|
|
646
657
|
pageSize: Joi.number(),
|
|
647
658
|
pageId: Joi.string().allow(""),
|
|
659
|
+
qtyGt: Joi.number(),
|
|
660
|
+
qtyLt: Joi.number(),
|
|
661
|
+
qtyType: Joi.string().allow(""),
|
|
662
|
+
fromDate: Joi.string().allow(""),
|
|
663
|
+
toDate: Joi.string().allow(""),
|
|
648
664
|
}).required();
|
|
649
665
|
}
|
|
650
666
|
|
|
@@ -676,6 +676,7 @@ export = ContentPlatformModel;
|
|
|
676
676
|
* @property {string} [key]
|
|
677
677
|
* @property {string} [code]
|
|
678
678
|
* @property {string} [number]
|
|
679
|
+
* @property {string} [phone_type]
|
|
679
680
|
*/
|
|
680
681
|
/**
|
|
681
682
|
* @typedef PhoneSchema
|
|
@@ -2005,6 +2006,7 @@ type PhoneProperties = {
|
|
|
2005
2006
|
key?: string;
|
|
2006
2007
|
code?: string;
|
|
2007
2008
|
number?: string;
|
|
2009
|
+
phone_type?: string;
|
|
2008
2010
|
};
|
|
2009
2011
|
/** @returns {PhoneSchema} */
|
|
2010
2012
|
declare function PhoneSchema(): PhoneSchema;
|
|
@@ -769,6 +769,7 @@ const Joi = require("joi");
|
|
|
769
769
|
* @property {string} [key]
|
|
770
770
|
* @property {string} [code]
|
|
771
771
|
* @property {string} [number]
|
|
772
|
+
* @property {string} [phone_type]
|
|
772
773
|
*/
|
|
773
774
|
|
|
774
775
|
/**
|
|
@@ -2340,6 +2341,7 @@ class ContentPlatformModel {
|
|
|
2340
2341
|
key: Joi.string().allow(""),
|
|
2341
2342
|
code: Joi.string().allow(""),
|
|
2342
2343
|
number: Joi.string().allow(""),
|
|
2344
|
+
phone_type: Joi.string().allow(""),
|
|
2343
2345
|
});
|
|
2344
2346
|
}
|
|
2345
2347
|
|
|
@@ -248,8 +248,8 @@ declare class Finance {
|
|
|
248
248
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>} -
|
|
249
249
|
* Success response
|
|
250
250
|
* @name invoicePaymentOptions
|
|
251
|
-
* @summary: Display all payment options for
|
|
252
|
-
* @description: Display all payment options for
|
|
251
|
+
* @summary: Display all payment options for invoice.
|
|
252
|
+
* @description: Display all payment options for invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentOptions/).
|
|
253
253
|
*/
|
|
254
254
|
invoicePaymentOptions({ body, requestHeaders }?: FinancePlatformValidator.InvoicePaymentOptionsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>;
|
|
255
255
|
/**
|
|
@@ -1787,8 +1787,8 @@ class Finance {
|
|
|
1787
1787
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>} -
|
|
1788
1788
|
* Success response
|
|
1789
1789
|
* @name invoicePaymentOptions
|
|
1790
|
-
* @summary: Display all payment options for
|
|
1791
|
-
* @description: Display all payment options for
|
|
1790
|
+
* @summary: Display all payment options for invoice.
|
|
1791
|
+
* @description: Display all payment options for invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentOptions/).
|
|
1792
1792
|
*/
|
|
1793
1793
|
async invoicePaymentOptions(
|
|
1794
1794
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -207,6 +207,11 @@ export = FinancePlatformModel;
|
|
|
207
207
|
* @property {boolean} [success]
|
|
208
208
|
* @property {DownloadCreditDebitNoteResponseData[]} [data]
|
|
209
209
|
*/
|
|
210
|
+
/**
|
|
211
|
+
* @typedef InvoiceBillingItem
|
|
212
|
+
* @property {string} [invoice_number]
|
|
213
|
+
* @property {number} [amount]
|
|
214
|
+
*/
|
|
210
215
|
/**
|
|
211
216
|
* @typedef PaymentProcessPayload
|
|
212
217
|
* @property {string} [platform]
|
|
@@ -218,7 +223,7 @@ export = FinancePlatformModel;
|
|
|
218
223
|
* @property {string} [currency]
|
|
219
224
|
* @property {string} [seller_id]
|
|
220
225
|
* @property {string} [mode_of_payment]
|
|
221
|
-
* @property {
|
|
226
|
+
* @property {InvoiceBillingItem[]} [invoice_billing_items]
|
|
222
227
|
*/
|
|
223
228
|
/**
|
|
224
229
|
* @typedef PaymentProcessReq
|
|
@@ -660,7 +665,7 @@ export = FinancePlatformModel;
|
|
|
660
665
|
*/
|
|
661
666
|
/**
|
|
662
667
|
* @typedef InvoicePaymentOptionsPayloadData
|
|
663
|
-
* @property {string} [
|
|
668
|
+
* @property {string[]} [invoice_numbers]
|
|
664
669
|
*/
|
|
665
670
|
/**
|
|
666
671
|
* @typedef InvoicePaymentOptionsReq
|
|
@@ -682,17 +687,20 @@ export = FinancePlatformModel;
|
|
|
682
687
|
*/
|
|
683
688
|
/**
|
|
684
689
|
* @typedef InvoicePaymentOptionsResponseData
|
|
685
|
-
* @property {
|
|
690
|
+
* @property {string} [invoice_number]
|
|
686
691
|
* @property {string} [invoice_type]
|
|
687
692
|
* @property {InvoicePaymentOptionsResponsePayableAmounts[]} [display_amounts]
|
|
688
693
|
* @property {Object} [total_amount]
|
|
689
694
|
* @property {Object} [deducted_amounts]
|
|
690
695
|
* @property {InvoicePaymentOptionsResponsePayableAmounts[]} [payable_amounts]
|
|
696
|
+
* @property {Currency} [currency]
|
|
691
697
|
*/
|
|
692
698
|
/**
|
|
693
699
|
* @typedef InvoicePaymentOptionsResponse
|
|
694
700
|
* @property {string} [reason]
|
|
695
|
-
* @property {InvoicePaymentOptionsResponseData} [data]
|
|
701
|
+
* @property {InvoicePaymentOptionsResponseData[]} [data]
|
|
702
|
+
* @property {number} [total_payable_amount]
|
|
703
|
+
* @property {number} [invoice_count]
|
|
696
704
|
* @property {boolean} [success]
|
|
697
705
|
*/
|
|
698
706
|
/**
|
|
@@ -759,7 +767,7 @@ export = FinancePlatformModel;
|
|
|
759
767
|
declare class FinancePlatformModel {
|
|
760
768
|
}
|
|
761
769
|
declare namespace FinancePlatformModel {
|
|
762
|
-
export { OrederFreezeResponse, GenerateReportMeta, GenerateReportFilters, GenerateReportPlatform, GenerateReportReq, Page, Currency, GenerateReportJson, Error, ErrorMeta, ErrorMetaItems, DownloadReport, DownloadReportData, DownloadReportItems, DownloadReportList, GetEngineFilters, GetEngineData, GetEngineReq, GetEngineResponse, GetReason, GetReasonReq, ReasonItem, GetReasonResponse, GetReportListData, GetReportListReq, GetAffiliate, GetReportListResponse, ReportItem, GetAffiliateResponse, DownloadCreditDebitNote, DownloadCreditDebitNoteReq, DownloadCreditDebitNoteResponseData, DownloadCreditDebitNoteResponse, PaymentProcessPayload, PaymentProcessReq, PaymentProcessResponse, CreditlineDataPlatformPayload, CreditlineDataPlatformReq, CreditlineDataPlatformResponse, IsCreditlinePayload, IsCreditlinePlatformReq, IsCreditlinePlatformResponse, InvoiceTypePayloadData, InvoiceTypeReq, InvoiceTypeResponseItems, InvoiceTypeResponse, InoviceListingPayloadDataFilters, InvoiceListingPayloadData, InvoiceListingReq, UnpaidInvoiceDataItems, InvoiceListingResponseItems, InvoiceListingResponse, InvoicePdfPayloadData, InvoicePdfReq, InvoicePdfResponse, IsCnRefundMethodData, IsCnRefundMethodReq, IsCnRefundMethodResponseData, IsCnRefundMethodResponse, CreditNoteConfigNotificationEvents, CreateSellerCreditNoteConfig, CreateSellerCreditNoteConfigReq, CreateSellerCreditNoteConfigResponse, DeleteConfig, DeleteConfigReq, DeleteConfigResponse, ChannelDisplayNameItems, ChannelDisplayNameResponse, CnReferenceNumber, GetPdfUrlViewReq, GetPdfUrlViewResponseData, GetPdfUrlViewResponse, CreditNoteDetailsReq, CnDetails, RedemptionDetails, CreditNoteDetails, CreditNoteDetailsResponse, GetCustomerCreditBalance, GetCustomerCreditBalanceReq, GetCustomerCreditBalanceResponseData, GetCustomerCreditBalanceResponse, GetCnConfigReq, GetCnConfigResponseMeta, GetCnConfigResponseData, GetCnConfigResponse, CnGenerateReportFilters, CnGenerateReport, GenerateReportCustomerCnReq, CnGenerateReportItems, GenerateReportCustomerCnResponseData, GenerateReportCustomerCnResponse, CnDownloadReport, DownloadReportCustomerCnReq, DownloadReportResponseData, DownloadReportCustomerCnResponse, GetReportingFilters, GetReportingNestedFilters, GetReportingFiltersReasonOptions, GetReportingFiltersReason, GetReportingFiltersResponse, InvoicePaymentOptionsPayloadData, InvoicePaymentOptionsReq, InvoicePaymentOptionsResponsePayableAmounts, InvoicePaymentOptionsResponseDeductedAmounts, InvoicePaymentOptionsResponseData, InvoicePaymentOptionsResponse, PaymentDetail, PaidInvoicePaymentDetail, InvoicePaymentDetailsResponseData, InvoicePaymentDetailsResponse, InvoiceActivityLogsResponseData, InvoiceActivityLogsResponse, InvoiceActivityLogError, UnlockCreditNoteRequestData, UnlockCreditNoteReq, UnlockCreditNoteResponseData, UnlockCreditNoteResponse };
|
|
770
|
+
export { OrederFreezeResponse, GenerateReportMeta, GenerateReportFilters, GenerateReportPlatform, GenerateReportReq, Page, Currency, GenerateReportJson, Error, ErrorMeta, ErrorMetaItems, DownloadReport, DownloadReportData, DownloadReportItems, DownloadReportList, GetEngineFilters, GetEngineData, GetEngineReq, GetEngineResponse, GetReason, GetReasonReq, ReasonItem, GetReasonResponse, GetReportListData, GetReportListReq, GetAffiliate, GetReportListResponse, ReportItem, GetAffiliateResponse, DownloadCreditDebitNote, DownloadCreditDebitNoteReq, DownloadCreditDebitNoteResponseData, DownloadCreditDebitNoteResponse, InvoiceBillingItem, PaymentProcessPayload, PaymentProcessReq, PaymentProcessResponse, CreditlineDataPlatformPayload, CreditlineDataPlatformReq, CreditlineDataPlatformResponse, IsCreditlinePayload, IsCreditlinePlatformReq, IsCreditlinePlatformResponse, InvoiceTypePayloadData, InvoiceTypeReq, InvoiceTypeResponseItems, InvoiceTypeResponse, InoviceListingPayloadDataFilters, InvoiceListingPayloadData, InvoiceListingReq, UnpaidInvoiceDataItems, InvoiceListingResponseItems, InvoiceListingResponse, InvoicePdfPayloadData, InvoicePdfReq, InvoicePdfResponse, IsCnRefundMethodData, IsCnRefundMethodReq, IsCnRefundMethodResponseData, IsCnRefundMethodResponse, CreditNoteConfigNotificationEvents, CreateSellerCreditNoteConfig, CreateSellerCreditNoteConfigReq, CreateSellerCreditNoteConfigResponse, DeleteConfig, DeleteConfigReq, DeleteConfigResponse, ChannelDisplayNameItems, ChannelDisplayNameResponse, CnReferenceNumber, GetPdfUrlViewReq, GetPdfUrlViewResponseData, GetPdfUrlViewResponse, CreditNoteDetailsReq, CnDetails, RedemptionDetails, CreditNoteDetails, CreditNoteDetailsResponse, GetCustomerCreditBalance, GetCustomerCreditBalanceReq, GetCustomerCreditBalanceResponseData, GetCustomerCreditBalanceResponse, GetCnConfigReq, GetCnConfigResponseMeta, GetCnConfigResponseData, GetCnConfigResponse, CnGenerateReportFilters, CnGenerateReport, GenerateReportCustomerCnReq, CnGenerateReportItems, GenerateReportCustomerCnResponseData, GenerateReportCustomerCnResponse, CnDownloadReport, DownloadReportCustomerCnReq, DownloadReportResponseData, DownloadReportCustomerCnResponse, GetReportingFilters, GetReportingNestedFilters, GetReportingFiltersReasonOptions, GetReportingFiltersReason, GetReportingFiltersResponse, InvoicePaymentOptionsPayloadData, InvoicePaymentOptionsReq, InvoicePaymentOptionsResponsePayableAmounts, InvoicePaymentOptionsResponseDeductedAmounts, InvoicePaymentOptionsResponseData, InvoicePaymentOptionsResponse, PaymentDetail, PaidInvoicePaymentDetail, InvoicePaymentDetailsResponseData, InvoicePaymentDetailsResponse, InvoiceActivityLogsResponseData, InvoiceActivityLogsResponse, InvoiceActivityLogError, UnlockCreditNoteRequestData, UnlockCreditNoteReq, UnlockCreditNoteResponseData, UnlockCreditNoteResponse };
|
|
763
771
|
}
|
|
764
772
|
/** @returns {OrederFreezeResponse} */
|
|
765
773
|
declare function OrederFreezeResponse(): OrederFreezeResponse;
|
|
@@ -1002,6 +1010,12 @@ type DownloadCreditDebitNoteResponse = {
|
|
|
1002
1010
|
success?: boolean;
|
|
1003
1011
|
data?: DownloadCreditDebitNoteResponseData[];
|
|
1004
1012
|
};
|
|
1013
|
+
/** @returns {InvoiceBillingItem} */
|
|
1014
|
+
declare function InvoiceBillingItem(): InvoiceBillingItem;
|
|
1015
|
+
type InvoiceBillingItem = {
|
|
1016
|
+
invoice_number?: string;
|
|
1017
|
+
amount?: number;
|
|
1018
|
+
};
|
|
1005
1019
|
/** @returns {PaymentProcessPayload} */
|
|
1006
1020
|
declare function PaymentProcessPayload(): PaymentProcessPayload;
|
|
1007
1021
|
type PaymentProcessPayload = {
|
|
@@ -1014,7 +1028,7 @@ type PaymentProcessPayload = {
|
|
|
1014
1028
|
currency?: string;
|
|
1015
1029
|
seller_id?: string;
|
|
1016
1030
|
mode_of_payment?: string;
|
|
1017
|
-
|
|
1031
|
+
invoice_billing_items?: InvoiceBillingItem[];
|
|
1018
1032
|
};
|
|
1019
1033
|
/** @returns {PaymentProcessReq} */
|
|
1020
1034
|
declare function PaymentProcessReq(): PaymentProcessReq;
|
|
@@ -1523,7 +1537,7 @@ type GetReportingFiltersResponse = {
|
|
|
1523
1537
|
/** @returns {InvoicePaymentOptionsPayloadData} */
|
|
1524
1538
|
declare function InvoicePaymentOptionsPayloadData(): InvoicePaymentOptionsPayloadData;
|
|
1525
1539
|
type InvoicePaymentOptionsPayloadData = {
|
|
1526
|
-
|
|
1540
|
+
invoice_numbers?: string[];
|
|
1527
1541
|
};
|
|
1528
1542
|
/** @returns {InvoicePaymentOptionsReq} */
|
|
1529
1543
|
declare function InvoicePaymentOptionsReq(): InvoicePaymentOptionsReq;
|
|
@@ -1549,18 +1563,21 @@ type InvoicePaymentOptionsResponseDeductedAmounts = {
|
|
|
1549
1563
|
/** @returns {InvoicePaymentOptionsResponseData} */
|
|
1550
1564
|
declare function InvoicePaymentOptionsResponseData(): InvoicePaymentOptionsResponseData;
|
|
1551
1565
|
type InvoicePaymentOptionsResponseData = {
|
|
1552
|
-
|
|
1566
|
+
invoice_number?: string;
|
|
1553
1567
|
invoice_type?: string;
|
|
1554
1568
|
display_amounts?: InvoicePaymentOptionsResponsePayableAmounts[];
|
|
1555
1569
|
total_amount?: any;
|
|
1556
1570
|
deducted_amounts?: any;
|
|
1557
1571
|
payable_amounts?: InvoicePaymentOptionsResponsePayableAmounts[];
|
|
1572
|
+
currency?: Currency;
|
|
1558
1573
|
};
|
|
1559
1574
|
/** @returns {InvoicePaymentOptionsResponse} */
|
|
1560
1575
|
declare function InvoicePaymentOptionsResponse(): InvoicePaymentOptionsResponse;
|
|
1561
1576
|
type InvoicePaymentOptionsResponse = {
|
|
1562
1577
|
reason?: string;
|
|
1563
|
-
data?: InvoicePaymentOptionsResponseData;
|
|
1578
|
+
data?: InvoicePaymentOptionsResponseData[];
|
|
1579
|
+
total_payable_amount?: number;
|
|
1580
|
+
invoice_count?: number;
|
|
1564
1581
|
success?: boolean;
|
|
1565
1582
|
};
|
|
1566
1583
|
/** @returns {PaymentDetail} */
|