@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- 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 +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- 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 +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- 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 +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- 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 +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -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/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -14,16 +14,16 @@ declare class Common {
|
|
|
14
14
|
* @returns {Promise<Locations>} - Success response
|
|
15
15
|
* @name getLocations
|
|
16
16
|
* @summary: Get a location
|
|
17
|
-
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://
|
|
17
|
+
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/getLocations/).
|
|
18
18
|
*/
|
|
19
19
|
getLocations({ locationType, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Locations>;
|
|
20
20
|
/**
|
|
21
21
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
22
22
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
23
|
-
* @returns {Promise<
|
|
23
|
+
* @returns {Promise<ApplicationResponseSchema>} - Success response
|
|
24
24
|
* @name searchApplication
|
|
25
25
|
* @summary: Get sales channel
|
|
26
|
-
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://
|
|
26
|
+
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/searchApplication/).
|
|
27
27
|
*/
|
|
28
|
-
searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
28
|
+
searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponseSchema>;
|
|
29
29
|
}
|
|
@@ -38,7 +38,7 @@ class Common {
|
|
|
38
38
|
* @returns {Promise<Locations>} - Success response
|
|
39
39
|
* @name getLocations
|
|
40
40
|
* @summary: Get a location
|
|
41
|
-
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://
|
|
41
|
+
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/getLocations/).
|
|
42
42
|
*/
|
|
43
43
|
async getLocations(
|
|
44
44
|
{ locationType, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -74,10 +74,10 @@ class Common {
|
|
|
74
74
|
/**
|
|
75
75
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
76
76
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
77
|
-
* @returns {Promise<
|
|
77
|
+
* @returns {Promise<ApplicationResponseSchema>} - Success response
|
|
78
78
|
* @name searchApplication
|
|
79
79
|
* @summary: Get sales channel
|
|
80
|
-
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://
|
|
80
|
+
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/searchApplication/).
|
|
81
81
|
*/
|
|
82
82
|
async searchApplication(
|
|
83
83
|
{ authorization, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -87,7 +87,7 @@ class Common {
|
|
|
87
87
|
query_params["query"] = query;
|
|
88
88
|
|
|
89
89
|
const xHeaders = {};
|
|
90
|
-
xHeaders["authorization"] = authorization;
|
|
90
|
+
if (authorization !== undefined) xHeaders["authorization"] = authorization;
|
|
91
91
|
|
|
92
92
|
const response = await ApplicationAPIClient.execute(
|
|
93
93
|
this._conf,
|
|
@@ -15,7 +15,7 @@ declare class Communication {
|
|
|
15
15
|
* @returns {Promise<CommunicationConsent>} - Success response
|
|
16
16
|
* @name getCommunicationConsent
|
|
17
17
|
* @summary: Retrieve consent status
|
|
18
|
-
* @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://
|
|
18
|
+
* @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/getCommunicationConsent/).
|
|
19
19
|
*/
|
|
20
20
|
getCommunicationConsent({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsent>;
|
|
21
21
|
/**
|
|
@@ -24,7 +24,7 @@ declare class Communication {
|
|
|
24
24
|
* @returns {Promise<PushtokenRes>} - Success response
|
|
25
25
|
* @name upsertAppPushtoken
|
|
26
26
|
* @summary: Update or adds app push token
|
|
27
|
-
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://
|
|
27
|
+
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/upsertAppPushtoken/).
|
|
28
28
|
*/
|
|
29
29
|
upsertAppPushtoken({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PushtokenRes>;
|
|
30
30
|
/**
|
|
@@ -33,7 +33,7 @@ declare class Communication {
|
|
|
33
33
|
* @returns {Promise<CommunicationConsentRes>} - Success response
|
|
34
34
|
* @name upsertCommunicationConsent
|
|
35
35
|
* @summary: Update or adds consent settings
|
|
36
|
-
* @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://
|
|
36
|
+
* @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/upsertCommunicationConsent/).
|
|
37
37
|
*/
|
|
38
38
|
upsertCommunicationConsent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsentRes>;
|
|
39
39
|
}
|
|
@@ -40,7 +40,7 @@ class Communication {
|
|
|
40
40
|
* @returns {Promise<CommunicationConsent>} - Success response
|
|
41
41
|
* @name getCommunicationConsent
|
|
42
42
|
* @summary: Retrieve consent status
|
|
43
|
-
* @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://
|
|
43
|
+
* @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/getCommunicationConsent/).
|
|
44
44
|
*/
|
|
45
45
|
async getCommunicationConsent(
|
|
46
46
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -77,7 +77,7 @@ class Communication {
|
|
|
77
77
|
* @returns {Promise<PushtokenRes>} - Success response
|
|
78
78
|
* @name upsertAppPushtoken
|
|
79
79
|
* @summary: Update or adds app push token
|
|
80
|
-
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://
|
|
80
|
+
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/upsertAppPushtoken/).
|
|
81
81
|
*/
|
|
82
82
|
async upsertAppPushtoken(
|
|
83
83
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -114,7 +114,7 @@ class Communication {
|
|
|
114
114
|
* @returns {Promise<CommunicationConsentRes>} - Success response
|
|
115
115
|
* @name upsertCommunicationConsent
|
|
116
116
|
* @summary: Update or adds consent settings
|
|
117
|
-
* @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://
|
|
117
|
+
* @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/upsertCommunicationConsent/).
|
|
118
118
|
*/
|
|
119
119
|
async upsertCommunicationConsent(
|
|
120
120
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -25,37 +25,58 @@ declare class Configuration {
|
|
|
25
25
|
/**
|
|
26
26
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
27
27
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
28
|
-
* @returns {Promise<
|
|
28
|
+
* @returns {Promise<AppCurrencyResponseSchema>} - Success response
|
|
29
29
|
* @name getAppCurrencies
|
|
30
30
|
* @summary: Get currency configuration
|
|
31
|
-
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://
|
|
31
|
+
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppCurrencies/).
|
|
32
32
|
*/
|
|
33
|
-
getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
33
|
+
getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppCurrencyResponseSchema>;
|
|
34
34
|
/**
|
|
35
35
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
36
36
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
37
|
-
* @returns {Promise<
|
|
37
|
+
* @returns {Promise<AppStaffListResponseSchema>} - Success response
|
|
38
38
|
* @name getAppStaffList
|
|
39
39
|
* @summary: List staff members
|
|
40
|
-
* @description: List all staff members of the sales channel. - Check out [method documentation](https://
|
|
40
|
+
* @description: List all staff members of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffList/).
|
|
41
|
+
*/
|
|
42
|
+
getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponseSchema>;
|
|
43
|
+
/**
|
|
44
|
+
* @param {Object} arg - Arg object.
|
|
45
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
46
|
+
* @param {boolean} [arg.orderIncent] - Select `true` to retrieve the staff
|
|
47
|
+
* members eligible for getting incentives on orders.
|
|
48
|
+
* @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
|
|
49
|
+
* retrieving staff members working at a particular ordering store.
|
|
50
|
+
* @param {string} [arg.user] - ID of the staff. Helps in retrieving the
|
|
51
|
+
* details of a particular staff member.
|
|
52
|
+
* @param {string} [arg.userName] - Username of the member.
|
|
53
|
+
* @returns {Paginator<AppStaffListResponseSchema>}
|
|
54
|
+
* @summary: List staff members
|
|
55
|
+
* @description: List all staff members of the sales channel.
|
|
41
56
|
*/
|
|
42
|
-
|
|
57
|
+
getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, userName, }?: {
|
|
58
|
+
pageSize?: number;
|
|
59
|
+
orderIncent?: boolean;
|
|
60
|
+
orderingStore?: number;
|
|
61
|
+
user?: string;
|
|
62
|
+
userName?: string;
|
|
63
|
+
}): Paginator<AppStaffListResponseSchema>;
|
|
43
64
|
/**
|
|
44
65
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
45
66
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
46
|
-
* @returns {Promise<
|
|
67
|
+
* @returns {Promise<AppStaffResponseSchema>} - Success response
|
|
47
68
|
* @name getAppStaffs
|
|
48
69
|
* @summary: Get staff member
|
|
49
|
-
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://
|
|
70
|
+
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffs/).
|
|
50
71
|
*/
|
|
51
|
-
getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
72
|
+
getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffResponseSchema>;
|
|
52
73
|
/**
|
|
53
74
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
75
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
55
76
|
* @returns {Promise<Application>} - Success response
|
|
56
77
|
* @name getApplication
|
|
57
78
|
* @summary: Get sales channel
|
|
58
|
-
* @description: Get details of the current sales channel. - Check out [method documentation](https://
|
|
79
|
+
* @description: Get details of the current sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getApplication/).
|
|
59
80
|
*/
|
|
60
81
|
getApplication({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Application>;
|
|
61
82
|
/**
|
|
@@ -64,7 +85,7 @@ declare class Configuration {
|
|
|
64
85
|
* @returns {Promise<ApplicationDetail>} - Success response
|
|
65
86
|
* @name getBasicDetails
|
|
66
87
|
* @summary: Get Sales channel
|
|
67
|
-
* @description: Get basic details of the sales channel. - Check out [method documentation](https://
|
|
88
|
+
* @description: Get basic details of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getBasicDetails/).
|
|
68
89
|
*/
|
|
69
90
|
getBasicDetails({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationDetail>;
|
|
70
91
|
/**
|
|
@@ -73,97 +94,98 @@ declare class Configuration {
|
|
|
73
94
|
* @returns {Promise<ApplicationInformation>} - Success response
|
|
74
95
|
* @name getContactInfo
|
|
75
96
|
* @summary: Get sales channel contact
|
|
76
|
-
* @description: Get contact details of the sales channel. - Check out [method documentation](https://
|
|
97
|
+
* @description: Get contact details of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getContactInfo/).
|
|
77
98
|
*/
|
|
78
99
|
getContactInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationInformation>;
|
|
79
100
|
/**
|
|
80
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
81
102
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
82
|
-
* @returns {Promise<
|
|
103
|
+
* @returns {Promise<CurrenciesResponseSchema>} - Success response
|
|
83
104
|
* @name getCurrencies
|
|
84
105
|
* @summary: List currencies
|
|
85
|
-
* @description: List available currencies. - Check out [method documentation](https://
|
|
106
|
+
* @description: List available currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getCurrencies/).
|
|
86
107
|
*/
|
|
87
|
-
getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
108
|
+
getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CurrenciesResponseSchema>;
|
|
88
109
|
/**
|
|
89
110
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
111
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
91
112
|
* @returns {Promise<Currency>} - Success response
|
|
92
113
|
* @name getCurrencyById
|
|
93
114
|
* @summary: Get a currency
|
|
94
|
-
* @description: Get details of the currency. - Check out [method documentation](https://
|
|
115
|
+
* @description: Get details of the currency. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getCurrencyById/).
|
|
95
116
|
*/
|
|
96
117
|
getCurrencyById({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Currency>;
|
|
97
118
|
/**
|
|
98
119
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
120
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
100
|
-
* @returns {Promise<
|
|
121
|
+
* @returns {Promise<AppFeatureResponseSchema>} - Success response
|
|
101
122
|
* @name getFeatures
|
|
102
123
|
* @summary: Get sales channel features
|
|
103
|
-
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://
|
|
124
|
+
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getFeatures/).
|
|
104
125
|
*/
|
|
105
|
-
getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
126
|
+
getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppFeatureResponseSchema>;
|
|
106
127
|
/**
|
|
107
128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
108
129
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
109
|
-
* @returns {Promise<
|
|
130
|
+
* @returns {Promise<AppTokenResponseSchema>} - Success response
|
|
110
131
|
* @name getIntegrationTokens
|
|
111
132
|
* @summary: Get API tokens
|
|
112
|
-
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://
|
|
133
|
+
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getIntegrationTokens/).
|
|
113
134
|
*/
|
|
114
|
-
getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
135
|
+
getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppTokenResponseSchema>;
|
|
115
136
|
/**
|
|
116
137
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
117
138
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
118
|
-
* @returns {Promise<
|
|
139
|
+
* @returns {Promise<LanguageResponseSchema>} - Success response
|
|
119
140
|
* @name getLanguages
|
|
120
141
|
* @summary: List languages
|
|
121
|
-
* @description: List available languages. - Check out [method documentation](https://
|
|
142
|
+
* @description: List available languages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getLanguages/).
|
|
122
143
|
*/
|
|
123
|
-
getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
144
|
+
getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LanguageResponseSchema>;
|
|
124
145
|
/**
|
|
125
146
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
126
147
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
127
|
-
* @returns {Promise<
|
|
148
|
+
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
128
149
|
* @name getOrderingStoreCookie
|
|
129
150
|
* @summary: Create cookies
|
|
130
|
-
* @description: Reset cookie of ordering store. - Check out [method documentation](https://
|
|
151
|
+
* @description: Reset cookie of ordering store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOrderingStoreCookie/).
|
|
131
152
|
*/
|
|
132
|
-
getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
153
|
+
getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponseSchema>;
|
|
133
154
|
/**
|
|
134
155
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
156
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
136
157
|
* @returns {Promise<OrderingStores>} - Success response
|
|
137
158
|
* @name getOrderingStores
|
|
138
159
|
* @summary: List order-enabled selling locations
|
|
139
|
-
* @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://
|
|
160
|
+
* @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOrderingStores/).
|
|
140
161
|
*/
|
|
141
162
|
getOrderingStores({ pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderingStores>;
|
|
142
163
|
/**
|
|
143
164
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
144
165
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
145
|
-
* @returns {Promise<
|
|
166
|
+
* @returns {Promise<ApplicationAboutResponseSchema>} - Success response
|
|
146
167
|
* @name getOwnerInfo
|
|
147
168
|
* @summary: Get sales channel owner
|
|
148
|
-
* @description: Get details of the sales channel owner. - Check out [method documentation](https://
|
|
169
|
+
* @description: Get details of the sales channel owner. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOwnerInfo/).
|
|
149
170
|
*/
|
|
150
|
-
getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
171
|
+
getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationAboutResponseSchema>;
|
|
151
172
|
/**
|
|
152
173
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
153
174
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
154
175
|
* @returns {Promise<OrderingStore>} - Success response
|
|
155
176
|
* @name getStoreDetailById
|
|
156
177
|
* @summary: Get a selling location
|
|
157
|
-
* @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://
|
|
178
|
+
* @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getStoreDetailById/).
|
|
158
179
|
*/
|
|
159
180
|
getStoreDetailById({ storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderingStore>;
|
|
160
181
|
/**
|
|
161
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
183
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<
|
|
184
|
+
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
164
185
|
* @name removeOrderingStoreCookie
|
|
165
186
|
* @summary: Delete store cookie
|
|
166
|
-
* @description: Delete store cookie. - Check out [method documentation](https://
|
|
187
|
+
* @description: Delete store cookie. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
167
188
|
*/
|
|
168
|
-
removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
189
|
+
removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponseSchema>;
|
|
169
190
|
}
|
|
191
|
+
import Paginator = require("../../common/Paginator");
|
|
@@ -26,10 +26,10 @@ class Configuration {
|
|
|
26
26
|
getOrderingStoreCookie:
|
|
27
27
|
"/service/application/configuration/v1.0/ordering-store/select",
|
|
28
28
|
getOrderingStores:
|
|
29
|
-
"/service/application/configuration/
|
|
30
|
-
getOwnerInfo: "/service/application/configuration/
|
|
29
|
+
"/service/application/configuration/v2.0/ordering-store/stores",
|
|
30
|
+
getOwnerInfo: "/service/application/configuration/v2.0/about",
|
|
31
31
|
getStoreDetailById:
|
|
32
|
-
"/service/application/configuration/
|
|
32
|
+
"/service/application/configuration/v2.0/ordering-store/stores/{store_id}",
|
|
33
33
|
removeOrderingStoreCookie:
|
|
34
34
|
"/service/application/configuration/v1.0/ordering-store/select",
|
|
35
35
|
};
|
|
@@ -52,10 +52,10 @@ class Configuration {
|
|
|
52
52
|
/**
|
|
53
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
55
|
-
* @returns {Promise<
|
|
55
|
+
* @returns {Promise<AppCurrencyResponseSchema>} - Success response
|
|
56
56
|
* @name getAppCurrencies
|
|
57
57
|
* @summary: Get currency configuration
|
|
58
|
-
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://
|
|
58
|
+
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppCurrencies/).
|
|
59
59
|
*/
|
|
60
60
|
async getAppCurrencies(
|
|
61
61
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -89,10 +89,10 @@ class Configuration {
|
|
|
89
89
|
/**
|
|
90
90
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
91
91
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
92
|
-
* @returns {Promise<
|
|
92
|
+
* @returns {Promise<AppStaffListResponseSchema>} - Success response
|
|
93
93
|
* @name getAppStaffList
|
|
94
94
|
* @summary: List staff members
|
|
95
|
-
* @description: List all staff members of the sales channel. - Check out [method documentation](https://
|
|
95
|
+
* @description: List all staff members of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffList/).
|
|
96
96
|
*/
|
|
97
97
|
async getAppStaffList(
|
|
98
98
|
{
|
|
@@ -137,13 +137,57 @@ class Configuration {
|
|
|
137
137
|
return response;
|
|
138
138
|
}
|
|
139
139
|
|
|
140
|
+
/**
|
|
141
|
+
* @param {Object} arg - Arg object.
|
|
142
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
143
|
+
* @param {boolean} [arg.orderIncent] - Select `true` to retrieve the staff
|
|
144
|
+
* members eligible for getting incentives on orders.
|
|
145
|
+
* @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
|
|
146
|
+
* retrieving staff members working at a particular ordering store.
|
|
147
|
+
* @param {string} [arg.user] - ID of the staff. Helps in retrieving the
|
|
148
|
+
* details of a particular staff member.
|
|
149
|
+
* @param {string} [arg.userName] - Username of the member.
|
|
150
|
+
* @returns {Paginator<AppStaffListResponseSchema>}
|
|
151
|
+
* @summary: List staff members
|
|
152
|
+
* @description: List all staff members of the sales channel.
|
|
153
|
+
*/
|
|
154
|
+
getAppStaffListPaginator({
|
|
155
|
+
pageSize,
|
|
156
|
+
orderIncent,
|
|
157
|
+
orderingStore,
|
|
158
|
+
user,
|
|
159
|
+
userName,
|
|
160
|
+
} = {}) {
|
|
161
|
+
const paginator = new Paginator();
|
|
162
|
+
const callback = async () => {
|
|
163
|
+
const pageId = paginator.nextId;
|
|
164
|
+
const pageNo = paginator.pageNo;
|
|
165
|
+
const pageType = "number";
|
|
166
|
+
const data = await this.getAppStaffList({
|
|
167
|
+
pageNo: pageNo,
|
|
168
|
+
pageSize: pageSize,
|
|
169
|
+
orderIncent: orderIncent,
|
|
170
|
+
orderingStore: orderingStore,
|
|
171
|
+
user: user,
|
|
172
|
+
userName: userName,
|
|
173
|
+
});
|
|
174
|
+
paginator.setPaginator({
|
|
175
|
+
hasNext: data.page.has_next ? true : false,
|
|
176
|
+
nextId: data.page.next_id,
|
|
177
|
+
});
|
|
178
|
+
return data;
|
|
179
|
+
};
|
|
180
|
+
paginator.setCallback(callback.bind(this));
|
|
181
|
+
return paginator;
|
|
182
|
+
}
|
|
183
|
+
|
|
140
184
|
/**
|
|
141
185
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
142
186
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
143
|
-
* @returns {Promise<
|
|
187
|
+
* @returns {Promise<AppStaffResponseSchema>} - Success response
|
|
144
188
|
* @name getAppStaffs
|
|
145
189
|
* @summary: Get staff member
|
|
146
|
-
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://
|
|
190
|
+
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffs/).
|
|
147
191
|
*/
|
|
148
192
|
async getAppStaffs(
|
|
149
193
|
{ orderIncent, orderingStore, user, requestHeaders } = {
|
|
@@ -185,7 +229,7 @@ class Configuration {
|
|
|
185
229
|
* @returns {Promise<Application>} - Success response
|
|
186
230
|
* @name getApplication
|
|
187
231
|
* @summary: Get sales channel
|
|
188
|
-
* @description: Get details of the current sales channel. - Check out [method documentation](https://
|
|
232
|
+
* @description: Get details of the current sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getApplication/).
|
|
189
233
|
*/
|
|
190
234
|
async getApplication(
|
|
191
235
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -222,7 +266,7 @@ class Configuration {
|
|
|
222
266
|
* @returns {Promise<ApplicationDetail>} - Success response
|
|
223
267
|
* @name getBasicDetails
|
|
224
268
|
* @summary: Get Sales channel
|
|
225
|
-
* @description: Get basic details of the sales channel. - Check out [method documentation](https://
|
|
269
|
+
* @description: Get basic details of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getBasicDetails/).
|
|
226
270
|
*/
|
|
227
271
|
async getBasicDetails(
|
|
228
272
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -259,7 +303,7 @@ class Configuration {
|
|
|
259
303
|
* @returns {Promise<ApplicationInformation>} - Success response
|
|
260
304
|
* @name getContactInfo
|
|
261
305
|
* @summary: Get sales channel contact
|
|
262
|
-
* @description: Get contact details of the sales channel. - Check out [method documentation](https://
|
|
306
|
+
* @description: Get contact details of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getContactInfo/).
|
|
263
307
|
*/
|
|
264
308
|
async getContactInfo(
|
|
265
309
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -293,10 +337,10 @@ class Configuration {
|
|
|
293
337
|
/**
|
|
294
338
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
295
339
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
296
|
-
* @returns {Promise<
|
|
340
|
+
* @returns {Promise<CurrenciesResponseSchema>} - Success response
|
|
297
341
|
* @name getCurrencies
|
|
298
342
|
* @summary: List currencies
|
|
299
|
-
* @description: List available currencies. - Check out [method documentation](https://
|
|
343
|
+
* @description: List available currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getCurrencies/).
|
|
300
344
|
*/
|
|
301
345
|
async getCurrencies(
|
|
302
346
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -333,7 +377,7 @@ class Configuration {
|
|
|
333
377
|
* @returns {Promise<Currency>} - Success response
|
|
334
378
|
* @name getCurrencyById
|
|
335
379
|
* @summary: Get a currency
|
|
336
|
-
* @description: Get details of the currency. - Check out [method documentation](https://
|
|
380
|
+
* @description: Get details of the currency. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getCurrencyById/).
|
|
337
381
|
*/
|
|
338
382
|
async getCurrencyById(
|
|
339
383
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -376,10 +420,10 @@ class Configuration {
|
|
|
376
420
|
/**
|
|
377
421
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
378
422
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
379
|
-
* @returns {Promise<
|
|
423
|
+
* @returns {Promise<AppFeatureResponseSchema>} - Success response
|
|
380
424
|
* @name getFeatures
|
|
381
425
|
* @summary: Get sales channel features
|
|
382
|
-
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://
|
|
426
|
+
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getFeatures/).
|
|
383
427
|
*/
|
|
384
428
|
async getFeatures(
|
|
385
429
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -413,10 +457,10 @@ class Configuration {
|
|
|
413
457
|
/**
|
|
414
458
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
415
459
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
416
|
-
* @returns {Promise<
|
|
460
|
+
* @returns {Promise<AppTokenResponseSchema>} - Success response
|
|
417
461
|
* @name getIntegrationTokens
|
|
418
462
|
* @summary: Get API tokens
|
|
419
|
-
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://
|
|
463
|
+
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getIntegrationTokens/).
|
|
420
464
|
*/
|
|
421
465
|
async getIntegrationTokens(
|
|
422
466
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -450,10 +494,10 @@ class Configuration {
|
|
|
450
494
|
/**
|
|
451
495
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
452
496
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
453
|
-
* @returns {Promise<
|
|
497
|
+
* @returns {Promise<LanguageResponseSchema>} - Success response
|
|
454
498
|
* @name getLanguages
|
|
455
499
|
* @summary: List languages
|
|
456
|
-
* @description: List available languages. - Check out [method documentation](https://
|
|
500
|
+
* @description: List available languages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getLanguages/).
|
|
457
501
|
*/
|
|
458
502
|
async getLanguages(
|
|
459
503
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -487,10 +531,10 @@ class Configuration {
|
|
|
487
531
|
/**
|
|
488
532
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
489
533
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
490
|
-
* @returns {Promise<
|
|
534
|
+
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
491
535
|
* @name getOrderingStoreCookie
|
|
492
536
|
* @summary: Create cookies
|
|
493
|
-
* @description: Reset cookie of ordering store. - Check out [method documentation](https://
|
|
537
|
+
* @description: Reset cookie of ordering store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOrderingStoreCookie/).
|
|
494
538
|
*/
|
|
495
539
|
async getOrderingStoreCookie(
|
|
496
540
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -527,7 +571,7 @@ class Configuration {
|
|
|
527
571
|
* @returns {Promise<OrderingStores>} - Success response
|
|
528
572
|
* @name getOrderingStores
|
|
529
573
|
* @summary: List order-enabled selling locations
|
|
530
|
-
* @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://
|
|
574
|
+
* @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOrderingStores/).
|
|
531
575
|
*/
|
|
532
576
|
async getOrderingStores(
|
|
533
577
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -564,10 +608,10 @@ class Configuration {
|
|
|
564
608
|
/**
|
|
565
609
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
566
610
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
567
|
-
* @returns {Promise<
|
|
611
|
+
* @returns {Promise<ApplicationAboutResponseSchema>} - Success response
|
|
568
612
|
* @name getOwnerInfo
|
|
569
613
|
* @summary: Get sales channel owner
|
|
570
|
-
* @description: Get details of the sales channel owner. - Check out [method documentation](https://
|
|
614
|
+
* @description: Get details of the sales channel owner. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOwnerInfo/).
|
|
571
615
|
*/
|
|
572
616
|
async getOwnerInfo(
|
|
573
617
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -604,7 +648,7 @@ class Configuration {
|
|
|
604
648
|
* @returns {Promise<OrderingStore>} - Success response
|
|
605
649
|
* @name getStoreDetailById
|
|
606
650
|
* @summary: Get a selling location
|
|
607
|
-
* @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://
|
|
651
|
+
* @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getStoreDetailById/).
|
|
608
652
|
*/
|
|
609
653
|
async getStoreDetailById(
|
|
610
654
|
{ storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -647,10 +691,10 @@ class Configuration {
|
|
|
647
691
|
/**
|
|
648
692
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
649
693
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
650
|
-
* @returns {Promise<
|
|
694
|
+
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
651
695
|
* @name removeOrderingStoreCookie
|
|
652
696
|
* @summary: Delete store cookie
|
|
653
|
-
* @description: Delete store cookie. - Check out [method documentation](https://
|
|
697
|
+
* @description: Delete store cookie. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
654
698
|
*/
|
|
655
699
|
async removeOrderingStoreCookie(
|
|
656
700
|
{ requestHeaders } = { requestHeaders: {} },
|