@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- 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 +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- 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 +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- 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/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- 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 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,76 +1,17 @@
|
|
|
1
1
|
export = CommunicationPlatformValidator;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef GetSystemNotificationsParam
|
|
4
|
-
* @property {number} [pageNo]
|
|
5
|
-
* @property {number} [pageSize]
|
|
6
|
-
* @property {string} [sort] - To sort based on created_at
|
|
7
|
-
* @property {string} [query] - To search based on plain text
|
|
8
|
-
*/
|
|
9
|
-
/**
|
|
10
|
-
* @typedef SenByCompanyCommunicationAsynchronouslyParam
|
|
11
|
-
* @property {string} xApplicationId - Application id
|
|
12
|
-
* @property {CommunicationPlatformModel.EngineRequest} body
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* @typedef SendByCompanyCommunicationInstantlyParam
|
|
16
|
-
* @property {string} xApplicationId - Application id
|
|
17
|
-
* @property {CommunicationPlatformModel.EngineRequest} body
|
|
18
|
-
*/
|
|
19
|
-
/**
|
|
20
|
-
* @typedef SendByCompanyCommunicationSynchronouslyParam
|
|
21
|
-
* @property {string} xApplicationId - Application id
|
|
22
|
-
* @property {CommunicationPlatformModel.EngineRequest} body
|
|
4
|
+
* @property {number} [pageNo]
|
|
5
|
+
* @property {number} [pageSize]
|
|
23
6
|
*/
|
|
24
7
|
declare class CommunicationPlatformValidator {
|
|
25
8
|
/** @returns {GetSystemNotificationsParam} */
|
|
26
9
|
static getSystemNotifications(): GetSystemNotificationsParam;
|
|
27
|
-
/** @returns {SenByCompanyCommunicationAsynchronouslyParam} */
|
|
28
|
-
static senByCompanyCommunicationAsynchronously(): SenByCompanyCommunicationAsynchronouslyParam;
|
|
29
|
-
/** @returns {SendByCompanyCommunicationInstantlyParam} */
|
|
30
|
-
static sendByCompanyCommunicationInstantly(): SendByCompanyCommunicationInstantlyParam;
|
|
31
|
-
/** @returns {SendByCompanyCommunicationSynchronouslyParam} */
|
|
32
|
-
static sendByCompanyCommunicationSynchronously(): SendByCompanyCommunicationSynchronouslyParam;
|
|
33
10
|
}
|
|
34
11
|
declare namespace CommunicationPlatformValidator {
|
|
35
|
-
export { GetSystemNotificationsParam
|
|
12
|
+
export { GetSystemNotificationsParam };
|
|
36
13
|
}
|
|
37
14
|
type GetSystemNotificationsParam = {
|
|
38
|
-
/**
|
|
39
|
-
* - Current page no
|
|
40
|
-
*/
|
|
41
15
|
pageNo?: number;
|
|
42
|
-
/**
|
|
43
|
-
* - Current request items count
|
|
44
|
-
*/
|
|
45
16
|
pageSize?: number;
|
|
46
|
-
/**
|
|
47
|
-
* - To sort based on created_at
|
|
48
|
-
*/
|
|
49
|
-
sort?: string;
|
|
50
|
-
/**
|
|
51
|
-
* - To search based on plain text
|
|
52
|
-
*/
|
|
53
|
-
query?: string;
|
|
54
|
-
};
|
|
55
|
-
type SenByCompanyCommunicationAsynchronouslyParam = {
|
|
56
|
-
/**
|
|
57
|
-
* - Application id
|
|
58
|
-
*/
|
|
59
|
-
xApplicationId: string;
|
|
60
|
-
body: CommunicationPlatformModel.EngineRequest;
|
|
61
|
-
};
|
|
62
|
-
type SendByCompanyCommunicationInstantlyParam = {
|
|
63
|
-
/**
|
|
64
|
-
* - Application id
|
|
65
|
-
*/
|
|
66
|
-
xApplicationId: string;
|
|
67
|
-
body: CommunicationPlatformModel.EngineRequest;
|
|
68
|
-
};
|
|
69
|
-
type SendByCompanyCommunicationSynchronouslyParam = {
|
|
70
|
-
/**
|
|
71
|
-
* - Application id
|
|
72
|
-
*/
|
|
73
|
-
xApplicationId: string;
|
|
74
|
-
body: CommunicationPlatformModel.EngineRequest;
|
|
75
17
|
};
|
|
76
|
-
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
@@ -4,28 +4,8 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* @typedef GetSystemNotificationsParam
|
|
7
|
-
* @property {number} [pageNo]
|
|
8
|
-
* @property {number} [pageSize]
|
|
9
|
-
* @property {string} [sort] - To sort based on created_at
|
|
10
|
-
* @property {string} [query] - To search based on plain text
|
|
11
|
-
*/
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* @typedef SenByCompanyCommunicationAsynchronouslyParam
|
|
15
|
-
* @property {string} xApplicationId - Application id
|
|
16
|
-
* @property {CommunicationPlatformModel.EngineRequest} body
|
|
17
|
-
*/
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @typedef SendByCompanyCommunicationInstantlyParam
|
|
21
|
-
* @property {string} xApplicationId - Application id
|
|
22
|
-
* @property {CommunicationPlatformModel.EngineRequest} body
|
|
23
|
-
*/
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* @typedef SendByCompanyCommunicationSynchronouslyParam
|
|
27
|
-
* @property {string} xApplicationId - Application id
|
|
28
|
-
* @property {CommunicationPlatformModel.EngineRequest} body
|
|
7
|
+
* @property {number} [pageNo]
|
|
8
|
+
* @property {number} [pageSize]
|
|
29
9
|
*/
|
|
30
10
|
|
|
31
11
|
class CommunicationPlatformValidator {
|
|
@@ -34,32 +14,6 @@ class CommunicationPlatformValidator {
|
|
|
34
14
|
return Joi.object({
|
|
35
15
|
pageNo: Joi.number(),
|
|
36
16
|
pageSize: Joi.number(),
|
|
37
|
-
sort: Joi.string().allow(""),
|
|
38
|
-
query: Joi.string().allow(""),
|
|
39
|
-
}).required();
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
/** @returns {SenByCompanyCommunicationAsynchronouslyParam} */
|
|
43
|
-
static senByCompanyCommunicationAsynchronously() {
|
|
44
|
-
return Joi.object({
|
|
45
|
-
xApplicationId: Joi.string().allow("").required(),
|
|
46
|
-
body: CommunicationPlatformModel.EngineRequest().required(),
|
|
47
|
-
}).required();
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/** @returns {SendByCompanyCommunicationInstantlyParam} */
|
|
51
|
-
static sendByCompanyCommunicationInstantly() {
|
|
52
|
-
return Joi.object({
|
|
53
|
-
xApplicationId: Joi.string().allow("").required(),
|
|
54
|
-
body: CommunicationPlatformModel.EngineRequest().required(),
|
|
55
|
-
}).required();
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
/** @returns {SendByCompanyCommunicationSynchronouslyParam} */
|
|
59
|
-
static sendByCompanyCommunicationSynchronously() {
|
|
60
|
-
return Joi.object({
|
|
61
|
-
xApplicationId: Joi.string().allow("").required(),
|
|
62
|
-
body: CommunicationPlatformModel.EngineRequest().required(),
|
|
63
17
|
}).required();
|
|
64
18
|
}
|
|
65
19
|
}
|
|
@@ -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
|
-
* @description:
|
|
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
|
-
* @summary: Create
|
|
25
|
-
* @description:
|
|
25
|
+
* @summary: Create brand
|
|
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
|
-
* @summary: Create
|
|
38
|
-
* @description:
|
|
39
|
+
* @summary: Create company-brand mapping
|
|
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
|
-
* @summary: Create
|
|
49
|
-
* @description:
|
|
51
|
+
* @summary: Create company stores
|
|
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
|
-
* @summary:
|
|
60
|
-
* @description:
|
|
63
|
+
* @summary: Bulk create company stores
|
|
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
|
-
* @summary:
|
|
71
|
-
* @description:
|
|
75
|
+
* @summary: update brand
|
|
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
|
-
* @summary: Get a
|
|
83
|
-
* @description:
|
|
86
|
+
* @summary: Get a brand
|
|
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
|
-
* @summary:
|
|
95
|
-
* @description:
|
|
97
|
+
* @summary: list company brands
|
|
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.
|
|
104
|
-
* @summary:
|
|
105
|
-
* @description:
|
|
106
|
+
* @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSchema>}
|
|
107
|
+
* @summary: list company brands
|
|
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
|
-
* @description:
|
|
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
|
-
* @summary: Get
|
|
130
|
-
* @description:
|
|
131
|
+
* @summary: Get company stores
|
|
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 `{}`
|
|
@@ -138,75 +140,45 @@ declare class CompanyProfile {
|
|
|
138
140
|
* - Success response
|
|
139
141
|
*
|
|
140
142
|
* @name getLocationTags
|
|
141
|
-
* @summary: Get
|
|
142
|
-
* @description:
|
|
143
|
+
* @summary: Get company store tags
|
|
144
|
+
* @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
145
|
*/
|
|
144
146
|
getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.StoreTagsResponseSchema>;
|
|
145
147
|
/**
|
|
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
|
-
* @summary: Get
|
|
153
|
-
* @description:
|
|
154
|
+
* @summary: Get company specific stores
|
|
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,
|
|
156
|
-
/**
|
|
157
|
-
* @param {Object} arg - Arg object.
|
|
158
|
-
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
159
|
-
* basis of location type.
|
|
160
|
-
* @param {string[]} [arg.storeCodes] - List of up to 50 store codes to
|
|
161
|
-
* fetch. Specify multiple values by repeating the query parameter (e.g.,
|
|
162
|
-
* `?store_codes=high_street&store_codes=main_avenue`). Comma-separated
|
|
163
|
-
* values are not supported.
|
|
164
|
-
* @param {string} [arg.q] - Query that is to be searched.
|
|
165
|
-
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
166
|
-
* unverified companies.
|
|
167
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
168
|
-
* page. Default is 10.
|
|
169
|
-
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
170
|
-
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
171
|
-
* basis of multiple location type.
|
|
172
|
-
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
173
|
-
* basis of multiple location tag.
|
|
174
|
-
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
175
|
-
* @summary: Get list of locations
|
|
176
|
-
* @description: This API allows to view all the locations associated to a company.
|
|
177
|
-
*/
|
|
178
|
-
getLocationsPaginator({ storeType, storeCodes, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
179
|
-
storeType?: string;
|
|
180
|
-
storeCodes?: string[];
|
|
181
|
-
q?: string;
|
|
182
|
-
stage?: string;
|
|
183
|
-
pageSize?: number;
|
|
184
|
-
locationIds?: number[];
|
|
185
|
-
types?: string[];
|
|
186
|
-
tags?: string[];
|
|
187
|
-
}): Paginator<CompanyProfilePlatformModel.LocationListSerializer>;
|
|
157
|
+
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSchema>;
|
|
188
158
|
/**
|
|
189
159
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
190
160
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
191
161
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
192
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
193
|
-
* Success response
|
|
162
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
163
|
+
* - Success response
|
|
164
|
+
*
|
|
194
165
|
* @name updateCompany
|
|
195
|
-
* @summary:
|
|
196
|
-
* @description:
|
|
166
|
+
* @summary: Update company profile
|
|
167
|
+
* @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/).
|
|
197
168
|
*/
|
|
198
|
-
updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
169
|
+
updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
199
170
|
/**
|
|
200
171
|
* @param {CompanyProfilePlatformValidator.UpdateLocationParam} arg - Arg object
|
|
201
172
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
173
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
|
-
* @returns {Promise<CompanyProfilePlatformModel.
|
|
204
|
-
* Success response
|
|
174
|
+
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
|
|
175
|
+
* - Success response
|
|
176
|
+
*
|
|
205
177
|
* @name updateLocation
|
|
206
|
-
* @summary:
|
|
207
|
-
* @description:
|
|
178
|
+
* @summary: Update company stores
|
|
179
|
+
* @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
|
|
208
180
|
*/
|
|
209
|
-
updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.
|
|
181
|
+
updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
|
|
210
182
|
}
|
|
211
183
|
import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
|
|
212
184
|
import CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");
|