@gofynd/fdk-client-javascript 3.3.6 → 3.4.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/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +115 -47
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +67 -35
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +454 -12
- package/sdk/platform/Cart/CartPlatformModel.js +457 -10
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
- package/sdk/platform/Content/ContentPlatformModel.js +6 -20
- package/sdk/platform/Order/OrderPlatformModel.d.ts +237 -17
- package/sdk/platform/Order/OrderPlatformModel.js +388 -14
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
- package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1033 -113
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +613 -35
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.4.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -324,7 +324,7 @@ declare class Catalog {
|
|
|
324
324
|
* @summary: Get product price
|
|
325
325
|
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
|
|
326
326
|
*/
|
|
327
|
-
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
|
|
327
|
+
getProductPriceBySlug({ slug, size, storeId, moq, fulfillmentOptionSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
|
|
328
328
|
/**
|
|
329
329
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
330
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -333,7 +333,7 @@ declare class Catalog {
|
|
|
333
333
|
* @summary: List sellers
|
|
334
334
|
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
335
335
|
*/
|
|
336
|
-
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
336
|
+
getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
337
337
|
/**
|
|
338
338
|
* @param {Object} arg - Arg object.
|
|
339
339
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -344,15 +344,18 @@ declare class Catalog {
|
|
|
344
344
|
* /service/application/catalog/v1.0/products/sizes.
|
|
345
345
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
346
346
|
* eg, fast-delivery, low-price, optimal.
|
|
347
|
+
* @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
|
|
348
|
+
* method, indicating whether an order is for home delivery or store pickup
|
|
347
349
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
348
350
|
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
349
351
|
* @summary: List sellers
|
|
350
352
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
351
353
|
*/
|
|
352
|
-
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
|
|
354
|
+
getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, }?: {
|
|
353
355
|
slug: string;
|
|
354
356
|
size: string;
|
|
355
357
|
strategy?: string;
|
|
358
|
+
fulfillmentOptionSlug?: string;
|
|
356
359
|
pageSize?: number;
|
|
357
360
|
}): Paginator<ProductSizeSellersResponseV4>;
|
|
358
361
|
/**
|
|
@@ -1168,7 +1168,9 @@ class Catalog {
|
|
|
1168
1168
|
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
|
|
1169
1169
|
*/
|
|
1170
1170
|
async getProductPriceBySlug(
|
|
1171
|
-
{ slug, size, storeId, moq, requestHeaders } = {
|
|
1171
|
+
{ slug, size, storeId, moq, fulfillmentOptionSlug, requestHeaders } = {
|
|
1172
|
+
requestHeaders: {},
|
|
1173
|
+
},
|
|
1172
1174
|
{ responseHeaders } = { responseHeaders: false }
|
|
1173
1175
|
) {
|
|
1174
1176
|
const errors = validateRequiredParams(arguments[0], ["slug", "size"]);
|
|
@@ -1183,6 +1185,7 @@ class Catalog {
|
|
|
1183
1185
|
const query_params = {};
|
|
1184
1186
|
query_params["store_id"] = storeId;
|
|
1185
1187
|
query_params["moq"] = moq;
|
|
1188
|
+
query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
|
|
1186
1189
|
|
|
1187
1190
|
const xHeaders = {};
|
|
1188
1191
|
|
|
@@ -1216,9 +1219,15 @@ class Catalog {
|
|
|
1216
1219
|
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
1217
1220
|
*/
|
|
1218
1221
|
async getProductSellersBySlug(
|
|
1219
|
-
{
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
+
{
|
|
1223
|
+
slug,
|
|
1224
|
+
size,
|
|
1225
|
+
strategy,
|
|
1226
|
+
fulfillmentOptionSlug,
|
|
1227
|
+
pageNo,
|
|
1228
|
+
pageSize,
|
|
1229
|
+
requestHeaders,
|
|
1230
|
+
} = { requestHeaders: {} },
|
|
1222
1231
|
{ responseHeaders } = { responseHeaders: false }
|
|
1223
1232
|
) {
|
|
1224
1233
|
const errors = validateRequiredParams(arguments[0], ["slug", "size"]);
|
|
@@ -1232,6 +1241,7 @@ class Catalog {
|
|
|
1232
1241
|
|
|
1233
1242
|
const query_params = {};
|
|
1234
1243
|
query_params["strategy"] = strategy;
|
|
1244
|
+
query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
|
|
1235
1245
|
query_params["page_no"] = pageNo;
|
|
1236
1246
|
query_params["page_size"] = pageSize;
|
|
1237
1247
|
|
|
@@ -1268,12 +1278,20 @@ class Catalog {
|
|
|
1268
1278
|
* /service/application/catalog/v1.0/products/sizes.
|
|
1269
1279
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
1270
1280
|
* eg, fast-delivery, low-price, optimal.
|
|
1281
|
+
* @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
|
|
1282
|
+
* method, indicating whether an order is for home delivery or store pickup
|
|
1271
1283
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1272
1284
|
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
1273
1285
|
* @summary: List sellers
|
|
1274
1286
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
1275
1287
|
*/
|
|
1276
|
-
getProductSellersBySlugPaginator({
|
|
1288
|
+
getProductSellersBySlugPaginator({
|
|
1289
|
+
slug,
|
|
1290
|
+
size,
|
|
1291
|
+
strategy,
|
|
1292
|
+
fulfillmentOptionSlug,
|
|
1293
|
+
pageSize,
|
|
1294
|
+
} = {}) {
|
|
1277
1295
|
const paginator = new Paginator();
|
|
1278
1296
|
const callback = async () => {
|
|
1279
1297
|
const pageId = paginator.nextId;
|
|
@@ -1283,6 +1301,7 @@ class Catalog {
|
|
|
1283
1301
|
slug: slug,
|
|
1284
1302
|
size: size,
|
|
1285
1303
|
strategy: strategy,
|
|
1304
|
+
fulfillmentOptionSlug: fulfillmentOptionSlug,
|
|
1286
1305
|
pageNo: pageNo,
|
|
1287
1306
|
pageSize: pageSize,
|
|
1288
1307
|
});
|
|
@@ -8,6 +8,7 @@ declare class Logistic {
|
|
|
8
8
|
getCountry: string;
|
|
9
9
|
getCourierPartners: string;
|
|
10
10
|
getDeliveryPromise: string;
|
|
11
|
+
getFulfillmentOptions: string;
|
|
11
12
|
getLocalities: string;
|
|
12
13
|
getLocality: string;
|
|
13
14
|
getPincodeCity: string;
|
|
@@ -60,6 +61,15 @@ declare class Logistic {
|
|
|
60
61
|
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
61
62
|
*/
|
|
62
63
|
getDeliveryPromise({ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
64
|
+
/**
|
|
65
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
66
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
67
|
+
* @returns {Promise<FulfillmentOptionsList>} - Success response
|
|
68
|
+
* @name getFulfillmentOptions
|
|
69
|
+
* @summary: Get fulfillment options
|
|
70
|
+
* @description: Fetches available fulfillment options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptions/).
|
|
71
|
+
*/
|
|
72
|
+
getFulfillmentOptions({ xApplicationData, productSlug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FulfillmentOptionsList>;
|
|
63
73
|
/**
|
|
64
74
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
65
75
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -20,6 +20,8 @@ class Logistic {
|
|
|
20
20
|
"/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
|
|
21
21
|
getDeliveryPromise:
|
|
22
22
|
"/service/application/logistics/v1.0/delivery-promise",
|
|
23
|
+
getFulfillmentOptions:
|
|
24
|
+
"/service/application/logistics/v1.0/fulfillment-options",
|
|
23
25
|
getLocalities:
|
|
24
26
|
"/service/application/logistics/v1.0/localities/{locality_type}",
|
|
25
27
|
getLocality:
|
|
@@ -270,6 +272,48 @@ class Logistic {
|
|
|
270
272
|
return response;
|
|
271
273
|
}
|
|
272
274
|
|
|
275
|
+
/**
|
|
276
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
277
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
278
|
+
* @returns {Promise<FulfillmentOptionsList>} - Success response
|
|
279
|
+
* @name getFulfillmentOptions
|
|
280
|
+
* @summary: Get fulfillment options
|
|
281
|
+
* @description: Fetches available fulfillment options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptions/).
|
|
282
|
+
*/
|
|
283
|
+
async getFulfillmentOptions(
|
|
284
|
+
{ xApplicationData, productSlug, storeId, requestHeaders } = {
|
|
285
|
+
requestHeaders: {},
|
|
286
|
+
},
|
|
287
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
288
|
+
) {
|
|
289
|
+
const query_params = {};
|
|
290
|
+
query_params["product_slug"] = productSlug;
|
|
291
|
+
query_params["store_id"] = storeId;
|
|
292
|
+
|
|
293
|
+
const xHeaders = {};
|
|
294
|
+
xHeaders["x-application-data"] = xApplicationData;
|
|
295
|
+
|
|
296
|
+
const response = await ApplicationAPIClient.execute(
|
|
297
|
+
this._conf,
|
|
298
|
+
"get",
|
|
299
|
+
constructUrl({
|
|
300
|
+
url: this._urls["getFulfillmentOptions"],
|
|
301
|
+
params: {},
|
|
302
|
+
}),
|
|
303
|
+
query_params,
|
|
304
|
+
undefined,
|
|
305
|
+
{ ...xHeaders, ...requestHeaders },
|
|
306
|
+
{ responseHeaders }
|
|
307
|
+
);
|
|
308
|
+
|
|
309
|
+
let responseData = response;
|
|
310
|
+
if (responseHeaders) {
|
|
311
|
+
responseData = response[0];
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
return response;
|
|
315
|
+
}
|
|
316
|
+
|
|
273
317
|
/**
|
|
274
318
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
275
319
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -8,7 +8,7 @@ export = LogisticsPartnerModel;
|
|
|
8
8
|
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
9
9
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
10
10
|
* fetch or modify scheme details.
|
|
11
|
-
* @property {string} [company_id] -
|
|
11
|
+
* @property {string} [company_id] - The unique identifier of the company.
|
|
12
12
|
* @property {string} name - Name of the scheme.
|
|
13
13
|
* @property {ArithmeticOperations} weight
|
|
14
14
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
@@ -31,6 +31,12 @@ export = LogisticsPartnerModel;
|
|
|
31
31
|
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
32
32
|
* quantity of items allowed in a non-quality check shipment.
|
|
33
33
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
34
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
35
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
36
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
37
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
38
|
+
* @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
|
|
39
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
34
40
|
*/
|
|
35
41
|
/**
|
|
36
42
|
* @typedef BulkRegionServiceabilityTatDetails
|
|
@@ -360,9 +366,10 @@ export = LogisticsPartnerModel;
|
|
|
360
366
|
* fetch or modify scheme details.
|
|
361
367
|
* @property {string} name - Name of the scheme.
|
|
362
368
|
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
363
|
-
* forward pickup (nullable).
|
|
369
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
364
370
|
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
365
|
-
* reverse pickup (nullable).
|
|
371
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
372
|
+
* @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
|
|
366
373
|
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
367
374
|
* @property {ArithmeticOperations} weight
|
|
368
375
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
@@ -394,7 +401,7 @@ export = LogisticsPartnerModel;
|
|
|
394
401
|
* @property {string} [created_on] - The timestamp when the record was created.
|
|
395
402
|
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
396
403
|
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
397
|
-
* @property {string} [company_id] -
|
|
404
|
+
* @property {string} [company_id] - The unique identifier of the company.
|
|
398
405
|
* @property {string} name - Name of the scheme.
|
|
399
406
|
* @property {ArithmeticOperations} weight
|
|
400
407
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
@@ -417,6 +424,12 @@ export = LogisticsPartnerModel;
|
|
|
417
424
|
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
418
425
|
* quantity of items allowed in a non-quality check shipment.
|
|
419
426
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
427
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
428
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
429
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
430
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
431
|
+
* @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
|
|
432
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
420
433
|
*/
|
|
421
434
|
/**
|
|
422
435
|
* @typedef CourierPartnerSchemeList
|
|
@@ -447,6 +460,12 @@ export = LogisticsPartnerModel;
|
|
|
447
460
|
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
448
461
|
* quantity of items allowed in a non-quality check shipment.
|
|
449
462
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
463
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
464
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
465
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
466
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
467
|
+
* @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
|
|
468
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
450
469
|
*/
|
|
451
470
|
/**
|
|
452
471
|
* @typedef GetCountries
|
|
@@ -534,6 +553,18 @@ export = LogisticsPartnerModel;
|
|
|
534
553
|
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
535
554
|
* quantity of items allowed in a non-quality check shipment.
|
|
536
555
|
*/
|
|
556
|
+
/**
|
|
557
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
558
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
559
|
+
* time (tat) to be used for the given scheme or not.
|
|
560
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
561
|
+
*/
|
|
562
|
+
/**
|
|
563
|
+
* @typedef CourierPartnerSchemeTat
|
|
564
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
565
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
566
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
567
|
+
*/
|
|
537
568
|
/**
|
|
538
569
|
* @typedef Error
|
|
539
570
|
* @property {string} [type] - The type of the error.
|
|
@@ -575,18 +606,6 @@ export = LogisticsPartnerModel;
|
|
|
575
606
|
* @property {string} stage - A string indicating the current stage of the scheme.
|
|
576
607
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
577
608
|
*/
|
|
578
|
-
/**
|
|
579
|
-
* @typedef CourierPartnerSchemeDefaultTat
|
|
580
|
-
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
581
|
-
* time (tat) to be used for the given scheme or not.
|
|
582
|
-
* @property {CourierPartnerSchemeTat} [tat]
|
|
583
|
-
*/
|
|
584
|
-
/**
|
|
585
|
-
* @typedef CourierPartnerSchemeTat
|
|
586
|
-
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
587
|
-
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
588
|
-
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
589
|
-
*/
|
|
590
609
|
/**
|
|
591
610
|
* @typedef GetCountriesItems
|
|
592
611
|
* @property {string} [id] - A string serving as the unique identifier.
|
|
@@ -633,7 +652,7 @@ export = LogisticsPartnerModel;
|
|
|
633
652
|
declare class LogisticsPartnerModel {
|
|
634
653
|
}
|
|
635
654
|
declare namespace LogisticsPartnerModel {
|
|
636
|
-
export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, Error, Page, TATDetails, CourierPartnerSchemeModel,
|
|
655
|
+
export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, Error, Page, TATDetails, CourierPartnerSchemeModel, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
|
|
637
656
|
}
|
|
638
657
|
/** @returns {CourierPartnerSchemeModelSchema} */
|
|
639
658
|
declare function CourierPartnerSchemeModelSchema(): CourierPartnerSchemeModelSchema;
|
|
@@ -658,7 +677,7 @@ type CourierPartnerSchemeModelSchema = {
|
|
|
658
677
|
*/
|
|
659
678
|
scheme_id?: string;
|
|
660
679
|
/**
|
|
661
|
-
* -
|
|
680
|
+
* - The unique identifier of the company.
|
|
662
681
|
*/
|
|
663
682
|
company_id?: string;
|
|
664
683
|
/**
|
|
@@ -713,6 +732,21 @@ type CourierPartnerSchemeModelSchema = {
|
|
|
713
732
|
*/
|
|
714
733
|
non_qc_shipment_item_quantity?: number;
|
|
715
734
|
feature: CourierPartnerSchemeFeatures;
|
|
735
|
+
/**
|
|
736
|
+
* - Default cutoff time for
|
|
737
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
738
|
+
*/
|
|
739
|
+
default_forward_pickup_cutoff?: string;
|
|
740
|
+
/**
|
|
741
|
+
* - Default cutoff time for
|
|
742
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
743
|
+
*/
|
|
744
|
+
default_reverse_pickup_cutoff?: string;
|
|
745
|
+
/**
|
|
746
|
+
* - Timezone for default cutoff time.
|
|
747
|
+
*/
|
|
748
|
+
default_cutoff_timezone?: string;
|
|
749
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
716
750
|
};
|
|
717
751
|
/** @returns {BulkRegionServiceabilityTatDetails} */
|
|
718
752
|
declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
|
|
@@ -1496,14 +1530,18 @@ type CourierPartnerSchemeDetailsModel = {
|
|
|
1496
1530
|
name: string;
|
|
1497
1531
|
/**
|
|
1498
1532
|
* - Default cutoff time for
|
|
1499
|
-
* forward pickup (nullable).
|
|
1533
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
1500
1534
|
*/
|
|
1501
1535
|
default_forward_pickup_cutoff?: string;
|
|
1502
1536
|
/**
|
|
1503
1537
|
* - Default cutoff time for
|
|
1504
|
-
* reverse pickup (nullable).
|
|
1538
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
1505
1539
|
*/
|
|
1506
1540
|
default_reverse_pickup_cutoff?: string;
|
|
1541
|
+
/**
|
|
1542
|
+
* - Timezone for default cutoff time.
|
|
1543
|
+
*/
|
|
1544
|
+
default_cutoff_timezone?: string;
|
|
1507
1545
|
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
1508
1546
|
weight: ArithmeticOperations;
|
|
1509
1547
|
volumetric_weight?: ArithmeticOperations;
|
|
@@ -1576,7 +1614,7 @@ type CourierPartnerPutSchema = {
|
|
|
1576
1614
|
*/
|
|
1577
1615
|
scheme_id?: string;
|
|
1578
1616
|
/**
|
|
1579
|
-
* -
|
|
1617
|
+
* - The unique identifier of the company.
|
|
1580
1618
|
*/
|
|
1581
1619
|
company_id?: string;
|
|
1582
1620
|
/**
|
|
@@ -1631,6 +1669,21 @@ type CourierPartnerPutSchema = {
|
|
|
1631
1669
|
*/
|
|
1632
1670
|
non_qc_shipment_item_quantity?: number;
|
|
1633
1671
|
feature: CourierPartnerSchemeFeatures;
|
|
1672
|
+
/**
|
|
1673
|
+
* - Default cutoff time for
|
|
1674
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
1675
|
+
*/
|
|
1676
|
+
default_forward_pickup_cutoff?: string;
|
|
1677
|
+
/**
|
|
1678
|
+
* - Default cutoff time for
|
|
1679
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
1680
|
+
*/
|
|
1681
|
+
default_reverse_pickup_cutoff?: string;
|
|
1682
|
+
/**
|
|
1683
|
+
* - Timezone for default cutoff time.
|
|
1684
|
+
*/
|
|
1685
|
+
default_cutoff_timezone?: string;
|
|
1686
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
1634
1687
|
};
|
|
1635
1688
|
/** @returns {CourierPartnerSchemeList} */
|
|
1636
1689
|
declare function CourierPartnerSchemeList(): CourierPartnerSchemeList;
|
|
@@ -1696,6 +1749,21 @@ type CourierPartnerSchemeUpdateDetails = {
|
|
|
1696
1749
|
*/
|
|
1697
1750
|
non_qc_shipment_item_quantity?: number;
|
|
1698
1751
|
feature: CourierPartnerSchemeFeatures;
|
|
1752
|
+
/**
|
|
1753
|
+
* - Default cutoff time for
|
|
1754
|
+
* forward pickup (nullable), having 24hour time format HH:MM.
|
|
1755
|
+
*/
|
|
1756
|
+
default_forward_pickup_cutoff?: string;
|
|
1757
|
+
/**
|
|
1758
|
+
* - Default cutoff time for
|
|
1759
|
+
* reverse pickup (nullable), having 24hour time format HH:MM.
|
|
1760
|
+
*/
|
|
1761
|
+
default_reverse_pickup_cutoff?: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* - Timezone for default cutoff time.
|
|
1764
|
+
*/
|
|
1765
|
+
default_cutoff_timezone?: string;
|
|
1766
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
1699
1767
|
};
|
|
1700
1768
|
/** @returns {GetCountries} */
|
|
1701
1769
|
declare function GetCountries(): GetCountries;
|
|
@@ -1884,6 +1952,32 @@ type CourierPartnerSchemeFeatures = {
|
|
|
1884
1952
|
*/
|
|
1885
1953
|
non_qc_shipment_item_quantity?: number;
|
|
1886
1954
|
};
|
|
1955
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
1956
|
+
declare function CourierPartnerSchemeDefaultTat(): CourierPartnerSchemeDefaultTat;
|
|
1957
|
+
type CourierPartnerSchemeDefaultTat = {
|
|
1958
|
+
/**
|
|
1959
|
+
* - Indicates whether the default turn around
|
|
1960
|
+
* time (tat) to be used for the given scheme or not.
|
|
1961
|
+
*/
|
|
1962
|
+
enabled?: boolean;
|
|
1963
|
+
tat?: CourierPartnerSchemeTat;
|
|
1964
|
+
};
|
|
1965
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
1966
|
+
declare function CourierPartnerSchemeTat(): CourierPartnerSchemeTat;
|
|
1967
|
+
type CourierPartnerSchemeTat = {
|
|
1968
|
+
/**
|
|
1969
|
+
* - Minimum turn around time (tat) value for a scheme.
|
|
1970
|
+
*/
|
|
1971
|
+
min?: number;
|
|
1972
|
+
/**
|
|
1973
|
+
* - Maximum turn around time (tat) value for a scheme.
|
|
1974
|
+
*/
|
|
1975
|
+
max?: number;
|
|
1976
|
+
/**
|
|
1977
|
+
* - Unit for the turn around time (tat) values for a scheme.
|
|
1978
|
+
*/
|
|
1979
|
+
unit?: string;
|
|
1980
|
+
};
|
|
1887
1981
|
/** @returns {Error} */
|
|
1888
1982
|
declare function Error(): Error;
|
|
1889
1983
|
type Error = {
|
|
@@ -1992,32 +2086,6 @@ type CourierPartnerSchemeModel = {
|
|
|
1992
2086
|
stage: string;
|
|
1993
2087
|
feature: CourierPartnerSchemeFeatures;
|
|
1994
2088
|
};
|
|
1995
|
-
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
1996
|
-
declare function CourierPartnerSchemeDefaultTat(): CourierPartnerSchemeDefaultTat;
|
|
1997
|
-
type CourierPartnerSchemeDefaultTat = {
|
|
1998
|
-
/**
|
|
1999
|
-
* - Indicates whether the default turn around
|
|
2000
|
-
* time (tat) to be used for the given scheme or not.
|
|
2001
|
-
*/
|
|
2002
|
-
enabled?: boolean;
|
|
2003
|
-
tat?: CourierPartnerSchemeTat;
|
|
2004
|
-
};
|
|
2005
|
-
/** @returns {CourierPartnerSchemeTat} */
|
|
2006
|
-
declare function CourierPartnerSchemeTat(): CourierPartnerSchemeTat;
|
|
2007
|
-
type CourierPartnerSchemeTat = {
|
|
2008
|
-
/**
|
|
2009
|
-
* - Minimum turn around time (tat) value for a scheme.
|
|
2010
|
-
*/
|
|
2011
|
-
min?: number;
|
|
2012
|
-
/**
|
|
2013
|
-
* - Maximum turn around time (tat) value for a scheme.
|
|
2014
|
-
*/
|
|
2015
|
-
max?: number;
|
|
2016
|
-
/**
|
|
2017
|
-
* - Unit for the turn around time (tat) values for a scheme.
|
|
2018
|
-
*/
|
|
2019
|
-
unit?: string;
|
|
2020
|
-
};
|
|
2021
2089
|
/** @returns {GetCountriesItems} */
|
|
2022
2090
|
declare function GetCountriesItems(): GetCountriesItems;
|
|
2023
2091
|
type GetCountriesItems = {
|