@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -828,4 +828,4 @@ type GetSystemAudiencesParam = any;
|
|
|
828
828
|
type GetSystemEmailTemplatesParam = any;
|
|
829
829
|
type GetSystemSmsTemplatesParam = any;
|
|
830
830
|
type UpdateOtpConfigurationParam = any;
|
|
831
|
-
import CommunicationPlatformModel = require("
|
|
831
|
+
import CommunicationPlatformModel = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformModel");
|
|
@@ -11,10 +11,10 @@ declare class Communication {
|
|
|
11
11
|
* @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
|
|
12
12
|
* Success response
|
|
13
13
|
* @name getSystemNotifications
|
|
14
|
-
* @summary: Get system notifications
|
|
15
|
-
* @description:
|
|
14
|
+
* @summary: Get system notifications
|
|
15
|
+
* @description: Retrieves a list of system notifications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
|
|
16
16
|
*/
|
|
17
17
|
getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
|
|
18
18
|
}
|
|
19
|
-
import CommunicationPlatformValidator = require("
|
|
20
|
-
import CommunicationPlatformModel = require("
|
|
19
|
+
import CommunicationPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformValidator");
|
|
20
|
+
import CommunicationPlatformModel = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformModel");
|
|
@@ -23,8 +23,8 @@ class Communication {
|
|
|
23
23
|
* @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
|
|
24
24
|
* Success response
|
|
25
25
|
* @name getSystemNotifications
|
|
26
|
-
* @summary: Get system notifications
|
|
27
|
-
* @description:
|
|
26
|
+
* @summary: Get system notifications
|
|
27
|
+
* @description: Retrieves a list of system notifications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
|
|
28
28
|
*/
|
|
29
29
|
async getSystemNotifications(
|
|
30
30
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -642,6 +642,7 @@ export = CommunicationPlatformModel;
|
|
|
642
642
|
* @property {string} [mobile]
|
|
643
643
|
* @property {string} [country_code]
|
|
644
644
|
* @property {string} [message]
|
|
645
|
+
* @property {string} [email]
|
|
645
646
|
*/
|
|
646
647
|
/**
|
|
647
648
|
* @typedef VerifyOtpCommsErrorRes
|
|
@@ -651,6 +652,7 @@ export = CommunicationPlatformModel;
|
|
|
651
652
|
/**
|
|
652
653
|
* @typedef SmsProviderReq
|
|
653
654
|
* @property {string} [name]
|
|
655
|
+
* @property {string} [token]
|
|
654
656
|
* @property {string} [description]
|
|
655
657
|
* @property {string} [sender]
|
|
656
658
|
* @property {string} [username]
|
|
@@ -672,6 +674,10 @@ export = CommunicationPlatformModel;
|
|
|
672
674
|
*/
|
|
673
675
|
/**
|
|
674
676
|
* @typedef SmsProvider
|
|
677
|
+
* @property {string} [token]
|
|
678
|
+
* @property {string} [sender_id]
|
|
679
|
+
* @property {string} [api_key]
|
|
680
|
+
* @property {number} [expiry_date]
|
|
675
681
|
* @property {number} [rpt]
|
|
676
682
|
* @property {string} [type]
|
|
677
683
|
* @property {string} [provider]
|
|
@@ -1605,6 +1611,7 @@ type VerifyOtpCommsSuccessRes = {
|
|
|
1605
1611
|
mobile?: string;
|
|
1606
1612
|
country_code?: string;
|
|
1607
1613
|
message?: string;
|
|
1614
|
+
email?: string;
|
|
1608
1615
|
};
|
|
1609
1616
|
/** @returns {VerifyOtpCommsErrorRes} */
|
|
1610
1617
|
declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
|
|
@@ -1616,6 +1623,7 @@ type VerifyOtpCommsErrorRes = {
|
|
|
1616
1623
|
declare function SmsProviderReq(): SmsProviderReq;
|
|
1617
1624
|
type SmsProviderReq = {
|
|
1618
1625
|
name?: string;
|
|
1626
|
+
token?: string;
|
|
1619
1627
|
description?: string;
|
|
1620
1628
|
sender?: string;
|
|
1621
1629
|
username?: string;
|
|
@@ -1674,6 +1682,10 @@ type SmsProviderReq = {
|
|
|
1674
1682
|
/** @returns {SmsProvider} */
|
|
1675
1683
|
declare function SmsProvider(): SmsProvider;
|
|
1676
1684
|
type SmsProvider = {
|
|
1685
|
+
token?: string;
|
|
1686
|
+
sender_id?: string;
|
|
1687
|
+
api_key?: string;
|
|
1688
|
+
expiry_date?: number;
|
|
1677
1689
|
rpt?: number;
|
|
1678
1690
|
type?: string;
|
|
1679
1691
|
provider?: string;
|
|
@@ -734,6 +734,7 @@ const Joi = require("joi");
|
|
|
734
734
|
* @property {string} [mobile]
|
|
735
735
|
* @property {string} [country_code]
|
|
736
736
|
* @property {string} [message]
|
|
737
|
+
* @property {string} [email]
|
|
737
738
|
*/
|
|
738
739
|
|
|
739
740
|
/**
|
|
@@ -745,6 +746,7 @@ const Joi = require("joi");
|
|
|
745
746
|
/**
|
|
746
747
|
* @typedef SmsProviderReq
|
|
747
748
|
* @property {string} [name]
|
|
749
|
+
* @property {string} [token]
|
|
748
750
|
* @property {string} [description]
|
|
749
751
|
* @property {string} [sender]
|
|
750
752
|
* @property {string} [username]
|
|
@@ -767,6 +769,10 @@ const Joi = require("joi");
|
|
|
767
769
|
|
|
768
770
|
/**
|
|
769
771
|
* @typedef SmsProvider
|
|
772
|
+
* @property {string} [token]
|
|
773
|
+
* @property {string} [sender_id]
|
|
774
|
+
* @property {string} [api_key]
|
|
775
|
+
* @property {number} [expiry_date]
|
|
770
776
|
* @property {number} [rpt]
|
|
771
777
|
* @property {string} [type]
|
|
772
778
|
* @property {string} [provider]
|
|
@@ -1903,6 +1909,7 @@ class CommunicationPlatformModel {
|
|
|
1903
1909
|
mobile: Joi.string().allow(""),
|
|
1904
1910
|
country_code: Joi.string().allow(""),
|
|
1905
1911
|
message: Joi.string().allow(""),
|
|
1912
|
+
email: Joi.string().allow(""),
|
|
1906
1913
|
});
|
|
1907
1914
|
}
|
|
1908
1915
|
|
|
@@ -1918,6 +1925,7 @@ class CommunicationPlatformModel {
|
|
|
1918
1925
|
static SmsProviderReq() {
|
|
1919
1926
|
return Joi.object({
|
|
1920
1927
|
name: Joi.string().allow(""),
|
|
1928
|
+
token: Joi.string().allow(""),
|
|
1921
1929
|
description: Joi.string().allow(""),
|
|
1922
1930
|
sender: Joi.string().allow(""),
|
|
1923
1931
|
username: Joi.string().allow(""),
|
|
@@ -1942,6 +1950,10 @@ class CommunicationPlatformModel {
|
|
|
1942
1950
|
/** @returns {SmsProvider} */
|
|
1943
1951
|
static SmsProvider() {
|
|
1944
1952
|
return Joi.object({
|
|
1953
|
+
token: Joi.string().allow(""),
|
|
1954
|
+
sender_id: Joi.string().allow(""),
|
|
1955
|
+
api_key: Joi.string().allow(""),
|
|
1956
|
+
expiry_date: Joi.number(),
|
|
1945
1957
|
rpt: Joi.number(),
|
|
1946
1958
|
type: Joi.string().allow(""),
|
|
1947
1959
|
provider: Joi.string().allow(""),
|
|
@@ -10,7 +10,7 @@ declare class CompanyProfile {
|
|
|
10
10
|
* - Success response
|
|
11
11
|
*
|
|
12
12
|
* @name cbsOnboardGet
|
|
13
|
-
* @summary: Get company
|
|
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
16
|
cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>;
|
|
@@ -21,7 +21,7 @@ declare class CompanyProfile {
|
|
|
21
21
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
22
22
|
* Success response
|
|
23
23
|
* @name createBrand
|
|
24
|
-
* @summary: Create brand
|
|
24
|
+
* @summary: Create brand
|
|
25
25
|
* @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
26
|
*/
|
|
27
27
|
createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
@@ -34,7 +34,7 @@ declare class CompanyProfile {
|
|
|
34
34
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name createCompanyBrandMapping
|
|
37
|
-
* @summary: Create company-brand mapping
|
|
37
|
+
* @summary: Create company-brand mapping
|
|
38
38
|
* @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
39
|
*/
|
|
40
40
|
createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
@@ -45,8 +45,8 @@ declare class CompanyProfile {
|
|
|
45
45
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
46
46
|
* Success response
|
|
47
47
|
* @name createLocation
|
|
48
|
-
* @summary: Create
|
|
49
|
-
* @description: Create a new location
|
|
48
|
+
* @summary: Create company stores
|
|
49
|
+
* @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
|
|
50
50
|
*/
|
|
51
51
|
createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
52
52
|
/**
|
|
@@ -56,8 +56,8 @@ declare class CompanyProfile {
|
|
|
56
56
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
57
57
|
* Success response
|
|
58
58
|
* @name createLocationBulk
|
|
59
|
-
* @summary:
|
|
60
|
-
* @description: Allows to create
|
|
59
|
+
* @summary: Bulk create company stores
|
|
60
|
+
* @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
61
|
*/
|
|
62
62
|
createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
63
63
|
/**
|
|
@@ -67,8 +67,8 @@ declare class CompanyProfile {
|
|
|
67
67
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
68
68
|
* Success response
|
|
69
69
|
* @name editBrand
|
|
70
|
-
* @summary:
|
|
71
|
-
* @description: Modify details and
|
|
70
|
+
* @summary: update brand
|
|
71
|
+
* @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
72
|
*/
|
|
73
73
|
editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
74
74
|
/**
|
|
@@ -79,8 +79,8 @@ declare class CompanyProfile {
|
|
|
79
79
|
* - Success response
|
|
80
80
|
*
|
|
81
81
|
* @name getBrand
|
|
82
|
-
* @summary: Get brand
|
|
83
|
-
* @description: Retrieve detailed information about a specific brand
|
|
82
|
+
* @summary: Get a brand
|
|
83
|
+
* @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
84
|
*/
|
|
85
85
|
getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>;
|
|
86
86
|
/**
|
|
@@ -91,8 +91,8 @@ declare class CompanyProfile {
|
|
|
91
91
|
* - Success response
|
|
92
92
|
*
|
|
93
93
|
* @name getBrands
|
|
94
|
-
* @summary:
|
|
95
|
-
* @description: Retrieve a list of available brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
|
|
94
|
+
* @summary: list company brands
|
|
95
|
+
* @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
96
|
*/
|
|
97
97
|
getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
|
|
98
98
|
/**
|
|
@@ -101,8 +101,8 @@ declare class CompanyProfile {
|
|
|
101
101
|
* page. Default is 10.
|
|
102
102
|
* @param {string} [arg.q] - Search term for name.
|
|
103
103
|
* @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
|
|
104
|
-
* @summary:
|
|
105
|
-
* @description: Retrieve a list of available brands.
|
|
104
|
+
* @summary: list company brands
|
|
105
|
+
* @description: Retrieve a list of available brands associated to a company.
|
|
106
106
|
*/
|
|
107
107
|
getBrandsPaginator({ pageSize, q }?: {
|
|
108
108
|
pageSize?: number;
|
|
@@ -115,8 +115,8 @@ declare class CompanyProfile {
|
|
|
115
115
|
* @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
|
|
116
116
|
* Success response
|
|
117
117
|
* @name getCompanyMetrics
|
|
118
|
-
* @summary: Get company metrics
|
|
119
|
-
* @description: Allows
|
|
118
|
+
* @summary: Get company metrics
|
|
119
|
+
* @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
120
|
*/
|
|
121
121
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSerializer>;
|
|
122
122
|
/**
|
|
@@ -126,8 +126,8 @@ declare class CompanyProfile {
|
|
|
126
126
|
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
|
|
127
127
|
* Success response
|
|
128
128
|
* @name getLocationDetail
|
|
129
|
-
* @summary: Get
|
|
130
|
-
* @description:
|
|
129
|
+
* @summary: Get company stores
|
|
130
|
+
* @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
131
|
*/
|
|
132
132
|
getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSerializer>;
|
|
133
133
|
/**
|
|
@@ -138,8 +138,8 @@ declare class CompanyProfile {
|
|
|
138
138
|
* - Success response
|
|
139
139
|
*
|
|
140
140
|
* @name getLocationTags
|
|
141
|
-
* @summary: Get
|
|
142
|
-
* @description: Retrieve all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
|
|
141
|
+
* @summary: Get company store tags
|
|
142
|
+
* @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
|
|
143
143
|
*/
|
|
144
144
|
getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.StoreTagsResponseSchema>;
|
|
145
145
|
/**
|
|
@@ -149,7 +149,7 @@ declare class CompanyProfile {
|
|
|
149
149
|
* @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
|
|
150
150
|
* Success response
|
|
151
151
|
* @name getLocations
|
|
152
|
-
* @summary: Get company
|
|
152
|
+
* @summary: Get company specific stores
|
|
153
153
|
* @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
154
|
*/
|
|
155
155
|
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
|
|
@@ -168,7 +168,7 @@ declare class CompanyProfile {
|
|
|
168
168
|
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
169
169
|
* basis of multiple location tag.
|
|
170
170
|
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
171
|
-
* @summary: Get company
|
|
171
|
+
* @summary: Get company specific stores
|
|
172
172
|
* @description: Retrieve a list of locations associated with the company.
|
|
173
173
|
*/
|
|
174
174
|
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
@@ -187,7 +187,7 @@ declare class CompanyProfile {
|
|
|
187
187
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
188
188
|
* Success response
|
|
189
189
|
* @name updateCompany
|
|
190
|
-
* @summary: Update company
|
|
190
|
+
* @summary: Update company profile
|
|
191
191
|
* @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
192
|
*/
|
|
193
193
|
updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
@@ -198,11 +198,11 @@ declare class CompanyProfile {
|
|
|
198
198
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
199
199
|
* Success response
|
|
200
200
|
* @name updateLocation
|
|
201
|
-
* @summary: Update
|
|
201
|
+
* @summary: Update company stores
|
|
202
202
|
* @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
203
|
*/
|
|
204
204
|
updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
205
205
|
}
|
|
206
|
-
import CompanyProfilePlatformModel = require("
|
|
207
|
-
import CompanyProfilePlatformValidator = require("
|
|
208
|
-
import Paginator = require("
|
|
206
|
+
import CompanyProfilePlatformModel = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformModel");
|
|
207
|
+
import CompanyProfilePlatformValidator = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator");
|
|
208
|
+
import Paginator = require("sdk/output/javascript/code/sdk/common/Paginator");
|
|
@@ -22,7 +22,7 @@ class CompanyProfile {
|
|
|
22
22
|
* - Success response
|
|
23
23
|
*
|
|
24
24
|
* @name cbsOnboardGet
|
|
25
|
-
* @summary: Get company
|
|
25
|
+
* @summary: Get company profile
|
|
26
26
|
* @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
|
|
27
27
|
*/
|
|
28
28
|
async cbsOnboardGet(
|
|
@@ -98,7 +98,7 @@ class CompanyProfile {
|
|
|
98
98
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
99
99
|
* Success response
|
|
100
100
|
* @name createBrand
|
|
101
|
-
* @summary: Create brand
|
|
101
|
+
* @summary: Create brand
|
|
102
102
|
* @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
|
|
103
103
|
*/
|
|
104
104
|
async createBrand(
|
|
@@ -180,7 +180,7 @@ class CompanyProfile {
|
|
|
180
180
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
181
181
|
* Success response
|
|
182
182
|
* @name createCompanyBrandMapping
|
|
183
|
-
* @summary: Create company-brand mapping
|
|
183
|
+
* @summary: Create company-brand mapping
|
|
184
184
|
* @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
|
|
185
185
|
*/
|
|
186
186
|
async createCompanyBrandMapping(
|
|
@@ -262,8 +262,8 @@ class CompanyProfile {
|
|
|
262
262
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
263
263
|
* Success response
|
|
264
264
|
* @name createLocation
|
|
265
|
-
* @summary: Create
|
|
266
|
-
* @description: Create a new location
|
|
265
|
+
* @summary: Create company stores
|
|
266
|
+
* @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
|
|
267
267
|
*/
|
|
268
268
|
async createLocation(
|
|
269
269
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -342,8 +342,8 @@ class CompanyProfile {
|
|
|
342
342
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
343
343
|
* Success response
|
|
344
344
|
* @name createLocationBulk
|
|
345
|
-
* @summary:
|
|
346
|
-
* @description: Allows to create
|
|
345
|
+
* @summary: Bulk create company stores
|
|
346
|
+
* @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/).
|
|
347
347
|
*/
|
|
348
348
|
async createLocationBulk(
|
|
349
349
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -424,8 +424,8 @@ class CompanyProfile {
|
|
|
424
424
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
425
425
|
* Success response
|
|
426
426
|
* @name editBrand
|
|
427
|
-
* @summary:
|
|
428
|
-
* @description: Modify details and
|
|
427
|
+
* @summary: update brand
|
|
428
|
+
* @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
|
|
429
429
|
*/
|
|
430
430
|
async editBrand(
|
|
431
431
|
{ brandId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -507,8 +507,8 @@ class CompanyProfile {
|
|
|
507
507
|
* - Success response
|
|
508
508
|
*
|
|
509
509
|
* @name getBrand
|
|
510
|
-
* @summary: Get brand
|
|
511
|
-
* @description: Retrieve detailed information about a specific brand
|
|
510
|
+
* @summary: Get a brand
|
|
511
|
+
* @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/).
|
|
512
512
|
*/
|
|
513
513
|
async getBrand(
|
|
514
514
|
{ brandId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -588,8 +588,8 @@ class CompanyProfile {
|
|
|
588
588
|
* - Success response
|
|
589
589
|
*
|
|
590
590
|
* @name getBrands
|
|
591
|
-
* @summary:
|
|
592
|
-
* @description: Retrieve a list of available brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
|
|
591
|
+
* @summary: list company brands
|
|
592
|
+
* @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/).
|
|
593
593
|
*/
|
|
594
594
|
async getBrands(
|
|
595
595
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -674,8 +674,8 @@ class CompanyProfile {
|
|
|
674
674
|
* page. Default is 10.
|
|
675
675
|
* @param {string} [arg.q] - Search term for name.
|
|
676
676
|
* @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
|
|
677
|
-
* @summary:
|
|
678
|
-
* @description: Retrieve a list of available brands.
|
|
677
|
+
* @summary: list company brands
|
|
678
|
+
* @description: Retrieve a list of available brands associated to a company.
|
|
679
679
|
*/
|
|
680
680
|
getBrandsPaginator({ pageSize, q } = {}) {
|
|
681
681
|
const paginator = new Paginator();
|
|
@@ -705,8 +705,8 @@ class CompanyProfile {
|
|
|
705
705
|
* @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
|
|
706
706
|
* Success response
|
|
707
707
|
* @name getCompanyMetrics
|
|
708
|
-
* @summary: Get company metrics
|
|
709
|
-
* @description: Allows
|
|
708
|
+
* @summary: Get company metrics
|
|
709
|
+
* @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/).
|
|
710
710
|
*/
|
|
711
711
|
async getCompanyMetrics(
|
|
712
712
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -783,8 +783,8 @@ class CompanyProfile {
|
|
|
783
783
|
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
|
|
784
784
|
* Success response
|
|
785
785
|
* @name getLocationDetail
|
|
786
|
-
* @summary: Get
|
|
787
|
-
* @description:
|
|
786
|
+
* @summary: Get company stores
|
|
787
|
+
* @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/).
|
|
788
788
|
*/
|
|
789
789
|
async getLocationDetail(
|
|
790
790
|
{ locationId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -866,8 +866,8 @@ class CompanyProfile {
|
|
|
866
866
|
* - Success response
|
|
867
867
|
*
|
|
868
868
|
* @name getLocationTags
|
|
869
|
-
* @summary: Get
|
|
870
|
-
* @description: Retrieve all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
|
|
869
|
+
* @summary: Get company store tags
|
|
870
|
+
* @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
|
|
871
871
|
*/
|
|
872
872
|
async getLocationTags(
|
|
873
873
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -944,7 +944,7 @@ class CompanyProfile {
|
|
|
944
944
|
* @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
|
|
945
945
|
* Success response
|
|
946
946
|
* @name getLocations
|
|
947
|
-
* @summary: Get company
|
|
947
|
+
* @summary: Get company specific stores
|
|
948
948
|
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
949
949
|
*/
|
|
950
950
|
async getLocations(
|
|
@@ -1064,7 +1064,7 @@ class CompanyProfile {
|
|
|
1064
1064
|
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
1065
1065
|
* basis of multiple location tag.
|
|
1066
1066
|
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
1067
|
-
* @summary: Get company
|
|
1067
|
+
* @summary: Get company specific stores
|
|
1068
1068
|
* @description: Retrieve a list of locations associated with the company.
|
|
1069
1069
|
*/
|
|
1070
1070
|
getLocationsPaginator({
|
|
@@ -1108,7 +1108,7 @@ class CompanyProfile {
|
|
|
1108
1108
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
1109
1109
|
* Success response
|
|
1110
1110
|
* @name updateCompany
|
|
1111
|
-
* @summary: Update company
|
|
1111
|
+
* @summary: Update company profile
|
|
1112
1112
|
* @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/).
|
|
1113
1113
|
*/
|
|
1114
1114
|
async updateCompany(
|
|
@@ -1188,7 +1188,7 @@ class CompanyProfile {
|
|
|
1188
1188
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
1189
1189
|
* Success response
|
|
1190
1190
|
* @name updateLocation
|
|
1191
|
-
* @summary: Update
|
|
1191
|
+
* @summary: Update company stores
|
|
1192
1192
|
* @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
|
|
1193
1193
|
*/
|
|
1194
1194
|
async updateLocation(
|
|
@@ -196,6 +196,7 @@ export = CompanyProfilePlatformModel;
|
|
|
196
196
|
* @property {number} [uid]
|
|
197
197
|
* @property {BrandBannerSerializer} banner
|
|
198
198
|
* @property {string} name
|
|
199
|
+
* @property {string} [slug]
|
|
199
200
|
*/
|
|
200
201
|
/**
|
|
201
202
|
* @typedef CompanySocialAccounts
|
|
@@ -650,6 +651,7 @@ type CreateUpdateBrandRequestSerializer = {
|
|
|
650
651
|
uid?: number;
|
|
651
652
|
banner: BrandBannerSerializer;
|
|
652
653
|
name: string;
|
|
654
|
+
slug?: string;
|
|
653
655
|
};
|
|
654
656
|
/** @returns {CompanySocialAccounts} */
|
|
655
657
|
declare function CompanySocialAccounts(): CompanySocialAccounts;
|
|
@@ -217,6 +217,7 @@ const Joi = require("joi");
|
|
|
217
217
|
* @property {number} [uid]
|
|
218
218
|
* @property {BrandBannerSerializer} banner
|
|
219
219
|
* @property {string} name
|
|
220
|
+
* @property {string} [slug]
|
|
220
221
|
*/
|
|
221
222
|
|
|
222
223
|
/**
|
|
@@ -739,6 +740,7 @@ class CompanyProfilePlatformModel {
|
|
|
739
740
|
uid: Joi.number(),
|
|
740
741
|
banner: CompanyProfilePlatformModel.BrandBannerSerializer().required(),
|
|
741
742
|
name: Joi.string().allow("").required(),
|
|
743
|
+
slug: Joi.string().allow(""),
|
|
742
744
|
});
|
|
743
745
|
}
|
|
744
746
|
|
|
@@ -198,4 +198,4 @@ type UpdateLocationParam = {
|
|
|
198
198
|
type CbsOnboardGetParam = any;
|
|
199
199
|
type GetCompanyMetricsParam = any;
|
|
200
200
|
type GetLocationTagsParam = any;
|
|
201
|
-
import CompanyProfilePlatformModel = require("
|
|
201
|
+
import CompanyProfilePlatformModel = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformModel");
|