@gofynd/fdk-client-javascript 1.1.6 → 1.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 +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -4,55 +4,52 @@ declare class Configuration {
|
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
|
-
* @param {
|
|
8
|
-
* @param {
|
|
9
|
-
* @returns {Promise<Domain>} - Success response
|
|
7
|
+
* @param {ConfigurationPlatformApplicationValidator.AddDomainParam} arg - Arg object
|
|
8
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
+
* @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
|
|
10
|
+
* @name addDomain
|
|
10
11
|
* @summary: Add new domain to current sales channel
|
|
11
|
-
* @description: Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand)
|
|
12
|
+
* @description: Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
|
|
12
13
|
*/
|
|
13
|
-
addDomain({ body }?: {
|
|
14
|
-
body: DomainAddRequest;
|
|
15
|
-
}): Promise<Domain>;
|
|
14
|
+
addDomain({ body }?: ConfigurationPlatformApplicationValidator.AddDomainParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.Domain>;
|
|
16
15
|
/**
|
|
17
|
-
* @param {
|
|
18
|
-
*
|
|
19
|
-
*
|
|
16
|
+
* @param {ConfigurationPlatformApplicationValidator.ChangeDomainTypeParam} arg
|
|
17
|
+
* - Arg object
|
|
18
|
+
*
|
|
19
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
+
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
21
|
+
* @name changeDomainType
|
|
20
22
|
* @summary: Change the type of domain in the current sales channel
|
|
21
|
-
* @description: Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. Use this API to change a domain to either Primary or a Shortlink domain.
|
|
23
|
+
* @description: Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. Use this API to change a domain to either Primary or a Shortlink domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
|
|
22
24
|
*/
|
|
23
|
-
changeDomainType({ body }?: {
|
|
24
|
-
body: UpdateDomainTypeRequest;
|
|
25
|
-
}): Promise<DomainsResponse>;
|
|
25
|
+
changeDomainType({ body }?: ConfigurationPlatformApplicationValidator.ChangeDomainTypeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
26
26
|
/**
|
|
27
|
-
* @param {
|
|
28
|
-
* @returns {Promise<TokenResponse>} - Success response
|
|
27
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
28
|
+
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
29
|
+
* @name getAppApiTokens
|
|
29
30
|
* @summary: Get social tokens for the sales channel
|
|
30
|
-
* @description: Use this API to retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. **Note** - Token values are encrypted with AES encryption using a secret key.
|
|
31
|
+
* @description: Use this API to retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. **Note** - Token values are encrypted with AES encryption using a secret key. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
|
|
31
32
|
*/
|
|
32
|
-
getAppApiTokens({}?:
|
|
33
|
+
getAppApiTokens({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
33
34
|
/**
|
|
34
|
-
* @param {
|
|
35
|
-
* @returns {Promise<ApplicationDetail>} - Success response
|
|
35
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
37
|
+
* @name getAppBasicDetails
|
|
36
38
|
* @summary: Get sales channel details
|
|
37
|
-
* @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information.
|
|
39
|
+
* @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppBasicDetails/).
|
|
38
40
|
*/
|
|
39
|
-
getAppBasicDetails({}?:
|
|
41
|
+
getAppBasicDetails({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
40
42
|
/**
|
|
41
|
-
* @param {
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* @
|
|
46
|
-
*
|
|
47
|
-
* @returns {Promise<CompaniesResponse>} - Success response
|
|
43
|
+
* @param {ConfigurationPlatformApplicationValidator.GetAppCompaniesParam} arg
|
|
44
|
+
* - Arg object
|
|
45
|
+
*
|
|
46
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
47
|
+
* @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
|
|
48
|
+
* @name getAppCompanies
|
|
48
49
|
* @summary: Get companies enabled in the sales channel inventory
|
|
49
|
-
* @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
|
|
50
|
+
* @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
|
|
50
51
|
*/
|
|
51
|
-
getAppCompanies({ uid, pageNo, pageSize }?: {
|
|
52
|
-
uid?: number;
|
|
53
|
-
pageNo?: number;
|
|
54
|
-
pageSize?: number;
|
|
55
|
-
}): Promise<CompaniesResponse>;
|
|
52
|
+
getAppCompanies({ uid, pageNo, pageSize }?: ConfigurationPlatformApplicationValidator.GetAppCompaniesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.CompaniesResponse>;
|
|
56
53
|
/**
|
|
57
54
|
* @param {Object} arg - Arg object.
|
|
58
55
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -62,6 +59,7 @@ declare class Configuration {
|
|
|
62
59
|
* @param {number} [arg.uid] - UID of companies to be fetched
|
|
63
60
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
64
61
|
* page. Default value is 10.
|
|
62
|
+
* @returns {Paginator<ConfigurationPlatformModel.CompaniesResponse>}
|
|
65
63
|
* @summary: Get companies enabled in the sales channel inventory
|
|
66
64
|
* @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
|
|
67
65
|
*/
|
|
@@ -70,42 +68,45 @@ declare class Configuration {
|
|
|
70
68
|
applicationId: string;
|
|
71
69
|
uid?: number;
|
|
72
70
|
pageSize?: number;
|
|
73
|
-
}): Paginator
|
|
71
|
+
}): Paginator<ConfigurationPlatformModel.CompaniesResponse>;
|
|
74
72
|
/**
|
|
75
|
-
* @param {
|
|
76
|
-
* @returns {Promise<ApplicationInformation>} -
|
|
73
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
74
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
75
|
+
* Success response
|
|
76
|
+
* @name getAppContactInfo
|
|
77
77
|
* @summary: Get current information of the sales channel
|
|
78
|
-
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
|
|
78
|
+
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
|
|
79
79
|
*/
|
|
80
|
-
getAppContactInfo({}?:
|
|
80
|
+
getAppContactInfo({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
81
81
|
/**
|
|
82
|
-
* @param {
|
|
83
|
-
* @returns {Promise<AppSupportedCurrency>} -
|
|
82
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
83
|
+
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
84
|
+
* Success response
|
|
85
|
+
* @name getAppCurrencyConfig
|
|
84
86
|
* @summary: Get currencies supported in the application
|
|
85
|
-
* @description: Get a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application.
|
|
87
|
+
* @description: Get a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
|
|
86
88
|
*/
|
|
87
|
-
getAppCurrencyConfig({}?:
|
|
89
|
+
getAppCurrencyConfig({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
88
90
|
/**
|
|
89
|
-
* @param {
|
|
90
|
-
* @returns {Promise<AppFeatureResponse>} -
|
|
91
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
92
|
+
* @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
|
|
93
|
+
* Success response
|
|
94
|
+
* @name getAppFeatures
|
|
91
95
|
* @summary: Get the sales channel configuration and features
|
|
92
|
-
* @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
|
|
96
|
+
* @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppFeatures/).
|
|
93
97
|
*/
|
|
94
|
-
getAppFeatures({}?:
|
|
98
|
+
getAppFeatures({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.AppFeatureResponse>;
|
|
95
99
|
/**
|
|
96
|
-
* @param {
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
* @param {
|
|
100
|
-
*
|
|
101
|
-
* @
|
|
100
|
+
* @param {ConfigurationPlatformApplicationValidator.GetAppStoresParam} arg
|
|
101
|
+
* - Arg object
|
|
102
|
+
*
|
|
103
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
|
+
* @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
|
|
105
|
+
* @name getAppStores
|
|
102
106
|
* @summary: Get stores enabled in the sales channel inventory
|
|
103
|
-
* @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
|
|
107
|
+
* @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
|
|
104
108
|
*/
|
|
105
|
-
getAppStores({ pageNo, pageSize }?: {
|
|
106
|
-
pageNo?: number;
|
|
107
|
-
pageSize?: number;
|
|
108
|
-
}): Promise<StoresResponse>;
|
|
109
|
+
getAppStores({ pageNo, pageSize }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.StoresResponse>;
|
|
109
110
|
/**
|
|
110
111
|
* @param {Object} arg - Arg object.
|
|
111
112
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -114,6 +115,7 @@ declare class Configuration {
|
|
|
114
115
|
* application (sales channel website) created within a business account
|
|
115
116
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
116
117
|
* page. Default value is 10.
|
|
118
|
+
* @returns {Paginator<ConfigurationPlatformModel.StoresResponse>}
|
|
117
119
|
* @summary: Get stores enabled in the sales channel inventory
|
|
118
120
|
* @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
|
|
119
121
|
*/
|
|
@@ -121,72 +123,76 @@ declare class Configuration {
|
|
|
121
123
|
companyId: string;
|
|
122
124
|
applicationId: string;
|
|
123
125
|
pageSize?: number;
|
|
124
|
-
}): Paginator
|
|
126
|
+
}): Paginator<ConfigurationPlatformModel.StoresResponse>;
|
|
125
127
|
/**
|
|
126
|
-
* @param {
|
|
127
|
-
* @returns {Promise<AppCurrencyResponse>} -
|
|
128
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
129
|
+
* @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
|
|
130
|
+
* Success response
|
|
131
|
+
* @name getAppSupportedCurrency
|
|
128
132
|
* @summary: Get currencies enabled in the application
|
|
129
|
-
* @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
|
|
133
|
+
* @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppSupportedCurrency/).
|
|
130
134
|
*/
|
|
131
|
-
getAppSupportedCurrency({}?:
|
|
135
|
+
getAppSupportedCurrency({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.AppCurrencyResponse>;
|
|
132
136
|
/**
|
|
133
|
-
* @param {
|
|
134
|
-
* @returns {Promise<Application>} - Success response
|
|
137
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
|
+
* @returns {Promise<ConfigurationPlatformModel.Application>} - Success response
|
|
139
|
+
* @name getApplicationById
|
|
135
140
|
* @summary: Get sales channel data by ID
|
|
136
|
-
* @description: Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.
|
|
141
|
+
* @description: Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
|
|
137
142
|
*/
|
|
138
|
-
getApplicationById({}?:
|
|
143
|
+
getApplicationById({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.Application>;
|
|
139
144
|
/**
|
|
140
|
-
* @param {
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
* @
|
|
145
|
+
* @param {ConfigurationPlatformApplicationValidator.GetBuildConfigParam} arg
|
|
146
|
+
* - Arg object
|
|
147
|
+
*
|
|
148
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
149
|
+
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
150
|
+
* Success response
|
|
151
|
+
* @name getBuildConfig
|
|
144
152
|
* @summary: Get configuration of latest mobile build
|
|
145
|
-
* @description: Fetch latest build configuration, such as app name, landing page image, splash image used in a mobile build.
|
|
153
|
+
* @description: Fetch latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBuildConfig/).
|
|
146
154
|
*/
|
|
147
|
-
getBuildConfig({ platformType }?: {
|
|
148
|
-
platformType: string;
|
|
149
|
-
}): Promise<MobileAppConfiguration>;
|
|
155
|
+
getBuildConfig({ platformType }?: ConfigurationPlatformApplicationValidator.GetBuildConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
150
156
|
/**
|
|
151
|
-
* @param {
|
|
152
|
-
*
|
|
153
|
-
*
|
|
157
|
+
* @param {ConfigurationPlatformApplicationValidator.GetDomainStatusParam} arg
|
|
158
|
+
* - Arg object
|
|
159
|
+
*
|
|
160
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
161
|
+
* @returns {Promise<ConfigurationPlatformModel.DomainStatusResponse>} -
|
|
162
|
+
* Success response
|
|
163
|
+
* @name getDomainStatus
|
|
154
164
|
* @summary: Get the status of connected domain
|
|
155
|
-
* @description: Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers.
|
|
165
|
+
* @description: Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainStatus/).
|
|
156
166
|
*/
|
|
157
|
-
getDomainStatus({ body }?: {
|
|
158
|
-
body: DomainStatusRequest;
|
|
159
|
-
}): Promise<DomainStatusResponse>;
|
|
167
|
+
getDomainStatus({ body }?: ConfigurationPlatformApplicationValidator.GetDomainStatusParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.DomainStatusResponse>;
|
|
160
168
|
/**
|
|
161
|
-
* @param {
|
|
162
|
-
* @returns {Promise<DomainsResponse>} - Success response
|
|
169
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
|
+
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
171
|
+
* @name getDomains
|
|
163
172
|
* @summary: Fetch all the domains added to an application (sales channel website), including pre-defined domain (free domain) or custom domain (owned by the brand). Know the verification status of each domain name, and find out which one is the primary domain, short link domain, or both.
|
|
164
|
-
* @description: Get list of domains
|
|
173
|
+
* @description: Get list of domains - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
165
174
|
*/
|
|
166
|
-
getDomains({}?:
|
|
175
|
+
getDomains({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
167
176
|
/**
|
|
168
|
-
* @param {
|
|
169
|
-
* @returns {Promise<ApplicationInventory>} -
|
|
177
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
178
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
179
|
+
* Success response
|
|
180
|
+
* @name getInventoryConfig
|
|
170
181
|
* @summary: Get sales channel configuration
|
|
171
|
-
* @description: Use this API to fetch configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
|
|
182
|
+
* @description: Use this API to fetch configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getInventoryConfig/).
|
|
172
183
|
*/
|
|
173
|
-
getInventoryConfig({}?:
|
|
184
|
+
getInventoryConfig({ headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
174
185
|
/**
|
|
175
|
-
* @param {
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
* @param {
|
|
179
|
-
*
|
|
180
|
-
* @
|
|
181
|
-
* @returns {Promise<OrderingStores>} - Success response
|
|
186
|
+
* @param {ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam} arg
|
|
187
|
+
* - Arg object
|
|
188
|
+
*
|
|
189
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
|
+
* @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
|
|
191
|
+
* @name getOrderingStoresByFilter
|
|
182
192
|
* @summary: Get ordering store by filter
|
|
183
|
-
* @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
|
|
193
|
+
* @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
|
|
184
194
|
*/
|
|
185
|
-
getOrderingStoresByFilter({ body, pageNo, pageSize }?: {
|
|
186
|
-
pageNo?: number;
|
|
187
|
-
pageSize?: number;
|
|
188
|
-
body: FilterOrderingStoreRequest;
|
|
189
|
-
}): Promise<OrderingStores>;
|
|
195
|
+
getOrderingStoresByFilter({ body, pageNo, pageSize }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.OrderingStores>;
|
|
190
196
|
/**
|
|
191
197
|
* @param {Object} arg - Arg object.
|
|
192
198
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -195,7 +201,8 @@ declare class Configuration {
|
|
|
195
201
|
* application (sales channel website) created within a business account
|
|
196
202
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
197
203
|
* page. Default value is 10.
|
|
198
|
-
* @param {FilterOrderingStoreRequest} arg.body
|
|
204
|
+
* @param {ConfigurationPlatformModel.FilterOrderingStoreRequest} arg.body
|
|
205
|
+
* @returns {Paginator<ConfigurationPlatformModel.OrderingStores>}
|
|
199
206
|
* @summary: Get ordering store by filter
|
|
200
207
|
* @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
|
|
201
208
|
*/
|
|
@@ -203,35 +210,32 @@ declare class Configuration {
|
|
|
203
210
|
companyId: string;
|
|
204
211
|
applicationId: string;
|
|
205
212
|
pageSize?: number;
|
|
206
|
-
body: FilterOrderingStoreRequest;
|
|
207
|
-
}): Paginator
|
|
208
|
-
/**
|
|
209
|
-
* @param {
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* @
|
|
213
|
+
body: ConfigurationPlatformModel.FilterOrderingStoreRequest;
|
|
214
|
+
}): Paginator<ConfigurationPlatformModel.OrderingStores>;
|
|
215
|
+
/**
|
|
216
|
+
* @param {ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam} arg
|
|
217
|
+
* - Arg object
|
|
218
|
+
*
|
|
219
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
|
+
* @returns {Promise<ConfigurationPlatformModel.BuildVersionHistory>} -
|
|
221
|
+
* Success response
|
|
222
|
+
* @name getPreviousVersions
|
|
213
223
|
* @summary: Get details of previous mobile builds
|
|
214
|
-
* @description: Fetch version details of the app, this includes the build status, build date, version name, latest version, and a lot more.
|
|
224
|
+
* @description: Fetch version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getPreviousVersions/).
|
|
215
225
|
*/
|
|
216
|
-
getPreviousVersions({ platformType }?: {
|
|
217
|
-
platformType: string;
|
|
218
|
-
}): Promise<BuildVersionHistory>;
|
|
226
|
+
getPreviousVersions({ platformType }?: ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.BuildVersionHistory>;
|
|
219
227
|
/**
|
|
220
|
-
* @param {
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* @param {
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
* @
|
|
228
|
+
* @param {ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam} arg
|
|
229
|
+
* - Arg object
|
|
230
|
+
*
|
|
231
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
+
* @returns {Promise<ConfigurationPlatformModel.OrderingStoresResponse>} -
|
|
233
|
+
* Success response
|
|
234
|
+
* @name getStaffOrderingStores
|
|
227
235
|
* @summary: Get deployment stores
|
|
228
|
-
* @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
|
|
236
|
+
* @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
|
|
229
237
|
*/
|
|
230
|
-
getStaffOrderingStores({ pageNo, pageSize, q }?: {
|
|
231
|
-
pageNo?: number;
|
|
232
|
-
pageSize?: number;
|
|
233
|
-
q?: string;
|
|
234
|
-
}): Promise<OrderingStoresResponse>;
|
|
238
|
+
getStaffOrderingStores({ pageNo, pageSize, q }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.OrderingStoresResponse>;
|
|
235
239
|
/**
|
|
236
240
|
* @param {Object} arg - Arg object.
|
|
237
241
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -241,6 +245,7 @@ declare class Configuration {
|
|
|
241
245
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
242
246
|
* page. Default value is 10.
|
|
243
247
|
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
248
|
+
* @returns {Paginator<ConfigurationPlatformModel.OrderingStoresResponse>}
|
|
244
249
|
* @summary: Get deployment stores
|
|
245
250
|
* @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
|
|
246
251
|
*/
|
|
@@ -249,120 +254,135 @@ declare class Configuration {
|
|
|
249
254
|
applicationId: string;
|
|
250
255
|
pageSize?: number;
|
|
251
256
|
q?: string;
|
|
252
|
-
}): Paginator
|
|
253
|
-
/**
|
|
254
|
-
* @param {
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
+
}): Paginator<ConfigurationPlatformModel.OrderingStoresResponse>;
|
|
258
|
+
/**
|
|
259
|
+
* @param {ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam} arg
|
|
260
|
+
* - Arg object
|
|
261
|
+
*
|
|
262
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
263
|
+
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
264
|
+
* @name modifyAppFeatures
|
|
257
265
|
* @summary: Update features of application
|
|
258
|
-
* @description: Update features of application
|
|
266
|
+
* @description: Update features of application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
|
|
259
267
|
*/
|
|
260
|
-
modifyAppFeatures({ body }?: {
|
|
261
|
-
body: AppFeatureRequest;
|
|
262
|
-
}): Promise<AppFeature>;
|
|
268
|
+
modifyAppFeatures({ body }?: ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
263
269
|
/**
|
|
264
|
-
* @param {
|
|
265
|
-
*
|
|
266
|
-
*
|
|
270
|
+
* @param {ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam} arg
|
|
271
|
+
* - Arg object
|
|
272
|
+
*
|
|
273
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
274
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
275
|
+
* Success response
|
|
276
|
+
* @name partiallyUpdateInventoryConfig
|
|
267
277
|
* @summary: Partially update sales channel configuration
|
|
268
|
-
* @description: Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
|
|
278
|
+
* @description: Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
|
|
269
279
|
*/
|
|
270
|
-
partiallyUpdateInventoryConfig({ body }?: {
|
|
271
|
-
body: AppInventoryPartialUpdate;
|
|
272
|
-
}): Promise<ApplicationInventory>;
|
|
280
|
+
partiallyUpdateInventoryConfig({ body }?: ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
273
281
|
/**
|
|
274
|
-
* @param {
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
* @
|
|
282
|
+
* @param {ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam} arg
|
|
283
|
+
* - Arg object
|
|
284
|
+
*
|
|
285
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
286
|
+
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
287
|
+
* Success response
|
|
288
|
+
* @name removeDomainById
|
|
278
289
|
* @summary: Remove attached domain from current sales channel
|
|
279
|
-
* @description: Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain.
|
|
290
|
+
* @description: Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
|
|
280
291
|
*/
|
|
281
|
-
removeDomainById({ id }?: {
|
|
282
|
-
id: string;
|
|
283
|
-
}): Promise<SuccessMessageResponse>;
|
|
292
|
+
removeDomainById({ id }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
284
293
|
/**
|
|
285
|
-
* @param {
|
|
286
|
-
*
|
|
287
|
-
*
|
|
294
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam} arg
|
|
295
|
+
* - Arg object
|
|
296
|
+
*
|
|
297
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
298
|
+
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
299
|
+
* @name updateAppApiTokens
|
|
288
300
|
* @summary: Add or update social tokens for the sales channel
|
|
289
|
-
* @description: Use this API to add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth.
|
|
301
|
+
* @description: Use this API to add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppApiTokens/).
|
|
290
302
|
*/
|
|
291
|
-
updateAppApiTokens({ body }?: {
|
|
292
|
-
body: TokenResponse;
|
|
293
|
-
}): Promise<TokenResponse>;
|
|
303
|
+
updateAppApiTokens({ body }?: ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
294
304
|
/**
|
|
295
|
-
* @param {
|
|
296
|
-
*
|
|
297
|
-
*
|
|
305
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam} arg
|
|
306
|
+
* - Arg object
|
|
307
|
+
*
|
|
308
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
309
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
310
|
+
* @name updateAppBasicDetails
|
|
298
311
|
* @summary: Update sales channel details
|
|
299
|
-
* @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information.
|
|
312
|
+
* @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppBasicDetails/).
|
|
300
313
|
*/
|
|
301
|
-
updateAppBasicDetails({ body }?: {
|
|
302
|
-
body: ApplicationDetail;
|
|
303
|
-
}): Promise<ApplicationDetail>;
|
|
314
|
+
updateAppBasicDetails({ body }?: ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
304
315
|
/**
|
|
305
|
-
* @param {
|
|
306
|
-
*
|
|
307
|
-
*
|
|
316
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam} arg
|
|
317
|
+
* - Arg object
|
|
318
|
+
*
|
|
319
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
320
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
321
|
+
* Success response
|
|
322
|
+
* @name updateAppContactInfo
|
|
308
323
|
* @summary: Save or update current information of the sales channel
|
|
309
|
-
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
|
|
324
|
+
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
|
|
310
325
|
*/
|
|
311
|
-
updateAppContactInfo({ body }?: {
|
|
312
|
-
body: ApplicationInformation;
|
|
313
|
-
}): Promise<ApplicationInformation>;
|
|
326
|
+
updateAppContactInfo({ body }?: ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
314
327
|
/**
|
|
315
|
-
* @param {
|
|
316
|
-
*
|
|
317
|
-
*
|
|
328
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam} arg
|
|
329
|
+
* - Arg object
|
|
330
|
+
*
|
|
331
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
332
|
+
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
333
|
+
* Success response
|
|
334
|
+
* @name updateAppCurrencyConfig
|
|
318
335
|
* @summary: Update initial sales channel supported currency
|
|
319
|
-
* @description: Use this API to add and edit the currencies supported in the application. Initially, INR will be enabled by default.
|
|
336
|
+
* @description: Use this API to add and edit the currencies supported in the application. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
|
|
320
337
|
*/
|
|
321
|
-
updateAppCurrencyConfig({ body }?: {
|
|
322
|
-
body: AppSupportedCurrency;
|
|
323
|
-
}): Promise<AppSupportedCurrency>;
|
|
338
|
+
updateAppCurrencyConfig({ body }?: ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
324
339
|
/**
|
|
325
|
-
* @param {
|
|
326
|
-
*
|
|
327
|
-
*
|
|
340
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam} arg
|
|
341
|
+
* - Arg object
|
|
342
|
+
*
|
|
343
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
344
|
+
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
345
|
+
* @name updateAppFeatures
|
|
328
346
|
* @summary: Update the sales channel configuration and features
|
|
329
|
-
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
|
|
347
|
+
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppFeatures/).
|
|
330
348
|
*/
|
|
331
|
-
updateAppFeatures({ body }?: {
|
|
332
|
-
body: AppFeatureRequest;
|
|
333
|
-
}): Promise<AppFeature>;
|
|
349
|
+
updateAppFeatures({ body }?: ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
334
350
|
/**
|
|
335
|
-
* @param {
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
* @param {
|
|
339
|
-
* @returns {Promise<MobileAppConfiguration>} -
|
|
351
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateBuildConfigParam} arg
|
|
352
|
+
* - Arg object
|
|
353
|
+
*
|
|
354
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
355
|
+
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
356
|
+
* Success response
|
|
357
|
+
* @name updateBuildConfig
|
|
340
358
|
* @summary: Update the configuration for next mobile build
|
|
341
|
-
* @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build.
|
|
359
|
+
* @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateBuildConfig/).
|
|
342
360
|
*/
|
|
343
|
-
updateBuildConfig({ platformType, body }?: {
|
|
344
|
-
platformType: string;
|
|
345
|
-
body: MobileAppConfigRequest;
|
|
346
|
-
}): Promise<MobileAppConfiguration>;
|
|
361
|
+
updateBuildConfig({ platformType, body }?: ConfigurationPlatformApplicationValidator.UpdateBuildConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
347
362
|
/**
|
|
348
|
-
* @param {
|
|
349
|
-
*
|
|
350
|
-
*
|
|
363
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateInventoryConfigParam} arg
|
|
364
|
+
* - Arg object
|
|
365
|
+
*
|
|
366
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
368
|
+
* Success response
|
|
369
|
+
* @name updateInventoryConfig
|
|
351
370
|
* @summary: Update sales channel configuration
|
|
352
|
-
* @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
|
|
371
|
+
* @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateInventoryConfig/).
|
|
353
372
|
*/
|
|
354
|
-
updateInventoryConfig({ body }?: {
|
|
355
|
-
body: ApplicationInventory;
|
|
356
|
-
}): Promise<ApplicationInventory>;
|
|
373
|
+
updateInventoryConfig({ body }?: ConfigurationPlatformApplicationValidator.UpdateInventoryConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
357
374
|
/**
|
|
358
|
-
* @param {
|
|
359
|
-
*
|
|
360
|
-
*
|
|
375
|
+
* @param {ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam} arg
|
|
376
|
+
* - Arg object
|
|
377
|
+
*
|
|
378
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
379
|
+
* @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
|
|
380
|
+
* @name updateOrderingStoreConfig
|
|
361
381
|
* @summary: Add/Update ordering store config
|
|
362
|
-
* @description: Use this API to edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders)
|
|
382
|
+
* @description: Use this API to edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
|
|
363
383
|
*/
|
|
364
|
-
updateOrderingStoreConfig({ body }?: {
|
|
365
|
-
body: OrderingStoreConfig;
|
|
366
|
-
}): Promise<DeploymentMeta>;
|
|
384
|
+
updateOrderingStoreConfig({ body }?: ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.DeploymentMeta>;
|
|
367
385
|
}
|
|
386
|
+
import ConfigurationPlatformApplicationValidator = require("./ConfigurationPlatformApplicationValidator");
|
|
387
|
+
import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
368
388
|
import Paginator = require("../../common/Paginator");
|