@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.4
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 +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +54 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -89
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -8,11 +8,11 @@ class Content {
|
|
|
8
8
|
this._relativeUrls = {
|
|
9
9
|
getAnnouncements: "/service/application/content/v1.0/announcements",
|
|
10
10
|
getBlog: "/service/application/content/v1.0/blogs/{slug}",
|
|
11
|
-
getBlogs: "/service/application/content/v1.0/blogs",
|
|
12
|
-
|
|
13
|
-
"/service/application/content/
|
|
14
|
-
|
|
15
|
-
"/service/application/content/
|
|
11
|
+
getBlogs: "/service/application/content/v1.0/blogs/",
|
|
12
|
+
getCustomFields:
|
|
13
|
+
"/service/application/content/v1.0/metafields/{resource}/{resource_id}",
|
|
14
|
+
getCustomObject:
|
|
15
|
+
"/service/application/content/v1.0/metaobjects/{metaobject_id}",
|
|
16
16
|
getDataLoaders: "/service/application/content/v1.0/data-loader",
|
|
17
17
|
getFaqBySlug: "/service/application/content/v1.0/faq/{slug}",
|
|
18
18
|
getFaqCategories: "/service/application/content/v1.0/faq/categories",
|
|
@@ -23,13 +23,13 @@ class Content {
|
|
|
23
23
|
"/service/application/content/v1.0/faq/category/{slug}/faqs",
|
|
24
24
|
getLandingPage: "/service/application/content/v1.0/landing-page",
|
|
25
25
|
getLegalInformation: "/service/application/content/v1.0/legal",
|
|
26
|
-
getNavigations: "/service/application/content/v1.0/navigations",
|
|
26
|
+
getNavigations: "/service/application/content/v1.0/navigations/",
|
|
27
27
|
getPage: "/service/application/content/v2.0/pages/{slug}",
|
|
28
|
-
getPages: "/service/application/content/v2.0/pages",
|
|
28
|
+
getPages: "/service/application/content/v2.0/pages/",
|
|
29
29
|
getSEOConfiguration: "/service/application/content/v1.0/seo",
|
|
30
30
|
getSEOMarkupSchemas: "/service/application/content/v1.0/seo/schema",
|
|
31
31
|
getSlideshow: "/service/application/content/v1.0/slideshow/{slug}",
|
|
32
|
-
getSlideshows: "/service/application/content/v1.0/slideshow",
|
|
32
|
+
getSlideshows: "/service/application/content/v1.0/slideshow/",
|
|
33
33
|
getSupportInformation: "/service/application/content/v1.0/support",
|
|
34
34
|
getTags: "/service/application/content/v1.0/tags",
|
|
35
35
|
};
|
|
@@ -95,12 +95,11 @@ class Content {
|
|
|
95
95
|
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
|
|
96
96
|
*/
|
|
97
97
|
async getBlog(
|
|
98
|
-
{ slug, rootId,
|
|
98
|
+
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
99
99
|
{ responseHeaders } = { responseHeaders: false }
|
|
100
100
|
) {
|
|
101
101
|
const query_params = {};
|
|
102
102
|
query_params["root_id"] = rootId;
|
|
103
|
-
query_params["preview"] = preview;
|
|
104
103
|
|
|
105
104
|
const xHeaders = {};
|
|
106
105
|
|
|
@@ -128,7 +127,7 @@ class Content {
|
|
|
128
127
|
/**
|
|
129
128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
130
129
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
131
|
-
* @returns {Promise<
|
|
130
|
+
* @returns {Promise<BlogGetResponse>} - Success response
|
|
132
131
|
* @name getBlogs
|
|
133
132
|
* @summary: List blogs
|
|
134
133
|
* @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
@@ -170,12 +169,12 @@ class Content {
|
|
|
170
169
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
170
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
172
171
|
* @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
|
|
173
|
-
* @name
|
|
174
|
-
* @summary: Get list of custom fields
|
|
175
|
-
* @description:
|
|
172
|
+
* @name getCustomFields
|
|
173
|
+
* @summary: Get list of custom fields
|
|
174
|
+
* @description: List custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
|
|
176
175
|
*/
|
|
177
|
-
async
|
|
178
|
-
{ resource,
|
|
176
|
+
async getCustomFields(
|
|
177
|
+
{ resource, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
179
178
|
{ responseHeaders } = { responseHeaders: false }
|
|
180
179
|
) {
|
|
181
180
|
const query_params = {};
|
|
@@ -186,8 +185,8 @@ class Content {
|
|
|
186
185
|
this._conf,
|
|
187
186
|
"get",
|
|
188
187
|
constructUrl({
|
|
189
|
-
url: this._urls["
|
|
190
|
-
params: { resource,
|
|
188
|
+
url: this._urls["getCustomFields"],
|
|
189
|
+
params: { resource, resourceId },
|
|
191
190
|
}),
|
|
192
191
|
query_params,
|
|
193
192
|
undefined,
|
|
@@ -207,12 +206,12 @@ class Content {
|
|
|
207
206
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
208
207
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
209
208
|
* @returns {Promise<CustomObjectByIdSchema>} - Success response
|
|
210
|
-
* @name
|
|
211
|
-
* @summary: Get custom object
|
|
212
|
-
* @description:
|
|
209
|
+
* @name getCustomObject
|
|
210
|
+
* @summary: Get custom object
|
|
211
|
+
* @description: Get details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
|
|
213
212
|
*/
|
|
214
|
-
async
|
|
215
|
-
{
|
|
213
|
+
async getCustomObject(
|
|
214
|
+
{ metaobjectId, requestHeaders } = { requestHeaders: {} },
|
|
216
215
|
{ responseHeaders } = { responseHeaders: false }
|
|
217
216
|
) {
|
|
218
217
|
const query_params = {};
|
|
@@ -223,8 +222,8 @@ class Content {
|
|
|
223
222
|
this._conf,
|
|
224
223
|
"get",
|
|
225
224
|
constructUrl({
|
|
226
|
-
url: this._urls["
|
|
227
|
-
params: {
|
|
225
|
+
url: this._urls["getCustomObject"],
|
|
226
|
+
params: { metaobjectId },
|
|
228
227
|
}),
|
|
229
228
|
query_params,
|
|
230
229
|
undefined,
|
|
@@ -539,7 +538,7 @@ class Content {
|
|
|
539
538
|
/**
|
|
540
539
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
541
540
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
542
|
-
* @returns {Promise<
|
|
541
|
+
* @returns {Promise<NavigationGetResponse>} - Success response
|
|
543
542
|
* @name getNavigations
|
|
544
543
|
* @summary: List navigation items
|
|
545
544
|
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
|
|
@@ -616,7 +615,7 @@ class Content {
|
|
|
616
615
|
/**
|
|
617
616
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
618
617
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
619
|
-
* @returns {Promise<
|
|
618
|
+
* @returns {Promise<PageGetResponse>} - Success response
|
|
620
619
|
* @name getPages
|
|
621
620
|
* @summary: Lists pages
|
|
622
621
|
* @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
@@ -768,7 +767,7 @@ class Content {
|
|
|
768
767
|
/**
|
|
769
768
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
770
769
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
771
|
-
* @returns {Promise<
|
|
770
|
+
* @returns {Promise<SlideshowGetResponse>} - Success response
|
|
772
771
|
* @name getSlideshows
|
|
773
772
|
* @summary: List Slideshows
|
|
774
773
|
* @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
|
|
@@ -804,6 +803,33 @@ class Content {
|
|
|
804
803
|
return response;
|
|
805
804
|
}
|
|
806
805
|
|
|
806
|
+
/**
|
|
807
|
+
* @param {Object} arg - Arg object.
|
|
808
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
809
|
+
* @returns {Paginator<SlideshowGetResponse>}
|
|
810
|
+
* @summary: List Slideshows
|
|
811
|
+
* @description: List slideshows along with their details.
|
|
812
|
+
*/
|
|
813
|
+
getSlideshowsPaginator({ pageSize } = {}) {
|
|
814
|
+
const paginator = new Paginator();
|
|
815
|
+
const callback = async () => {
|
|
816
|
+
const pageId = paginator.nextId;
|
|
817
|
+
const pageNo = paginator.pageNo;
|
|
818
|
+
const pageType = "number";
|
|
819
|
+
const data = await this.getSlideshows({
|
|
820
|
+
pageNo: pageNo,
|
|
821
|
+
pageSize: pageSize,
|
|
822
|
+
});
|
|
823
|
+
paginator.setPaginator({
|
|
824
|
+
hasNext: data.page.has_next ? true : false,
|
|
825
|
+
nextId: data.page.next_id,
|
|
826
|
+
});
|
|
827
|
+
return data;
|
|
828
|
+
};
|
|
829
|
+
paginator.setCallback(callback.bind(this));
|
|
830
|
+
return paginator;
|
|
831
|
+
}
|
|
832
|
+
|
|
807
833
|
/**
|
|
808
834
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
809
835
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -12,30 +12,30 @@ declare class FileStorage {
|
|
|
12
12
|
/**
|
|
13
13
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
14
14
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
15
|
-
* @returns {Promise<
|
|
15
|
+
* @returns {Promise<CompleteResponse>} - Success response
|
|
16
16
|
* @name completeUpload
|
|
17
|
-
* @summary:
|
|
17
|
+
* @summary: Complete file upload
|
|
18
18
|
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
19
19
|
*/
|
|
20
|
-
completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
20
|
+
completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CompleteResponse>;
|
|
21
21
|
/**
|
|
22
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
23
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<
|
|
24
|
+
* @returns {Promise<SignUrlResponse>} - Success response
|
|
25
25
|
* @name signUrls
|
|
26
|
-
* @summary:
|
|
26
|
+
* @summary: Get signed URLs
|
|
27
27
|
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
28
28
|
*/
|
|
29
|
-
signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
29
|
+
signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SignUrlResponse>;
|
|
30
30
|
/**
|
|
31
31
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
32
32
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
33
|
-
* @returns {Promise<
|
|
33
|
+
* @returns {Promise<StartResponse>} - Success response
|
|
34
34
|
* @name startUpload
|
|
35
35
|
* @summary: Initiates file upload
|
|
36
36
|
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
37
37
|
*/
|
|
38
|
-
startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
38
|
+
startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StartResponse>;
|
|
39
39
|
/**
|
|
40
40
|
* @param data
|
|
41
41
|
* @param {string} file_name
|
|
@@ -9,10 +9,10 @@ class FileStorage {
|
|
|
9
9
|
this._conf = _conf;
|
|
10
10
|
this._relativeUrls = {
|
|
11
11
|
completeUpload:
|
|
12
|
-
"/service/application/assets/
|
|
12
|
+
"/service/application/assets/v1.0/namespaces/{namespace}/upload/complete",
|
|
13
13
|
signUrls: "/service/application/assets/v1.0/sign-urls",
|
|
14
14
|
startUpload:
|
|
15
|
-
"/service/application/assets/
|
|
15
|
+
"/service/application/assets/v1.0/namespaces/{namespace}/upload/start",
|
|
16
16
|
};
|
|
17
17
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
18
18
|
(urls, [method, relativeUrl]) => {
|
|
@@ -33,9 +33,9 @@ class FileStorage {
|
|
|
33
33
|
/**
|
|
34
34
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
35
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
36
|
-
* @returns {Promise<
|
|
36
|
+
* @returns {Promise<CompleteResponse>} - Success response
|
|
37
37
|
* @name completeUpload
|
|
38
|
-
* @summary:
|
|
38
|
+
* @summary: Complete file upload
|
|
39
39
|
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
40
40
|
*/
|
|
41
41
|
async completeUpload(
|
|
@@ -70,9 +70,9 @@ class FileStorage {
|
|
|
70
70
|
/**
|
|
71
71
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
72
72
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
73
|
-
* @returns {Promise<
|
|
73
|
+
* @returns {Promise<SignUrlResponse>} - Success response
|
|
74
74
|
* @name signUrls
|
|
75
|
-
* @summary:
|
|
75
|
+
* @summary: Get signed URLs
|
|
76
76
|
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
77
77
|
*/
|
|
78
78
|
async signUrls(
|
|
@@ -107,7 +107,7 @@ class FileStorage {
|
|
|
107
107
|
/**
|
|
108
108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
109
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
110
|
-
* @returns {Promise<
|
|
110
|
+
* @returns {Promise<StartResponse>} - Success response
|
|
111
111
|
* @name startUpload
|
|
112
112
|
* @summary: Initiates file upload
|
|
113
113
|
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
@@ -50,10 +50,10 @@ declare class Lead {
|
|
|
50
50
|
/**
|
|
51
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
52
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<
|
|
53
|
+
* @returns {Promise<SubmitCustomFormResponse>} - Success response
|
|
54
54
|
* @name submitCustomForm
|
|
55
55
|
* @summary: Submits form data
|
|
56
56
|
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
57
57
|
*/
|
|
58
|
-
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
58
|
+
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SubmitCustomFormResponse>;
|
|
59
59
|
}
|
|
@@ -179,7 +179,7 @@ class Lead {
|
|
|
179
179
|
/**
|
|
180
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
181
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<
|
|
182
|
+
* @returns {Promise<SubmitCustomFormResponse>} - Success response
|
|
183
183
|
* @name submitCustomForm
|
|
184
184
|
* @summary: Submits form data
|
|
185
185
|
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
@@ -6,8 +6,6 @@ declare class Logistic {
|
|
|
6
6
|
getAllCountries: string;
|
|
7
7
|
getCountries: string;
|
|
8
8
|
getCountry: string;
|
|
9
|
-
getCourierPartners: string;
|
|
10
|
-
getDeliveryPromise: string;
|
|
11
9
|
getLocalities: string;
|
|
12
10
|
getLocality: string;
|
|
13
11
|
getLocations: string;
|
|
@@ -22,12 +20,12 @@ declare class Logistic {
|
|
|
22
20
|
/**
|
|
23
21
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
24
22
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
25
|
-
* @returns {Promise<
|
|
23
|
+
* @returns {Promise<CountryListResponse>} - Success response
|
|
26
24
|
* @name getAllCountries
|
|
27
25
|
* @summary: Get deliverable countries
|
|
28
26
|
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
29
27
|
*/
|
|
30
|
-
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
28
|
+
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryListResponse>;
|
|
31
29
|
/**
|
|
32
30
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
33
31
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -36,7 +34,7 @@ declare class Logistic {
|
|
|
36
34
|
* @summary: Get countries
|
|
37
35
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
38
36
|
*/
|
|
39
|
-
getCountries({ onboarding, pageNo, pageSize, q,
|
|
37
|
+
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
40
38
|
/**
|
|
41
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
40
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -46,24 +44,6 @@ declare class Logistic {
|
|
|
46
44
|
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
|
|
47
45
|
*/
|
|
48
46
|
getCountry({ countryIsoCode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountry>;
|
|
49
|
-
/**
|
|
50
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
53
|
-
* @name getCourierPartners
|
|
54
|
-
* @summary: Serviceable Courier Partners.
|
|
55
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCourierPartners/).
|
|
56
|
-
*/
|
|
57
|
-
getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentCourierPartnerResult>;
|
|
58
|
-
/**
|
|
59
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
60
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
|
-
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
62
|
-
* @name getDeliveryPromise
|
|
63
|
-
* @summary: Get delivery promise
|
|
64
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getDeliveryPromise/).
|
|
65
|
-
*/
|
|
66
|
-
getDeliveryPromise({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
67
47
|
/**
|
|
68
48
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
49
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -85,55 +65,55 @@ declare class Logistic {
|
|
|
85
65
|
/**
|
|
86
66
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
87
67
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
|
-
* @returns {Promise<
|
|
68
|
+
* @returns {Promise<GetStoreResponse>} - Success response
|
|
89
69
|
* @name getLocations
|
|
90
70
|
* @summary: Get available selling locations
|
|
91
71
|
* @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
92
72
|
*/
|
|
93
|
-
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
73
|
+
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetStoreResponse>;
|
|
94
74
|
/**
|
|
95
75
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
96
76
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
97
|
-
* @returns {Promise<
|
|
77
|
+
* @returns {Promise<ReAssignStoreResponse>} - Success response
|
|
98
78
|
* @name getOptimalLocations
|
|
99
79
|
* @summary: Get selling locations
|
|
100
80
|
* @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
101
81
|
*/
|
|
102
|
-
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
82
|
+
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReAssignStoreResponse>;
|
|
103
83
|
/**
|
|
104
84
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
105
85
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
106
|
-
* @returns {Promise<
|
|
86
|
+
* @returns {Promise<PincodeApiResponse>} - Success response
|
|
107
87
|
* @name getPincodeCity
|
|
108
88
|
* @summary: Get pincode details
|
|
109
89
|
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
110
90
|
*/
|
|
111
|
-
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
91
|
+
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PincodeApiResponse>;
|
|
112
92
|
/**
|
|
113
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
114
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
115
|
-
* @returns {Promise<
|
|
95
|
+
* @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
|
|
116
96
|
* @name getPincodeZones
|
|
117
97
|
* @summary: Get zones
|
|
118
98
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
119
99
|
*/
|
|
120
|
-
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
100
|
+
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetZoneFromPincodeViewResponse>;
|
|
121
101
|
/**
|
|
122
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
103
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
124
|
-
* @returns {Promise<
|
|
104
|
+
* @returns {Promise<TATViewResponse>} - Success response
|
|
125
105
|
* @name getTatProduct
|
|
126
106
|
* @summary: Get product's turnaround time
|
|
127
107
|
* @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
128
108
|
*/
|
|
129
|
-
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
109
|
+
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TATViewResponse>;
|
|
130
110
|
/**
|
|
131
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
132
112
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
133
|
-
* @returns {Promise<
|
|
113
|
+
* @returns {Promise<ValidateAddressRequest>} - Success response
|
|
134
114
|
* @name validateAddress
|
|
135
115
|
* @summary: Validate address
|
|
136
116
|
* @description: Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
|
|
137
117
|
*/
|
|
138
|
-
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
118
|
+
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ValidateAddressRequest>;
|
|
139
119
|
}
|
|
@@ -10,10 +10,6 @@ class Logistic {
|
|
|
10
10
|
getCountries: "/service/application/logistics/v2.0/countries",
|
|
11
11
|
getCountry:
|
|
12
12
|
"/service/application/logistics/v1.0/countries/{country_iso_code}",
|
|
13
|
-
getCourierPartners:
|
|
14
|
-
"/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
|
|
15
|
-
getDeliveryPromise:
|
|
16
|
-
"/service/application/logistics/v1.0/delivery-promise",
|
|
17
13
|
getLocalities:
|
|
18
14
|
"/service/application/logistics/v1.0/localities/{locality_type}",
|
|
19
15
|
getLocality:
|
|
@@ -46,7 +42,7 @@ class Logistic {
|
|
|
46
42
|
/**
|
|
47
43
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
44
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<
|
|
45
|
+
* @returns {Promise<CountryListResponse>} - Success response
|
|
50
46
|
* @name getAllCountries
|
|
51
47
|
* @summary: Get deliverable countries
|
|
52
48
|
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
@@ -89,7 +85,7 @@ class Logistic {
|
|
|
89
85
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
90
86
|
*/
|
|
91
87
|
async getCountries(
|
|
92
|
-
{ onboarding, pageNo, pageSize, q,
|
|
88
|
+
{ onboarding, pageNo, pageSize, q, requestHeaders } = {
|
|
93
89
|
requestHeaders: {},
|
|
94
90
|
},
|
|
95
91
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -99,7 +95,6 @@ class Logistic {
|
|
|
99
95
|
query_params["page_no"] = pageNo;
|
|
100
96
|
query_params["page_size"] = pageSize;
|
|
101
97
|
query_params["q"] = q;
|
|
102
|
-
query_params["hierarchy"] = hierarchy;
|
|
103
98
|
|
|
104
99
|
const xHeaders = {};
|
|
105
100
|
|
|
@@ -161,82 +156,6 @@ class Logistic {
|
|
|
161
156
|
return response;
|
|
162
157
|
}
|
|
163
158
|
|
|
164
|
-
/**
|
|
165
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
167
|
-
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
168
|
-
* @name getCourierPartners
|
|
169
|
-
* @summary: Serviceable Courier Partners.
|
|
170
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCourierPartners/).
|
|
171
|
-
*/
|
|
172
|
-
async getCourierPartners(
|
|
173
|
-
{ companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
|
|
174
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
175
|
-
) {
|
|
176
|
-
const query_params = {};
|
|
177
|
-
|
|
178
|
-
const xHeaders = {};
|
|
179
|
-
|
|
180
|
-
const response = await ApplicationAPIClient.execute(
|
|
181
|
-
this._conf,
|
|
182
|
-
"post",
|
|
183
|
-
constructUrl({
|
|
184
|
-
url: this._urls["getCourierPartners"],
|
|
185
|
-
params: { companyId, applicationId },
|
|
186
|
-
}),
|
|
187
|
-
query_params,
|
|
188
|
-
body,
|
|
189
|
-
{ ...xHeaders, ...requestHeaders },
|
|
190
|
-
{ responseHeaders }
|
|
191
|
-
);
|
|
192
|
-
|
|
193
|
-
let responseData = response;
|
|
194
|
-
if (responseHeaders) {
|
|
195
|
-
responseData = response[0];
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
return response;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
/**
|
|
202
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
204
|
-
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
205
|
-
* @name getDeliveryPromise
|
|
206
|
-
* @summary: Get delivery promise
|
|
207
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getDeliveryPromise/).
|
|
208
|
-
*/
|
|
209
|
-
async getDeliveryPromise(
|
|
210
|
-
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
211
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
212
|
-
) {
|
|
213
|
-
const query_params = {};
|
|
214
|
-
query_params["page_no"] = pageNo;
|
|
215
|
-
query_params["page_size"] = pageSize;
|
|
216
|
-
|
|
217
|
-
const xHeaders = {};
|
|
218
|
-
|
|
219
|
-
const response = await ApplicationAPIClient.execute(
|
|
220
|
-
this._conf,
|
|
221
|
-
"get",
|
|
222
|
-
constructUrl({
|
|
223
|
-
url: this._urls["getDeliveryPromise"],
|
|
224
|
-
params: {},
|
|
225
|
-
}),
|
|
226
|
-
query_params,
|
|
227
|
-
undefined,
|
|
228
|
-
{ ...xHeaders, ...requestHeaders },
|
|
229
|
-
{ responseHeaders }
|
|
230
|
-
);
|
|
231
|
-
|
|
232
|
-
let responseData = response;
|
|
233
|
-
if (responseHeaders) {
|
|
234
|
-
responseData = response[0];
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
return response;
|
|
238
|
-
}
|
|
239
|
-
|
|
240
159
|
/**
|
|
241
160
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
242
161
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -334,7 +253,7 @@ class Logistic {
|
|
|
334
253
|
/**
|
|
335
254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
336
255
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
337
|
-
* @returns {Promise<
|
|
256
|
+
* @returns {Promise<GetStoreResponse>} - Success response
|
|
338
257
|
* @name getLocations
|
|
339
258
|
* @summary: Get available selling locations
|
|
340
259
|
* @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
@@ -391,7 +310,7 @@ class Logistic {
|
|
|
391
310
|
/**
|
|
392
311
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
393
312
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
394
|
-
* @returns {Promise<
|
|
313
|
+
* @returns {Promise<ReAssignStoreResponse>} - Success response
|
|
395
314
|
* @name getOptimalLocations
|
|
396
315
|
* @summary: Get selling locations
|
|
397
316
|
* @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
@@ -428,7 +347,7 @@ class Logistic {
|
|
|
428
347
|
/**
|
|
429
348
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
430
349
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
431
|
-
* @returns {Promise<
|
|
350
|
+
* @returns {Promise<PincodeApiResponse>} - Success response
|
|
432
351
|
* @name getPincodeCity
|
|
433
352
|
* @summary: Get pincode details
|
|
434
353
|
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
@@ -465,7 +384,7 @@ class Logistic {
|
|
|
465
384
|
/**
|
|
466
385
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
467
386
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
468
|
-
* @returns {Promise<
|
|
387
|
+
* @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
|
|
469
388
|
* @name getPincodeZones
|
|
470
389
|
* @summary: Get zones
|
|
471
390
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
@@ -502,7 +421,7 @@ class Logistic {
|
|
|
502
421
|
/**
|
|
503
422
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
504
423
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
505
|
-
* @returns {Promise<
|
|
424
|
+
* @returns {Promise<TATViewResponse>} - Success response
|
|
506
425
|
* @name getTatProduct
|
|
507
426
|
* @summary: Get product's turnaround time
|
|
508
427
|
* @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
@@ -539,7 +458,7 @@ class Logistic {
|
|
|
539
458
|
/**
|
|
540
459
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
541
460
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
542
|
-
* @returns {Promise<
|
|
461
|
+
* @returns {Promise<ValidateAddressRequest>} - Success response
|
|
543
462
|
* @name validateAddress
|
|
544
463
|
* @summary: Validate address
|
|
545
464
|
* @description: Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
|