@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -65,8 +65,8 @@ class Content {
|
|
|
65
65
|
* - Success response
|
|
66
66
|
*
|
|
67
67
|
* @name getAnnouncements
|
|
68
|
-
* @summary:
|
|
69
|
-
* @description:
|
|
68
|
+
* @summary: List announcements
|
|
69
|
+
* @description: List all current announcements in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getAnnouncements/).
|
|
70
70
|
*/
|
|
71
71
|
async getAnnouncements(
|
|
72
72
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -143,8 +143,8 @@ class Content {
|
|
|
143
143
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
144
144
|
* @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
|
|
145
145
|
* @name getBlog
|
|
146
|
-
* @summary:
|
|
147
|
-
* @description:
|
|
146
|
+
* @summary: Get a blog
|
|
147
|
+
* @description: Get all 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/).
|
|
148
148
|
*/
|
|
149
149
|
async getBlog(
|
|
150
150
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -220,8 +220,8 @@ class Content {
|
|
|
220
220
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
221
221
|
* @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
|
|
222
222
|
* @name getBlogs
|
|
223
|
-
* @summary:
|
|
224
|
-
* @description:
|
|
223
|
+
* @summary: List blogs
|
|
224
|
+
* @description: List all the blogs against an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
225
225
|
*/
|
|
226
226
|
async getBlogs(
|
|
227
227
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -300,8 +300,8 @@ class Content {
|
|
|
300
300
|
* - Success response
|
|
301
301
|
*
|
|
302
302
|
* @name getCustomFields
|
|
303
|
-
* @summary: Get list of custom fields
|
|
304
|
-
* @description:
|
|
303
|
+
* @summary: Get list of custom fields
|
|
304
|
+
* @description: Retrieves a list of 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/).
|
|
305
305
|
*/
|
|
306
306
|
async getCustomFields(
|
|
307
307
|
{ resource, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -379,8 +379,8 @@ class Content {
|
|
|
379
379
|
* @returns {Promise<ContentApplicationModel.CustomObjectByIdSchema>} -
|
|
380
380
|
* Success response
|
|
381
381
|
* @name getCustomObject
|
|
382
|
-
* @summary: Get custom object
|
|
383
|
-
* @description:
|
|
382
|
+
* @summary: Get custom object
|
|
383
|
+
* @description: 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/).
|
|
384
384
|
*/
|
|
385
385
|
async getCustomObject(
|
|
386
386
|
{ metaobjectId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -457,8 +457,8 @@ class Content {
|
|
|
457
457
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
458
458
|
* @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
|
|
459
459
|
* @name getDataLoaders
|
|
460
|
-
* @summary:
|
|
461
|
-
* @description:
|
|
460
|
+
* @summary: List Dataloaders
|
|
461
|
+
* @description: List all the data loaders that are enabled for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
|
|
462
462
|
*/
|
|
463
463
|
async getDataLoaders(
|
|
464
464
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -535,8 +535,8 @@ class Content {
|
|
|
535
535
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
536
536
|
* @returns {Promise<ContentApplicationModel.FaqSchema>} - Success response
|
|
537
537
|
* @name getFaqBySlug
|
|
538
|
-
* @summary:
|
|
539
|
-
* @description:
|
|
538
|
+
* @summary: Get FAQ
|
|
539
|
+
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqBySlug/).
|
|
540
540
|
*/
|
|
541
541
|
async getFaqBySlug(
|
|
542
542
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -614,8 +614,8 @@ class Content {
|
|
|
614
614
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoriesSchema>} -
|
|
615
615
|
* Success response
|
|
616
616
|
* @name getFaqCategories
|
|
617
|
-
* @summary:
|
|
618
|
-
* @description:
|
|
617
|
+
* @summary: List FAQ Categories
|
|
618
|
+
* @description: Lists categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
|
|
619
619
|
*/
|
|
620
620
|
async getFaqCategories(
|
|
621
621
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -693,8 +693,8 @@ class Content {
|
|
|
693
693
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>} -
|
|
694
694
|
* Success response
|
|
695
695
|
* @name getFaqCategoryBySlug
|
|
696
|
-
* @summary:
|
|
697
|
-
* @description:
|
|
696
|
+
* @summary: Get a FAQ category
|
|
697
|
+
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategoryBySlug/).
|
|
698
698
|
*/
|
|
699
699
|
async getFaqCategoryBySlug(
|
|
700
700
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -773,8 +773,8 @@ class Content {
|
|
|
773
773
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
774
774
|
* @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
|
|
775
775
|
* @name getFaqs
|
|
776
|
-
* @summary:
|
|
777
|
-
* @description:
|
|
776
|
+
* @summary: List FAQs
|
|
777
|
+
* @description: List a list of frequently asked questions and ansers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
|
|
778
778
|
*/
|
|
779
779
|
async getFaqs(
|
|
780
780
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -849,8 +849,8 @@ class Content {
|
|
|
849
849
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
850
850
|
* @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
|
|
851
851
|
* @name getFaqsByCategorySlug
|
|
852
|
-
* @summary:
|
|
853
|
-
* @description:
|
|
852
|
+
* @summary: List FAQs by category
|
|
853
|
+
* @description: Get FAQs belonging to a specific category slug - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
|
|
854
854
|
*/
|
|
855
855
|
async getFaqsByCategorySlug(
|
|
856
856
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -929,7 +929,7 @@ class Content {
|
|
|
929
929
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
930
930
|
* @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
|
|
931
931
|
* @name getLandingPage
|
|
932
|
-
* @summary:
|
|
932
|
+
* @summary: Get a landing page
|
|
933
933
|
* @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
|
|
934
934
|
*/
|
|
935
935
|
async getLandingPage(
|
|
@@ -1007,8 +1007,8 @@ class Content {
|
|
|
1007
1007
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1008
1008
|
* @returns {Promise<ContentApplicationModel.ApplicationLegal>} - Success response
|
|
1009
1009
|
* @name getLegalInformation
|
|
1010
|
-
* @summary:
|
|
1011
|
-
* @description:
|
|
1010
|
+
* @summary: Get legal information
|
|
1011
|
+
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLegalInformation/).
|
|
1012
1012
|
*/
|
|
1013
1013
|
async getLegalInformation(
|
|
1014
1014
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1088,8 +1088,8 @@ class Content {
|
|
|
1088
1088
|
* @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
|
|
1089
1089
|
* Success response
|
|
1090
1090
|
* @name getNavigations
|
|
1091
|
-
* @summary:
|
|
1092
|
-
* @description:
|
|
1091
|
+
* @summary: List navigation items
|
|
1092
|
+
* @description: Get the navigation link items which can be powered to genreate menus on application's website or equivalent mobile apps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
|
|
1093
1093
|
*/
|
|
1094
1094
|
async getNavigations(
|
|
1095
1095
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1168,8 +1168,8 @@ class Content {
|
|
|
1168
1168
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1169
1169
|
* @returns {Promise<ContentApplicationModel.PageSchema>} - Success response
|
|
1170
1170
|
* @name getPage
|
|
1171
|
-
* @summary:
|
|
1172
|
-
* @description:
|
|
1171
|
+
* @summary: Get a page
|
|
1172
|
+
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
|
|
1173
1173
|
*/
|
|
1174
1174
|
async getPage(
|
|
1175
1175
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1245,8 +1245,8 @@ class Content {
|
|
|
1245
1245
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1246
1246
|
* @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
|
|
1247
1247
|
* @name getPages
|
|
1248
|
-
* @summary: Lists
|
|
1249
|
-
* @description:
|
|
1248
|
+
* @summary: Lists pages
|
|
1249
|
+
* @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
1250
1250
|
*/
|
|
1251
1251
|
async getPages(
|
|
1252
1252
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1323,8 +1323,8 @@ class Content {
|
|
|
1323
1323
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1324
1324
|
* @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
|
|
1325
1325
|
* @name getSEOConfiguration
|
|
1326
|
-
* @summary:
|
|
1327
|
-
* @description:
|
|
1326
|
+
* @summary: Get SEO settings
|
|
1327
|
+
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
|
|
1328
1328
|
*/
|
|
1329
1329
|
async getSEOConfiguration(
|
|
1330
1330
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1403,8 +1403,8 @@ class Content {
|
|
|
1403
1403
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1404
1404
|
* @returns {Promise<ContentApplicationModel.SeoSchemaComponent>} - Success response
|
|
1405
1405
|
* @name getSEOMarkupSchemas
|
|
1406
|
-
* @summary:
|
|
1407
|
-
* @description:
|
|
1406
|
+
* @summary: List SEO Markup schemas
|
|
1407
|
+
* @description: Get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
|
|
1408
1408
|
*/
|
|
1409
1409
|
async getSEOMarkupSchemas(
|
|
1410
1410
|
{ pageType, active, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1485,8 +1485,8 @@ class Content {
|
|
|
1485
1485
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1486
1486
|
* @returns {Promise<ContentApplicationModel.SlideshowSchema>} - Success response
|
|
1487
1487
|
* @name getSlideshow
|
|
1488
|
-
* @summary: Get a
|
|
1489
|
-
* @description:
|
|
1488
|
+
* @summary: Get a Slideshow
|
|
1489
|
+
* @description: Get a slideshow using its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshow/).
|
|
1490
1490
|
*/
|
|
1491
1491
|
async getSlideshow(
|
|
1492
1492
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1563,8 +1563,8 @@ class Content {
|
|
|
1563
1563
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1564
1564
|
* @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
|
|
1565
1565
|
* @name getSlideshows
|
|
1566
|
-
* @summary:
|
|
1567
|
-
* @description:
|
|
1566
|
+
* @summary: List Slideshows
|
|
1567
|
+
* @description: Get a list of slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
|
|
1568
1568
|
*/
|
|
1569
1569
|
async getSlideshows(
|
|
1570
1570
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1641,8 +1641,8 @@ class Content {
|
|
|
1641
1641
|
* @param {Object} arg - Arg object.
|
|
1642
1642
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1643
1643
|
* @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
|
|
1644
|
-
* @summary:
|
|
1645
|
-
* @description:
|
|
1644
|
+
* @summary: List Slideshows
|
|
1645
|
+
* @description: Get a list of slideshows along with their details.
|
|
1646
1646
|
*/
|
|
1647
1647
|
getSlideshowsPaginator({ pageSize } = {}) {
|
|
1648
1648
|
const paginator = new Paginator();
|
|
@@ -1670,8 +1670,8 @@ class Content {
|
|
|
1670
1670
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1671
1671
|
* @returns {Promise<ContentApplicationModel.Support>} - Success response
|
|
1672
1672
|
* @name getSupportInformation
|
|
1673
|
-
* @summary:
|
|
1674
|
-
* @description:
|
|
1673
|
+
* @summary: Get customer support information
|
|
1674
|
+
* @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://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
|
|
1675
1675
|
*/
|
|
1676
1676
|
async getSupportInformation(
|
|
1677
1677
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1750,8 +1750,8 @@ class Content {
|
|
|
1750
1750
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1751
1751
|
* @returns {Promise<ContentApplicationModel.TagsSchema>} - Success response
|
|
1752
1752
|
* @name getTags
|
|
1753
|
-
* @summary:
|
|
1754
|
-
* @description:
|
|
1753
|
+
* @summary: Get HTML tags
|
|
1754
|
+
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
|
|
1755
1755
|
*/
|
|
1756
1756
|
async getTags(
|
|
1757
1757
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -15,8 +15,8 @@ declare class FileStorage {
|
|
|
15
15
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
16
16
|
* @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
|
|
17
17
|
* @name completeUpload
|
|
18
|
-
* @summary:
|
|
19
|
-
* @description: Complete the
|
|
18
|
+
* @summary: Complete file upload
|
|
19
|
+
* @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/).
|
|
20
20
|
*/
|
|
21
21
|
completeUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.CompleteResponse>;
|
|
22
22
|
/**
|
|
@@ -25,7 +25,7 @@ declare class FileStorage {
|
|
|
25
25
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
26
26
|
* @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
|
|
27
27
|
* @name signUrls
|
|
28
|
-
* @summary:
|
|
28
|
+
* @summary: Get signed URLs
|
|
29
29
|
* @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/).
|
|
30
30
|
*/
|
|
31
31
|
signUrls({ body, requestHeaders }?: FileStorageApplicationValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.SignUrlResponse>;
|
|
@@ -35,8 +35,8 @@ declare class FileStorage {
|
|
|
35
35
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
36
36
|
* @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
|
|
37
37
|
* @name startUpload
|
|
38
|
-
* @summary:
|
|
39
|
-
* @description:
|
|
38
|
+
* @summary: Initiate file upload
|
|
39
|
+
* @description: Get a signed url for uploading a file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
40
40
|
*/
|
|
41
41
|
startUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.StartResponse>;
|
|
42
42
|
/**
|
|
@@ -43,8 +43,8 @@ class FileStorage {
|
|
|
43
43
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
44
44
|
* @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
|
|
45
45
|
* @name completeUpload
|
|
46
|
-
* @summary:
|
|
47
|
-
* @description: Complete the
|
|
46
|
+
* @summary: Complete file upload
|
|
47
|
+
* @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/).
|
|
48
48
|
*/
|
|
49
49
|
async completeUpload(
|
|
50
50
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -121,7 +121,7 @@ class FileStorage {
|
|
|
121
121
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
122
122
|
* @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
|
|
123
123
|
* @name signUrls
|
|
124
|
-
* @summary:
|
|
124
|
+
* @summary: Get signed URLs
|
|
125
125
|
* @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/).
|
|
126
126
|
*/
|
|
127
127
|
async signUrls(
|
|
@@ -199,8 +199,8 @@ class FileStorage {
|
|
|
199
199
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
200
200
|
* @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
|
|
201
201
|
* @name startUpload
|
|
202
|
-
* @summary:
|
|
203
|
-
* @description:
|
|
202
|
+
* @summary: Initiate file upload
|
|
203
|
+
* @description: Get a signed url for uploading a file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
204
204
|
*/
|
|
205
205
|
async startUpload(
|
|
206
206
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -19,7 +19,7 @@ declare class Lead {
|
|
|
19
19
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
|
|
21
21
|
* @name createHistory
|
|
22
|
-
* @summary:
|
|
22
|
+
* @summary: Log ticket history
|
|
23
23
|
* @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
|
|
24
24
|
*/
|
|
25
25
|
createHistory({ id, body, requestHeaders }?: LeadApplicationValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadApplicationModel.TicketHistory>;
|
|
@@ -29,7 +29,7 @@ declare class Lead {
|
|
|
29
29
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
31
31
|
* @name createTicket
|
|
32
|
-
* @summary: Creates a
|
|
32
|
+
* @summary: Creates a ticket
|
|
33
33
|
* @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
|
|
34
34
|
*/
|
|
35
35
|
createTicket({ body, requestHeaders }?: LeadApplicationValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
|
|
@@ -39,8 +39,8 @@ declare class Lead {
|
|
|
39
39
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
40
40
|
* @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
|
|
41
41
|
* @name getCustomForm
|
|
42
|
-
* @summary:
|
|
43
|
-
* @description:
|
|
42
|
+
* @summary: Get custom form
|
|
43
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
|
|
44
44
|
*/
|
|
45
45
|
getCustomForm({ slug, requestHeaders }?: LeadApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.CustomForm>;
|
|
46
46
|
/**
|
|
@@ -53,7 +53,7 @@ declare class Lead {
|
|
|
53
53
|
* - Success response
|
|
54
54
|
*
|
|
55
55
|
* @name getParticipantsInsideVideoRoom
|
|
56
|
-
* @summary:
|
|
56
|
+
* @summary: List video room participants
|
|
57
57
|
* @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
|
|
58
58
|
*/
|
|
59
59
|
getParticipantsInsideVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetParticipantsInsideVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>;
|
|
@@ -63,8 +63,8 @@ declare class Lead {
|
|
|
63
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
65
65
|
* @name getTicket
|
|
66
|
-
* @summary:
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Get a support ticket
|
|
67
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
|
|
68
68
|
*/
|
|
69
69
|
getTicket({ id, requestHeaders }?: LeadApplicationValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
|
|
70
70
|
/**
|
|
@@ -74,8 +74,8 @@ declare class Lead {
|
|
|
74
74
|
* @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
|
|
75
75
|
* Success response
|
|
76
76
|
* @name getTokenForVideoRoom
|
|
77
|
-
* @summary:
|
|
78
|
-
* @description:
|
|
77
|
+
* @summary: Get video room token
|
|
78
|
+
* @description: Get a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
|
|
79
79
|
*/
|
|
80
80
|
getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>;
|
|
81
81
|
/**
|
|
@@ -46,7 +46,7 @@ class Lead {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
|
|
48
48
|
* @name createHistory
|
|
49
|
-
* @summary:
|
|
49
|
+
* @summary: Log ticket history
|
|
50
50
|
* @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
|
|
51
51
|
*/
|
|
52
52
|
async createHistory(
|
|
@@ -124,7 +124,7 @@ class Lead {
|
|
|
124
124
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
125
125
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
126
126
|
* @name createTicket
|
|
127
|
-
* @summary: Creates a
|
|
127
|
+
* @summary: Creates a ticket
|
|
128
128
|
* @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
|
|
129
129
|
*/
|
|
130
130
|
async createTicket(
|
|
@@ -202,8 +202,8 @@ class Lead {
|
|
|
202
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
|
|
204
204
|
* @name getCustomForm
|
|
205
|
-
* @summary:
|
|
206
|
-
* @description:
|
|
205
|
+
* @summary: Get custom form
|
|
206
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
|
|
207
207
|
*/
|
|
208
208
|
async getCustomForm(
|
|
209
209
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -284,7 +284,7 @@ class Lead {
|
|
|
284
284
|
* - Success response
|
|
285
285
|
*
|
|
286
286
|
* @name getParticipantsInsideVideoRoom
|
|
287
|
-
* @summary:
|
|
287
|
+
* @summary: List video room participants
|
|
288
288
|
* @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
|
|
289
289
|
*/
|
|
290
290
|
async getParticipantsInsideVideoRoom(
|
|
@@ -364,8 +364,8 @@ class Lead {
|
|
|
364
364
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
365
365
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
366
366
|
* @name getTicket
|
|
367
|
-
* @summary:
|
|
368
|
-
* @description:
|
|
367
|
+
* @summary: Get a support ticket
|
|
368
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
|
|
369
369
|
*/
|
|
370
370
|
async getTicket(
|
|
371
371
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -441,8 +441,8 @@ class Lead {
|
|
|
441
441
|
* @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
|
|
442
442
|
* Success response
|
|
443
443
|
* @name getTokenForVideoRoom
|
|
444
|
-
* @summary:
|
|
445
|
-
* @description:
|
|
444
|
+
* @summary: Get video room token
|
|
445
|
+
* @description: Get a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
|
|
446
446
|
*/
|
|
447
447
|
async getTokenForVideoRoom(
|
|
448
448
|
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -23,8 +23,8 @@ declare class Logistic {
|
|
|
23
23
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
24
24
|
* @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
|
|
25
25
|
* @name getAllCountries
|
|
26
|
-
* @summary:
|
|
27
|
-
* @description:
|
|
26
|
+
* @summary: Get deliverable countries
|
|
27
|
+
* @description: Retrieves 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/).
|
|
28
28
|
*/
|
|
29
29
|
getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
|
|
30
30
|
/**
|
|
@@ -33,8 +33,8 @@ declare class Logistic {
|
|
|
33
33
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
34
34
|
* @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
|
|
35
35
|
* @name getCountries
|
|
36
|
-
* @summary: Get
|
|
37
|
-
* @description:
|
|
36
|
+
* @summary: Get countries
|
|
37
|
+
* @description: Fetch the list of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
38
38
|
*/
|
|
39
39
|
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticApplicationValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountries>;
|
|
40
40
|
/**
|
|
@@ -43,8 +43,8 @@ declare class Logistic {
|
|
|
43
43
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
44
44
|
* @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
|
|
45
45
|
* @name getCountry
|
|
46
|
-
* @summary: Get
|
|
47
|
-
* @description:
|
|
46
|
+
* @summary: Get country details
|
|
47
|
+
* @description: Fetch 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/).
|
|
48
48
|
*/
|
|
49
49
|
getCountry({ countryIsoCode, requestHeaders }?: LogisticApplicationValidator.GetCountryParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountry>;
|
|
50
50
|
/**
|
|
@@ -53,8 +53,8 @@ declare class Logistic {
|
|
|
53
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
|
|
55
55
|
* @name getLocalities
|
|
56
|
-
* @summary: Get
|
|
57
|
-
* @description:
|
|
56
|
+
* @summary: Get localities
|
|
57
|
+
* @description: Retrieve geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
|
|
58
58
|
*/
|
|
59
59
|
getLocalities({ localityType, country, state, city, pageNo, pageSize, q, requestHeaders, }?: LogisticApplicationValidator.GetLocalitiesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocalities>;
|
|
60
60
|
/**
|
|
@@ -63,8 +63,8 @@ declare class Logistic {
|
|
|
63
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<LogisticApplicationModel.GetLocality>} - Success response
|
|
65
65
|
* @name getLocality
|
|
66
|
-
* @summary: Get
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Get locality detail
|
|
67
|
+
* @description: Retrieve 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://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
|
|
68
68
|
*/
|
|
69
69
|
getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: LogisticApplicationValidator.GetLocalityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocality>;
|
|
70
70
|
/**
|
|
@@ -73,8 +73,8 @@ declare class Logistic {
|
|
|
73
73
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
74
74
|
* @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
|
|
75
75
|
* @name getLocations
|
|
76
|
-
* @summary:
|
|
77
|
-
* @description: Retrieves
|
|
76
|
+
* @summary: Get available selling locations
|
|
77
|
+
* @description: Retrieves 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/).
|
|
78
78
|
*/
|
|
79
79
|
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: LogisticApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetStoreResponse>;
|
|
80
80
|
/**
|
|
@@ -84,8 +84,8 @@ declare class Logistic {
|
|
|
84
84
|
* @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
|
|
85
85
|
* Success response
|
|
86
86
|
* @name getOptimalLocations
|
|
87
|
-
* @summary:
|
|
88
|
-
* @description:
|
|
87
|
+
* @summary: Get selling locations
|
|
88
|
+
* @description: Determines and returns the best fulfillment center 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/).
|
|
89
89
|
*/
|
|
90
90
|
getOptimalLocations({ body, requestHeaders }?: LogisticApplicationValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ReAssignStoreResponse>;
|
|
91
91
|
/**
|
|
@@ -94,8 +94,8 @@ declare class Logistic {
|
|
|
94
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
95
95
|
* @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
|
|
96
96
|
* @name getPincodeCity
|
|
97
|
-
* @summary:
|
|
98
|
-
* @description: Retrieve
|
|
97
|
+
* @summary: Get pincode details
|
|
98
|
+
* @description: Retrieve 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/).
|
|
99
99
|
*/
|
|
100
100
|
getPincodeCity({ pincode, requestHeaders }?: LogisticApplicationValidator.GetPincodeCityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.PincodeApiResponse>;
|
|
101
101
|
/**
|
|
@@ -106,8 +106,8 @@ declare class Logistic {
|
|
|
106
106
|
* - Success response
|
|
107
107
|
*
|
|
108
108
|
* @name getPincodeZones
|
|
109
|
-
* @summary:
|
|
110
|
-
* @description:
|
|
109
|
+
* @summary: Get zones
|
|
110
|
+
* @description: Retrieve the delivery zone associated with a given pincode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
111
111
|
*/
|
|
112
112
|
getPincodeZones({ body, requestHeaders }?: LogisticApplicationValidator.GetPincodeZonesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>;
|
|
113
113
|
/**
|
|
@@ -116,8 +116,8 @@ declare class Logistic {
|
|
|
116
116
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
117
117
|
* @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
|
|
118
118
|
* @name getTatProduct
|
|
119
|
-
* @summary:
|
|
120
|
-
* @description: Retrieve the estimated delivery
|
|
119
|
+
* @summary: Get product's turnaround time
|
|
120
|
+
* @description: Retrieve the estimated delivery timeframe for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
121
121
|
*/
|
|
122
122
|
getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
|
|
123
123
|
/**
|
|
@@ -127,8 +127,8 @@ declare class Logistic {
|
|
|
127
127
|
* @returns {Promise<LogisticApplicationModel.ValidateAddressRequest>} -
|
|
128
128
|
* Success response
|
|
129
129
|
* @name validateAddress
|
|
130
|
-
* @summary: Validate
|
|
131
|
-
* @description: Validate
|
|
130
|
+
* @summary: Validate address
|
|
131
|
+
* @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/).
|
|
132
132
|
*/
|
|
133
133
|
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: LogisticApplicationValidator.ValidateAddressParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ValidateAddressRequest>;
|
|
134
134
|
}
|