@gofynd/fdk-client-javascript 3.3.5 → 3.3.6
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/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +41 -3
- package/sdk/platform/Cart/CartPlatformModel.js +24 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +77 -77
- package/sdk/platform/Catalog/CatalogPlatformClient.js +77 -77
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +56 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +40 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -66,7 +66,7 @@ class Content {
|
|
|
66
66
|
* @returns {Promise<ResourceTranslations>} - Success response
|
|
67
67
|
* @name fetchResourceTranslations
|
|
68
68
|
* @summary: Get Resource Translations
|
|
69
|
-
* @description: Fetch translations for specific resource IDs based on type and locale settings. - Check out [method documentation](https://
|
|
69
|
+
* @description: Fetch translations for specific resource IDs based on type and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/fetchResourceTranslations/).
|
|
70
70
|
*/
|
|
71
71
|
async fetchResourceTranslations(
|
|
72
72
|
{ type, locale, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -113,7 +113,7 @@ class Content {
|
|
|
113
113
|
* @returns {Promise<ResourceTranslations>} - Success response
|
|
114
114
|
* @name fetchResourceTranslationsWithPayload
|
|
115
115
|
* @summary: Post Resource Translations
|
|
116
|
-
* @description: Submit and retrieve translations for resources using payload data and locale settings. - Check out [method documentation](https://
|
|
116
|
+
* @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
117
|
*/
|
|
118
118
|
async fetchResourceTranslationsWithPayload(
|
|
119
119
|
{ type, locale, resourceId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -160,7 +160,7 @@ class Content {
|
|
|
160
160
|
* @returns {Promise<AnnouncementsResponseSchema>} - Success response
|
|
161
161
|
* @name getAnnouncements
|
|
162
162
|
* @summary: List announcements
|
|
163
|
-
* @description: List all current announcements in the application. - Check out [method documentation](https://
|
|
163
|
+
* @description: List all current announcements in the application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getAnnouncements/).
|
|
164
164
|
*/
|
|
165
165
|
async getAnnouncements(
|
|
166
166
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -197,7 +197,7 @@ class Content {
|
|
|
197
197
|
* @returns {Promise<BlogSchema>} - Success response
|
|
198
198
|
* @name getBlog
|
|
199
199
|
* @summary: Get a blog
|
|
200
|
-
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://
|
|
200
|
+
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlog/).
|
|
201
201
|
*/
|
|
202
202
|
async getBlog(
|
|
203
203
|
{ slug, rootId, preview, requestHeaders } = { requestHeaders: {} },
|
|
@@ -245,7 +245,7 @@ class Content {
|
|
|
245
245
|
* @returns {Promise<BlogGetDetails>} - Success response
|
|
246
246
|
* @name getBlogs
|
|
247
247
|
* @summary: List blogs
|
|
248
|
-
* @description: List all the blogs against an application. - Check out [method documentation](https://
|
|
248
|
+
* @description: List all the blogs against an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlogs/).
|
|
249
249
|
*/
|
|
250
250
|
async getBlogs(
|
|
251
251
|
{ pageNo, pageSize, tags, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -286,7 +286,7 @@ class Content {
|
|
|
286
286
|
* @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
|
|
287
287
|
* @name getCustomFieldsByResourceId
|
|
288
288
|
* @summary: Get list of custom fields of given resource and resource slug
|
|
289
|
-
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://
|
|
289
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getCustomFieldsByResourceId/).
|
|
290
290
|
*/
|
|
291
291
|
async getCustomFieldsByResourceId(
|
|
292
292
|
{ resource, resourceSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -335,7 +335,7 @@ class Content {
|
|
|
335
335
|
* @returns {Promise<CustomObjectByIdSchema>} - Success response
|
|
336
336
|
* @name getCustomObjectBySlug
|
|
337
337
|
* @summary: Get custom object details
|
|
338
|
-
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://
|
|
338
|
+
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getCustomObjectBySlug/).
|
|
339
339
|
*/
|
|
340
340
|
async getCustomObjectBySlug(
|
|
341
341
|
{ definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -384,7 +384,7 @@ class Content {
|
|
|
384
384
|
* @returns {Promise<DataLoadersSchema>} - Success response
|
|
385
385
|
* @name getDataLoaders
|
|
386
386
|
* @summary: List Dataloaders
|
|
387
|
-
* @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://
|
|
387
|
+
* @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getDataLoaders/).
|
|
388
388
|
*/
|
|
389
389
|
async getDataLoaders(
|
|
390
390
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -421,7 +421,7 @@ class Content {
|
|
|
421
421
|
* @returns {Promise<FaqSchema>} - Success response
|
|
422
422
|
* @name getFaqBySlug
|
|
423
423
|
* @summary: Get FAQ
|
|
424
|
-
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://
|
|
424
|
+
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqBySlug/).
|
|
425
425
|
*/
|
|
426
426
|
async getFaqBySlug(
|
|
427
427
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -467,7 +467,7 @@ class Content {
|
|
|
467
467
|
* @returns {Promise<GetFaqCategoriesSchema>} - Success response
|
|
468
468
|
* @name getFaqCategories
|
|
469
469
|
* @summary: List FAQ Categories
|
|
470
|
-
* @description: List categories for organizing FAQs. - Check out [method documentation](https://
|
|
470
|
+
* @description: List categories for organizing FAQs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqCategories/).
|
|
471
471
|
*/
|
|
472
472
|
async getFaqCategories(
|
|
473
473
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -504,7 +504,7 @@ class Content {
|
|
|
504
504
|
* @returns {Promise<GetFaqCategoryBySlugSchema>} - Success response
|
|
505
505
|
* @name getFaqCategoryBySlug
|
|
506
506
|
* @summary: Get a FAQ category
|
|
507
|
-
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://
|
|
507
|
+
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqCategoryBySlug/).
|
|
508
508
|
*/
|
|
509
509
|
async getFaqCategoryBySlug(
|
|
510
510
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -550,7 +550,7 @@ class Content {
|
|
|
550
550
|
* @returns {Promise<FaqResponseSchema>} - Success response
|
|
551
551
|
* @name getFaqs
|
|
552
552
|
* @summary: List FAQs
|
|
553
|
-
* @description: List frequently asked questions and answers. - Check out [method documentation](https://
|
|
553
|
+
* @description: List frequently asked questions and answers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqs/).
|
|
554
554
|
*/
|
|
555
555
|
async getFaqs(
|
|
556
556
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -587,7 +587,7 @@ class Content {
|
|
|
587
587
|
* @returns {Promise<GetFaqSchema>} - Success response
|
|
588
588
|
* @name getFaqsByCategorySlug
|
|
589
589
|
* @summary: List FAQs by category
|
|
590
|
-
* @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://
|
|
590
|
+
* @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqsByCategorySlug/).
|
|
591
591
|
*/
|
|
592
592
|
async getFaqsByCategorySlug(
|
|
593
593
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -633,7 +633,7 @@ class Content {
|
|
|
633
633
|
* @returns {Promise<LandingPageSchema>} - Success response
|
|
634
634
|
* @name getLandingPage
|
|
635
635
|
* @summary: Get a landing page
|
|
636
|
-
* @description: Get content of the application's landing page. - Check out [method documentation](https://
|
|
636
|
+
* @description: Get content of the application's landing page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getLandingPage/).
|
|
637
637
|
*/
|
|
638
638
|
async getLandingPage(
|
|
639
639
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -670,7 +670,7 @@ class Content {
|
|
|
670
670
|
* @returns {Promise<ApplicationLegal>} - Success response
|
|
671
671
|
* @name getLegalInformation
|
|
672
672
|
* @summary: Get legal information
|
|
673
|
-
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://
|
|
673
|
+
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getLegalInformation/).
|
|
674
674
|
*/
|
|
675
675
|
async getLegalInformation(
|
|
676
676
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -707,7 +707,7 @@ class Content {
|
|
|
707
707
|
* @returns {Promise<NavigationGetDetails>} - Success response
|
|
708
708
|
* @name getNavigations
|
|
709
709
|
* @summary: List navigation items
|
|
710
|
-
* @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://
|
|
710
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/content/getNavigations/).
|
|
711
711
|
*/
|
|
712
712
|
async getNavigations(
|
|
713
713
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -746,7 +746,7 @@ class Content {
|
|
|
746
746
|
* @returns {Promise<PageSchema>} - Success response
|
|
747
747
|
* @name getPage
|
|
748
748
|
* @summary: Get a page
|
|
749
|
-
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://
|
|
749
|
+
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getPage/).
|
|
750
750
|
*/
|
|
751
751
|
async getPage(
|
|
752
752
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -793,7 +793,7 @@ class Content {
|
|
|
793
793
|
* @returns {Promise<PageGetDetails>} - Success response
|
|
794
794
|
* @name getPages
|
|
795
795
|
* @summary: Lists pages
|
|
796
|
-
* @description: Lists all Custom Pages. - Check out [method documentation](https://
|
|
796
|
+
* @description: Lists all Custom Pages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getPages/).
|
|
797
797
|
*/
|
|
798
798
|
async getPages(
|
|
799
799
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -832,7 +832,7 @@ class Content {
|
|
|
832
832
|
* @returns {Promise<SeoComponent>} - Success response
|
|
833
833
|
* @name getSEOConfiguration
|
|
834
834
|
* @summary: Get SEO settings
|
|
835
|
-
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://
|
|
835
|
+
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSEOConfiguration/).
|
|
836
836
|
*/
|
|
837
837
|
async getSEOConfiguration(
|
|
838
838
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -869,7 +869,7 @@ class Content {
|
|
|
869
869
|
* @returns {Promise<SeoSchemaComponent>} - Success response
|
|
870
870
|
* @name getSEOMarkupSchemas
|
|
871
871
|
* @summary: List SEO Markup schemas
|
|
872
|
-
* @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://
|
|
872
|
+
* @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSEOMarkupSchemas/).
|
|
873
873
|
*/
|
|
874
874
|
async getSEOMarkupSchemas(
|
|
875
875
|
{ pageType, active, requestHeaders } = { requestHeaders: {} },
|
|
@@ -908,7 +908,7 @@ class Content {
|
|
|
908
908
|
* @returns {Promise<Support>} - Success response
|
|
909
909
|
* @name getSupportInformation
|
|
910
910
|
* @summary: Get customer support information
|
|
911
|
-
* @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both. - Check out [method documentation](https://
|
|
911
|
+
* @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSupportInformation/).
|
|
912
912
|
*/
|
|
913
913
|
async getSupportInformation(
|
|
914
914
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -945,7 +945,7 @@ class Content {
|
|
|
945
945
|
* @returns {Promise<Object>} - Success response
|
|
946
946
|
* @name getSupportedLanguages
|
|
947
947
|
* @summary: List App Languages
|
|
948
|
-
* @description: Retrieve available languages and their configurations for the specified application. - Check out [method documentation](https://
|
|
948
|
+
* @description: Retrieve available languages and their configurations for the specified application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSupportedLanguages/).
|
|
949
949
|
*/
|
|
950
950
|
async getSupportedLanguages(
|
|
951
951
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -982,7 +982,7 @@ class Content {
|
|
|
982
982
|
* @returns {Promise<TagsSchema>} - Success response
|
|
983
983
|
* @name getTags
|
|
984
984
|
* @summary: Get HTML tags
|
|
985
|
-
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://
|
|
985
|
+
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getTags/).
|
|
986
986
|
*/
|
|
987
987
|
async getTags(
|
|
988
988
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1019,7 +1019,7 @@ class Content {
|
|
|
1019
1019
|
* @returns {Promise<TranslateUiLabelsPage>} - Success response
|
|
1020
1020
|
* @name getTranslateUILabels
|
|
1021
1021
|
* @summary: Get Translate Ui Labels
|
|
1022
|
-
* @description: Retrieve Translate Ui Labels with filtering options for type, template, and locale settings. - Check out [method documentation](https://
|
|
1022
|
+
* @description: Retrieve Translate Ui Labels with filtering options for type, template, and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getTranslateUILabels/).
|
|
1023
1023
|
*/
|
|
1024
1024
|
async getTranslateUILabels(
|
|
1025
1025
|
{ template, templateThemeId, themeId, locale, type, requestHeaders } = {
|
|
@@ -15,7 +15,7 @@ declare class FileStorage {
|
|
|
15
15
|
* @returns {Promise<FileUploadComplete>} - Success response
|
|
16
16
|
* @name completeUpload
|
|
17
17
|
* @summary: Finalizes upload process.
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/application/filestorage/completeUpload/).
|
|
19
19
|
*/
|
|
20
20
|
completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FileUploadComplete>;
|
|
21
21
|
/**
|
|
@@ -24,7 +24,7 @@ declare class FileStorage {
|
|
|
24
24
|
* @returns {Promise<SignUrlResult>} - Success response
|
|
25
25
|
* @name signUrls
|
|
26
26
|
* @summary: Signs file URLs.
|
|
27
|
-
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://
|
|
27
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/signUrls/).
|
|
28
28
|
*/
|
|
29
29
|
signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SignUrlResult>;
|
|
30
30
|
/**
|
|
@@ -33,7 +33,7 @@ declare class FileStorage {
|
|
|
33
33
|
* @returns {Promise<FileUpload>} - Success response
|
|
34
34
|
* @name startUpload
|
|
35
35
|
* @summary: Initiates file upload
|
|
36
|
-
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://
|
|
36
|
+
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/startUpload/).
|
|
37
37
|
*/
|
|
38
38
|
startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FileUpload>;
|
|
39
39
|
/**
|
|
@@ -42,7 +42,7 @@ class FileStorage {
|
|
|
42
42
|
* @returns {Promise<FileUploadComplete>} - Success response
|
|
43
43
|
* @name completeUpload
|
|
44
44
|
* @summary: Finalizes upload process.
|
|
45
|
-
* @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://
|
|
45
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/filestorage/completeUpload/).
|
|
46
46
|
*/
|
|
47
47
|
async completeUpload(
|
|
48
48
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -88,7 +88,7 @@ class FileStorage {
|
|
|
88
88
|
* @returns {Promise<SignUrlResult>} - Success response
|
|
89
89
|
* @name signUrls
|
|
90
90
|
* @summary: Signs file URLs.
|
|
91
|
-
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://
|
|
91
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/signUrls/).
|
|
92
92
|
*/
|
|
93
93
|
async signUrls(
|
|
94
94
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -125,7 +125,7 @@ class FileStorage {
|
|
|
125
125
|
* @returns {Promise<FileUpload>} - Success response
|
|
126
126
|
* @name startUpload
|
|
127
127
|
* @summary: Initiates file upload
|
|
128
|
-
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://
|
|
128
|
+
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/startUpload/).
|
|
129
129
|
*/
|
|
130
130
|
async startUpload(
|
|
131
131
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -14,7 +14,7 @@ declare class Finance {
|
|
|
14
14
|
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
15
15
|
* @name customerCreditBalance
|
|
16
16
|
* @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
|
|
17
|
-
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://
|
|
17
|
+
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/customerCreditBalance/).
|
|
18
18
|
*/
|
|
19
19
|
customerCreditBalance({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerCreditBalanceResponseSchema>;
|
|
20
20
|
/**
|
|
@@ -23,7 +23,7 @@ declare class Finance {
|
|
|
23
23
|
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
24
24
|
* @name lockUnlockCreditNote
|
|
25
25
|
* @summary: Lock or Unlock requested credit note.
|
|
26
|
-
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://
|
|
26
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/lockUnlockCreditNote/).
|
|
27
27
|
*/
|
|
28
28
|
lockUnlockCreditNote({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LockUnlockResponseSchema>;
|
|
29
29
|
}
|
|
@@ -39,7 +39,7 @@ class Finance {
|
|
|
39
39
|
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
40
40
|
* @name customerCreditBalance
|
|
41
41
|
* @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
|
|
42
|
-
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://
|
|
42
|
+
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/customerCreditBalance/).
|
|
43
43
|
*/
|
|
44
44
|
async customerCreditBalance(
|
|
45
45
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -76,7 +76,7 @@ class Finance {
|
|
|
76
76
|
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
77
77
|
* @name lockUnlockCreditNote
|
|
78
78
|
* @summary: Lock or Unlock requested credit note.
|
|
79
|
-
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://
|
|
79
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/lockUnlockCreditNote/).
|
|
80
80
|
*/
|
|
81
81
|
async lockUnlockCreditNote(
|
|
82
82
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -17,7 +17,7 @@ declare class Lead {
|
|
|
17
17
|
* @returns {Promise<TicketHistory>} - Success response
|
|
18
18
|
* @name createHistory
|
|
19
19
|
* @summary: Log ticket history
|
|
20
|
-
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://
|
|
20
|
+
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createHistory/).
|
|
21
21
|
*/
|
|
22
22
|
createHistory({ id, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<TicketHistory>;
|
|
23
23
|
/**
|
|
@@ -26,7 +26,7 @@ declare class Lead {
|
|
|
26
26
|
* @returns {Promise<Ticket>} - Success response
|
|
27
27
|
* @name createTicket
|
|
28
28
|
* @summary: Creates a ticket
|
|
29
|
-
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://
|
|
29
|
+
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createTicket/).
|
|
30
30
|
*/
|
|
31
31
|
createTicket({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Ticket>;
|
|
32
32
|
/**
|
|
@@ -35,7 +35,7 @@ declare class Lead {
|
|
|
35
35
|
* @returns {Promise<CustomForm>} - Success response
|
|
36
36
|
* @name getCustomForm
|
|
37
37
|
* @summary: Get custom form
|
|
38
|
-
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://
|
|
38
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getCustomForm/).
|
|
39
39
|
*/
|
|
40
40
|
getCustomForm({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomForm>;
|
|
41
41
|
/**
|
|
@@ -44,7 +44,7 @@ declare class Lead {
|
|
|
44
44
|
* @returns {Promise<Ticket>} - Success response
|
|
45
45
|
* @name getTicket
|
|
46
46
|
* @summary: Get a support ticket
|
|
47
|
-
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://
|
|
47
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getTicket/).
|
|
48
48
|
*/
|
|
49
49
|
getTicket({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Ticket>;
|
|
50
50
|
/**
|
|
@@ -53,7 +53,7 @@ declare class Lead {
|
|
|
53
53
|
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
54
54
|
* @name submitCustomForm
|
|
55
55
|
* @summary: Submits form data
|
|
56
|
-
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://
|
|
56
|
+
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/submitCustomForm/).
|
|
57
57
|
*/
|
|
58
58
|
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SubmitCustomFormDetails>;
|
|
59
59
|
}
|
|
@@ -40,7 +40,7 @@ class Lead {
|
|
|
40
40
|
* @returns {Promise<TicketHistory>} - Success response
|
|
41
41
|
* @name createHistory
|
|
42
42
|
* @summary: Log ticket history
|
|
43
|
-
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://
|
|
43
|
+
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createHistory/).
|
|
44
44
|
*/
|
|
45
45
|
async createHistory(
|
|
46
46
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -86,7 +86,7 @@ class Lead {
|
|
|
86
86
|
* @returns {Promise<Ticket>} - Success response
|
|
87
87
|
* @name createTicket
|
|
88
88
|
* @summary: Creates a ticket
|
|
89
|
-
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://
|
|
89
|
+
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createTicket/).
|
|
90
90
|
*/
|
|
91
91
|
async createTicket(
|
|
92
92
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -123,7 +123,7 @@ class Lead {
|
|
|
123
123
|
* @returns {Promise<CustomForm>} - Success response
|
|
124
124
|
* @name getCustomForm
|
|
125
125
|
* @summary: Get custom form
|
|
126
|
-
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://
|
|
126
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getCustomForm/).
|
|
127
127
|
*/
|
|
128
128
|
async getCustomForm(
|
|
129
129
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -169,7 +169,7 @@ class Lead {
|
|
|
169
169
|
* @returns {Promise<Ticket>} - Success response
|
|
170
170
|
* @name getTicket
|
|
171
171
|
* @summary: Get a support ticket
|
|
172
|
-
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://
|
|
172
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getTicket/).
|
|
173
173
|
*/
|
|
174
174
|
async getTicket(
|
|
175
175
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -215,7 +215,7 @@ class Lead {
|
|
|
215
215
|
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
216
216
|
* @name submitCustomForm
|
|
217
217
|
* @summary: Submits form data
|
|
218
|
-
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://
|
|
218
|
+
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/submitCustomForm/).
|
|
219
219
|
*/
|
|
220
220
|
async submitCustomForm(
|
|
221
221
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -21,7 +21,7 @@ declare class Logistic {
|
|
|
21
21
|
* @returns {Promise<CountryResult>} - Success response
|
|
22
22
|
* @name getAllCountries
|
|
23
23
|
* @summary: Get deliverable countries
|
|
24
|
-
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://
|
|
24
|
+
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getAllCountries/).
|
|
25
25
|
*/
|
|
26
26
|
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryResult>;
|
|
27
27
|
/**
|
|
@@ -30,7 +30,7 @@ declare class Logistic {
|
|
|
30
30
|
* @returns {Promise<GetCountries>} - Success response
|
|
31
31
|
* @name getCountries
|
|
32
32
|
* @summary: Get countries
|
|
33
|
-
* @description: List of supported countries. - Check out [method documentation](https://
|
|
33
|
+
* @description: List of supported countries. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountries/).
|
|
34
34
|
*/
|
|
35
35
|
getCountries({ onboarding, pageNo, pageSize, q, hierarchy, phoneCode, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
36
36
|
/**
|
|
@@ -39,7 +39,7 @@ declare class Logistic {
|
|
|
39
39
|
* @returns {Promise<GetCountry>} - Success response
|
|
40
40
|
* @name getCountry
|
|
41
41
|
* @summary: Get country details
|
|
42
|
-
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://
|
|
42
|
+
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountry/).
|
|
43
43
|
*/
|
|
44
44
|
getCountry({ countryIsoCode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetCountry>;
|
|
45
45
|
/**
|
|
@@ -48,7 +48,7 @@ declare class Logistic {
|
|
|
48
48
|
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
49
49
|
* @name getCourierPartners
|
|
50
50
|
* @summary: Serviceable Courier Partners
|
|
51
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
51
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCourierPartners/).
|
|
52
52
|
*/
|
|
53
53
|
getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentCourierPartnerResult>;
|
|
54
54
|
/**
|
|
@@ -57,7 +57,7 @@ declare class Logistic {
|
|
|
57
57
|
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
58
58
|
* @name getDeliveryPromise
|
|
59
59
|
* @summary: Get delivery promise
|
|
60
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://
|
|
60
|
+
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
61
61
|
*/
|
|
62
62
|
getDeliveryPromise({ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
63
63
|
/**
|
|
@@ -66,7 +66,7 @@ declare class Logistic {
|
|
|
66
66
|
* @returns {Promise<GetLocalitiesApp>} - Success response
|
|
67
67
|
* @name getLocalities
|
|
68
68
|
* @summary: Get Localities
|
|
69
|
-
* @description: Get Localities data. - Check out [method documentation](https://
|
|
69
|
+
* @description: Get Localities data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocalities/).
|
|
70
70
|
*/
|
|
71
71
|
getLocalities({ localityType, country, state, city, pageNo, pageSize, q, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetLocalitiesApp>;
|
|
72
72
|
/**
|
|
@@ -75,7 +75,7 @@ declare class Logistic {
|
|
|
75
75
|
* @returns {Promise<GetLocalityApp>} - Success response
|
|
76
76
|
* @name getLocality
|
|
77
77
|
* @summary: Get Locality API
|
|
78
|
-
* @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://
|
|
78
|
+
* @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/).
|
|
79
79
|
*/
|
|
80
80
|
getLocality({ localityType, localityValue, country, state, city, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetLocalityApp>;
|
|
81
81
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Logistic {
|
|
|
84
84
|
* @returns {Promise<PincodeDetailsResult>} - Success response
|
|
85
85
|
* @name getPincodeCity
|
|
86
86
|
* @summary: Get pincode details
|
|
87
|
-
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://
|
|
87
|
+
* @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/).
|
|
88
88
|
*/
|
|
89
89
|
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PincodeDetailsResult>;
|
|
90
90
|
/**
|
|
@@ -93,7 +93,7 @@ declare class Logistic {
|
|
|
93
93
|
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
94
94
|
* @name validateAddress
|
|
95
95
|
* @summary: Validate address
|
|
96
|
-
* @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://
|
|
96
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/logistic/validateAddress/).
|
|
97
97
|
*/
|
|
98
98
|
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ValidateAddressDetails>;
|
|
99
99
|
}
|
|
@@ -50,7 +50,7 @@ class Logistic {
|
|
|
50
50
|
* @returns {Promise<CountryResult>} - Success response
|
|
51
51
|
* @name getAllCountries
|
|
52
52
|
* @summary: Get deliverable countries
|
|
53
|
-
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://
|
|
53
|
+
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getAllCountries/).
|
|
54
54
|
*/
|
|
55
55
|
async getAllCountries(
|
|
56
56
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -87,7 +87,7 @@ class Logistic {
|
|
|
87
87
|
* @returns {Promise<GetCountries>} - Success response
|
|
88
88
|
* @name getCountries
|
|
89
89
|
* @summary: Get countries
|
|
90
|
-
* @description: List of supported countries. - Check out [method documentation](https://
|
|
90
|
+
* @description: List of supported countries. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountries/).
|
|
91
91
|
*/
|
|
92
92
|
async getCountries(
|
|
93
93
|
{
|
|
@@ -138,7 +138,7 @@ class Logistic {
|
|
|
138
138
|
* @returns {Promise<GetCountry>} - Success response
|
|
139
139
|
* @name getCountry
|
|
140
140
|
* @summary: Get country details
|
|
141
|
-
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://
|
|
141
|
+
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountry/).
|
|
142
142
|
*/
|
|
143
143
|
async getCountry(
|
|
144
144
|
{ countryIsoCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -184,7 +184,7 @@ class Logistic {
|
|
|
184
184
|
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
185
185
|
* @name getCourierPartners
|
|
186
186
|
* @summary: Serviceable Courier Partners
|
|
187
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
187
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCourierPartners/).
|
|
188
188
|
*/
|
|
189
189
|
async getCourierPartners(
|
|
190
190
|
{ companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -233,7 +233,7 @@ class Logistic {
|
|
|
233
233
|
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
234
234
|
* @name getDeliveryPromise
|
|
235
235
|
* @summary: Get delivery promise
|
|
236
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://
|
|
236
|
+
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
237
237
|
*/
|
|
238
238
|
async getDeliveryPromise(
|
|
239
239
|
{ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders } = {
|
|
@@ -276,7 +276,7 @@ class Logistic {
|
|
|
276
276
|
* @returns {Promise<GetLocalitiesApp>} - Success response
|
|
277
277
|
* @name getLocalities
|
|
278
278
|
* @summary: Get Localities
|
|
279
|
-
* @description: Get Localities data. - Check out [method documentation](https://
|
|
279
|
+
* @description: Get Localities data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocalities/).
|
|
280
280
|
*/
|
|
281
281
|
async getLocalities(
|
|
282
282
|
{
|
|
@@ -339,7 +339,7 @@ class Logistic {
|
|
|
339
339
|
* @returns {Promise<GetLocalityApp>} - Success response
|
|
340
340
|
* @name getLocality
|
|
341
341
|
* @summary: Get Locality API
|
|
342
|
-
* @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://
|
|
342
|
+
* @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/).
|
|
343
343
|
*/
|
|
344
344
|
async getLocality(
|
|
345
345
|
{
|
|
@@ -400,7 +400,7 @@ class Logistic {
|
|
|
400
400
|
* @returns {Promise<PincodeDetailsResult>} - Success response
|
|
401
401
|
* @name getPincodeCity
|
|
402
402
|
* @summary: Get pincode details
|
|
403
|
-
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://
|
|
403
|
+
* @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/).
|
|
404
404
|
*/
|
|
405
405
|
async getPincodeCity(
|
|
406
406
|
{ pincode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -446,7 +446,7 @@ class Logistic {
|
|
|
446
446
|
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
447
447
|
* @name validateAddress
|
|
448
448
|
* @summary: Validate address
|
|
449
|
-
* @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://
|
|
449
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/logistic/validateAddress/).
|
|
450
450
|
*/
|
|
451
451
|
async validateAddress(
|
|
452
452
|
{ countryIsoCode, templateName, body, requestHeaders } = {
|