@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -8,7 +8,7 @@ declare class Payment {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
|
|
10
10
|
* @name activateAndDectivatePayout
|
|
11
|
-
* @summary: Activate/Deactivate payout
|
|
11
|
+
* @summary: Activate/Deactivate payout
|
|
12
12
|
* @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
|
|
13
13
|
*/
|
|
14
14
|
activateAndDectivatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.ActivateAndDectivatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
|
|
@@ -18,7 +18,7 @@ declare class Payment {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
|
|
20
20
|
* @name deletePayout
|
|
21
|
-
* @summary: Delete payout
|
|
21
|
+
* @summary: Delete payout
|
|
22
22
|
* @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
|
|
23
23
|
*/
|
|
24
24
|
deletePayout({ uniqueTransferNo, requestHeaders }?: PaymentPlatformValidator.DeletePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeletePayoutResponse>;
|
|
@@ -32,7 +32,7 @@ declare class Payment {
|
|
|
32
32
|
* - Success response
|
|
33
33
|
*
|
|
34
34
|
* @name deleteSubscriptionPaymentMethod
|
|
35
|
-
* @summary: Delete subscription payment method
|
|
35
|
+
* @summary: Delete subscription payment method
|
|
36
36
|
* @description: Remove a payment method from subscription options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
|
|
37
37
|
*/
|
|
38
38
|
deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId, requestHeaders }?: PaymentPlatformValidator.DeleteSubscriptionPaymentMethodParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeleteSubscriptionPaymentMethodResponse>;
|
|
@@ -42,7 +42,7 @@ declare class Payment {
|
|
|
42
42
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
43
43
|
* @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
|
|
44
44
|
* @name getAllPayouts
|
|
45
|
-
* @summary:
|
|
45
|
+
* @summary: List payouts
|
|
46
46
|
* @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
|
|
47
47
|
*/
|
|
48
48
|
getAllPayouts({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetAllPayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutsResponse>;
|
|
@@ -53,7 +53,7 @@ declare class Payment {
|
|
|
53
53
|
* @returns {Promise<PaymentPlatformModel.SubscriptionConfigResponse>} -
|
|
54
54
|
* Success response
|
|
55
55
|
* @name getSubscriptionConfig
|
|
56
|
-
* @summary: Get subscription config
|
|
56
|
+
* @summary: Get subscription config
|
|
57
57
|
* @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
|
|
58
58
|
*/
|
|
59
59
|
getSubscriptionConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.SubscriptionConfigResponse>;
|
|
@@ -67,7 +67,7 @@ declare class Payment {
|
|
|
67
67
|
* - Success response
|
|
68
68
|
*
|
|
69
69
|
* @name getSubscriptionPaymentMethod
|
|
70
|
-
* @summary: Get subscription payment method
|
|
70
|
+
* @summary: Get subscription payment method
|
|
71
71
|
* @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
|
|
72
72
|
*/
|
|
73
73
|
getSubscriptionPaymentMethod({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetSubscriptionPaymentMethodParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SubscriptionPaymentMethodResponse>;
|
|
@@ -77,7 +77,7 @@ declare class Payment {
|
|
|
77
77
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
78
78
|
* @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
|
|
79
79
|
* @name savePayout
|
|
80
|
-
* @summary: Save payout
|
|
80
|
+
* @summary: Save payout
|
|
81
81
|
* @description: Store and process a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
|
|
82
82
|
*/
|
|
83
83
|
savePayout({ body, requestHeaders }?: PaymentPlatformValidator.SavePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutResponse>;
|
|
@@ -89,7 +89,7 @@ declare class Payment {
|
|
|
89
89
|
* - Success response
|
|
90
90
|
*
|
|
91
91
|
* @name saveSubscriptionSetupIntent
|
|
92
|
-
* @summary: Save subscription setup intent
|
|
92
|
+
* @summary: Save subscription setup intent
|
|
93
93
|
* @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
|
|
94
94
|
*/
|
|
95
95
|
saveSubscriptionSetupIntent({ body, requestHeaders }?: PaymentPlatformValidator.SaveSubscriptionSetupIntentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SaveSubscriptionSetupIntentResponse>;
|
|
@@ -99,7 +99,7 @@ declare class Payment {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
|
|
101
101
|
* @name updatePayout
|
|
102
|
-
* @summary: Update payout
|
|
102
|
+
* @summary: Update payout
|
|
103
103
|
* @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
|
|
104
104
|
*/
|
|
105
105
|
updatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.UpdatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
|
|
@@ -109,10 +109,10 @@ declare class Payment {
|
|
|
109
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
110
|
* @returns {Promise<PaymentPlatformModel.IfscCodeResponse>} - Success response
|
|
111
111
|
* @name verifyIfscCode
|
|
112
|
-
* @summary: Verify IFSC code
|
|
113
|
-
* @description:
|
|
112
|
+
* @summary: Verify IFSC code
|
|
113
|
+
* @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
|
|
114
114
|
*/
|
|
115
115
|
verifyIfscCode({ ifscCode, requestHeaders }?: PaymentPlatformValidator.VerifyIfscCodeParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.IfscCodeResponse>;
|
|
116
116
|
}
|
|
117
|
-
import PaymentPlatformValidator = require("
|
|
118
|
-
import PaymentPlatformModel = require("
|
|
117
|
+
import PaymentPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformValidator");
|
|
118
|
+
import PaymentPlatformModel = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformModel");
|
|
@@ -20,7 +20,7 @@ class Payment {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
|
|
22
22
|
* @name activateAndDectivatePayout
|
|
23
|
-
* @summary: Activate/Deactivate payout
|
|
23
|
+
* @summary: Activate/Deactivate payout
|
|
24
24
|
* @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
|
|
25
25
|
*/
|
|
26
26
|
async activateAndDectivatePayout(
|
|
@@ -103,7 +103,7 @@ class Payment {
|
|
|
103
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
104
|
* @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
|
|
105
105
|
* @name deletePayout
|
|
106
|
-
* @summary: Delete payout
|
|
106
|
+
* @summary: Delete payout
|
|
107
107
|
* @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
|
|
108
108
|
*/
|
|
109
109
|
async deletePayout(
|
|
@@ -186,7 +186,7 @@ class Payment {
|
|
|
186
186
|
* - Success response
|
|
187
187
|
*
|
|
188
188
|
* @name deleteSubscriptionPaymentMethod
|
|
189
|
-
* @summary: Delete subscription payment method
|
|
189
|
+
* @summary: Delete subscription payment method
|
|
190
190
|
* @description: Remove a payment method from subscription options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
|
|
191
191
|
*/
|
|
192
192
|
async deleteSubscriptionPaymentMethod(
|
|
@@ -273,7 +273,7 @@ class Payment {
|
|
|
273
273
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
274
274
|
* @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
|
|
275
275
|
* @name getAllPayouts
|
|
276
|
-
* @summary:
|
|
276
|
+
* @summary: List payouts
|
|
277
277
|
* @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
|
|
278
278
|
*/
|
|
279
279
|
async getAllPayouts(
|
|
@@ -354,7 +354,7 @@ class Payment {
|
|
|
354
354
|
* @returns {Promise<PaymentPlatformModel.SubscriptionConfigResponse>} -
|
|
355
355
|
* Success response
|
|
356
356
|
* @name getSubscriptionConfig
|
|
357
|
-
* @summary: Get subscription config
|
|
357
|
+
* @summary: Get subscription config
|
|
358
358
|
* @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
|
|
359
359
|
*/
|
|
360
360
|
async getSubscriptionConfig(
|
|
@@ -433,7 +433,7 @@ class Payment {
|
|
|
433
433
|
* - Success response
|
|
434
434
|
*
|
|
435
435
|
* @name getSubscriptionPaymentMethod
|
|
436
|
-
* @summary: Get subscription payment method
|
|
436
|
+
* @summary: Get subscription payment method
|
|
437
437
|
* @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
|
|
438
438
|
*/
|
|
439
439
|
async getSubscriptionPaymentMethod(
|
|
@@ -515,7 +515,7 @@ class Payment {
|
|
|
515
515
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
516
516
|
* @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
|
|
517
517
|
* @name savePayout
|
|
518
|
-
* @summary: Save payout
|
|
518
|
+
* @summary: Save payout
|
|
519
519
|
* @description: Store and process a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
|
|
520
520
|
*/
|
|
521
521
|
async savePayout(
|
|
@@ -594,7 +594,7 @@ class Payment {
|
|
|
594
594
|
* - Success response
|
|
595
595
|
*
|
|
596
596
|
* @name saveSubscriptionSetupIntent
|
|
597
|
-
* @summary: Save subscription setup intent
|
|
597
|
+
* @summary: Save subscription setup intent
|
|
598
598
|
* @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
|
|
599
599
|
*/
|
|
600
600
|
async saveSubscriptionSetupIntent(
|
|
@@ -675,7 +675,7 @@ class Payment {
|
|
|
675
675
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
676
676
|
* @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
|
|
677
677
|
* @name updatePayout
|
|
678
|
-
* @summary: Update payout
|
|
678
|
+
* @summary: Update payout
|
|
679
679
|
* @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
|
|
680
680
|
*/
|
|
681
681
|
async updatePayout(
|
|
@@ -756,8 +756,8 @@ class Payment {
|
|
|
756
756
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
757
757
|
* @returns {Promise<PaymentPlatformModel.IfscCodeResponse>} - Success response
|
|
758
758
|
* @name verifyIfscCode
|
|
759
|
-
* @summary: Verify IFSC code
|
|
760
|
-
* @description:
|
|
759
|
+
* @summary: Verify IFSC code
|
|
760
|
+
* @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
|
|
761
761
|
*/
|
|
762
762
|
async verifyIfscCode(
|
|
763
763
|
{ ifscCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -929,6 +929,8 @@ export = PaymentPlatformModel;
|
|
|
929
929
|
* reversal of payment.
|
|
930
930
|
* @property {string} [receipt_number] - Unique receipt for refund, generated by
|
|
931
931
|
* payment gateway, if not available can be utr.
|
|
932
|
+
* @property {string} [pg_refund_id] - Unique identifier for refund, generated
|
|
933
|
+
* by payment gateway.
|
|
932
934
|
* @property {string} currency - Currency of the payment.
|
|
933
935
|
* @property {string} [transfer_reversal] - Description in case of reversal of payment.
|
|
934
936
|
* @property {string} [balance_transaction] - Balance transaction.
|
|
@@ -3616,6 +3618,11 @@ type RefundSessionDetail = {
|
|
|
3616
3618
|
* payment gateway, if not available can be utr.
|
|
3617
3619
|
*/
|
|
3618
3620
|
receipt_number?: string;
|
|
3621
|
+
/**
|
|
3622
|
+
* - Unique identifier for refund, generated
|
|
3623
|
+
* by payment gateway.
|
|
3624
|
+
*/
|
|
3625
|
+
pg_refund_id?: string;
|
|
3619
3626
|
/**
|
|
3620
3627
|
* - Currency of the payment.
|
|
3621
3628
|
*/
|
|
@@ -1038,6 +1038,8 @@ const Joi = require("joi");
|
|
|
1038
1038
|
* reversal of payment.
|
|
1039
1039
|
* @property {string} [receipt_number] - Unique receipt for refund, generated by
|
|
1040
1040
|
* payment gateway, if not available can be utr.
|
|
1041
|
+
* @property {string} [pg_refund_id] - Unique identifier for refund, generated
|
|
1042
|
+
* by payment gateway.
|
|
1041
1043
|
* @property {string} currency - Currency of the payment.
|
|
1042
1044
|
* @property {string} [transfer_reversal] - Description in case of reversal of payment.
|
|
1043
1045
|
* @property {string} [balance_transaction] - Balance transaction.
|
|
@@ -2560,6 +2562,7 @@ class PaymentPlatformModel {
|
|
|
2560
2562
|
created: Joi.string().allow("").required(),
|
|
2561
2563
|
source_transfer_reversal: Joi.string().allow(""),
|
|
2562
2564
|
receipt_number: Joi.string().allow(""),
|
|
2565
|
+
pg_refund_id: Joi.string().allow(""),
|
|
2563
2566
|
currency: Joi.string().allow("").required(),
|
|
2564
2567
|
transfer_reversal: Joi.string().allow(""),
|
|
2565
2568
|
balance_transaction: Joi.string().allow(""),
|
|
@@ -110,4 +110,4 @@ type VerifyIfscCodeParam = {
|
|
|
110
110
|
ifscCode?: string;
|
|
111
111
|
};
|
|
112
112
|
type GetSubscriptionConfigParam = any;
|
|
113
|
-
import PaymentPlatformModel = require("
|
|
113
|
+
import PaymentPlatformModel = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformModel");
|
|
@@ -13,7 +13,7 @@ declare class APIClient {
|
|
|
13
13
|
* @param {object} xHeaders
|
|
14
14
|
* @param {Options} options
|
|
15
15
|
*/
|
|
16
|
-
static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<any
|
|
16
|
+
static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("sdk/node_modules/axios").AxiosResponse<any, any>>;
|
|
17
17
|
get(url: any, config: any): Promise<any>;
|
|
18
18
|
}
|
|
19
19
|
declare namespace APIClient {
|
|
@@ -12,7 +12,7 @@ declare class PlatformApplicationClient {
|
|
|
12
12
|
* @param {import("./PlatformConfig")} config - The platform configuration.
|
|
13
13
|
*/
|
|
14
14
|
constructor(applicationId: string, config: import("./PlatformConfig"));
|
|
15
|
-
config: import("
|
|
15
|
+
config: import("sdk/output/javascript/code/sdk/platform/PlatformConfig");
|
|
16
16
|
companyId: string;
|
|
17
17
|
applicationId: string;
|
|
18
18
|
cart: Cart;
|
|
@@ -38,18 +38,18 @@ declare class PlatformApplicationClient {
|
|
|
38
38
|
*/
|
|
39
39
|
setExtraHeaders(header: object): void;
|
|
40
40
|
}
|
|
41
|
-
import Cart = require("
|
|
42
|
-
import Catalog = require("
|
|
43
|
-
import Communication = require("
|
|
44
|
-
import Configuration = require("
|
|
45
|
-
import Content = require("
|
|
46
|
-
import FileStorage = require("
|
|
47
|
-
import Lead = require("
|
|
48
|
-
import Serviceability = require("
|
|
49
|
-
import Order = require("
|
|
50
|
-
import Partner = require("
|
|
51
|
-
import Payment = require("
|
|
52
|
-
import Rewards = require("
|
|
53
|
-
import Share = require("
|
|
54
|
-
import Theme = require("
|
|
55
|
-
import User = require("
|
|
41
|
+
import Cart = require("sdk/output/javascript/code/sdk/platform/Cart/CartPlatformApplicationClient");
|
|
42
|
+
import Catalog = require("sdk/output/javascript/code/sdk/platform/Catalog/CatalogPlatformApplicationClient");
|
|
43
|
+
import Communication = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformApplicationClient");
|
|
44
|
+
import Configuration = require("sdk/output/javascript/code/sdk/platform/Configuration/ConfigurationPlatformApplicationClient");
|
|
45
|
+
import Content = require("sdk/output/javascript/code/sdk/platform/Content/ContentPlatformApplicationClient");
|
|
46
|
+
import FileStorage = require("sdk/output/javascript/code/sdk/platform/FileStorage/FileStoragePlatformApplicationClient");
|
|
47
|
+
import Lead = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformApplicationClient");
|
|
48
|
+
import Serviceability = require("sdk/output/javascript/code/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient");
|
|
49
|
+
import Order = require("sdk/output/javascript/code/sdk/platform/Order/OrderPlatformApplicationClient");
|
|
50
|
+
import Partner = require("sdk/output/javascript/code/sdk/platform/Partner/PartnerPlatformApplicationClient");
|
|
51
|
+
import Payment = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformApplicationClient");
|
|
52
|
+
import Rewards = require("sdk/output/javascript/code/sdk/platform/Rewards/RewardsPlatformApplicationClient");
|
|
53
|
+
import Share = require("sdk/output/javascript/code/sdk/platform/Share/SharePlatformApplicationClient");
|
|
54
|
+
import Theme = require("sdk/output/javascript/code/sdk/platform/Theme/ThemePlatformApplicationClient");
|
|
55
|
+
import User = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformApplicationClient");
|
|
@@ -11,7 +11,7 @@ declare class PlatformClient {
|
|
|
11
11
|
* @param {import("./PlatformConfig")} config - The application configuration.
|
|
12
12
|
*/
|
|
13
13
|
constructor(config: import("./PlatformConfig"));
|
|
14
|
-
config: import("
|
|
14
|
+
config: import("sdk/output/javascript/code/sdk/platform/PlatformConfig");
|
|
15
15
|
auditTrail: AuditTrail;
|
|
16
16
|
billing: Billing;
|
|
17
17
|
catalog: Catalog;
|
|
@@ -23,7 +23,6 @@ declare class PlatformClient {
|
|
|
23
23
|
discount: Discount;
|
|
24
24
|
fileStorage: FileStorage;
|
|
25
25
|
finance: Finance;
|
|
26
|
-
inventory: Inventory;
|
|
27
26
|
lead: Lead;
|
|
28
27
|
serviceability: Serviceability;
|
|
29
28
|
order: Order;
|
|
@@ -48,22 +47,21 @@ declare class PlatformClient {
|
|
|
48
47
|
*/
|
|
49
48
|
setExtraHeaders(header: object): void;
|
|
50
49
|
}
|
|
51
|
-
import AuditTrail = require("
|
|
52
|
-
import Billing = require("
|
|
53
|
-
import Catalog = require("
|
|
54
|
-
import Common = require("
|
|
55
|
-
import Communication = require("
|
|
56
|
-
import CompanyProfile = require("
|
|
57
|
-
import Configuration = require("
|
|
58
|
-
import Content = require("
|
|
59
|
-
import Discount = require("
|
|
60
|
-
import FileStorage = require("
|
|
61
|
-
import Finance = require("
|
|
62
|
-
import
|
|
63
|
-
import
|
|
64
|
-
import
|
|
65
|
-
import
|
|
66
|
-
import
|
|
67
|
-
import
|
|
68
|
-
import
|
|
69
|
-
import PlatformApplicationClient = require("./PlatformApplicationClient");
|
|
50
|
+
import AuditTrail = require("sdk/output/javascript/code/sdk/platform/AuditTrail/AuditTrailPlatformClient");
|
|
51
|
+
import Billing = require("sdk/output/javascript/code/sdk/platform/Billing/BillingPlatformClient");
|
|
52
|
+
import Catalog = require("sdk/output/javascript/code/sdk/platform/Catalog/CatalogPlatformClient");
|
|
53
|
+
import Common = require("sdk/output/javascript/code/sdk/platform/Common/CommonPlatformClient");
|
|
54
|
+
import Communication = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformClient");
|
|
55
|
+
import CompanyProfile = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformClient");
|
|
56
|
+
import Configuration = require("sdk/output/javascript/code/sdk/platform/Configuration/ConfigurationPlatformClient");
|
|
57
|
+
import Content = require("sdk/output/javascript/code/sdk/platform/Content/ContentPlatformClient");
|
|
58
|
+
import Discount = require("sdk/output/javascript/code/sdk/platform/Discount/DiscountPlatformClient");
|
|
59
|
+
import FileStorage = require("sdk/output/javascript/code/sdk/platform/FileStorage/FileStoragePlatformClient");
|
|
60
|
+
import Finance = require("sdk/output/javascript/code/sdk/platform/Finance/FinancePlatformClient");
|
|
61
|
+
import Lead = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformClient");
|
|
62
|
+
import Serviceability = require("sdk/output/javascript/code/sdk/platform/Serviceability/ServiceabilityPlatformClient");
|
|
63
|
+
import Order = require("sdk/output/javascript/code/sdk/platform/Order/OrderPlatformClient");
|
|
64
|
+
import Payment = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformClient");
|
|
65
|
+
import Theme = require("sdk/output/javascript/code/sdk/platform/Theme/ThemePlatformClient");
|
|
66
|
+
import Webhook = require("sdk/output/javascript/code/sdk/platform/Webhook/WebhookPlatformClient");
|
|
67
|
+
import PlatformApplicationClient = require("sdk/output/javascript/code/sdk/platform/PlatformApplicationClient");
|
|
@@ -20,8 +20,6 @@ const FileStorage = require("./FileStorage/FileStoragePlatformClient");
|
|
|
20
20
|
|
|
21
21
|
const Finance = require("./Finance/FinancePlatformClient");
|
|
22
22
|
|
|
23
|
-
const Inventory = require("./Inventory/InventoryPlatformClient");
|
|
24
|
-
|
|
25
23
|
const Lead = require("./Lead/LeadPlatformClient");
|
|
26
24
|
|
|
27
25
|
const Serviceability = require("./Serviceability/ServiceabilityPlatformClient");
|
|
@@ -73,8 +71,6 @@ class PlatformClient {
|
|
|
73
71
|
|
|
74
72
|
this.finance = new Finance(config);
|
|
75
73
|
|
|
76
|
-
this.inventory = new Inventory(config);
|
|
77
|
-
|
|
78
74
|
this.lead = new Lead(config);
|
|
79
75
|
|
|
80
76
|
this.serviceability = new Serviceability(config);
|
|
@@ -33,7 +33,7 @@ declare class PlatformConfig {
|
|
|
33
33
|
apiKey: string;
|
|
34
34
|
apiSecret: string;
|
|
35
35
|
useAutoRenewTimer?: boolean;
|
|
36
|
-
logLevel?: "
|
|
36
|
+
logLevel?: "DEBUG" | "TRACE" | "INFO" | "WARN" | "ERROR";
|
|
37
37
|
}, options?: {
|
|
38
38
|
strictResponseCheck?: boolean;
|
|
39
39
|
});
|
|
@@ -43,7 +43,7 @@ declare class PlatformConfig {
|
|
|
43
43
|
apiSecret: string;
|
|
44
44
|
useAutoRenewTimer: boolean;
|
|
45
45
|
oauthClient: OauthClient;
|
|
46
|
-
logLevel: "
|
|
46
|
+
logLevel: "DEBUG" | "TRACE" | "INFO" | "WARN" | "ERROR";
|
|
47
47
|
extraHeaders: any[];
|
|
48
48
|
options: {
|
|
49
49
|
strictResponseCheck: boolean;
|
|
@@ -53,7 +53,7 @@ declare class PlatformConfig {
|
|
|
53
53
|
*
|
|
54
54
|
* @param {logLevelEnum} level - The log level to set.
|
|
55
55
|
*/
|
|
56
|
-
setLogLevel(level: "
|
|
56
|
+
setLogLevel(level: "DEBUG" | "TRACE" | "INFO" | "WARN" | "ERROR"): void;
|
|
57
57
|
/**
|
|
58
58
|
* Retrieves the access token from the OAuth client.
|
|
59
59
|
*
|
|
@@ -62,4 +62,4 @@ declare class PlatformConfig {
|
|
|
62
62
|
*/
|
|
63
63
|
getAccessToken(): Promise<string>;
|
|
64
64
|
}
|
|
65
|
-
import OauthClient = require("
|
|
65
|
+
import OauthClient = require("sdk/output/javascript/code/sdk/platform/OAuthClient");
|
|
@@ -9,7 +9,7 @@ declare class Rewards {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
11
11
|
* @name getGiveawayById
|
|
12
|
-
* @summary: Get giveaway
|
|
12
|
+
* @summary: Get a giveaway
|
|
13
13
|
* @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
|
|
14
14
|
*/
|
|
15
15
|
getGiveawayById({ id, requestHeaders }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
|
|
@@ -19,7 +19,7 @@ declare class Rewards {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<RewardsPlatformModel.Offer>} - Success response
|
|
21
21
|
* @name getOfferByName
|
|
22
|
-
* @summary: Get offer by name
|
|
22
|
+
* @summary: Get offer by name
|
|
23
23
|
* @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
|
|
24
24
|
*/
|
|
25
25
|
getOfferByName({ name, requestHeaders }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
|
|
@@ -31,7 +31,7 @@ declare class Rewards {
|
|
|
31
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
32
|
* @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
|
|
33
33
|
* @name getRewardsConfiguration
|
|
34
|
-
* @summary: Get rewards configuration
|
|
34
|
+
* @summary: Get rewards configuration
|
|
35
35
|
* @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
|
|
36
36
|
*/
|
|
37
37
|
getRewardsConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.ConfigurationRes>;
|
|
@@ -41,7 +41,7 @@ declare class Rewards {
|
|
|
41
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
42
|
* @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
|
|
43
43
|
* @name getUserDetails
|
|
44
|
-
* @summary: Get user
|
|
44
|
+
* @summary: Get a user
|
|
45
45
|
* @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
|
|
46
46
|
*/
|
|
47
47
|
getUserDetails({ userId, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.UserRes>;
|
|
@@ -53,7 +53,7 @@ declare class Rewards {
|
|
|
53
53
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
|
|
55
55
|
* @name getUserPointsHistory
|
|
56
|
-
* @summary: Get user points history
|
|
56
|
+
* @summary: Get reward user points history
|
|
57
57
|
* @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
|
|
58
58
|
*/
|
|
59
59
|
getUserPointsHistory({ userId, pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.HistoryRes>;
|
|
@@ -63,7 +63,7 @@ declare class Rewards {
|
|
|
63
63
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
65
65
|
* @name saveGiveAway
|
|
66
|
-
* @summary:
|
|
66
|
+
* @summary: Create a giveaway
|
|
67
67
|
* @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
|
|
68
68
|
*/
|
|
69
69
|
saveGiveAway({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
|
|
@@ -75,7 +75,7 @@ declare class Rewards {
|
|
|
75
75
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
76
76
|
* @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
|
|
77
77
|
* @name setRewardsConfiguration
|
|
78
|
-
* @summary: Set rewards configuration
|
|
78
|
+
* @summary: Set rewards configuration
|
|
79
79
|
* @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
|
|
80
80
|
*/
|
|
81
81
|
setRewardsConfiguration({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.SetConfigurationRes>;
|
|
@@ -85,7 +85,7 @@ declare class Rewards {
|
|
|
85
85
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
86
|
* @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
|
|
87
87
|
* @name showGiveaways
|
|
88
|
-
* @summary:
|
|
88
|
+
* @summary: List giveaways
|
|
89
89
|
* @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
|
|
90
90
|
*/
|
|
91
91
|
showGiveaways({ pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.GiveawayResponse>;
|
|
@@ -95,7 +95,7 @@ declare class Rewards {
|
|
|
95
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
96
|
* @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
|
|
97
97
|
* @name showOffers
|
|
98
|
-
* @summary:
|
|
98
|
+
* @summary: List offers
|
|
99
99
|
* @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
|
|
100
100
|
*/
|
|
101
101
|
showOffers({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer[]>;
|
|
@@ -105,7 +105,7 @@ declare class Rewards {
|
|
|
105
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
107
107
|
* @name updateGiveAway
|
|
108
|
-
* @summary: Update giveaway
|
|
108
|
+
* @summary: Update a giveaway
|
|
109
109
|
* @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
|
|
110
110
|
*/
|
|
111
111
|
updateGiveAway({ id, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
|
|
@@ -117,7 +117,7 @@ declare class Rewards {
|
|
|
117
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
118
|
* @returns {Promise<RewardsPlatformModel.Offer>} - Success response
|
|
119
119
|
* @name updateOfferByName
|
|
120
|
-
* @summary: Update offer by name
|
|
120
|
+
* @summary: Update offer by name
|
|
121
121
|
* @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
|
|
122
122
|
*/
|
|
123
123
|
updateOfferByName({ name, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
|
|
@@ -127,10 +127,10 @@ declare class Rewards {
|
|
|
127
127
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
128
|
* @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
|
|
129
129
|
* @name updateUserStatus
|
|
130
|
-
* @summary: Update user status
|
|
130
|
+
* @summary: Update user status
|
|
131
131
|
* @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
|
|
132
132
|
*/
|
|
133
133
|
updateUserStatus({ userId, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.AppUser>;
|
|
134
134
|
}
|
|
135
|
-
import RewardsPlatformApplicationValidator = require("
|
|
136
|
-
import RewardsPlatformModel = require("
|
|
135
|
+
import RewardsPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Rewards/RewardsPlatformApplicationValidator");
|
|
136
|
+
import RewardsPlatformModel = require("sdk/output/javascript/code/sdk/platform/Rewards/RewardsPlatformModel");
|
|
@@ -21,7 +21,7 @@ class Rewards {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
23
23
|
* @name getGiveawayById
|
|
24
|
-
* @summary: Get giveaway
|
|
24
|
+
* @summary: Get a giveaway
|
|
25
25
|
* @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
|
|
26
26
|
*/
|
|
27
27
|
async getGiveawayById(
|
|
@@ -100,7 +100,7 @@ class Rewards {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<RewardsPlatformModel.Offer>} - Success response
|
|
102
102
|
* @name getOfferByName
|
|
103
|
-
* @summary: Get offer by name
|
|
103
|
+
* @summary: Get offer by name
|
|
104
104
|
* @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
|
|
105
105
|
*/
|
|
106
106
|
async getOfferByName(
|
|
@@ -177,7 +177,7 @@ class Rewards {
|
|
|
177
177
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
178
178
|
* @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
|
|
179
179
|
* @name getRewardsConfiguration
|
|
180
|
-
* @summary: Get rewards configuration
|
|
180
|
+
* @summary: Get rewards configuration
|
|
181
181
|
* @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
|
|
182
182
|
*/
|
|
183
183
|
async getRewardsConfiguration(
|
|
@@ -252,7 +252,7 @@ class Rewards {
|
|
|
252
252
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
253
253
|
* @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
|
|
254
254
|
* @name getUserDetails
|
|
255
|
-
* @summary: Get user
|
|
255
|
+
* @summary: Get a user
|
|
256
256
|
* @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
|
|
257
257
|
*/
|
|
258
258
|
async getUserDetails(
|
|
@@ -329,7 +329,7 @@ class Rewards {
|
|
|
329
329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
330
330
|
* @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
|
|
331
331
|
* @name getUserPointsHistory
|
|
332
|
-
* @summary: Get user points history
|
|
332
|
+
* @summary: Get reward user points history
|
|
333
333
|
* @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
|
|
334
334
|
*/
|
|
335
335
|
async getUserPointsHistory(
|
|
@@ -416,7 +416,7 @@ class Rewards {
|
|
|
416
416
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
417
417
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
418
418
|
* @name saveGiveAway
|
|
419
|
-
* @summary:
|
|
419
|
+
* @summary: Create a giveaway
|
|
420
420
|
* @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
|
|
421
421
|
*/
|
|
422
422
|
async saveGiveAway(
|
|
@@ -497,7 +497,7 @@ class Rewards {
|
|
|
497
497
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
498
498
|
* @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
|
|
499
499
|
* @name setRewardsConfiguration
|
|
500
|
-
* @summary: Set rewards configuration
|
|
500
|
+
* @summary: Set rewards configuration
|
|
501
501
|
* @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
|
|
502
502
|
*/
|
|
503
503
|
async setRewardsConfiguration(
|
|
@@ -576,7 +576,7 @@ class Rewards {
|
|
|
576
576
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
577
|
* @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
|
|
578
578
|
* @name showGiveaways
|
|
579
|
-
* @summary:
|
|
579
|
+
* @summary: List giveaways
|
|
580
580
|
* @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
|
|
581
581
|
*/
|
|
582
582
|
async showGiveaways(
|
|
@@ -659,7 +659,7 @@ class Rewards {
|
|
|
659
659
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
660
|
* @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
|
|
661
661
|
* @name showOffers
|
|
662
|
-
* @summary:
|
|
662
|
+
* @summary: List offers
|
|
663
663
|
* @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
|
|
664
664
|
*/
|
|
665
665
|
async showOffers(
|
|
@@ -729,7 +729,7 @@ class Rewards {
|
|
|
729
729
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
730
730
|
* @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
|
|
731
731
|
* @name updateGiveAway
|
|
732
|
-
* @summary: Update giveaway
|
|
732
|
+
* @summary: Update a giveaway
|
|
733
733
|
* @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
|
|
734
734
|
*/
|
|
735
735
|
async updateGiveAway(
|
|
@@ -812,7 +812,7 @@ class Rewards {
|
|
|
812
812
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
813
813
|
* @returns {Promise<RewardsPlatformModel.Offer>} - Success response
|
|
814
814
|
* @name updateOfferByName
|
|
815
|
-
* @summary: Update offer by name
|
|
815
|
+
* @summary: Update offer by name
|
|
816
816
|
* @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
|
|
817
817
|
*/
|
|
818
818
|
async updateOfferByName(
|
|
@@ -895,7 +895,7 @@ class Rewards {
|
|
|
895
895
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
896
896
|
* @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
|
|
897
897
|
* @name updateUserStatus
|
|
898
|
-
* @summary: Update user status
|
|
898
|
+
* @summary: Update user status
|
|
899
899
|
* @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
|
|
900
900
|
*/
|
|
901
901
|
async updateUserStatus(
|
|
@@ -149,4 +149,4 @@ type UpdateUserStatusParam = {
|
|
|
149
149
|
};
|
|
150
150
|
type GetRewardsConfigurationParam = any;
|
|
151
151
|
type ShowOffersParam = any;
|
|
152
|
-
import RewardsPlatformModel = require("
|
|
152
|
+
import RewardsPlatformModel = require("sdk/output/javascript/code/sdk/platform/Rewards/RewardsPlatformModel");
|