@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
|
@@ -23,7 +23,7 @@ class Serviceability {
|
|
|
23
23
|
*
|
|
24
24
|
* @name bulkServiceability
|
|
25
25
|
* @summary: Bulk update serviceability of localities
|
|
26
|
-
* @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://
|
|
26
|
+
* @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkServiceability/).
|
|
27
27
|
*/
|
|
28
28
|
async bulkServiceability(
|
|
29
29
|
{ extensionId, schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -111,7 +111,7 @@ class Serviceability {
|
|
|
111
111
|
* @name bulkTat
|
|
112
112
|
* @summary: Locality TAT import or export
|
|
113
113
|
* @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
|
|
114
|
-
* Export locality wise CSV files. - Check out [method documentation](https://
|
|
114
|
+
* Export locality wise CSV files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkTat/).
|
|
115
115
|
*/
|
|
116
116
|
async bulkTat(
|
|
117
117
|
{ extensionId, schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -198,7 +198,7 @@ class Serviceability {
|
|
|
198
198
|
*
|
|
199
199
|
* @name createCourierPartnerAccount
|
|
200
200
|
* @summary: Create courier account
|
|
201
|
-
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://
|
|
201
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
202
202
|
*/
|
|
203
203
|
async createCourierPartnerAccount(
|
|
204
204
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -283,7 +283,7 @@ class Serviceability {
|
|
|
283
283
|
*
|
|
284
284
|
* @name createCourierPartnerScheme
|
|
285
285
|
* @summary: Create Scheme for courier partner extension
|
|
286
|
-
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://
|
|
286
|
+
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerScheme/).
|
|
287
287
|
*/
|
|
288
288
|
async createCourierPartnerScheme(
|
|
289
289
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -367,7 +367,7 @@ class Serviceability {
|
|
|
367
367
|
* Success response
|
|
368
368
|
* @name createPackageMaterial
|
|
369
369
|
* @summary: Create packaging material
|
|
370
|
-
* @description: Creates a packaging material - Check out [method documentation](https://
|
|
370
|
+
* @description: Creates a packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterial/).
|
|
371
371
|
*/
|
|
372
372
|
async createPackageMaterial(
|
|
373
373
|
{ body, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -454,7 +454,7 @@ class Serviceability {
|
|
|
454
454
|
* Success response
|
|
455
455
|
* @name createPackageMaterialRule
|
|
456
456
|
* @summary: Create packaging rule
|
|
457
|
-
* @description: Creates a packaging rule - Check out [method documentation](https://
|
|
457
|
+
* @description: Creates a packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
458
458
|
*/
|
|
459
459
|
async createPackageMaterialRule(
|
|
460
460
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -537,7 +537,7 @@ class Serviceability {
|
|
|
537
537
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
538
538
|
* @name getBulkServiceability
|
|
539
539
|
* @summary: Bulk update history
|
|
540
|
-
* @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://
|
|
540
|
+
* @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkServiceability/).
|
|
541
541
|
*/
|
|
542
542
|
async getBulkServiceability(
|
|
543
543
|
{
|
|
@@ -660,7 +660,7 @@ class Serviceability {
|
|
|
660
660
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
661
661
|
* @name getBulkTat
|
|
662
662
|
* @summary: Locality TAT change history
|
|
663
|
-
* @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://
|
|
663
|
+
* @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkTat/).
|
|
664
664
|
*/
|
|
665
665
|
async getBulkTat(
|
|
666
666
|
{
|
|
@@ -783,7 +783,7 @@ class Serviceability {
|
|
|
783
783
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
784
784
|
* @name getCompanyConfiguration
|
|
785
785
|
* @summary: Get delivery configuration
|
|
786
|
-
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://
|
|
786
|
+
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
787
787
|
*/
|
|
788
788
|
async getCompanyConfiguration(
|
|
789
789
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -860,7 +860,7 @@ class Serviceability {
|
|
|
860
860
|
* @returns {Promise<ServiceabilityPlatformModel.GetCountries>} - Success response
|
|
861
861
|
* @name getCountries
|
|
862
862
|
* @summary: Get all countries and associated data
|
|
863
|
-
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://
|
|
863
|
+
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCountries/).
|
|
864
864
|
*/
|
|
865
865
|
async getCountries(
|
|
866
866
|
{ onboard, pageNo, pageSize, q, hierarchy, requestHeaders } = {
|
|
@@ -957,7 +957,7 @@ class Serviceability {
|
|
|
957
957
|
* Success response
|
|
958
958
|
* @name getCourierPartnerAccount
|
|
959
959
|
* @summary: Get courier account
|
|
960
|
-
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://
|
|
960
|
+
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
961
961
|
*/
|
|
962
962
|
async getCourierPartnerAccount(
|
|
963
963
|
{ accountId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1042,7 +1042,7 @@ class Serviceability {
|
|
|
1042
1042
|
*
|
|
1043
1043
|
* @name getCourierPartnerAccounts
|
|
1044
1044
|
* @summary: List courier accounts
|
|
1045
|
-
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://
|
|
1045
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
1046
1046
|
*/
|
|
1047
1047
|
async getCourierPartnerAccounts(
|
|
1048
1048
|
{
|
|
@@ -1163,7 +1163,7 @@ class Serviceability {
|
|
|
1163
1163
|
*
|
|
1164
1164
|
* @name getCourierPartnerScheme
|
|
1165
1165
|
* @summary: Get Scheme for courier partner extension by Id
|
|
1166
|
-
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://
|
|
1166
|
+
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerScheme/).
|
|
1167
1167
|
*/
|
|
1168
1168
|
async getCourierPartnerScheme(
|
|
1169
1169
|
{ schemeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1244,7 +1244,7 @@ class Serviceability {
|
|
|
1244
1244
|
*
|
|
1245
1245
|
* @name getCourierPartnerSchemes
|
|
1246
1246
|
* @summary: Get created Schemes for courier partner
|
|
1247
|
-
* @description: Get created Schemes for courier partner - Check out [method documentation](https://
|
|
1247
|
+
* @description: Get created Schemes for courier partner - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
1248
1248
|
*/
|
|
1249
1249
|
async getCourierPartnerSchemes(
|
|
1250
1250
|
{ schemeType, paymentMode, capabilities, schemeIds, requestHeaders } = {
|
|
@@ -1341,7 +1341,7 @@ class Serviceability {
|
|
|
1341
1341
|
*
|
|
1342
1342
|
* @name getInstalledCourierPartnerExtensions
|
|
1343
1343
|
* @summary: Fetching of Package Material Rules from database.
|
|
1344
|
-
* @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://
|
|
1344
|
+
* @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
|
|
1345
1345
|
*/
|
|
1346
1346
|
async getInstalledCourierPartnerExtensions(
|
|
1347
1347
|
{ pageNo, pageSize, isInstalled, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1430,7 +1430,7 @@ class Serviceability {
|
|
|
1430
1430
|
* Success response
|
|
1431
1431
|
* @name getOptimalLocations
|
|
1432
1432
|
* @summary: Get selling locations
|
|
1433
|
-
* @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://
|
|
1433
|
+
* @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getOptimalLocations/).
|
|
1434
1434
|
*/
|
|
1435
1435
|
async getOptimalLocations(
|
|
1436
1436
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1514,7 +1514,7 @@ class Serviceability {
|
|
|
1514
1514
|
* Success response
|
|
1515
1515
|
* @name getPackageMaterialList
|
|
1516
1516
|
* @summary: Get packaging materials
|
|
1517
|
-
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://
|
|
1517
|
+
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialList/).
|
|
1518
1518
|
*/
|
|
1519
1519
|
async getPackageMaterialList(
|
|
1520
1520
|
{ pageNo, pageSize, q, size, packageType, requestHeaders } = {
|
|
@@ -1613,7 +1613,7 @@ class Serviceability {
|
|
|
1613
1613
|
* Success response
|
|
1614
1614
|
* @name getPackageMaterialRule
|
|
1615
1615
|
* @summary: Get packaging material rule
|
|
1616
|
-
* @description: Retrieve packaging rule details. - Check out [method documentation](https://
|
|
1616
|
+
* @description: Retrieve packaging rule details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
1617
1617
|
*/
|
|
1618
1618
|
async getPackageMaterialRule(
|
|
1619
1619
|
{ ruleId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1694,7 +1694,7 @@ class Serviceability {
|
|
|
1694
1694
|
* @returns {Promise<ServiceabilityPlatformModel.PackageItem>} - Success response
|
|
1695
1695
|
* @name getPackageMaterials
|
|
1696
1696
|
* @summary: Get packaging material
|
|
1697
|
-
* @description: Retrieve a single packaging material - Check out [method documentation](https://
|
|
1697
|
+
* @description: Retrieve a single packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterials/).
|
|
1698
1698
|
*/
|
|
1699
1699
|
async getPackageMaterials(
|
|
1700
1700
|
{ packageMaterialId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1779,7 +1779,7 @@ class Serviceability {
|
|
|
1779
1779
|
*
|
|
1780
1780
|
* @name getSampleFileServiceabilityStatus
|
|
1781
1781
|
* @summary: Get Serviceability TAT sample files generator status
|
|
1782
|
-
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://
|
|
1782
|
+
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSampleFileServiceabilityStatus/).
|
|
1783
1783
|
*/
|
|
1784
1784
|
async getSampleFileServiceabilityStatus(
|
|
1785
1785
|
{ pageNo, pageSize, batchId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1867,7 +1867,7 @@ class Serviceability {
|
|
|
1867
1867
|
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
1868
1868
|
* @name getSelfShipDetails
|
|
1869
1869
|
* @summary: Get self-ship details
|
|
1870
|
-
* @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://
|
|
1870
|
+
* @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSelfShipDetails/).
|
|
1871
1871
|
*/
|
|
1872
1872
|
async getSelfShipDetails(
|
|
1873
1873
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1948,7 +1948,7 @@ class Serviceability {
|
|
|
1948
1948
|
*
|
|
1949
1949
|
* @name sampleFileServiceability
|
|
1950
1950
|
* @summary: Sample File Download
|
|
1951
|
-
* @description: Sample File Download - Check out [method documentation](https://
|
|
1951
|
+
* @description: Sample File Download - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/sampleFileServiceability/).
|
|
1952
1952
|
*/
|
|
1953
1953
|
async sampleFileServiceability(
|
|
1954
1954
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2031,7 +2031,7 @@ class Serviceability {
|
|
|
2031
2031
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
2032
2032
|
* @name updateCompanyConfiguration
|
|
2033
2033
|
* @summary: Update delivery configuration
|
|
2034
|
-
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://
|
|
2034
|
+
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
2035
2035
|
*/
|
|
2036
2036
|
async updateCompanyConfiguration(
|
|
2037
2037
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2116,7 +2116,7 @@ class Serviceability {
|
|
|
2116
2116
|
*
|
|
2117
2117
|
* @name updateCourierPartnerAccount
|
|
2118
2118
|
* @summary: Update courier account
|
|
2119
|
-
* @description: Updates an existing courier partner account. - Check out [method documentation](https://
|
|
2119
|
+
* @description: Updates an existing courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
2120
2120
|
*/
|
|
2121
2121
|
async updateCourierPartnerAccount(
|
|
2122
2122
|
{ accountId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2203,7 +2203,7 @@ class Serviceability {
|
|
|
2203
2203
|
*
|
|
2204
2204
|
* @name updateCourierPartnerScheme
|
|
2205
2205
|
* @summary: Update Scheme for courier partner extension
|
|
2206
|
-
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://
|
|
2206
|
+
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerScheme/).
|
|
2207
2207
|
*/
|
|
2208
2208
|
async updateCourierPartnerScheme(
|
|
2209
2209
|
{ schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2291,7 +2291,7 @@ class Serviceability {
|
|
|
2291
2291
|
* Success response
|
|
2292
2292
|
* @name updatePackageMaterialRule
|
|
2293
2293
|
* @summary: Update packaging rule
|
|
2294
|
-
* @description: Update an existing packaging rule - Check out [method documentation](https://
|
|
2294
|
+
* @description: Update an existing packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
2295
2295
|
*/
|
|
2296
2296
|
async updatePackageMaterialRule(
|
|
2297
2297
|
{ ruleId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2377,7 +2377,7 @@ class Serviceability {
|
|
|
2377
2377
|
* Success response
|
|
2378
2378
|
* @name updatePackageMaterials
|
|
2379
2379
|
* @summary: Update packaging material
|
|
2380
|
-
* @description: Update an existing packaging material - Check out [method documentation](https://
|
|
2380
|
+
* @description: Update an existing packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterials/).
|
|
2381
2381
|
*/
|
|
2382
2382
|
async updatePackageMaterials(
|
|
2383
2383
|
{ packageMaterialId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2462,7 +2462,7 @@ class Serviceability {
|
|
|
2462
2462
|
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
2463
2463
|
* @name updateSelfShipDetails
|
|
2464
2464
|
* @summary: Update self-ship details
|
|
2465
|
-
* @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://
|
|
2465
|
+
* @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateSelfShipDetails/).
|
|
2466
2466
|
*/
|
|
2467
2467
|
async updateSelfShipDetails(
|
|
2468
2468
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1141,7 +1141,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1141
1141
|
*/
|
|
1142
1142
|
/**
|
|
1143
1143
|
* @typedef Page
|
|
1144
|
-
* @property {number} [item_total] - The total number of items
|
|
1144
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1145
1145
|
* @property {string} [next_id] - The identifier for the next page.
|
|
1146
1146
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1147
1147
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -4851,7 +4851,7 @@ type RegionSchema = {
|
|
|
4851
4851
|
declare function Page(): Page;
|
|
4852
4852
|
type Page = {
|
|
4853
4853
|
/**
|
|
4854
|
-
* - The total number of items
|
|
4854
|
+
* - The total number of all items across all pages.
|
|
4855
4855
|
*/
|
|
4856
4856
|
item_total?: number;
|
|
4857
4857
|
/**
|
|
@@ -1251,7 +1251,7 @@ const Joi = require("joi");
|
|
|
1251
1251
|
|
|
1252
1252
|
/**
|
|
1253
1253
|
* @typedef Page
|
|
1254
|
-
* @property {number} [item_total] - The total number of items
|
|
1254
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1255
1255
|
* @property {string} [next_id] - The identifier for the next page.
|
|
1256
1256
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1257
1257
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -10,7 +10,7 @@ declare class Share {
|
|
|
10
10
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
11
11
|
* @name createShortLink
|
|
12
12
|
* @summary: Create short link
|
|
13
|
-
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://
|
|
13
|
+
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/createShortLink/).
|
|
14
14
|
*/
|
|
15
15
|
createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
16
16
|
/**
|
|
@@ -20,7 +20,7 @@ declare class Share {
|
|
|
20
20
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
21
21
|
* @name getShortLinkByHash
|
|
22
22
|
* @summary: Get short link by hash
|
|
23
|
-
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://
|
|
23
|
+
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkByHash/).
|
|
24
24
|
*/
|
|
25
25
|
getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
26
26
|
/**
|
|
@@ -32,7 +32,7 @@ declare class Share {
|
|
|
32
32
|
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
33
33
|
* @name getShortLinkClickStats
|
|
34
34
|
* @summary: Get short link click statistics
|
|
35
|
-
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://
|
|
35
|
+
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkClickStats/).
|
|
36
36
|
*/
|
|
37
37
|
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
|
|
38
38
|
/**
|
|
@@ -42,7 +42,7 @@ declare class Share {
|
|
|
42
42
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
43
43
|
* @name getShortLinks
|
|
44
44
|
* @summary: Get short links
|
|
45
|
-
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://
|
|
45
|
+
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinks/).
|
|
46
46
|
*/
|
|
47
47
|
getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
|
|
48
48
|
/**
|
|
@@ -54,7 +54,7 @@ declare class Share {
|
|
|
54
54
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
55
55
|
* @name updateShortLinkById
|
|
56
56
|
* @summary: Update short link
|
|
57
|
-
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://
|
|
57
|
+
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/updateShortLinkById/).
|
|
58
58
|
*/
|
|
59
59
|
updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
60
60
|
}
|
|
@@ -22,7 +22,7 @@ class Share {
|
|
|
22
22
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
23
23
|
* @name createShortLink
|
|
24
24
|
* @summary: Create short link
|
|
25
|
-
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://
|
|
25
|
+
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/createShortLink/).
|
|
26
26
|
*/
|
|
27
27
|
async createShortLink(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -101,7 +101,7 @@ class Share {
|
|
|
101
101
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
102
102
|
* @name getShortLinkByHash
|
|
103
103
|
* @summary: Get short link by hash
|
|
104
|
-
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://
|
|
104
|
+
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkByHash/).
|
|
105
105
|
*/
|
|
106
106
|
async getShortLinkByHash(
|
|
107
107
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -182,7 +182,7 @@ class Share {
|
|
|
182
182
|
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
183
183
|
* @name getShortLinkClickStats
|
|
184
184
|
* @summary: Get short link click statistics
|
|
185
|
-
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://
|
|
185
|
+
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkClickStats/).
|
|
186
186
|
*/
|
|
187
187
|
async getShortLinkClickStats(
|
|
188
188
|
{ surlId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -258,7 +258,7 @@ class Share {
|
|
|
258
258
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
259
259
|
* @name getShortLinks
|
|
260
260
|
* @summary: Get short links
|
|
261
|
-
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://
|
|
261
|
+
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinks/).
|
|
262
262
|
*/
|
|
263
263
|
async getShortLinks(
|
|
264
264
|
{
|
|
@@ -367,7 +367,7 @@ class Share {
|
|
|
367
367
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
368
368
|
* @name updateShortLinkById
|
|
369
369
|
* @summary: Update short link
|
|
370
|
-
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://
|
|
370
|
+
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/updateShortLinkById/).
|
|
371
371
|
*/
|
|
372
372
|
async updateShortLinkById(
|
|
373
373
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -99,7 +99,7 @@ export = SharePlatformModel;
|
|
|
99
99
|
*/
|
|
100
100
|
/**
|
|
101
101
|
* @typedef Page
|
|
102
|
-
* @property {number} [item_total] - The total number of items
|
|
102
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
103
103
|
* @property {string} [next_id] - The identifier for the next page.
|
|
104
104
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
105
105
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -263,7 +263,7 @@ type ShortLinkRes = {
|
|
|
263
263
|
declare function Page(): Page;
|
|
264
264
|
type Page = {
|
|
265
265
|
/**
|
|
266
|
-
* - The total number of items
|
|
266
|
+
* - The total number of all items across all pages.
|
|
267
267
|
*/
|
|
268
268
|
item_total?: number;
|
|
269
269
|
/**
|
|
@@ -112,7 +112,7 @@ const Joi = require("joi");
|
|
|
112
112
|
|
|
113
113
|
/**
|
|
114
114
|
* @typedef Page
|
|
115
|
-
* @property {number} [item_total] - The total number of items
|
|
115
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
116
116
|
* @property {string} [next_id] - The identifier for the next page.
|
|
117
117
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
118
118
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -12,7 +12,7 @@ declare class Theme {
|
|
|
12
12
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
13
13
|
* @name addThemeToApplication
|
|
14
14
|
* @summary: Create theme in sales channel
|
|
15
|
-
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://
|
|
15
|
+
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/addThemeToApplication/).
|
|
16
16
|
*/
|
|
17
17
|
addThemeToApplication({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddThemeToApplicationParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
18
18
|
/**
|
|
@@ -22,7 +22,7 @@ declare class Theme {
|
|
|
22
22
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
23
23
|
* @name applyTheme
|
|
24
24
|
* @summary: Apply a theme
|
|
25
|
-
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://
|
|
25
|
+
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/applyTheme/).
|
|
26
26
|
*/
|
|
27
27
|
applyTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ApplyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
28
28
|
/**
|
|
@@ -32,7 +32,7 @@ declare class Theme {
|
|
|
32
32
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
33
33
|
* @name createPage
|
|
34
34
|
* @summary: Create theme page
|
|
35
|
-
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://
|
|
35
|
+
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/createPage/).
|
|
36
36
|
*/
|
|
37
37
|
createPage({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
38
38
|
/**
|
|
@@ -42,7 +42,7 @@ declare class Theme {
|
|
|
42
42
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
43
43
|
* @name deletePage
|
|
44
44
|
* @summary: Delete a page
|
|
45
|
-
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://
|
|
45
|
+
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deletePage/).
|
|
46
46
|
*/
|
|
47
47
|
deletePage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
48
48
|
/**
|
|
@@ -52,7 +52,7 @@ declare class Theme {
|
|
|
52
52
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
53
53
|
* @name deleteTheme
|
|
54
54
|
* @summary: Delete theme
|
|
55
|
-
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://
|
|
55
|
+
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deleteTheme/).
|
|
56
56
|
*/
|
|
57
57
|
deleteTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DeleteThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
58
58
|
/**
|
|
@@ -62,7 +62,7 @@ declare class Theme {
|
|
|
62
62
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
63
63
|
* @name duplicateTheme
|
|
64
64
|
* @summary: Duplicate a theme
|
|
65
|
-
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://
|
|
65
|
+
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/duplicateTheme/).
|
|
66
66
|
*/
|
|
67
67
|
duplicateTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DuplicateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
68
68
|
/**
|
|
@@ -72,7 +72,7 @@ declare class Theme {
|
|
|
72
72
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
73
73
|
* @name getAllPages
|
|
74
74
|
* @summary: List pages of a theme
|
|
75
|
-
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://
|
|
75
|
+
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getAllPages/).
|
|
76
76
|
*/
|
|
77
77
|
getAllPages({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
78
78
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Theme {
|
|
|
84
84
|
* @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
|
|
85
85
|
* @name getApplicationThemes
|
|
86
86
|
* @summary: List sales channel themes
|
|
87
|
-
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://
|
|
87
|
+
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getApplicationThemes/).
|
|
88
88
|
*/
|
|
89
89
|
getApplicationThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
|
|
90
90
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Theme {
|
|
|
96
96
|
* @returns {Promise<Object>} - Success response
|
|
97
97
|
* @name getApplicationThemesCount
|
|
98
98
|
* @summary: Get sales channel themes count
|
|
99
|
-
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://
|
|
99
|
+
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getApplicationThemesCount/).
|
|
100
100
|
*/
|
|
101
101
|
getApplicationThemesCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
102
102
|
/**
|
|
@@ -106,7 +106,7 @@ declare class Theme {
|
|
|
106
106
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
107
107
|
* @name getAppliedTheme
|
|
108
108
|
* @summary: Get applied theme
|
|
109
|
-
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://
|
|
109
|
+
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getAppliedTheme/).
|
|
110
110
|
*/
|
|
111
111
|
getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
112
112
|
/**
|
|
@@ -118,7 +118,7 @@ declare class Theme {
|
|
|
118
118
|
* @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
|
|
119
119
|
* @name getExtensionSections
|
|
120
120
|
* @summary: Get extension sections
|
|
121
|
-
* @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://
|
|
121
|
+
* @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getExtensionSections/).
|
|
122
122
|
*/
|
|
123
123
|
getExtensionSections({ type, companyMode, requestHeaders }?: ThemePlatformApplicationValidator.GetExtensionSectionsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.GetExtensionSectionRes[]>;
|
|
124
124
|
/**
|
|
@@ -128,7 +128,7 @@ declare class Theme {
|
|
|
128
128
|
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
129
129
|
* @name getFonts
|
|
130
130
|
* @summary: List theme fonts
|
|
131
|
-
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://
|
|
131
|
+
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getFonts/).
|
|
132
132
|
*/
|
|
133
133
|
getFonts({ capability, requestHeaders }?: ThemePlatformApplicationValidator.GetFontsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
134
134
|
/**
|
|
@@ -138,7 +138,7 @@ declare class Theme {
|
|
|
138
138
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
139
139
|
* @name getPage
|
|
140
140
|
* @summary: Get a page
|
|
141
|
-
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://
|
|
141
|
+
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getPage/).
|
|
142
142
|
*/
|
|
143
143
|
getPage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
144
144
|
/**
|
|
@@ -148,7 +148,7 @@ declare class Theme {
|
|
|
148
148
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
149
149
|
* @name getThemeById
|
|
150
150
|
* @summary: Get theme
|
|
151
|
-
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://
|
|
151
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeById/).
|
|
152
152
|
*/
|
|
153
153
|
getThemeById({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeByIdParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
154
154
|
/**
|
|
@@ -158,7 +158,7 @@ declare class Theme {
|
|
|
158
158
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
159
159
|
* @name getThemeForPreview
|
|
160
160
|
* @summary: Get theme for preview
|
|
161
|
-
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://
|
|
161
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeForPreview/).
|
|
162
162
|
*/
|
|
163
163
|
getThemeForPreview({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
164
164
|
/**
|
|
@@ -170,7 +170,7 @@ declare class Theme {
|
|
|
170
170
|
* @returns {Promise<any>} - Success response
|
|
171
171
|
* @name getThemeLastModified
|
|
172
172
|
* @summary: Get theme last modified date
|
|
173
|
-
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://
|
|
173
|
+
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeLastModified/).
|
|
174
174
|
*/
|
|
175
175
|
getThemeLastModified({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLastModifiedParam, { responseHeaders }?: object): Promise<any>;
|
|
176
176
|
/**
|
|
@@ -180,7 +180,7 @@ declare class Theme {
|
|
|
180
180
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://
|
|
183
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
185
|
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
186
186
|
/**
|
|
@@ -192,7 +192,7 @@ declare class Theme {
|
|
|
192
192
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
193
193
|
* @name updateMultiplePages
|
|
194
194
|
* @summary: Update theme pages
|
|
195
|
-
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://
|
|
195
|
+
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateMultiplePages/).
|
|
196
196
|
*/
|
|
197
197
|
updateMultiplePages({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateMultiplePagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
198
198
|
/**
|
|
@@ -202,7 +202,7 @@ declare class Theme {
|
|
|
202
202
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
203
203
|
* @name updatePage
|
|
204
204
|
* @summary: Update a page
|
|
205
|
-
* @description: Modify and update the content of a page. - Check out [method documentation](https://
|
|
205
|
+
* @description: Modify and update the content of a page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updatePage/).
|
|
206
206
|
*/
|
|
207
207
|
updatePage({ themeId, pageValue, socketId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
208
208
|
/**
|
|
@@ -212,7 +212,7 @@ declare class Theme {
|
|
|
212
212
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
213
213
|
* @name updateTheme
|
|
214
214
|
* @summary: Update theme
|
|
215
|
-
* @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://
|
|
215
|
+
* @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateTheme/).
|
|
216
216
|
*/
|
|
217
217
|
updateTheme({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
218
218
|
/**
|
|
@@ -222,7 +222,7 @@ declare class Theme {
|
|
|
222
222
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
223
223
|
* @name updateThemeName
|
|
224
224
|
* @summary: Update theme name
|
|
225
|
-
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://
|
|
225
|
+
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateThemeName/).
|
|
226
226
|
*/
|
|
227
227
|
updateThemeName({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeNameParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
228
228
|
/**
|
|
@@ -232,7 +232,7 @@ declare class Theme {
|
|
|
232
232
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
233
233
|
* @name upgradeTheme
|
|
234
234
|
* @summary: Upgrade theme
|
|
235
|
-
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://
|
|
235
|
+
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/upgradeTheme/).
|
|
236
236
|
*/
|
|
237
237
|
upgradeTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UpgradeThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
238
238
|
}
|