@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef EventSubscriptionsBulkUpdatePayload
|
|
5
5
|
* @property {SubscriptionsObject[]} [subscriptions]
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef EventSubscriptionsBulkUpdateResult
|
|
10
10
|
* @property {EventSubscriptionTemplate} [template]
|
|
11
11
|
* @property {string} [_id]
|
|
12
12
|
* @property {string} [application]
|
|
@@ -471,13 +471,13 @@ const Joi = require("joi");
|
|
|
471
471
|
*/
|
|
472
472
|
|
|
473
473
|
/**
|
|
474
|
-
* @typedef
|
|
474
|
+
* @typedef EnginePayload
|
|
475
475
|
* @property {PayloadStructure} [payload]
|
|
476
476
|
* @property {MetaStructure} [meta]
|
|
477
477
|
*/
|
|
478
478
|
|
|
479
479
|
/**
|
|
480
|
-
* @typedef
|
|
480
|
+
* @typedef EngineResult
|
|
481
481
|
* @property {boolean} [success]
|
|
482
482
|
*/
|
|
483
483
|
|
|
@@ -519,23 +519,23 @@ const Joi = require("joi");
|
|
|
519
519
|
*/
|
|
520
520
|
|
|
521
521
|
/**
|
|
522
|
-
* @typedef
|
|
522
|
+
* @typedef TriggerJobResult
|
|
523
523
|
* @property {number} [status]
|
|
524
524
|
*/
|
|
525
525
|
|
|
526
526
|
/**
|
|
527
|
-
* @typedef
|
|
527
|
+
* @typedef TriggerJobPayload
|
|
528
528
|
* @property {string} [job_id]
|
|
529
529
|
*/
|
|
530
530
|
|
|
531
531
|
/**
|
|
532
|
-
* @typedef
|
|
532
|
+
* @typedef GetGlobalVariablesResult
|
|
533
533
|
* @property {Object} [read_only]
|
|
534
534
|
* @property {Object} [editable]
|
|
535
535
|
*/
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
|
-
* @typedef
|
|
538
|
+
* @typedef CreateGlobalVariablesResult
|
|
539
539
|
* @property {string} [_id]
|
|
540
540
|
* @property {string} [category]
|
|
541
541
|
* @property {string} [application]
|
|
@@ -765,6 +765,8 @@ const Joi = require("joi");
|
|
|
765
765
|
* @property {number} [version_id] - The version ID for the test.
|
|
766
766
|
* @property {string} [sender_id] - The sender ID for the test.
|
|
767
767
|
* @property {string} [api_key] - The api_key for the test.
|
|
768
|
+
* @property {string} [tenant_name_1] - First part of jiocx url.
|
|
769
|
+
* @property {string} [tenant_name_2] - Second part of jiocx url.
|
|
768
770
|
*/
|
|
769
771
|
|
|
770
772
|
/**
|
|
@@ -970,8 +972,8 @@ const Joi = require("joi");
|
|
|
970
972
|
*/
|
|
971
973
|
|
|
972
974
|
class CommunicationPlatformModel {
|
|
973
|
-
/** @returns {
|
|
974
|
-
static
|
|
975
|
+
/** @returns {EventSubscriptionsBulkUpdatePayload} */
|
|
976
|
+
static EventSubscriptionsBulkUpdatePayload() {
|
|
975
977
|
return Joi.object({
|
|
976
978
|
subscriptions: Joi.array().items(
|
|
977
979
|
CommunicationPlatformModel.SubscriptionsObject()
|
|
@@ -979,8 +981,8 @@ class CommunicationPlatformModel {
|
|
|
979
981
|
});
|
|
980
982
|
}
|
|
981
983
|
|
|
982
|
-
/** @returns {
|
|
983
|
-
static
|
|
984
|
+
/** @returns {EventSubscriptionsBulkUpdateResult} */
|
|
985
|
+
static EventSubscriptionsBulkUpdateResult() {
|
|
984
986
|
return Joi.object({
|
|
985
987
|
template: CommunicationPlatformModel.EventSubscriptionTemplate(),
|
|
986
988
|
_id: Joi.string().allow(""),
|
|
@@ -1401,7 +1403,7 @@ class CommunicationPlatformModel {
|
|
|
1401
1403
|
reply_to: Joi.string().allow(""),
|
|
1402
1404
|
priority: Joi.string().allow(""),
|
|
1403
1405
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
1404
|
-
template_variables: Joi.any(),
|
|
1406
|
+
template_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
1405
1407
|
published: Joi.boolean(),
|
|
1406
1408
|
subject: CommunicationPlatformModel.TemplateAndType(),
|
|
1407
1409
|
html: CommunicationPlatformModel.TemplateAndType(),
|
|
@@ -1443,7 +1445,7 @@ class CommunicationPlatformModel {
|
|
|
1443
1445
|
html: CommunicationPlatformModel.TemplateAndType(),
|
|
1444
1446
|
url_shorten: CommunicationPlatformModel.EnabledObj(),
|
|
1445
1447
|
priority: Joi.string().allow(""),
|
|
1446
|
-
template_variables: Joi.any(),
|
|
1448
|
+
template_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
1447
1449
|
published: Joi.boolean(),
|
|
1448
1450
|
category: Joi.string().allow(""),
|
|
1449
1451
|
_id: Joi.string().allow(""),
|
|
@@ -1475,7 +1477,7 @@ class CommunicationPlatformModel {
|
|
|
1475
1477
|
html: CommunicationPlatformModel.TemplateAndType(),
|
|
1476
1478
|
url_shorten: CommunicationPlatformModel.EnabledObj(),
|
|
1477
1479
|
priority: Joi.string().allow(""),
|
|
1478
|
-
template_variables: Joi.any(),
|
|
1480
|
+
template_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
1479
1481
|
published: Joi.boolean(),
|
|
1480
1482
|
category: Joi.string().allow(""),
|
|
1481
1483
|
_id: Joi.string().allow(""),
|
|
@@ -1574,16 +1576,16 @@ class CommunicationPlatformModel {
|
|
|
1574
1576
|
});
|
|
1575
1577
|
}
|
|
1576
1578
|
|
|
1577
|
-
/** @returns {
|
|
1578
|
-
static
|
|
1579
|
+
/** @returns {EnginePayload} */
|
|
1580
|
+
static EnginePayload() {
|
|
1579
1581
|
return Joi.object({
|
|
1580
1582
|
payload: CommunicationPlatformModel.PayloadStructure(),
|
|
1581
1583
|
meta: CommunicationPlatformModel.MetaStructure(),
|
|
1582
1584
|
});
|
|
1583
1585
|
}
|
|
1584
1586
|
|
|
1585
|
-
/** @returns {
|
|
1586
|
-
static
|
|
1587
|
+
/** @returns {EngineResult} */
|
|
1588
|
+
static EngineResult() {
|
|
1587
1589
|
return Joi.object({
|
|
1588
1590
|
success: Joi.boolean(),
|
|
1589
1591
|
});
|
|
@@ -1636,35 +1638,35 @@ class CommunicationPlatformModel {
|
|
|
1636
1638
|
});
|
|
1637
1639
|
}
|
|
1638
1640
|
|
|
1639
|
-
/** @returns {
|
|
1640
|
-
static
|
|
1641
|
+
/** @returns {TriggerJobResult} */
|
|
1642
|
+
static TriggerJobResult() {
|
|
1641
1643
|
return Joi.object({
|
|
1642
1644
|
status: Joi.number(),
|
|
1643
1645
|
});
|
|
1644
1646
|
}
|
|
1645
1647
|
|
|
1646
|
-
/** @returns {
|
|
1647
|
-
static
|
|
1648
|
+
/** @returns {TriggerJobPayload} */
|
|
1649
|
+
static TriggerJobPayload() {
|
|
1648
1650
|
return Joi.object({
|
|
1649
1651
|
job_id: Joi.string().allow(""),
|
|
1650
1652
|
});
|
|
1651
1653
|
}
|
|
1652
1654
|
|
|
1653
|
-
/** @returns {
|
|
1654
|
-
static
|
|
1655
|
+
/** @returns {GetGlobalVariablesResult} */
|
|
1656
|
+
static GetGlobalVariablesResult() {
|
|
1655
1657
|
return Joi.object({
|
|
1656
|
-
read_only: Joi.any(),
|
|
1657
|
-
editable: Joi.any(),
|
|
1658
|
+
read_only: Joi.object().pattern(/\S/, Joi.any()),
|
|
1659
|
+
editable: Joi.object().pattern(/\S/, Joi.any()),
|
|
1658
1660
|
});
|
|
1659
1661
|
}
|
|
1660
1662
|
|
|
1661
|
-
/** @returns {
|
|
1662
|
-
static
|
|
1663
|
+
/** @returns {CreateGlobalVariablesResult} */
|
|
1664
|
+
static CreateGlobalVariablesResult() {
|
|
1663
1665
|
return Joi.object({
|
|
1664
1666
|
_id: Joi.string().allow(""),
|
|
1665
1667
|
category: Joi.string().allow(""),
|
|
1666
1668
|
application: Joi.string().allow(""),
|
|
1667
|
-
global_variables: Joi.any(),
|
|
1669
|
+
global_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
1668
1670
|
created_at: Joi.string().allow(""),
|
|
1669
1671
|
});
|
|
1670
1672
|
}
|
|
@@ -1672,7 +1674,7 @@ class CommunicationPlatformModel {
|
|
|
1672
1674
|
/** @returns {GlobalVariablesReq} */
|
|
1673
1675
|
static GlobalVariablesReq() {
|
|
1674
1676
|
return Joi.object({
|
|
1675
|
-
global_variables: Joi.any(),
|
|
1677
|
+
global_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
1676
1678
|
});
|
|
1677
1679
|
}
|
|
1678
1680
|
|
|
@@ -1944,6 +1946,8 @@ class CommunicationPlatformModel {
|
|
|
1944
1946
|
version_id: Joi.number(),
|
|
1945
1947
|
sender_id: Joi.string().allow(""),
|
|
1946
1948
|
api_key: Joi.string().allow(""),
|
|
1949
|
+
tenant_name_1: Joi.string().allow(""),
|
|
1950
|
+
tenant_name_2: Joi.string().allow(""),
|
|
1947
1951
|
});
|
|
1948
1952
|
}
|
|
1949
1953
|
|
|
@@ -2018,7 +2022,7 @@ class CommunicationPlatformModel {
|
|
|
2018
2022
|
message: CommunicationPlatformModel.SmsTemplateMessage(),
|
|
2019
2023
|
priority: Joi.string().allow(""),
|
|
2020
2024
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
2021
|
-
template_variables: Joi.any(),
|
|
2025
|
+
template_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
2022
2026
|
template_id: Joi.string().allow(""),
|
|
2023
2027
|
published: Joi.boolean(),
|
|
2024
2028
|
category: Joi.string().allow(""),
|
|
@@ -2041,7 +2045,7 @@ class CommunicationPlatformModel {
|
|
|
2041
2045
|
message: CommunicationPlatformModel.SmsTemplateMessage(),
|
|
2042
2046
|
priority: Joi.string().allow(""),
|
|
2043
2047
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
2044
|
-
template_variables: Joi.any(),
|
|
2048
|
+
template_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
2045
2049
|
template_id: Joi.string().allow(""),
|
|
2046
2050
|
published: Joi.boolean(),
|
|
2047
2051
|
category: Joi.string().allow(""),
|
|
@@ -2069,7 +2073,7 @@ class CommunicationPlatformModel {
|
|
|
2069
2073
|
priority: Joi.string().allow(""),
|
|
2070
2074
|
template_id: Joi.string().allow(""),
|
|
2071
2075
|
meta: CommunicationPlatformModel.metaObj(),
|
|
2072
|
-
template_variables: Joi.any(),
|
|
2076
|
+
template_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
2073
2077
|
published: Joi.boolean(),
|
|
2074
2078
|
message: CommunicationPlatformModel.SmsTemplateMessage(),
|
|
2075
2079
|
});
|
|
@@ -6,130 +6,132 @@ declare class CompanyProfile {
|
|
|
6
6
|
* @param {CompanyProfilePlatformValidator.CbsOnboardGetParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
9
|
+
* @returns {Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponseSchema>}
|
|
10
10
|
* - Success response
|
|
11
11
|
*
|
|
12
12
|
* @name cbsOnboardGet
|
|
13
13
|
* @summary: Get company profile
|
|
14
14
|
* @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
|
|
15
15
|
*/
|
|
16
|
-
cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
16
|
+
cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponseSchema>;
|
|
17
17
|
/**
|
|
18
18
|
* @param {CompanyProfilePlatformValidator.CreateBrandParam} arg - Arg object
|
|
19
19
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
22
|
-
* Success response
|
|
21
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
22
|
+
* - Success response
|
|
23
|
+
*
|
|
23
24
|
* @name createBrand
|
|
24
25
|
* @summary: Create brand
|
|
25
26
|
* @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
|
|
26
27
|
*/
|
|
27
|
-
createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
28
|
+
createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
28
29
|
/**
|
|
29
30
|
* @param {CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam} arg
|
|
30
31
|
* - Arg object
|
|
31
32
|
*
|
|
32
33
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
33
34
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
35
|
-
* Success response
|
|
35
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
36
|
+
* - Success response
|
|
37
|
+
*
|
|
36
38
|
* @name createCompanyBrandMapping
|
|
37
39
|
* @summary: Create company-brand mapping
|
|
38
40
|
* @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
|
|
39
41
|
*/
|
|
40
|
-
createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
42
|
+
createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
41
43
|
/**
|
|
42
44
|
* @param {CompanyProfilePlatformValidator.CreateLocationParam} arg - Arg object
|
|
43
45
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
44
46
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
45
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
46
|
-
* Success response
|
|
47
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
48
|
+
* - Success response
|
|
49
|
+
*
|
|
47
50
|
* @name createLocation
|
|
48
51
|
* @summary: Create company stores
|
|
49
52
|
* @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
|
|
50
53
|
*/
|
|
51
|
-
createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
54
|
+
createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
52
55
|
/**
|
|
53
56
|
* @param {CompanyProfilePlatformValidator.CreateLocationBulkParam} arg - Arg object
|
|
54
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
55
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
56
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
57
|
-
* Success response
|
|
59
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
60
|
+
* - Success response
|
|
61
|
+
*
|
|
58
62
|
* @name createLocationBulk
|
|
59
63
|
* @summary: Bulk create company stores
|
|
60
64
|
* @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
|
|
61
65
|
*/
|
|
62
|
-
createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
66
|
+
createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
63
67
|
/**
|
|
64
68
|
* @param {CompanyProfilePlatformValidator.EditBrandParam} arg - Arg object
|
|
65
69
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
66
70
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
67
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
68
|
-
* Success response
|
|
71
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
72
|
+
* - Success response
|
|
73
|
+
*
|
|
69
74
|
* @name editBrand
|
|
70
75
|
* @summary: update brand
|
|
71
76
|
* @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
|
|
72
77
|
*/
|
|
73
|
-
editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
78
|
+
editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
74
79
|
/**
|
|
75
80
|
* @param {CompanyProfilePlatformValidator.GetBrandParam} arg - Arg object
|
|
76
81
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
77
82
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
78
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
79
|
-
*
|
|
80
|
-
*
|
|
83
|
+
* @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>} -
|
|
84
|
+
* Success response
|
|
81
85
|
* @name getBrand
|
|
82
86
|
* @summary: Get a brand
|
|
83
87
|
* @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
|
|
84
88
|
*/
|
|
85
|
-
getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
89
|
+
getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>;
|
|
86
90
|
/**
|
|
87
91
|
* @param {CompanyProfilePlatformValidator.GetBrandsParam} arg - Arg object
|
|
88
92
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
89
93
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
91
|
-
*
|
|
92
|
-
*
|
|
94
|
+
* @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>} -
|
|
95
|
+
* Success response
|
|
93
96
|
* @name getBrands
|
|
94
97
|
* @summary: list company brands
|
|
95
98
|
* @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
|
|
96
99
|
*/
|
|
97
|
-
getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
100
|
+
getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>;
|
|
98
101
|
/**
|
|
99
102
|
* @param {Object} arg - Arg object.
|
|
100
103
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
101
104
|
* page. Default is 10.
|
|
102
105
|
* @param {string} [arg.q] - Search term for name.
|
|
103
|
-
* @returns {Paginator<CompanyProfilePlatformModel.
|
|
106
|
+
* @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSchema>}
|
|
104
107
|
* @summary: list company brands
|
|
105
108
|
* @description: Retrieve a list of available brands associated to a company.
|
|
106
109
|
*/
|
|
107
110
|
getBrandsPaginator({ pageSize, q }?: {
|
|
108
111
|
pageSize?: number;
|
|
109
112
|
q?: string;
|
|
110
|
-
}): Paginator<CompanyProfilePlatformModel.
|
|
113
|
+
}): Paginator<CompanyProfilePlatformModel.CompanyBrandListSchema>;
|
|
111
114
|
/**
|
|
112
115
|
* @param {CompanyProfilePlatformValidator.GetCompanyMetricsParam} arg - Arg object
|
|
113
116
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
114
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
115
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
116
|
-
* Success response
|
|
118
|
+
* @returns {Promise<CompanyProfilePlatformModel.MetricsSchema>} - Success response
|
|
117
119
|
* @name getCompanyMetrics
|
|
118
120
|
* @summary: Get company metrics
|
|
119
121
|
* @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
|
|
120
122
|
*/
|
|
121
|
-
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
123
|
+
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSchema>;
|
|
122
124
|
/**
|
|
123
125
|
* @param {CompanyProfilePlatformValidator.GetLocationDetailParam} arg - Arg object
|
|
124
126
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
125
127
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
126
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
128
|
+
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSchema>} -
|
|
127
129
|
* Success response
|
|
128
130
|
* @name getLocationDetail
|
|
129
131
|
* @summary: Get company stores
|
|
130
132
|
* @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
|
|
131
133
|
*/
|
|
132
|
-
getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
134
|
+
getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSchema>;
|
|
133
135
|
/**
|
|
134
136
|
* @param {CompanyProfilePlatformValidator.GetLocationTagsParam} arg - Arg object
|
|
135
137
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -146,13 +148,13 @@ declare class CompanyProfile {
|
|
|
146
148
|
* @param {CompanyProfilePlatformValidator.GetLocationsParam} arg - Arg object
|
|
147
149
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
148
150
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
149
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
151
|
+
* @returns {Promise<CompanyProfilePlatformModel.LocationListSchema>} -
|
|
150
152
|
* Success response
|
|
151
153
|
* @name getLocations
|
|
152
154
|
* @summary: Get company specific stores
|
|
153
155
|
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
154
156
|
*/
|
|
155
|
-
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
157
|
+
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSchema>;
|
|
156
158
|
/**
|
|
157
159
|
* @param {Object} arg - Arg object.
|
|
158
160
|
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
@@ -167,7 +169,7 @@ declare class CompanyProfile {
|
|
|
167
169
|
* basis of multiple location type.
|
|
168
170
|
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
169
171
|
* basis of multiple location tag.
|
|
170
|
-
* @returns {Paginator<CompanyProfilePlatformModel.
|
|
172
|
+
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSchema>}
|
|
171
173
|
* @summary: Get company specific stores
|
|
172
174
|
* @description: Retrieve a list of locations associated with the company.
|
|
173
175
|
*/
|
|
@@ -179,29 +181,31 @@ declare class CompanyProfile {
|
|
|
179
181
|
locationIds?: number[];
|
|
180
182
|
types?: string[];
|
|
181
183
|
tags?: string[];
|
|
182
|
-
}): Paginator<CompanyProfilePlatformModel.
|
|
184
|
+
}): Paginator<CompanyProfilePlatformModel.LocationListSchema>;
|
|
183
185
|
/**
|
|
184
186
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
185
187
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
188
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
188
|
-
* Success response
|
|
189
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
190
|
+
* - Success response
|
|
191
|
+
*
|
|
189
192
|
* @name updateCompany
|
|
190
193
|
* @summary: Update company profile
|
|
191
194
|
* @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
|
|
192
195
|
*/
|
|
193
|
-
updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
196
|
+
updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
194
197
|
/**
|
|
195
198
|
* @param {CompanyProfilePlatformValidator.UpdateLocationParam} arg - Arg object
|
|
196
199
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
197
200
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
199
|
-
* Success response
|
|
201
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
202
|
+
* - Success response
|
|
203
|
+
*
|
|
200
204
|
* @name updateLocation
|
|
201
205
|
* @summary: Update company stores
|
|
202
206
|
* @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
|
|
203
207
|
*/
|
|
204
|
-
updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
208
|
+
updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
205
209
|
}
|
|
206
210
|
import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
|
|
207
211
|
import CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");
|