@gofynd/fdk-client-javascript 1.2.0 → 1.3.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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -213,7 +213,7 @@ export = PosCartApplicationModel;
|
|
|
213
213
|
* @property {string} [billing_address_id]
|
|
214
214
|
* @property {string} [callback_url]
|
|
215
215
|
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
216
|
-
* @property {
|
|
216
|
+
* @property {Object} [customer_details] - Customer details
|
|
217
217
|
* @property {Object} [delivery_address]
|
|
218
218
|
* @property {Object} [extra_meta]
|
|
219
219
|
* @property {Files[]} [files] - List of file url
|
|
@@ -1093,7 +1093,7 @@ type CartPosCheckoutDetailRequest = {
|
|
|
1093
1093
|
/**
|
|
1094
1094
|
* - Customer details
|
|
1095
1095
|
*/
|
|
1096
|
-
customer_details?:
|
|
1096
|
+
customer_details?: any;
|
|
1097
1097
|
delivery_address?: any;
|
|
1098
1098
|
extra_meta?: any;
|
|
1099
1099
|
/**
|
|
@@ -239,7 +239,7 @@ const Joi = require("joi");
|
|
|
239
239
|
* @property {string} [billing_address_id]
|
|
240
240
|
* @property {string} [callback_url]
|
|
241
241
|
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
242
|
-
* @property {
|
|
242
|
+
* @property {Object} [customer_details] - Customer details
|
|
243
243
|
* @property {Object} [delivery_address]
|
|
244
244
|
* @property {Object} [extra_meta]
|
|
245
245
|
* @property {Files[]} [files] - List of file url
|
|
@@ -1144,7 +1144,7 @@ class PosCartApplicationModel {
|
|
|
1144
1144
|
custom_meta: Joi.array().items(
|
|
1145
1145
|
PosCartApplicationModel.CartCheckoutCustomMeta()
|
|
1146
1146
|
),
|
|
1147
|
-
customer_details:
|
|
1147
|
+
customer_details: Joi.any().allow(null),
|
|
1148
1148
|
delivery_address: Joi.any(),
|
|
1149
1149
|
extra_meta: Joi.any(),
|
|
1150
1150
|
files: Joi.array().items(PosCartApplicationModel.Files()),
|
|
@@ -15,6 +15,7 @@ declare class Rewards {
|
|
|
15
15
|
updateUrls(urls: any): void;
|
|
16
16
|
/**
|
|
17
17
|
* @param {RewardsApplicationValidator.CatalogueOrderParam} arg - Arg object.
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
19
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
19
20
|
* @returns {Promise<RewardsApplicationModel.CatalogueOrderResponse>} -
|
|
20
21
|
* Success response
|
|
@@ -22,18 +23,20 @@ declare class Rewards {
|
|
|
22
23
|
* @summary: Get all transactions of reward points
|
|
23
24
|
* @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/catalogueOrder/).
|
|
24
25
|
*/
|
|
25
|
-
catalogueOrder({ body }?: RewardsApplicationValidator.CatalogueOrderParam, {
|
|
26
|
+
catalogueOrder({ body, requestHeaders }?: RewardsApplicationValidator.CatalogueOrderParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.CatalogueOrderResponse>;
|
|
26
27
|
/**
|
|
27
28
|
* @param {RewardsApplicationValidator.GetOfferByNameParam} arg - Arg object.
|
|
29
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
30
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
29
31
|
* @returns {Promise<RewardsApplicationModel.Offer>} - Success response
|
|
30
32
|
* @name getOfferByName
|
|
31
33
|
* @summary: Get offer by name
|
|
32
34
|
* @description: Use this API to get fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
|
|
33
35
|
*/
|
|
34
|
-
getOfferByName({ name }?: RewardsApplicationValidator.GetOfferByNameParam, {
|
|
36
|
+
getOfferByName({ name, requestHeaders }?: RewardsApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.Offer>;
|
|
35
37
|
/**
|
|
36
38
|
* @param {RewardsApplicationValidator.GetOrderDiscountParam} arg - Arg object.
|
|
39
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
37
40
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
38
41
|
* @returns {Promise<RewardsApplicationModel.OrderDiscountResponse>} -
|
|
39
42
|
* Success response
|
|
@@ -41,17 +44,20 @@ declare class Rewards {
|
|
|
41
44
|
* @summary: Calculates the discount on order-amount
|
|
42
45
|
* @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
|
|
43
46
|
*/
|
|
44
|
-
getOrderDiscount({ body }?: RewardsApplicationValidator.GetOrderDiscountParam, {
|
|
47
|
+
getOrderDiscount({ body, requestHeaders }?: RewardsApplicationValidator.GetOrderDiscountParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.OrderDiscountResponse>;
|
|
45
48
|
/**
|
|
49
|
+
* @param {RewardsApplicationValidator.GetUserPointsParam} arg - Arg object.
|
|
50
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
46
51
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
52
|
* @returns {Promise<RewardsApplicationModel.PointsResponse>} - Success response
|
|
48
53
|
* @name getUserPoints
|
|
49
54
|
* @summary: Get total available points of a user
|
|
50
55
|
* @description: Use this API to retrieve total available points of a user for current application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
|
|
51
56
|
*/
|
|
52
|
-
getUserPoints({
|
|
57
|
+
getUserPoints({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsApplicationModel.PointsResponse>;
|
|
53
58
|
/**
|
|
54
59
|
* @param {RewardsApplicationValidator.GetUserPointsHistoryParam} arg - Arg object.
|
|
60
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
55
61
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
56
62
|
* @returns {Promise<RewardsApplicationModel.PointsHistoryResponse>} -
|
|
57
63
|
* Success response
|
|
@@ -59,7 +65,7 @@ declare class Rewards {
|
|
|
59
65
|
* @summary: Get all transactions of reward points
|
|
60
66
|
* @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPointsHistory/).
|
|
61
67
|
*/
|
|
62
|
-
getUserPointsHistory({ pageId, pageSize }?: RewardsApplicationValidator.GetUserPointsHistoryParam, {
|
|
68
|
+
getUserPointsHistory({ pageId, pageSize, requestHeaders }?: RewardsApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.PointsHistoryResponse>;
|
|
63
69
|
/**
|
|
64
70
|
* @param {Object} arg - Arg object.
|
|
65
71
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
@@ -71,6 +77,8 @@ declare class Rewards {
|
|
|
71
77
|
pageSize?: number;
|
|
72
78
|
}): Paginator<RewardsApplicationModel.PointsHistoryResponse>;
|
|
73
79
|
/**
|
|
80
|
+
* @param {RewardsApplicationValidator.GetUserReferralDetailsParam} arg - Arg object.
|
|
81
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
74
82
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
75
83
|
* @returns {Promise<RewardsApplicationModel.ReferralDetailsResponse>} -
|
|
76
84
|
* Success response
|
|
@@ -78,9 +86,10 @@ declare class Rewards {
|
|
|
78
86
|
* @summary: Get referral details of a user
|
|
79
87
|
* @description: Use this API to retrieve the referral details like referral code of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserReferralDetails/).
|
|
80
88
|
*/
|
|
81
|
-
getUserReferralDetails({
|
|
89
|
+
getUserReferralDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsApplicationModel.ReferralDetailsResponse>;
|
|
82
90
|
/**
|
|
83
91
|
* @param {RewardsApplicationValidator.RedeemReferralCodeParam} arg - Arg object.
|
|
92
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
93
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
85
94
|
* @returns {Promise<RewardsApplicationModel.RedeemReferralCodeResponse>} -
|
|
86
95
|
* Success response
|
|
@@ -88,7 +97,7 @@ declare class Rewards {
|
|
|
88
97
|
* @summary: Redeems a referral code and credits reward points to referee and the referrer as per the configuration
|
|
89
98
|
* @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
|
|
90
99
|
*/
|
|
91
|
-
redeemReferralCode({ body }?: RewardsApplicationValidator.RedeemReferralCodeParam, {
|
|
100
|
+
redeemReferralCode({ body, requestHeaders }?: RewardsApplicationValidator.RedeemReferralCodeParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.RedeemReferralCodeResponse>;
|
|
92
101
|
}
|
|
93
102
|
import RewardsApplicationValidator = require("./RewardsApplicationValidator");
|
|
94
103
|
import RewardsApplicationModel = require("./RewardsApplicationModel");
|
|
@@ -42,6 +42,7 @@ class Rewards {
|
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
44
|
* @param {RewardsApplicationValidator.CatalogueOrderParam} arg - Arg object.
|
|
45
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
45
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
46
47
|
* @returns {Promise<RewardsApplicationModel.CatalogueOrderResponse>} -
|
|
47
48
|
* Success response
|
|
@@ -49,7 +50,10 @@ class Rewards {
|
|
|
49
50
|
* @summary: Get all transactions of reward points
|
|
50
51
|
* @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/catalogueOrder/).
|
|
51
52
|
*/
|
|
52
|
-
async catalogueOrder(
|
|
53
|
+
async catalogueOrder(
|
|
54
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
55
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
56
|
+
) {
|
|
53
57
|
const { error } = RewardsApplicationValidator.catalogueOrder().validate(
|
|
54
58
|
{ body },
|
|
55
59
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -85,12 +89,12 @@ class Rewards {
|
|
|
85
89
|
}),
|
|
86
90
|
query_params,
|
|
87
91
|
body,
|
|
88
|
-
xHeaders,
|
|
89
|
-
{
|
|
92
|
+
{ ...xHeaders, ...requestHeaders },
|
|
93
|
+
{ responseHeaders }
|
|
90
94
|
);
|
|
91
95
|
|
|
92
96
|
let responseData = response;
|
|
93
|
-
if (
|
|
97
|
+
if (responseHeaders) {
|
|
94
98
|
responseData = response[0];
|
|
95
99
|
}
|
|
96
100
|
|
|
@@ -113,13 +117,17 @@ class Rewards {
|
|
|
113
117
|
|
|
114
118
|
/**
|
|
115
119
|
* @param {RewardsApplicationValidator.GetOfferByNameParam} arg - Arg object.
|
|
120
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
116
121
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
117
122
|
* @returns {Promise<RewardsApplicationModel.Offer>} - Success response
|
|
118
123
|
* @name getOfferByName
|
|
119
124
|
* @summary: Get offer by name
|
|
120
125
|
* @description: Use this API to get fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
|
|
121
126
|
*/
|
|
122
|
-
async getOfferByName(
|
|
127
|
+
async getOfferByName(
|
|
128
|
+
{ name, requestHeaders } = { requestHeaders: {} },
|
|
129
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
130
|
+
) {
|
|
123
131
|
const { error } = RewardsApplicationValidator.getOfferByName().validate(
|
|
124
132
|
{ name },
|
|
125
133
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -155,12 +163,12 @@ class Rewards {
|
|
|
155
163
|
}),
|
|
156
164
|
query_params,
|
|
157
165
|
undefined,
|
|
158
|
-
xHeaders,
|
|
159
|
-
{
|
|
166
|
+
{ ...xHeaders, ...requestHeaders },
|
|
167
|
+
{ responseHeaders }
|
|
160
168
|
);
|
|
161
169
|
|
|
162
170
|
let responseData = response;
|
|
163
|
-
if (
|
|
171
|
+
if (responseHeaders) {
|
|
164
172
|
responseData = response[0];
|
|
165
173
|
}
|
|
166
174
|
|
|
@@ -183,6 +191,7 @@ class Rewards {
|
|
|
183
191
|
|
|
184
192
|
/**
|
|
185
193
|
* @param {RewardsApplicationValidator.GetOrderDiscountParam} arg - Arg object.
|
|
194
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
195
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
187
196
|
* @returns {Promise<RewardsApplicationModel.OrderDiscountResponse>} -
|
|
188
197
|
* Success response
|
|
@@ -190,7 +199,10 @@ class Rewards {
|
|
|
190
199
|
* @summary: Calculates the discount on order-amount
|
|
191
200
|
* @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
|
|
192
201
|
*/
|
|
193
|
-
async getOrderDiscount(
|
|
202
|
+
async getOrderDiscount(
|
|
203
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
204
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
205
|
+
) {
|
|
194
206
|
const { error } = RewardsApplicationValidator.getOrderDiscount().validate(
|
|
195
207
|
{ body },
|
|
196
208
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -226,12 +238,12 @@ class Rewards {
|
|
|
226
238
|
}),
|
|
227
239
|
query_params,
|
|
228
240
|
body,
|
|
229
|
-
xHeaders,
|
|
230
|
-
{
|
|
241
|
+
{ ...xHeaders, ...requestHeaders },
|
|
242
|
+
{ responseHeaders }
|
|
231
243
|
);
|
|
232
244
|
|
|
233
245
|
let responseData = response;
|
|
234
|
-
if (
|
|
246
|
+
if (responseHeaders) {
|
|
235
247
|
responseData = response[0];
|
|
236
248
|
}
|
|
237
249
|
|
|
@@ -253,13 +265,18 @@ class Rewards {
|
|
|
253
265
|
}
|
|
254
266
|
|
|
255
267
|
/**
|
|
268
|
+
* @param {RewardsApplicationValidator.GetUserPointsParam} arg - Arg object.
|
|
269
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
270
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
257
271
|
* @returns {Promise<RewardsApplicationModel.PointsResponse>} - Success response
|
|
258
272
|
* @name getUserPoints
|
|
259
273
|
* @summary: Get total available points of a user
|
|
260
274
|
* @description: Use this API to retrieve total available points of a user for current application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
|
|
261
275
|
*/
|
|
262
|
-
async getUserPoints(
|
|
276
|
+
async getUserPoints(
|
|
277
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
278
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
279
|
+
) {
|
|
263
280
|
const { error } = RewardsApplicationValidator.getUserPoints().validate(
|
|
264
281
|
{},
|
|
265
282
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -295,12 +312,12 @@ class Rewards {
|
|
|
295
312
|
}),
|
|
296
313
|
query_params,
|
|
297
314
|
undefined,
|
|
298
|
-
xHeaders,
|
|
299
|
-
{
|
|
315
|
+
{ ...xHeaders, ...requestHeaders },
|
|
316
|
+
{ responseHeaders }
|
|
300
317
|
);
|
|
301
318
|
|
|
302
319
|
let responseData = response;
|
|
303
|
-
if (
|
|
320
|
+
if (responseHeaders) {
|
|
304
321
|
responseData = response[0];
|
|
305
322
|
}
|
|
306
323
|
|
|
@@ -323,6 +340,7 @@ class Rewards {
|
|
|
323
340
|
|
|
324
341
|
/**
|
|
325
342
|
* @param {RewardsApplicationValidator.GetUserPointsHistoryParam} arg - Arg object.
|
|
343
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
326
344
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
327
345
|
* @returns {Promise<RewardsApplicationModel.PointsHistoryResponse>} -
|
|
328
346
|
* Success response
|
|
@@ -331,8 +349,8 @@ class Rewards {
|
|
|
331
349
|
* @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPointsHistory/).
|
|
332
350
|
*/
|
|
333
351
|
async getUserPointsHistory(
|
|
334
|
-
{ pageId, pageSize } = {},
|
|
335
|
-
{
|
|
352
|
+
{ pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
353
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
336
354
|
) {
|
|
337
355
|
const {
|
|
338
356
|
error,
|
|
@@ -373,12 +391,12 @@ class Rewards {
|
|
|
373
391
|
}),
|
|
374
392
|
query_params,
|
|
375
393
|
undefined,
|
|
376
|
-
xHeaders,
|
|
377
|
-
{
|
|
394
|
+
{ ...xHeaders, ...requestHeaders },
|
|
395
|
+
{ responseHeaders }
|
|
378
396
|
);
|
|
379
397
|
|
|
380
398
|
let responseData = response;
|
|
381
|
-
if (
|
|
399
|
+
if (responseHeaders) {
|
|
382
400
|
responseData = response[0];
|
|
383
401
|
}
|
|
384
402
|
|
|
@@ -427,6 +445,8 @@ class Rewards {
|
|
|
427
445
|
}
|
|
428
446
|
|
|
429
447
|
/**
|
|
448
|
+
* @param {RewardsApplicationValidator.GetUserReferralDetailsParam} arg - Arg object.
|
|
449
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
430
450
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
431
451
|
* @returns {Promise<RewardsApplicationModel.ReferralDetailsResponse>} -
|
|
432
452
|
* Success response
|
|
@@ -434,7 +454,10 @@ class Rewards {
|
|
|
434
454
|
* @summary: Get referral details of a user
|
|
435
455
|
* @description: Use this API to retrieve the referral details like referral code of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserReferralDetails/).
|
|
436
456
|
*/
|
|
437
|
-
async getUserReferralDetails(
|
|
457
|
+
async getUserReferralDetails(
|
|
458
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
459
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
460
|
+
) {
|
|
438
461
|
const {
|
|
439
462
|
error,
|
|
440
463
|
} = RewardsApplicationValidator.getUserReferralDetails().validate(
|
|
@@ -472,12 +495,12 @@ class Rewards {
|
|
|
472
495
|
}),
|
|
473
496
|
query_params,
|
|
474
497
|
undefined,
|
|
475
|
-
xHeaders,
|
|
476
|
-
{
|
|
498
|
+
{ ...xHeaders, ...requestHeaders },
|
|
499
|
+
{ responseHeaders }
|
|
477
500
|
);
|
|
478
501
|
|
|
479
502
|
let responseData = response;
|
|
480
|
-
if (
|
|
503
|
+
if (responseHeaders) {
|
|
481
504
|
responseData = response[0];
|
|
482
505
|
}
|
|
483
506
|
|
|
@@ -500,6 +523,7 @@ class Rewards {
|
|
|
500
523
|
|
|
501
524
|
/**
|
|
502
525
|
* @param {RewardsApplicationValidator.RedeemReferralCodeParam} arg - Arg object.
|
|
526
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
503
527
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
504
528
|
* @returns {Promise<RewardsApplicationModel.RedeemReferralCodeResponse>} -
|
|
505
529
|
* Success response
|
|
@@ -507,7 +531,10 @@ class Rewards {
|
|
|
507
531
|
* @summary: Redeems a referral code and credits reward points to referee and the referrer as per the configuration
|
|
508
532
|
* @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
|
|
509
533
|
*/
|
|
510
|
-
async redeemReferralCode(
|
|
534
|
+
async redeemReferralCode(
|
|
535
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
536
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
537
|
+
) {
|
|
511
538
|
const { error } = RewardsApplicationValidator.redeemReferralCode().validate(
|
|
512
539
|
{ body },
|
|
513
540
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -543,12 +570,12 @@ class Rewards {
|
|
|
543
570
|
}),
|
|
544
571
|
query_params,
|
|
545
572
|
body,
|
|
546
|
-
xHeaders,
|
|
547
|
-
{
|
|
573
|
+
{ ...xHeaders, ...requestHeaders },
|
|
574
|
+
{ responseHeaders }
|
|
548
575
|
);
|
|
549
576
|
|
|
550
577
|
let responseData = response;
|
|
551
|
-
if (
|
|
578
|
+
if (responseHeaders) {
|
|
552
579
|
responseData = response[0];
|
|
553
580
|
}
|
|
554
581
|
|
|
@@ -15,67 +15,75 @@ declare class Share {
|
|
|
15
15
|
updateUrls(urls: any): void;
|
|
16
16
|
/**
|
|
17
17
|
* @param {ShareApplicationValidator.CreateShortLinkParam} arg - Arg object.
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
19
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
19
20
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
20
21
|
* @name createShortLink
|
|
21
22
|
* @summary: Create a short link
|
|
22
23
|
* @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/createShortLink/).
|
|
23
24
|
*/
|
|
24
|
-
createShortLink({ body }?: ShareApplicationValidator.CreateShortLinkParam, {
|
|
25
|
+
createShortLink({ body, requestHeaders }?: ShareApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
25
26
|
/**
|
|
27
|
+
* @param {ShareApplicationValidator.GetApplicationQRCodeParam} arg - Arg object.
|
|
28
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
26
29
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
27
30
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
28
31
|
* @name getApplicationQRCode
|
|
29
32
|
* @summary: Create QR Code of an app
|
|
30
33
|
* @description: Use this API to create a QR code of an app for sharing it with users who want to use the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getApplicationQRCode/).
|
|
31
34
|
*/
|
|
32
|
-
getApplicationQRCode({
|
|
35
|
+
getApplicationQRCode({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
33
36
|
/**
|
|
34
37
|
* @param {ShareApplicationValidator.GetCollectionQRCodeBySlugParam} arg - Arg object.
|
|
38
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
39
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
36
40
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
37
41
|
* @name getCollectionQRCodeBySlug
|
|
38
42
|
* @summary: Create QR Code of a collection
|
|
39
43
|
* @description: Use this API to create a QR code of a collection of products for sharing it with users who want to view/purchase the collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getCollectionQRCodeBySlug/).
|
|
40
44
|
*/
|
|
41
|
-
getCollectionQRCodeBySlug({ slug }?: ShareApplicationValidator.GetCollectionQRCodeBySlugParam, {
|
|
45
|
+
getCollectionQRCodeBySlug({ slug, requestHeaders }?: ShareApplicationValidator.GetCollectionQRCodeBySlugParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
42
46
|
/**
|
|
43
47
|
* @param {ShareApplicationValidator.GetOriginalShortLinkByHashParam} arg -
|
|
44
48
|
* Arg object.
|
|
49
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
45
50
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
46
51
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
47
52
|
* @name getOriginalShortLinkByHash
|
|
48
53
|
* @summary: Get original link by hash
|
|
49
54
|
* @description: Use this API to retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getOriginalShortLinkByHash/).
|
|
50
55
|
*/
|
|
51
|
-
getOriginalShortLinkByHash({ hash }?: ShareApplicationValidator.GetOriginalShortLinkByHashParam, {
|
|
56
|
+
getOriginalShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetOriginalShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
52
57
|
/**
|
|
53
58
|
* @param {ShareApplicationValidator.GetProductQRCodeBySlugParam} arg - Arg object.
|
|
59
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
60
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
55
61
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
56
62
|
* @name getProductQRCodeBySlug
|
|
57
63
|
* @summary: Create QR Code of a product
|
|
58
64
|
* @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getProductQRCodeBySlug/).
|
|
59
65
|
*/
|
|
60
|
-
getProductQRCodeBySlug({ slug }?: ShareApplicationValidator.GetProductQRCodeBySlugParam, {
|
|
66
|
+
getProductQRCodeBySlug({ slug, requestHeaders }?: ShareApplicationValidator.GetProductQRCodeBySlugParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
61
67
|
/**
|
|
62
68
|
* @param {ShareApplicationValidator.GetShortLinkByHashParam} arg - Arg object.
|
|
69
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
63
70
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
64
71
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
65
72
|
* @name getShortLinkByHash
|
|
66
73
|
* @summary: Get short link by hash
|
|
67
74
|
* @description: Use this API to get a short link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
|
|
68
75
|
*/
|
|
69
|
-
getShortLinkByHash({ hash }?: ShareApplicationValidator.GetShortLinkByHashParam, {
|
|
76
|
+
getShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
70
77
|
/**
|
|
71
78
|
* @param {ShareApplicationValidator.GetUrlQRCodeParam} arg - Arg object.
|
|
79
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
72
80
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
73
81
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
74
82
|
* @name getUrlQRCode
|
|
75
83
|
* @summary: Create QR Code of a URL
|
|
76
84
|
* @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getUrlQRCode/).
|
|
77
85
|
*/
|
|
78
|
-
getUrlQRCode({ url }?: ShareApplicationValidator.GetUrlQRCodeParam, {
|
|
86
|
+
getUrlQRCode({ url, requestHeaders }?: ShareApplicationValidator.GetUrlQRCodeParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
79
87
|
}
|
|
80
88
|
import ShareApplicationValidator = require("./ShareApplicationValidator");
|
|
81
89
|
import ShareApplicationModel = require("./ShareApplicationModel");
|