@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
|
@@ -21,7 +21,7 @@ class Content {
|
|
|
21
21
|
* @returns {Promise<Object>} - Success response
|
|
22
22
|
* @name addCompanyLanguage
|
|
23
23
|
* @summary: Add company language
|
|
24
|
-
* @description: Add new languages to company's supported language list. - Check out [method documentation](https://
|
|
24
|
+
* @description: Add new languages to company's supported language list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/addCompanyLanguage/).
|
|
25
25
|
*/
|
|
26
26
|
async addCompanyLanguage(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -100,7 +100,7 @@ class Content {
|
|
|
100
100
|
* @returns {Promise<ContentPlatformModel.ResourceTranslation>} - Success response
|
|
101
101
|
* @name createCompanyResourceTranslation
|
|
102
102
|
* @summary: Add company translation
|
|
103
|
-
* @description: Create new translations for company resources. - Check out [method documentation](https://
|
|
103
|
+
* @description: Create new translations for company resources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/createCompanyResourceTranslation/).
|
|
104
104
|
*/
|
|
105
105
|
async createCompanyResourceTranslation(
|
|
106
106
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -183,7 +183,7 @@ class Content {
|
|
|
183
183
|
*
|
|
184
184
|
* @name createCustomFieldDefinition
|
|
185
185
|
* @summary: Create custom field definition for a given resource type
|
|
186
|
-
* @description: You can create custom fields definition to any resource so you can extend property of resource. - Check out [method documentation](https://
|
|
186
|
+
* @description: You can create custom fields definition to any resource so you can extend property of resource. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/createCustomFieldDefinition/).
|
|
187
187
|
*/
|
|
188
188
|
async createCustomFieldDefinition(
|
|
189
189
|
{ resource, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -266,7 +266,7 @@ class Content {
|
|
|
266
266
|
* @returns {Promise<ContentPlatformModel.CustomObjectSchema>} - Success response
|
|
267
267
|
* @name createCustomObjectBySlug
|
|
268
268
|
* @summary: Create custom object entries
|
|
269
|
-
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://
|
|
269
|
+
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/createCustomObjectBySlug/).
|
|
270
270
|
*/
|
|
271
271
|
async createCustomObjectBySlug(
|
|
272
272
|
{ definitionSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -353,7 +353,7 @@ class Content {
|
|
|
353
353
|
*
|
|
354
354
|
* @name createCustomObjectDefinition
|
|
355
355
|
* @summary: Create custom object definition
|
|
356
|
-
* @description: Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource. - Check out [method documentation](https://
|
|
356
|
+
* @description: Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/createCustomObjectDefinition/).
|
|
357
357
|
*/
|
|
358
358
|
async createCustomObjectDefinition(
|
|
359
359
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -434,7 +434,7 @@ class Content {
|
|
|
434
434
|
* @returns {Promise<ContentPlatformModel.OperationResponseSchema>} - Success response
|
|
435
435
|
* @name deleteCompanyLanguage
|
|
436
436
|
* @summary: Remove company language
|
|
437
|
-
* @description: Remove a language from company's supported languages list. - Check out [method documentation](https://
|
|
437
|
+
* @description: Remove a language from company's supported languages list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteCompanyLanguage/).
|
|
438
438
|
*/
|
|
439
439
|
async deleteCompanyLanguage(
|
|
440
440
|
{ locale, requestHeaders } = { requestHeaders: {} },
|
|
@@ -515,7 +515,7 @@ class Content {
|
|
|
515
515
|
* @returns {Promise<ContentPlatformModel.OperationResponseSchema>} - Success response
|
|
516
516
|
* @name deleteCompanyResourceTranslation
|
|
517
517
|
* @summary: Remove company translation
|
|
518
|
-
* @description: Remove translations for company resources. - Check out [method documentation](https://
|
|
518
|
+
* @description: Remove translations for company resources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteCompanyResourceTranslation/).
|
|
519
519
|
*/
|
|
520
520
|
async deleteCompanyResourceTranslation(
|
|
521
521
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -598,7 +598,7 @@ class Content {
|
|
|
598
598
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
599
599
|
* @name deleteCustomFieldDefinitionBySlug
|
|
600
600
|
* @summary: Delete custom fields definition
|
|
601
|
-
* @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://
|
|
601
|
+
* @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteCustomFieldDefinitionBySlug/).
|
|
602
602
|
*/
|
|
603
603
|
async deleteCustomFieldDefinitionBySlug(
|
|
604
604
|
{ slug, resource, namespace, requestHeaders } = { requestHeaders: {} },
|
|
@@ -686,7 +686,7 @@ class Content {
|
|
|
686
686
|
* Success response
|
|
687
687
|
* @name deleteCustomFieldsByResourceSlug
|
|
688
688
|
* @summary: delete custom fields of given resource and resource slug
|
|
689
|
-
* @description: Use this API to delete the custom fields for given resource in param. - Check out [method documentation](https://
|
|
689
|
+
* @description: Use this API to delete the custom fields for given resource in param. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteCustomFieldsByResourceSlug/).
|
|
690
690
|
*/
|
|
691
691
|
async deleteCustomFieldsByResourceSlug(
|
|
692
692
|
{ resource, resourceSlug, ids, requestHeaders } = { requestHeaders: {} },
|
|
@@ -772,7 +772,7 @@ class Content {
|
|
|
772
772
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
773
773
|
* @name deleteCustomObjectBySlug
|
|
774
774
|
* @summary: Delete custom object
|
|
775
|
-
* @description: Custom object entries can be deleted by providing the delete ID using this endpoint. - Check out [method documentation](https://
|
|
775
|
+
* @description: Custom object entries can be deleted by providing the delete ID using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteCustomObjectBySlug/).
|
|
776
776
|
*/
|
|
777
777
|
async deleteCustomObjectBySlug(
|
|
778
778
|
{ definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -859,7 +859,7 @@ class Content {
|
|
|
859
859
|
*
|
|
860
860
|
* @name deleteCustomObjectDefinitionBySlug
|
|
861
861
|
* @summary: Delete custom object definition
|
|
862
|
-
* @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://
|
|
862
|
+
* @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteCustomObjectDefinitionBySlug/).
|
|
863
863
|
*/
|
|
864
864
|
async deleteCustomObjectDefinitionBySlug(
|
|
865
865
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -944,7 +944,7 @@ class Content {
|
|
|
944
944
|
*
|
|
945
945
|
* @name exportCustomObjectEntriesBySlug
|
|
946
946
|
* @summary: Initiate download for bulk custom object entries
|
|
947
|
-
* @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://
|
|
947
|
+
* @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/exportCustomObjectEntriesBySlug/).
|
|
948
948
|
*/
|
|
949
949
|
async exportCustomObjectEntriesBySlug(
|
|
950
950
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1025,7 +1025,7 @@ class Content {
|
|
|
1025
1025
|
* @returns {Promise<Object>} - Success response
|
|
1026
1026
|
* @name getAllResourceDefinitions
|
|
1027
1027
|
* @summary: Get all resource defination
|
|
1028
|
-
* @description: Retrieve translation schemas and configurations for resources. - Check out [method documentation](https://
|
|
1028
|
+
* @description: Retrieve translation schemas and configurations for resources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getAllResourceDefinitions/).
|
|
1029
1029
|
*/
|
|
1030
1030
|
async getAllResourceDefinitions(
|
|
1031
1031
|
{ translatableResourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1105,7 +1105,7 @@ class Content {
|
|
|
1105
1105
|
* @returns {Promise<Object>} - Success response
|
|
1106
1106
|
* @name getAllSections
|
|
1107
1107
|
* @summary: List all translatable content sections
|
|
1108
|
-
* @description: Retrieve all translatable content sections for organization. - Check out [method documentation](https://
|
|
1108
|
+
* @description: Retrieve all translatable content sections for organization. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getAllSections/).
|
|
1109
1109
|
*/
|
|
1110
1110
|
async getAllSections(
|
|
1111
1111
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1178,7 +1178,7 @@ class Content {
|
|
|
1178
1178
|
* @returns {Promise<Object>} - Success response
|
|
1179
1179
|
* @name getAllTranslatableResources
|
|
1180
1180
|
* @summary: List all translatable resources
|
|
1181
|
-
* @description: Retrieve all translatable content resources for the company. - Check out [method documentation](https://
|
|
1181
|
+
* @description: Retrieve all translatable content resources for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getAllTranslatableResources/).
|
|
1182
1182
|
*/
|
|
1183
1183
|
async getAllTranslatableResources(
|
|
1184
1184
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1253,7 +1253,7 @@ class Content {
|
|
|
1253
1253
|
* @returns {Promise<Object>} - Success response
|
|
1254
1254
|
* @name getCompanyLanguages
|
|
1255
1255
|
* @summary: Get company languages
|
|
1256
|
-
* @description: Retrieve language configurations and settings for the specified company. - Check out [method documentation](https://
|
|
1256
|
+
* @description: Retrieve language configurations and settings for the specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCompanyLanguages/).
|
|
1257
1257
|
*/
|
|
1258
1258
|
async getCompanyLanguages(
|
|
1259
1259
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1328,7 +1328,7 @@ class Content {
|
|
|
1328
1328
|
* @returns {Promise<ContentPlatformModel.ResourceTranslation>} - Success response
|
|
1329
1329
|
* @name getCompanyResourceTranslation
|
|
1330
1330
|
* @summary: Get company translations
|
|
1331
|
-
* @description: Fetch translations for company-level resources. - Check out [method documentation](https://
|
|
1331
|
+
* @description: Fetch translations for company-level resources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCompanyResourceTranslation/).
|
|
1332
1332
|
*/
|
|
1333
1333
|
async getCompanyResourceTranslation(
|
|
1334
1334
|
{ locale, type, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1419,7 +1419,7 @@ class Content {
|
|
|
1419
1419
|
* Success response
|
|
1420
1420
|
* @name getCustomFieldDefinitionByResource
|
|
1421
1421
|
* @summary: Get custom fields definitions for a given resource type
|
|
1422
|
-
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://
|
|
1422
|
+
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomFieldDefinitionByResource/).
|
|
1423
1423
|
*/
|
|
1424
1424
|
async getCustomFieldDefinitionByResource(
|
|
1425
1425
|
{
|
|
@@ -1531,7 +1531,7 @@ class Content {
|
|
|
1531
1531
|
*
|
|
1532
1532
|
* @name getCustomFieldDefinitionBySlug
|
|
1533
1533
|
* @summary: Get custom fields definition by resource, slug and namespace
|
|
1534
|
-
* @description: Custom field definitions can be retrived from this using its slug, namespace and resource - Check out [method documentation](https://
|
|
1534
|
+
* @description: Custom field definitions can be retrived from this using its slug, namespace and resource - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomFieldDefinitionBySlug/).
|
|
1535
1535
|
*/
|
|
1536
1536
|
async getCustomFieldDefinitionBySlug(
|
|
1537
1537
|
{ slug, resource, namespace, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1617,7 +1617,7 @@ class Content {
|
|
|
1617
1617
|
* Success response
|
|
1618
1618
|
* @name getCustomFieldDefinitions
|
|
1619
1619
|
* @summary: Get custom fields definitions
|
|
1620
|
-
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://
|
|
1620
|
+
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomFieldDefinitions/).
|
|
1621
1621
|
*/
|
|
1622
1622
|
async getCustomFieldDefinitions(
|
|
1623
1623
|
{
|
|
@@ -1726,7 +1726,7 @@ class Content {
|
|
|
1726
1726
|
* @returns {Promise<ContentPlatformModel.MetafieldTypesSchema>} - Success response
|
|
1727
1727
|
* @name getCustomFieldTypes
|
|
1728
1728
|
* @summary: Get custom field types
|
|
1729
|
-
* @description: Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types - Check out [method documentation](https://
|
|
1729
|
+
* @description: Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomFieldTypes/).
|
|
1730
1730
|
*/
|
|
1731
1731
|
async getCustomFieldTypes(
|
|
1732
1732
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1805,7 +1805,7 @@ class Content {
|
|
|
1805
1805
|
*
|
|
1806
1806
|
* @name getCustomFieldsByResourceSlug
|
|
1807
1807
|
* @summary: Get list of custom fields of given resource and resource slug
|
|
1808
|
-
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://
|
|
1808
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomFieldsByResourceSlug/).
|
|
1809
1809
|
*/
|
|
1810
1810
|
async getCustomFieldsByResourceSlug(
|
|
1811
1811
|
{ resource, resourceSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1889,7 +1889,7 @@ class Content {
|
|
|
1889
1889
|
* Success response
|
|
1890
1890
|
* @name getCustomObjectBySlug
|
|
1891
1891
|
* @summary: Get custom object details
|
|
1892
|
-
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://
|
|
1892
|
+
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomObjectBySlug/).
|
|
1893
1893
|
*/
|
|
1894
1894
|
async getCustomObjectBySlug(
|
|
1895
1895
|
{ definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1974,7 +1974,7 @@ class Content {
|
|
|
1974
1974
|
*
|
|
1975
1975
|
* @name getCustomObjectDefinitionBySlug
|
|
1976
1976
|
* @summary: Get custom object definition
|
|
1977
|
-
* @description: Custom object definitions can be fetched using their custom object definition slug. - Check out [method documentation](https://
|
|
1977
|
+
* @description: Custom object definitions can be fetched using their custom object definition slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomObjectDefinitionBySlug/).
|
|
1978
1978
|
*/
|
|
1979
1979
|
async getCustomObjectDefinitionBySlug(
|
|
1980
1980
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2056,7 +2056,7 @@ class Content {
|
|
|
2056
2056
|
* Success response
|
|
2057
2057
|
* @name getCustomObjectDefinitions
|
|
2058
2058
|
* @summary: Get custom object definitions
|
|
2059
|
-
* @description: Custom object definition lists can be obtained using this endpoint. - Check out [method documentation](https://
|
|
2059
|
+
* @description: Custom object definition lists can be obtained using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomObjectDefinitions/).
|
|
2060
2060
|
*/
|
|
2061
2061
|
async getCustomObjectDefinitions(
|
|
2062
2062
|
{ pageNo, pageSize, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2144,7 +2144,7 @@ class Content {
|
|
|
2144
2144
|
* @returns {Promise<ContentPlatformModel.CustomObjectsSchema>} - Success response
|
|
2145
2145
|
* @name getCustomObjectsBySlug
|
|
2146
2146
|
* @summary: Get list of custom objects under a certain custom object definition
|
|
2147
|
-
* @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://
|
|
2147
|
+
* @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getCustomObjectsBySlug/).
|
|
2148
2148
|
*/
|
|
2149
2149
|
async getCustomObjectsBySlug(
|
|
2150
2150
|
{ pageNo, pageSize, definitionSlug, requestHeaders } = {
|
|
@@ -2233,7 +2233,7 @@ class Content {
|
|
|
2233
2233
|
* @returns {Promise<ContentPlatformModel.CustomObjectBulkEntry>} - Success response
|
|
2234
2234
|
* @name getJobs
|
|
2235
2235
|
* @summary: Get bulk import and export job list
|
|
2236
|
-
* @description: Custom object bulk import and export jobs status and details can be obtained using this endpoint. - Check out [method documentation](https://
|
|
2236
|
+
* @description: Custom object bulk import and export jobs status and details can be obtained using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getJobs/).
|
|
2237
2237
|
*/
|
|
2238
2238
|
async getJobs(
|
|
2239
2239
|
{ page, pageSize, actionType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2317,7 +2317,7 @@ class Content {
|
|
|
2317
2317
|
* @returns {Promise<ContentPlatformModel.ResourceDefinition>} - Success response
|
|
2318
2318
|
* @name getResourceDefinitionById
|
|
2319
2319
|
* @summary: Get resource definitions details
|
|
2320
|
-
* @description: Fetch specific resource definition and its translation schema. - Check out [method documentation](https://
|
|
2320
|
+
* @description: Fetch specific resource definition and its translation schema. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getResourceDefinitionById/).
|
|
2321
2321
|
*/
|
|
2322
2322
|
async getResourceDefinitionById(
|
|
2323
2323
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2398,7 +2398,7 @@ class Content {
|
|
|
2398
2398
|
* @returns {Promise<ContentPlatformModel.ResourcesSchema>} - Success response
|
|
2399
2399
|
* @name getResources
|
|
2400
2400
|
* @summary: Get resources
|
|
2401
|
-
* @description: Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc. - Check out [method documentation](https://
|
|
2401
|
+
* @description: Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getResources/).
|
|
2402
2402
|
*/
|
|
2403
2403
|
async getResources(
|
|
2404
2404
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2473,7 +2473,7 @@ class Content {
|
|
|
2473
2473
|
* @returns {Promise<ContentPlatformModel.TranslatableSection>} - Success response
|
|
2474
2474
|
* @name getSectionById
|
|
2475
2475
|
* @summary: Retrieve details of a specific translatable section by its ID.
|
|
2476
|
-
* @description: Fetch details of a specific translatable section. - Check out [method documentation](https://
|
|
2476
|
+
* @description: Fetch details of a specific translatable section. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getSectionById/).
|
|
2477
2477
|
*/
|
|
2478
2478
|
async getSectionById(
|
|
2479
2479
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2552,7 +2552,7 @@ class Content {
|
|
|
2552
2552
|
* @returns {Promise<ContentPlatformModel.TranslatableResource>} - Success response
|
|
2553
2553
|
* @name getTranslatableResourceById
|
|
2554
2554
|
* @summary: Get translatable resource details
|
|
2555
|
-
* @description: Fetch details of a specific translatable resource. - Check out [method documentation](https://
|
|
2555
|
+
* @description: Fetch details of a specific translatable resource. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getTranslatableResourceById/).
|
|
2556
2556
|
*/
|
|
2557
2557
|
async getTranslatableResourceById(
|
|
2558
2558
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2635,7 +2635,7 @@ class Content {
|
|
|
2635
2635
|
* @returns {Promise<Object>} - Success response
|
|
2636
2636
|
* @name getTranslatableResourcesBySectionId
|
|
2637
2637
|
* @summary: Get section resources
|
|
2638
|
-
* @description: Retrieve all resources within a specific section. - Check out [method documentation](https://
|
|
2638
|
+
* @description: Retrieve all resources within a specific section. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getTranslatableResourcesBySectionId/).
|
|
2639
2639
|
*/
|
|
2640
2640
|
async getTranslatableResourcesBySectionId(
|
|
2641
2641
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2718,7 +2718,7 @@ class Content {
|
|
|
2718
2718
|
*
|
|
2719
2719
|
* @name importCustomObjectEntriesBySlug
|
|
2720
2720
|
* @summary: Bulk custom object entries upload
|
|
2721
|
-
* @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://
|
|
2721
|
+
* @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/importCustomObjectEntriesBySlug/).
|
|
2722
2722
|
*/
|
|
2723
2723
|
async importCustomObjectEntriesBySlug(
|
|
2724
2724
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2803,7 +2803,7 @@ class Content {
|
|
|
2803
2803
|
* @returns {Promise<string>} - Success response
|
|
2804
2804
|
* @name sampleCustomObjectBulkEntryBySlug
|
|
2805
2805
|
* @summary: Download sample for custom object bulk entry
|
|
2806
|
-
* @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://
|
|
2806
|
+
* @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/sampleCustomObjectBulkEntryBySlug/).
|
|
2807
2807
|
*/
|
|
2808
2808
|
async sampleCustomObjectBulkEntryBySlug(
|
|
2809
2809
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2883,7 +2883,7 @@ class Content {
|
|
|
2883
2883
|
* @returns {Promise<ContentPlatformModel.CompanyLanguage>} - Success response
|
|
2884
2884
|
* @name updateCompanyLanguageDefault
|
|
2885
2885
|
* @summary: Set default language
|
|
2886
|
-
* @description: Update default language settings for the company. - Check out [method documentation](https://
|
|
2886
|
+
* @description: Update default language settings for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateCompanyLanguageDefault/).
|
|
2887
2887
|
*/
|
|
2888
2888
|
async updateCompanyLanguageDefault(
|
|
2889
2889
|
{ locale, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2968,7 +2968,7 @@ class Content {
|
|
|
2968
2968
|
* @returns {Promise<ContentPlatformModel.ResourceTranslation>} - Success response
|
|
2969
2969
|
* @name updateCompanyResourceTranslation
|
|
2970
2970
|
* @summary: Update company translation
|
|
2971
|
-
* @description: Update existing translations for company resources. - Check out [method documentation](https://
|
|
2971
|
+
* @description: Update existing translations for company resources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateCompanyResourceTranslation/).
|
|
2972
2972
|
*/
|
|
2973
2973
|
async updateCompanyResourceTranslation(
|
|
2974
2974
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3055,7 +3055,7 @@ class Content {
|
|
|
3055
3055
|
*
|
|
3056
3056
|
* @name updateCustomFieldByResourceSlug
|
|
3057
3057
|
* @summary: Update custom field entries for gives resource and resource slug
|
|
3058
|
-
* @description: You can add a custom field using this endpoint to any resource by providing the resource slug. - Check out [method documentation](https://
|
|
3058
|
+
* @description: You can add a custom field using this endpoint to any resource by providing the resource slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateCustomFieldByResourceSlug/).
|
|
3059
3059
|
*/
|
|
3060
3060
|
async updateCustomFieldByResourceSlug(
|
|
3061
3061
|
{ resource, resourceSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3144,7 +3144,7 @@ class Content {
|
|
|
3144
3144
|
*
|
|
3145
3145
|
* @name updateCustomFieldDefinitionBySlug
|
|
3146
3146
|
* @summary: Update custom field definition
|
|
3147
|
-
* @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://
|
|
3147
|
+
* @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateCustomFieldDefinitionBySlug/).
|
|
3148
3148
|
*/
|
|
3149
3149
|
async updateCustomFieldDefinitionBySlug(
|
|
3150
3150
|
{ slug, resource, namespace, body, requestHeaders } = {
|
|
@@ -3234,7 +3234,7 @@ class Content {
|
|
|
3234
3234
|
* Success response
|
|
3235
3235
|
* @name updateCustomObjectBySlug
|
|
3236
3236
|
* @summary: Update custom object details
|
|
3237
|
-
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://
|
|
3237
|
+
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateCustomObjectBySlug/).
|
|
3238
3238
|
*/
|
|
3239
3239
|
async updateCustomObjectBySlug(
|
|
3240
3240
|
{ definitionSlug, slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3323,7 +3323,7 @@ class Content {
|
|
|
3323
3323
|
*
|
|
3324
3324
|
* @name updateCustomObjectDefinitionBySlug
|
|
3325
3325
|
* @summary: Update custom object definition
|
|
3326
|
-
* @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://
|
|
3326
|
+
* @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateCustomObjectDefinitionBySlug/).
|
|
3327
3327
|
*/
|
|
3328
3328
|
async updateCustomObjectDefinitionBySlug(
|
|
3329
3329
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -518,7 +518,7 @@ export = ContentPlatformModel;
|
|
|
518
518
|
*/
|
|
519
519
|
/**
|
|
520
520
|
* @typedef Page
|
|
521
|
-
* @property {number} [item_total] - The total number of items
|
|
521
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
522
522
|
* @property {string} [next_id] - The identifier for the next page.
|
|
523
523
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
524
524
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -2228,7 +2228,7 @@ type GetFaqCategoryBySlugSchema = {
|
|
|
2228
2228
|
declare function Page(): Page;
|
|
2229
2229
|
type Page = {
|
|
2230
2230
|
/**
|
|
2231
|
-
* - The total number of items
|
|
2231
|
+
* - The total number of all items across all pages.
|
|
2232
2232
|
*/
|
|
2233
2233
|
item_total?: number;
|
|
2234
2234
|
/**
|
|
@@ -589,7 +589,7 @@ const Joi = require("joi");
|
|
|
589
589
|
|
|
590
590
|
/**
|
|
591
591
|
* @typedef Page
|
|
592
|
-
* @property {number} [item_total] - The total number of items
|
|
592
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
593
593
|
* @property {string} [next_id] - The identifier for the next page.
|
|
594
594
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
595
595
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -10,7 +10,7 @@ declare class Discount {
|
|
|
10
10
|
* Success response
|
|
11
11
|
* @name cancelDownloadJob
|
|
12
12
|
* @summary: delete discount download job
|
|
13
|
-
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://
|
|
13
|
+
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/cancelDownloadJob/).
|
|
14
14
|
*/
|
|
15
15
|
cancelDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponseSchema>;
|
|
16
16
|
/**
|
|
@@ -21,7 +21,7 @@ declare class Discount {
|
|
|
21
21
|
* Success response
|
|
22
22
|
* @name cancelValidationJob
|
|
23
23
|
* @summary: deletel validation job discount
|
|
24
|
-
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://
|
|
24
|
+
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/cancelValidationJob/).
|
|
25
25
|
*/
|
|
26
26
|
cancelValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponseSchema>;
|
|
27
27
|
/**
|
|
@@ -31,7 +31,7 @@ declare class Discount {
|
|
|
31
31
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
32
32
|
* @name createDiscount
|
|
33
33
|
* @summary: Create discount
|
|
34
|
-
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://
|
|
34
|
+
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/createDiscount/).
|
|
35
35
|
*/
|
|
36
36
|
createDiscount({ body, requestHeaders }?: DiscountPlatformValidator.CreateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
37
37
|
/**
|
|
@@ -41,7 +41,7 @@ declare class Discount {
|
|
|
41
41
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
42
42
|
* @name downloadDiscountFile
|
|
43
43
|
* @summary: Get discount file
|
|
44
|
-
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://
|
|
44
|
+
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/downloadDiscountFile/).
|
|
45
45
|
*/
|
|
46
46
|
downloadDiscountFile({ type, body, requestHeaders }?: DiscountPlatformValidator.DownloadDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
47
47
|
/**
|
|
@@ -51,7 +51,7 @@ declare class Discount {
|
|
|
51
51
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
52
52
|
* @name getDiscount
|
|
53
53
|
* @summary: Get discount
|
|
54
|
-
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://
|
|
54
|
+
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getDiscount/).
|
|
55
55
|
*/
|
|
56
56
|
getDiscount({ id, requestHeaders }?: DiscountPlatformValidator.GetDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
57
57
|
/**
|
|
@@ -61,7 +61,7 @@ declare class Discount {
|
|
|
61
61
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
62
62
|
* @name getDiscounts
|
|
63
63
|
* @summary: List discounts
|
|
64
|
-
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://
|
|
64
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getDiscounts/).
|
|
65
65
|
*/
|
|
66
66
|
getDiscounts({ view, q, pageNo, pageSize, archived, month, year, type, appIds, requestHeaders, }?: DiscountPlatformValidator.GetDiscountsParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.ListOrCalender>;
|
|
67
67
|
/**
|
|
@@ -104,7 +104,7 @@ declare class Discount {
|
|
|
104
104
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
105
105
|
* @name getDownloadJob
|
|
106
106
|
* @summary: List discount download job
|
|
107
|
-
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://
|
|
107
|
+
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getDownloadJob/).
|
|
108
108
|
*/
|
|
109
109
|
getDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.GetDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
110
110
|
/**
|
|
@@ -114,7 +114,7 @@ declare class Discount {
|
|
|
114
114
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
115
115
|
* @name getValidationJob
|
|
116
116
|
* @summary: List validation job discount
|
|
117
|
-
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://
|
|
117
|
+
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getValidationJob/).
|
|
118
118
|
*/
|
|
119
119
|
getValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.GetValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
120
120
|
/**
|
|
@@ -124,7 +124,7 @@ declare class Discount {
|
|
|
124
124
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
125
125
|
* @name updateDiscount
|
|
126
126
|
* @summary: Update discount
|
|
127
|
-
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://
|
|
127
|
+
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/updateDiscount/).
|
|
128
128
|
*/
|
|
129
129
|
updateDiscount({ id, body, requestHeaders }?: DiscountPlatformValidator.UpdateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
130
130
|
/**
|
|
@@ -134,7 +134,7 @@ declare class Discount {
|
|
|
134
134
|
* @returns {Promise<Object>} - Success response
|
|
135
135
|
* @name upsertDiscountItems
|
|
136
136
|
* @summary: Upsert discount items
|
|
137
|
-
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://
|
|
137
|
+
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/upsertDiscountItems/).
|
|
138
138
|
*/
|
|
139
139
|
upsertDiscountItems({ id, body, requestHeaders }?: DiscountPlatformValidator.UpsertDiscountItemsParam, { responseHeaders }?: object): Promise<any>;
|
|
140
140
|
/**
|
|
@@ -144,7 +144,7 @@ declare class Discount {
|
|
|
144
144
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
145
145
|
* @name validateDiscountFile
|
|
146
146
|
* @summary: Validate discount file
|
|
147
|
-
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://
|
|
147
|
+
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/validateDiscountFile/).
|
|
148
148
|
*/
|
|
149
149
|
validateDiscountFile({ body, discount, requestHeaders }?: DiscountPlatformValidator.ValidateDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
150
150
|
}
|
|
@@ -22,7 +22,7 @@ class Discount {
|
|
|
22
22
|
* Success response
|
|
23
23
|
* @name cancelDownloadJob
|
|
24
24
|
* @summary: delete discount download job
|
|
25
|
-
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://
|
|
25
|
+
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/cancelDownloadJob/).
|
|
26
26
|
*/
|
|
27
27
|
async cancelDownloadJob(
|
|
28
28
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,7 +102,7 @@ class Discount {
|
|
|
102
102
|
* Success response
|
|
103
103
|
* @name cancelValidationJob
|
|
104
104
|
* @summary: deletel validation job discount
|
|
105
|
-
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://
|
|
105
|
+
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/cancelValidationJob/).
|
|
106
106
|
*/
|
|
107
107
|
async cancelValidationJob(
|
|
108
108
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,7 +181,7 @@ class Discount {
|
|
|
181
181
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
182
182
|
* @name createDiscount
|
|
183
183
|
* @summary: Create discount
|
|
184
|
-
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://
|
|
184
|
+
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/createDiscount/).
|
|
185
185
|
*/
|
|
186
186
|
async createDiscount(
|
|
187
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -260,7 +260,7 @@ class Discount {
|
|
|
260
260
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
261
261
|
* @name downloadDiscountFile
|
|
262
262
|
* @summary: Get discount file
|
|
263
|
-
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://
|
|
263
|
+
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/downloadDiscountFile/).
|
|
264
264
|
*/
|
|
265
265
|
async downloadDiscountFile(
|
|
266
266
|
{ type, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -341,7 +341,7 @@ class Discount {
|
|
|
341
341
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
342
342
|
* @name getDiscount
|
|
343
343
|
* @summary: Get discount
|
|
344
|
-
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://
|
|
344
|
+
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getDiscount/).
|
|
345
345
|
*/
|
|
346
346
|
async getDiscount(
|
|
347
347
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -420,7 +420,7 @@ class Discount {
|
|
|
420
420
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
421
421
|
* @name getDiscounts
|
|
422
422
|
* @summary: List discounts
|
|
423
|
-
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://
|
|
423
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getDiscounts/).
|
|
424
424
|
*/
|
|
425
425
|
async getDiscounts(
|
|
426
426
|
{
|
|
@@ -594,7 +594,7 @@ class Discount {
|
|
|
594
594
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
595
595
|
* @name getDownloadJob
|
|
596
596
|
* @summary: List discount download job
|
|
597
|
-
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://
|
|
597
|
+
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getDownloadJob/).
|
|
598
598
|
*/
|
|
599
599
|
async getDownloadJob(
|
|
600
600
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -673,7 +673,7 @@ class Discount {
|
|
|
673
673
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
674
674
|
* @name getValidationJob
|
|
675
675
|
* @summary: List validation job discount
|
|
676
|
-
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://
|
|
676
|
+
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/getValidationJob/).
|
|
677
677
|
*/
|
|
678
678
|
async getValidationJob(
|
|
679
679
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -752,7 +752,7 @@ class Discount {
|
|
|
752
752
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
753
753
|
* @name updateDiscount
|
|
754
754
|
* @summary: Update discount
|
|
755
|
-
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://
|
|
755
|
+
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/updateDiscount/).
|
|
756
756
|
*/
|
|
757
757
|
async updateDiscount(
|
|
758
758
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -833,7 +833,7 @@ class Discount {
|
|
|
833
833
|
* @returns {Promise<Object>} - Success response
|
|
834
834
|
* @name upsertDiscountItems
|
|
835
835
|
* @summary: Upsert discount items
|
|
836
|
-
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://
|
|
836
|
+
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/upsertDiscountItems/).
|
|
837
837
|
*/
|
|
838
838
|
async upsertDiscountItems(
|
|
839
839
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -912,7 +912,7 @@ class Discount {
|
|
|
912
912
|
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
913
913
|
* @name validateDiscountFile
|
|
914
914
|
* @summary: Validate discount file
|
|
915
|
-
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://
|
|
915
|
+
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/discount/validateDiscountFile/).
|
|
916
916
|
*/
|
|
917
917
|
async validateDiscountFile(
|
|
918
918
|
{ body, discount, requestHeaders } = { requestHeaders: {} },
|
|
@@ -143,7 +143,7 @@ export = DiscountPlatformModel;
|
|
|
143
143
|
*/
|
|
144
144
|
/**
|
|
145
145
|
* @typedef Page
|
|
146
|
-
* @property {number} [item_total] - The total number of items
|
|
146
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
147
147
|
* @property {string} [next_id] - The identifier for the next page.
|
|
148
148
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
149
149
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -589,7 +589,7 @@ type CancelJobResponseSchema = {
|
|
|
589
589
|
declare function Page(): Page;
|
|
590
590
|
type Page = {
|
|
591
591
|
/**
|
|
592
|
-
* - The total number of items
|
|
592
|
+
* - The total number of all items across all pages.
|
|
593
593
|
*/
|
|
594
594
|
item_total?: number;
|
|
595
595
|
/**
|
|
@@ -156,7 +156,7 @@ const Joi = require("joi");
|
|
|
156
156
|
|
|
157
157
|
/**
|
|
158
158
|
* @typedef Page
|
|
159
|
-
* @property {number} [item_total] - The total number of items
|
|
159
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
160
160
|
* @property {string} [next_id] - The identifier for the next page.
|
|
161
161
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
162
162
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|