@gofynd/fdk-client-javascript 3.16.3 → 3.17.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/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
- package/sdk/application/Cart/CartApplicationClient.js +176 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
- package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +21 -1
- package/sdk/application/Content/ContentApplicationClient.js +93 -2
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
- package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
- package/sdk/application/Order/OrderApplicationClient.js +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +5 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +74 -12
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +637 -36
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +952 -5
- package/sdk/platform/Cart/CartPlatformModel.js +598 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +125 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +831 -41
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -16
- package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1025 -159
- package/sdk/platform/Catalog/CatalogPlatformModel.js +840 -165
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +8 -10
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -12
- package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
- package/sdk/platform/Common/CommonPlatformModel.js +14 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -462
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +7 -45
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +4 -55
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +27 -19
- package/sdk/platform/Order/OrderPlatformClient.js +176 -108
- package/sdk/platform/Order/OrderPlatformModel.d.ts +359 -45
- package/sdk/platform/Order/OrderPlatformModel.js +218 -44
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
- package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +376 -11
- package/sdk/platform/Payment/PaymentPlatformModel.js +243 -10
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
- package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
|
@@ -19,6 +19,8 @@ class Content {
|
|
|
19
19
|
getAnnouncements: "/service/application/content/v1.0/announcements",
|
|
20
20
|
getBlog: "/service/application/content/v1.0/blogs/{slug}",
|
|
21
21
|
getBlogs: "/service/application/content/v1.0/blogs",
|
|
22
|
+
getBulkCustomFieldsByResource:
|
|
23
|
+
"/service/application/content/v2.0/customfields/resource/{resource}",
|
|
22
24
|
getCustomFieldsByResourceId:
|
|
23
25
|
"/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}",
|
|
24
26
|
getCustomObjectBySlug:
|
|
@@ -34,6 +36,8 @@ class Content {
|
|
|
34
36
|
getLandingPage: "/service/application/content/v1.0/landing-page",
|
|
35
37
|
getLegalInformation: "/service/application/content/v1.0/legal",
|
|
36
38
|
getNavigations: "/service/application/content/v1.0/navigations",
|
|
39
|
+
getOrderTranslation:
|
|
40
|
+
"/service/application/content/v1.0/resource/translations/orders",
|
|
37
41
|
getPage: "/service/application/content/v2.0/pages/{slug}",
|
|
38
42
|
getPages: "/service/application/content/v2.0/pages",
|
|
39
43
|
getSEOConfiguration: "/service/application/content/v1.0/seo",
|
|
@@ -116,7 +120,7 @@ class Content {
|
|
|
116
120
|
* @description: Submit and retrieve translations for resources using payload data and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/fetchResourceTranslationsWithPayload/).
|
|
117
121
|
*/
|
|
118
122
|
async fetchResourceTranslationsWithPayload(
|
|
119
|
-
{ type, locale,
|
|
123
|
+
{ type, locale, body, requestHeaders } = { requestHeaders: {} },
|
|
120
124
|
{ responseHeaders } = { responseHeaders: false }
|
|
121
125
|
) {
|
|
122
126
|
const errors = validateRequiredParams(arguments[0], ["type", "locale"]);
|
|
@@ -129,7 +133,6 @@ class Content {
|
|
|
129
133
|
}
|
|
130
134
|
|
|
131
135
|
const query_params = {};
|
|
132
|
-
query_params["resource_id"] = resourceId;
|
|
133
136
|
|
|
134
137
|
const xHeaders = {};
|
|
135
138
|
|
|
@@ -280,6 +283,57 @@ class Content {
|
|
|
280
283
|
return response;
|
|
281
284
|
}
|
|
282
285
|
|
|
286
|
+
/**
|
|
287
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
288
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
289
|
+
* @returns {Promise<BulkCustomFieldsResponseByResourceSchema>} - Success response
|
|
290
|
+
* @name getBulkCustomFieldsByResource
|
|
291
|
+
* @summary: Get bulk list of custom fields of given resource
|
|
292
|
+
* @description: Retrieves a bulk list of custom fields attached to a particular resource by using the resource and resource IDs. The resource_ids query parameter is required and can accept multiple comma-separated values. Optional filters for keys and namespaces can also be applied. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBulkCustomFieldsByResource/).
|
|
293
|
+
*/
|
|
294
|
+
async getBulkCustomFieldsByResource(
|
|
295
|
+
{ resource, resourceIds, keys, namespaces, requestHeaders } = {
|
|
296
|
+
requestHeaders: {},
|
|
297
|
+
},
|
|
298
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
299
|
+
) {
|
|
300
|
+
const errors = validateRequiredParams(arguments[0], ["resource"]);
|
|
301
|
+
if (errors.length > 0) {
|
|
302
|
+
const error = new FDKClientValidationError({
|
|
303
|
+
message: "Missing required field",
|
|
304
|
+
details: errors,
|
|
305
|
+
});
|
|
306
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
const query_params = {};
|
|
310
|
+
query_params["resource_ids"] = resourceIds;
|
|
311
|
+
query_params["keys"] = keys;
|
|
312
|
+
query_params["namespaces"] = namespaces;
|
|
313
|
+
|
|
314
|
+
const xHeaders = {};
|
|
315
|
+
|
|
316
|
+
const response = await ApplicationAPIClient.execute(
|
|
317
|
+
this._conf,
|
|
318
|
+
"get",
|
|
319
|
+
constructUrl({
|
|
320
|
+
url: this._urls["getBulkCustomFieldsByResource"],
|
|
321
|
+
params: { resource },
|
|
322
|
+
}),
|
|
323
|
+
query_params,
|
|
324
|
+
undefined,
|
|
325
|
+
{ ...xHeaders, ...requestHeaders },
|
|
326
|
+
{ responseHeaders }
|
|
327
|
+
);
|
|
328
|
+
|
|
329
|
+
let responseData = response;
|
|
330
|
+
if (responseHeaders) {
|
|
331
|
+
responseData = response[0];
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
return response;
|
|
335
|
+
}
|
|
336
|
+
|
|
283
337
|
/**
|
|
284
338
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
285
339
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -740,6 +794,43 @@ class Content {
|
|
|
740
794
|
return response;
|
|
741
795
|
}
|
|
742
796
|
|
|
797
|
+
/**
|
|
798
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
799
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
800
|
+
* @returns {Promise<TranslationResult>} - Success response
|
|
801
|
+
* @name getOrderTranslation
|
|
802
|
+
* @summary: Get Order Translations
|
|
803
|
+
* @description: Retrieves translated information for orders or shipments. This endpoint processes the order/shipment payload and returns the same structure with translated details including names, brands, categories, and other localized content. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getOrderTranslation/).
|
|
804
|
+
*/
|
|
805
|
+
async getOrderTranslation(
|
|
806
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
807
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
808
|
+
) {
|
|
809
|
+
const query_params = {};
|
|
810
|
+
|
|
811
|
+
const xHeaders = {};
|
|
812
|
+
|
|
813
|
+
const response = await ApplicationAPIClient.execute(
|
|
814
|
+
this._conf,
|
|
815
|
+
"post",
|
|
816
|
+
constructUrl({
|
|
817
|
+
url: this._urls["getOrderTranslation"],
|
|
818
|
+
params: {},
|
|
819
|
+
}),
|
|
820
|
+
query_params,
|
|
821
|
+
body,
|
|
822
|
+
{ ...xHeaders, ...requestHeaders },
|
|
823
|
+
{ responseHeaders }
|
|
824
|
+
);
|
|
825
|
+
|
|
826
|
+
let responseData = response;
|
|
827
|
+
if (responseHeaders) {
|
|
828
|
+
responseData = response[0];
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
return response;
|
|
832
|
+
}
|
|
833
|
+
|
|
743
834
|
/**
|
|
744
835
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
745
836
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -6,12 +6,11 @@ declare class Logistic {
|
|
|
6
6
|
getAllCountries: string;
|
|
7
7
|
getCountries: string;
|
|
8
8
|
getCountry: string;
|
|
9
|
-
getCourierPartners: string;
|
|
10
9
|
getDeliveryPromise: string;
|
|
10
|
+
getFulfillmentOptionStores: string;
|
|
11
11
|
getFulfillmentOptions: string;
|
|
12
12
|
getLocalities: string;
|
|
13
13
|
getLocality: string;
|
|
14
|
-
getPincodeCity: string;
|
|
15
14
|
validateAddress: string;
|
|
16
15
|
};
|
|
17
16
|
_urls: {};
|
|
@@ -46,21 +45,21 @@ declare class Logistic {
|
|
|
46
45
|
/**
|
|
47
46
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
47
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<
|
|
50
|
-
* @name
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
48
|
+
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
49
|
+
* @name getDeliveryPromise
|
|
50
|
+
* @summary: Get delivery promise
|
|
51
|
+
* @description: Delivery Promise Configurations involve estimating and communicating the anticipated delivery date or time to customers, taking into account parameters like store processing time, delivery partner time to delivery, and buffer time. This helps establish precise delivery expectations based on both the delivery partner's capabilities and the store's operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
53
52
|
*/
|
|
54
|
-
|
|
53
|
+
getDeliveryPromise({ xLocationDetail, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
55
54
|
/**
|
|
56
55
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
57
56
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
58
|
-
* @returns {Promise<
|
|
59
|
-
* @name
|
|
60
|
-
* @summary: Get
|
|
61
|
-
* @description:
|
|
57
|
+
* @returns {Promise<FulfillmentOptionStores>} - Success response
|
|
58
|
+
* @name getFulfillmentOptionStores
|
|
59
|
+
* @summary: Get Fulfillment Option Stores
|
|
60
|
+
* @description: Fetches a paginated list of stores associated with a given fulfillment option slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptionStores/).
|
|
62
61
|
*/
|
|
63
|
-
|
|
62
|
+
getFulfillmentOptionStores({ slug, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FulfillmentOptionStores>;
|
|
64
63
|
/**
|
|
65
64
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
66
65
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -88,15 +87,6 @@ declare class Logistic {
|
|
|
88
87
|
* @description: Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocality/).
|
|
89
88
|
*/
|
|
90
89
|
getLocality({ localityType, localityValue, country, state, city, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetLocalityApp>;
|
|
91
|
-
/**
|
|
92
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
93
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
94
|
-
* @returns {Promise<PincodeDetailsResult>} - Success response
|
|
95
|
-
* @name getPincodeCity
|
|
96
|
-
* @summary: Get pincode details
|
|
97
|
-
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getPincodeCity/).
|
|
98
|
-
*/
|
|
99
|
-
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PincodeDetailsResult>;
|
|
100
90
|
/**
|
|
101
91
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
92
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -16,17 +16,16 @@ class Logistic {
|
|
|
16
16
|
getCountries: "/service/application/logistics/v2.0/countries",
|
|
17
17
|
getCountry:
|
|
18
18
|
"/service/application/logistics/v1.0/countries/{country_iso_code}",
|
|
19
|
-
getCourierPartners:
|
|
20
|
-
"/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
|
|
21
19
|
getDeliveryPromise:
|
|
22
20
|
"/service/application/logistics/v1.0/delivery-promise",
|
|
21
|
+
getFulfillmentOptionStores:
|
|
22
|
+
"/service/application/logistics/v1.0/fulfillment-options/{slug}/stores",
|
|
23
23
|
getFulfillmentOptions:
|
|
24
24
|
"/service/application/logistics/v1.0/fulfillment-options",
|
|
25
25
|
getLocalities:
|
|
26
26
|
"/service/application/logistics/v1.0/localities/{locality_type}",
|
|
27
27
|
getLocality:
|
|
28
28
|
"/service/application/logistics/v1.0/localities/{locality_type}/{locality_value}",
|
|
29
|
-
getPincodeCity: "/service/application/logistics/v1.0/pincode/{pincode}",
|
|
30
29
|
validateAddress:
|
|
31
30
|
"/service/application/logistics/v1.0/country/{country_iso_code}/address/templates/{template_name}/validate",
|
|
32
31
|
};
|
|
@@ -183,40 +182,33 @@ class Logistic {
|
|
|
183
182
|
/**
|
|
184
183
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
185
184
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
186
|
-
* @returns {Promise<
|
|
187
|
-
* @name
|
|
188
|
-
* @summary:
|
|
189
|
-
* @description:
|
|
185
|
+
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
186
|
+
* @name getDeliveryPromise
|
|
187
|
+
* @summary: Get delivery promise
|
|
188
|
+
* @description: Delivery Promise Configurations involve estimating and communicating the anticipated delivery date or time to customers, taking into account parameters like store processing time, delivery partner time to delivery, and buffer time. This helps establish precise delivery expectations based on both the delivery partner's capabilities and the store's operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
190
189
|
*/
|
|
191
|
-
async
|
|
192
|
-
{
|
|
190
|
+
async getDeliveryPromise(
|
|
191
|
+
{ xLocationDetail, pageNo, pageSize, requestHeaders } = {
|
|
192
|
+
requestHeaders: {},
|
|
193
|
+
},
|
|
193
194
|
{ responseHeaders } = { responseHeaders: false }
|
|
194
195
|
) {
|
|
195
|
-
const errors = validateRequiredParams(arguments[0], [
|
|
196
|
-
"companyId",
|
|
197
|
-
"applicationId",
|
|
198
|
-
]);
|
|
199
|
-
if (errors.length > 0) {
|
|
200
|
-
const error = new FDKClientValidationError({
|
|
201
|
-
message: "Missing required field",
|
|
202
|
-
details: errors,
|
|
203
|
-
});
|
|
204
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
205
|
-
}
|
|
206
|
-
|
|
207
196
|
const query_params = {};
|
|
197
|
+
query_params["page_no"] = pageNo;
|
|
198
|
+
query_params["page_size"] = pageSize;
|
|
208
199
|
|
|
209
200
|
const xHeaders = {};
|
|
201
|
+
xHeaders["x-location-detail"] = xLocationDetail;
|
|
210
202
|
|
|
211
203
|
const response = await ApplicationAPIClient.execute(
|
|
212
204
|
this._conf,
|
|
213
|
-
"
|
|
205
|
+
"get",
|
|
214
206
|
constructUrl({
|
|
215
|
-
url: this._urls["
|
|
216
|
-
params: {
|
|
207
|
+
url: this._urls["getDeliveryPromise"],
|
|
208
|
+
params: {},
|
|
217
209
|
}),
|
|
218
210
|
query_params,
|
|
219
|
-
|
|
211
|
+
undefined,
|
|
220
212
|
{ ...xHeaders, ...requestHeaders },
|
|
221
213
|
{ responseHeaders }
|
|
222
214
|
);
|
|
@@ -232,31 +224,36 @@ class Logistic {
|
|
|
232
224
|
/**
|
|
233
225
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
234
226
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
235
|
-
* @returns {Promise<
|
|
236
|
-
* @name
|
|
237
|
-
* @summary: Get
|
|
238
|
-
* @description:
|
|
227
|
+
* @returns {Promise<FulfillmentOptionStores>} - Success response
|
|
228
|
+
* @name getFulfillmentOptionStores
|
|
229
|
+
* @summary: Get Fulfillment Option Stores
|
|
230
|
+
* @description: Fetches a paginated list of stores associated with a given fulfillment option slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptionStores/).
|
|
239
231
|
*/
|
|
240
|
-
async
|
|
241
|
-
{
|
|
242
|
-
requestHeaders: {},
|
|
243
|
-
},
|
|
232
|
+
async getFulfillmentOptionStores(
|
|
233
|
+
{ slug, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
244
234
|
{ responseHeaders } = { responseHeaders: false }
|
|
245
235
|
) {
|
|
236
|
+
const errors = validateRequiredParams(arguments[0], ["slug"]);
|
|
237
|
+
if (errors.length > 0) {
|
|
238
|
+
const error = new FDKClientValidationError({
|
|
239
|
+
message: "Missing required field",
|
|
240
|
+
details: errors,
|
|
241
|
+
});
|
|
242
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
243
|
+
}
|
|
244
|
+
|
|
246
245
|
const query_params = {};
|
|
247
246
|
query_params["page_no"] = pageNo;
|
|
248
247
|
query_params["page_size"] = pageSize;
|
|
249
248
|
|
|
250
249
|
const xHeaders = {};
|
|
251
|
-
xHeaders["x-location-detail"] = xLocationDetail;
|
|
252
|
-
xHeaders["x-application-data"] = xApplicationData;
|
|
253
250
|
|
|
254
251
|
const response = await ApplicationAPIClient.execute(
|
|
255
252
|
this._conf,
|
|
256
253
|
"get",
|
|
257
254
|
constructUrl({
|
|
258
|
-
url: this._urls["
|
|
259
|
-
params: {},
|
|
255
|
+
url: this._urls["getFulfillmentOptionStores"],
|
|
256
|
+
params: { slug },
|
|
260
257
|
}),
|
|
261
258
|
query_params,
|
|
262
259
|
undefined,
|
|
@@ -438,52 +435,6 @@ class Logistic {
|
|
|
438
435
|
return response;
|
|
439
436
|
}
|
|
440
437
|
|
|
441
|
-
/**
|
|
442
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
443
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
444
|
-
* @returns {Promise<PincodeDetailsResult>} - Success response
|
|
445
|
-
* @name getPincodeCity
|
|
446
|
-
* @summary: Get pincode details
|
|
447
|
-
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getPincodeCity/).
|
|
448
|
-
*/
|
|
449
|
-
async getPincodeCity(
|
|
450
|
-
{ pincode, requestHeaders } = { requestHeaders: {} },
|
|
451
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
452
|
-
) {
|
|
453
|
-
const errors = validateRequiredParams(arguments[0], ["pincode"]);
|
|
454
|
-
if (errors.length > 0) {
|
|
455
|
-
const error = new FDKClientValidationError({
|
|
456
|
-
message: "Missing required field",
|
|
457
|
-
details: errors,
|
|
458
|
-
});
|
|
459
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
const query_params = {};
|
|
463
|
-
|
|
464
|
-
const xHeaders = {};
|
|
465
|
-
|
|
466
|
-
const response = await ApplicationAPIClient.execute(
|
|
467
|
-
this._conf,
|
|
468
|
-
"get",
|
|
469
|
-
constructUrl({
|
|
470
|
-
url: this._urls["getPincodeCity"],
|
|
471
|
-
params: { pincode },
|
|
472
|
-
}),
|
|
473
|
-
query_params,
|
|
474
|
-
undefined,
|
|
475
|
-
{ ...xHeaders, ...requestHeaders },
|
|
476
|
-
{ responseHeaders }
|
|
477
|
-
);
|
|
478
|
-
|
|
479
|
-
let responseData = response;
|
|
480
|
-
if (responseHeaders) {
|
|
481
|
-
responseData = response[0];
|
|
482
|
-
}
|
|
483
|
-
|
|
484
|
-
return response;
|
|
485
|
-
}
|
|
486
|
-
|
|
487
438
|
/**
|
|
488
439
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
489
440
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -8,6 +8,7 @@ declare class Order {
|
|
|
8
8
|
getOrderById: string;
|
|
9
9
|
getOrders: string;
|
|
10
10
|
getPosOrderById: string;
|
|
11
|
+
getRefundModes: string;
|
|
11
12
|
getShipmentBagReasons: string;
|
|
12
13
|
getShipmentById: string;
|
|
13
14
|
getShipmentReasons: string;
|
|
@@ -64,6 +65,16 @@ declare class Order {
|
|
|
64
65
|
* @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getPosOrderById/).
|
|
65
66
|
*/
|
|
66
67
|
getPosOrderById({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
|
|
68
|
+
/**
|
|
69
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
71
|
+
* @returns {Promise<RefundOptions>} - Success response
|
|
72
|
+
* @name getRefundModes
|
|
73
|
+
* @summary: Get refund modes for a shipment
|
|
74
|
+
* @description: Returns a list of available refund options for the given company and shipment.
|
|
75
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getRefundModes/).
|
|
76
|
+
*/
|
|
77
|
+
getRefundModes({ shipmentId, lineNumbers, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<RefundOptions>;
|
|
67
78
|
/**
|
|
68
79
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
80
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -20,6 +20,8 @@ class Order {
|
|
|
20
20
|
getOrders: "/service/application/order/v1.0/orders",
|
|
21
21
|
getPosOrderById:
|
|
22
22
|
"/service/application/order/v1.0/orders/pos-order/{order_id}",
|
|
23
|
+
getRefundModes:
|
|
24
|
+
"/service/application/order-manage/v1.0/shipment/{shipment_id}/refund/modes",
|
|
23
25
|
getShipmentBagReasons:
|
|
24
26
|
"/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons",
|
|
25
27
|
getShipmentById:
|
|
@@ -298,6 +300,54 @@ class Order {
|
|
|
298
300
|
return response;
|
|
299
301
|
}
|
|
300
302
|
|
|
303
|
+
/**
|
|
304
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
305
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
306
|
+
* @returns {Promise<RefundOptions>} - Success response
|
|
307
|
+
* @name getRefundModes
|
|
308
|
+
* @summary: Get refund modes for a shipment
|
|
309
|
+
* @description: Returns a list of available refund options for the given company and shipment.
|
|
310
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getRefundModes/).
|
|
311
|
+
*/
|
|
312
|
+
async getRefundModes(
|
|
313
|
+
{ shipmentId, lineNumbers, requestHeaders } = { requestHeaders: {} },
|
|
314
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
315
|
+
) {
|
|
316
|
+
const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
|
|
317
|
+
if (errors.length > 0) {
|
|
318
|
+
const error = new FDKClientValidationError({
|
|
319
|
+
message: "Missing required field",
|
|
320
|
+
details: errors,
|
|
321
|
+
});
|
|
322
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
const query_params = {};
|
|
326
|
+
query_params["line_numbers"] = lineNumbers;
|
|
327
|
+
|
|
328
|
+
const xHeaders = {};
|
|
329
|
+
|
|
330
|
+
const response = await ApplicationAPIClient.execute(
|
|
331
|
+
this._conf,
|
|
332
|
+
"get",
|
|
333
|
+
constructUrl({
|
|
334
|
+
url: this._urls["getRefundModes"],
|
|
335
|
+
params: { shipmentId },
|
|
336
|
+
}),
|
|
337
|
+
query_params,
|
|
338
|
+
undefined,
|
|
339
|
+
{ ...xHeaders, ...requestHeaders },
|
|
340
|
+
{ responseHeaders }
|
|
341
|
+
);
|
|
342
|
+
|
|
343
|
+
let responseData = response;
|
|
344
|
+
if (responseHeaders) {
|
|
345
|
+
responseData = response[0];
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
return response;
|
|
349
|
+
}
|
|
350
|
+
|
|
301
351
|
/**
|
|
302
352
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
353
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -288,7 +288,7 @@ declare class Payment {
|
|
|
288
288
|
* @summary: Get payment modes
|
|
289
289
|
* @description: Get available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPaymentModeRoutes/).
|
|
290
290
|
*/
|
|
291
|
-
getPaymentModeRoutes({ amount, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PaymentModeRouteDetails>;
|
|
291
|
+
getPaymentModeRoutes({ amount, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, fulfillmentOption, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PaymentModeRouteDetails>;
|
|
292
292
|
/**
|
|
293
293
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
294
294
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -310,21 +310,21 @@ declare class Payment {
|
|
|
310
310
|
/**
|
|
311
311
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
312
312
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
313
|
-
* @returns {Promise<
|
|
313
|
+
* @returns {Promise<GetRefundBeneficiary>} - Success response
|
|
314
314
|
* @name getRefundBeneficiaries
|
|
315
315
|
* @summary: Get Refund Beneficiaries
|
|
316
316
|
* @description: Returns a list of UPI and Bank refund beneficiaries associated with a user. Both `order_id` and `shipment_id` are optional query parameters. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiaries/).
|
|
317
317
|
*/
|
|
318
|
-
getRefundBeneficiaries({ orderId, shipmentId,
|
|
318
|
+
getRefundBeneficiaries({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetRefundBeneficiary>;
|
|
319
319
|
/**
|
|
320
320
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
321
321
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
322
|
-
* @returns {Promise<
|
|
322
|
+
* @returns {Promise<GetRefundBeneficiary>} - Success response
|
|
323
323
|
* @name getRefundBeneficiariesUsingOTPSession
|
|
324
324
|
* @summary: Get Refund Beneficiaries using OTP session
|
|
325
325
|
* @description: Returns a list of UPI and Bank refund beneficiaries associated with a user for a given order and shipment. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiariesUsingOTPSession/).
|
|
326
326
|
*/
|
|
327
|
-
getRefundBeneficiariesUsingOTPSession({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
327
|
+
getRefundBeneficiariesUsingOTPSession({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetRefundBeneficiary>;
|
|
328
328
|
/**
|
|
329
329
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
330
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -1084,6 +1084,7 @@ class Payment {
|
|
|
1084
1084
|
displaySplit,
|
|
1085
1085
|
advancePayment,
|
|
1086
1086
|
shipmentId,
|
|
1087
|
+
fulfillmentOption,
|
|
1087
1088
|
requestHeaders,
|
|
1088
1089
|
} = { requestHeaders: {} },
|
|
1089
1090
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -1099,6 +1100,7 @@ class Payment {
|
|
|
1099
1100
|
query_params["display_split"] = displaySplit;
|
|
1100
1101
|
query_params["advance_payment"] = advancePayment;
|
|
1101
1102
|
query_params["shipment_id"] = shipmentId;
|
|
1103
|
+
query_params["fulfillment_option"] = fulfillmentOption;
|
|
1102
1104
|
|
|
1103
1105
|
const xHeaders = {};
|
|
1104
1106
|
|
|
@@ -1219,19 +1221,18 @@ class Payment {
|
|
|
1219
1221
|
/**
|
|
1220
1222
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1221
1223
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1222
|
-
* @returns {Promise<
|
|
1224
|
+
* @returns {Promise<GetRefundBeneficiary>} - Success response
|
|
1223
1225
|
* @name getRefundBeneficiaries
|
|
1224
1226
|
* @summary: Get Refund Beneficiaries
|
|
1225
1227
|
* @description: Returns a list of UPI and Bank refund beneficiaries associated with a user. Both `order_id` and `shipment_id` are optional query parameters. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiaries/).
|
|
1226
1228
|
*/
|
|
1227
1229
|
async getRefundBeneficiaries(
|
|
1228
|
-
{ orderId, shipmentId,
|
|
1230
|
+
{ orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
1229
1231
|
{ responseHeaders } = { responseHeaders: false }
|
|
1230
1232
|
) {
|
|
1231
1233
|
const query_params = {};
|
|
1232
1234
|
query_params["order_id"] = orderId;
|
|
1233
1235
|
query_params["shipment_id"] = shipmentId;
|
|
1234
|
-
query_params["filter_by"] = filterBy;
|
|
1235
1236
|
|
|
1236
1237
|
const xHeaders = {};
|
|
1237
1238
|
|
|
@@ -1259,7 +1260,7 @@ class Payment {
|
|
|
1259
1260
|
/**
|
|
1260
1261
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1261
1262
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1262
|
-
* @returns {Promise<
|
|
1263
|
+
* @returns {Promise<GetRefundBeneficiary>} - Success response
|
|
1263
1264
|
* @name getRefundBeneficiariesUsingOTPSession
|
|
1264
1265
|
* @summary: Get Refund Beneficiaries using OTP session
|
|
1265
1266
|
* @description: Returns a list of UPI and Bank refund beneficiaries associated with a user for a given order and shipment. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiariesUsingOTPSession/).
|
|
@@ -282,5 +282,89 @@ declare class Logistics {
|
|
|
282
282
|
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/getCourierPartnerScheme/).
|
|
283
283
|
*/
|
|
284
284
|
getCourierPartnerScheme({ schemeId, requestHeaders }?: LogisticsPartnerValidator.GetCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.CourierPartnerSchemeModelSchema>;
|
|
285
|
+
/**
|
|
286
|
+
* @param {LogisticsPartnerValidator.GetSampleFileRateCardParam} arg - Arg object.
|
|
287
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
288
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
289
|
+
* @returns {Promise<LogisticsPartnerModel.RateCardSampleFile>} - Success response
|
|
290
|
+
* @name getSampleFileRateCard
|
|
291
|
+
* @summary: Retrieves a sample file that shows the required format for rate card uploads.
|
|
292
|
+
* @description: Retrieves a downloadable sample file template for bulk rate card uploads. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/getSampleFileRateCard/).
|
|
293
|
+
*/
|
|
294
|
+
getSampleFileRateCard({ requestHeaders }?: LogisticsPartnerValidator.GetSampleFileRateCardParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.RateCardSampleFile>;
|
|
295
|
+
/**
|
|
296
|
+
* @param {LogisticsPartnerValidator.BulkRateCardParam} arg - Arg object.
|
|
297
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
298
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
299
|
+
* @returns {Promise<LogisticsPartnerModel.BulkRateCardJob>} - Success response
|
|
300
|
+
* @name bulkRateCard
|
|
301
|
+
* @summary: Rate Card Import or Export
|
|
302
|
+
* @description: Rate Card Import or Export - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/bulkRateCard/).
|
|
303
|
+
*/
|
|
304
|
+
bulkRateCard({ extensionId, schemeId, body, requestHeaders }?: LogisticsPartnerValidator.BulkRateCardParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.BulkRateCardJob>;
|
|
305
|
+
/**
|
|
306
|
+
* @param {LogisticsPartnerValidator.GetBulkRateCardParam} arg - Arg object.
|
|
307
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
308
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
309
|
+
* @returns {Promise<LogisticsPartnerModel.BulkRateCardJob>} - Success response
|
|
310
|
+
* @name getBulkRateCard
|
|
311
|
+
* @summary: Retrieve the history of bulk rate card uploads.
|
|
312
|
+
* @description: Returns the history of all bulk rate card upload operations, including their statuses and details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/getBulkRateCard/).
|
|
313
|
+
*/
|
|
314
|
+
getBulkRateCard({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, startDate, endDate, requestHeaders, }?: LogisticsPartnerValidator.GetBulkRateCardParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.BulkRateCardJob>;
|
|
315
|
+
/**
|
|
316
|
+
* @param {LogisticsPartnerValidator.GetSampleFileRateZoneParam} arg - Arg object.
|
|
317
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
318
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
319
|
+
* @returns {Promise<LogisticsPartnerModel.BulkRateCardJob>} - Success response
|
|
320
|
+
* @name getSampleFileRateZone
|
|
321
|
+
* @summary: Get Rate Zone sample file
|
|
322
|
+
* @description: Retrieves a downloadable sample file template for bulk rate zone uploads. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/getSampleFileRateZone/).
|
|
323
|
+
*/
|
|
324
|
+
getSampleFileRateZone({ body, requestHeaders }?: LogisticsPartnerValidator.GetSampleFileRateZoneParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.BulkRateCardJob>;
|
|
325
|
+
/**
|
|
326
|
+
* @param {LogisticsPartnerValidator.CreateRateZoneBulkJobParam} arg - Arg object.
|
|
327
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
328
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
329
|
+
* @returns {Promise<LogisticsPartnerModel.BulkRateCardJob>} - Success response
|
|
330
|
+
* @name createRateZoneBulkJob
|
|
331
|
+
* @summary: Rate Zone Import or Export
|
|
332
|
+
* @description: Performs bulk import or export of rate zone details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/createRateZoneBulkJob/).
|
|
333
|
+
*/
|
|
334
|
+
createRateZoneBulkJob({ extensionId, schemeId, body, requestHeaders }?: LogisticsPartnerValidator.CreateRateZoneBulkJobParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.BulkRateCardJob>;
|
|
335
|
+
/**
|
|
336
|
+
* @param {LogisticsPartnerValidator.GetBulkRateZoneJobHistoryParam} arg - Arg object.
|
|
337
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
338
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
339
|
+
* @returns {Promise<LogisticsPartnerModel.RateZoneBulkJobList>} - Success response
|
|
340
|
+
* @name getBulkRateZoneJobHistory
|
|
341
|
+
* @summary: Get Rate Zone Bulk History
|
|
342
|
+
* @description: Retrieves the bulk job history for rate zone import and export operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/getBulkRateZoneJobHistory/).
|
|
343
|
+
*/
|
|
344
|
+
getBulkRateZoneJobHistory({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, zoneType, startDate, endDate, requestHeaders, }?: LogisticsPartnerValidator.GetBulkRateZoneJobHistoryParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.RateZoneBulkJobList>;
|
|
345
|
+
/**
|
|
346
|
+
* @param {LogisticsPartnerValidator.GetRateZoneConfigParam} arg - Arg object.
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
349
|
+
* @returns {Promise<LogisticsPartnerModel.RateZoneConfigurationDetails>} -
|
|
350
|
+
* Success response
|
|
351
|
+
* @name getRateZoneConfig
|
|
352
|
+
* @summary: Fetch Rate Zone Configuration
|
|
353
|
+
* @description: Fetch Rate Zone Configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/getRateZoneConfig/).
|
|
354
|
+
*/
|
|
355
|
+
getRateZoneConfig({ extensionId, schemeId, requestHeaders }?: LogisticsPartnerValidator.GetRateZoneConfigParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.RateZoneConfigurationDetails>;
|
|
356
|
+
/**
|
|
357
|
+
* @param {LogisticsPartnerValidator.UpdateRateZoneConfigurationParam} arg
|
|
358
|
+
* - Arg object.
|
|
359
|
+
*
|
|
360
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
361
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
362
|
+
* @returns {Promise<LogisticsPartnerModel.RateZoneConfigurationDetails>} -
|
|
363
|
+
* Success response
|
|
364
|
+
* @name updateRateZoneConfiguration
|
|
365
|
+
* @summary: Update Rate Zone Configuration
|
|
366
|
+
* @description: Updates the rate zone configuration for the specified courier partner scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/logistics/updateRateZoneConfiguration/).
|
|
367
|
+
*/
|
|
368
|
+
updateRateZoneConfiguration({ extensionId, schemeId, body, requestHeaders }?: LogisticsPartnerValidator.UpdateRateZoneConfigurationParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.RateZoneConfigurationDetails>;
|
|
285
369
|
}
|
|
286
370
|
import LogisticsPartnerModel = require("./LogisticsPartnerModel");
|