@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8
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 +26 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +8 -0
- package/sdk/application/ApplicationClient.js +14 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
- package/sdk/application/Cart/CartApplicationClient.js +20 -20
- package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
- package/sdk/application/Cart/CartApplicationModel.js +783 -552
- package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
- package/sdk/application/Cart/CartApplicationValidator.js +100 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
- package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
- package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
- package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
- package/sdk/application/Common/CommonApplicationModel.js +59 -58
- package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
- package/sdk/application/Common/CommonApplicationValidator.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
- package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
- package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
- package/sdk/application/Content/ContentApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
- package/sdk/application/Content/ContentApplicationModel.js +342 -276
- package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
- package/sdk/application/Content/ContentApplicationValidator.js +11 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
- package/sdk/application/Lead/LeadApplicationModel.js +110 -67
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
- package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
- package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
- package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
- package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
- package/sdk/application/Order/OrderApplicationClient.js +10 -10
- package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
- package/sdk/application/Order/OrderApplicationModel.js +392 -316
- package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
- package/sdk/application/Order/OrderApplicationValidator.js +15 -14
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
- package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
- package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
- package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
- package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
- package/sdk/application/Share/ShareApplicationModel.js +53 -37
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
- package/sdk/application/Share/ShareApplicationValidator.js +2 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
- package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
- package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
- package/sdk/application/User/UserApplicationClient.d.ts +36 -36
- package/sdk/application/User/UserApplicationClient.js +36 -36
- package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
- package/sdk/application/User/UserApplicationModel.js +298 -244
- package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
- package/sdk/application/User/UserApplicationValidator.js +40 -40
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
- package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
- package/sdk/common/Clickstream.js +95 -15
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/common/Utility.js +19 -0
- package/sdk/common/utils.js +8 -1
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
- package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/PartnerClient.d.ts +8 -0
- package/sdk/partner/PartnerClient.js +14 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
- package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
- package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
- package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
- package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
- package/sdk/platform/Cart/CartPlatformModel.js +8 -8
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
- package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
- package/sdk/platform/Content/ContentPlatformModel.js +30 -15
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
- package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
- package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformClient.js +165 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
- package/sdk/platform/Order/OrderPlatformModel.js +367 -41
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
- package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +8 -0
- package/sdk/platform/PlatformClient.js +14 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
- package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
- package/sdk/platform/Share/SharePlatformModel.js +7 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
- package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
- package/sdk/platform/User/UserPlatformModel.js +9 -11
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
- package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
- package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
- package/sdk/public/Billing/BillingPublicClient.js +80 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
- package/sdk/public/Billing/BillingPublicModel.js +252 -87
- package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
- package/sdk/public/Billing/BillingPublicValidator.js +12 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
- package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
- package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
- package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
|
@@ -174,27 +174,33 @@ const Joi = require("joi");
|
|
|
174
174
|
|
|
175
175
|
/**
|
|
176
176
|
* @typedef CompanyDetail
|
|
177
|
-
* @property {string} [name]
|
|
178
|
-
* @property {string} [address]
|
|
179
|
-
* @property {string} [city]
|
|
180
|
-
* @property {string} [state]
|
|
181
|
-
* @property {string} [country]
|
|
182
|
-
* @property {number} [zip_code]
|
|
183
|
-
* @property {string} [state_code]
|
|
184
|
-
*
|
|
185
|
-
* @property {string} [
|
|
186
|
-
* @property {string} [
|
|
187
|
-
*
|
|
188
|
-
* @property {string} [
|
|
189
|
-
*
|
|
190
|
-
* @property {string} [
|
|
191
|
-
* @property {string} [
|
|
192
|
-
*
|
|
193
|
-
* @property {
|
|
194
|
-
* @property {string} [
|
|
195
|
-
* @property {string} [
|
|
196
|
-
* @property {string} [
|
|
197
|
-
* @property {Object} [
|
|
177
|
+
* @property {string} [name] - The official name of the company.
|
|
178
|
+
* @property {string} [address] - The physical street address of the company.
|
|
179
|
+
* @property {string} [city] - The city where the company is located.
|
|
180
|
+
* @property {string} [state] - The state or province where the company is located.
|
|
181
|
+
* @property {string} [country] - The country where the company is based.
|
|
182
|
+
* @property {number} [zip_code] - The postal code for the company's location.
|
|
183
|
+
* @property {string} [state_code] - A code representing the state, often used
|
|
184
|
+
* in official documents and forms.
|
|
185
|
+
* @property {string} [country_code] - The code of the country.
|
|
186
|
+
* @property {string} [gstin] - The Goods and Services Tax Identification
|
|
187
|
+
* Number, unique to each business in India.
|
|
188
|
+
* @property {string} [pan] - The Permanent Account Number, unique to each
|
|
189
|
+
* taxpayer in India.
|
|
190
|
+
* @property {string} [phone_no] - The primary contact phone number for the company.
|
|
191
|
+
* @property {string} [cin] - The Corporate Identification Number, unique to
|
|
192
|
+
* each company registered in India.
|
|
193
|
+
* @property {string} [website_url] - The URL to the company's official website.
|
|
194
|
+
* @property {string} [email] - The company's official email address.
|
|
195
|
+
* @property {string} [display_address] - The display address of the company.
|
|
196
|
+
* @property {string} [sector] - The sector in which company is located.
|
|
197
|
+
* @property {Object} [phone] - The provided phone no of country.
|
|
198
|
+
* @property {string} [trn] - The trn no of the company.
|
|
199
|
+
* @property {string} [vat] - The vat no of the company.
|
|
200
|
+
* @property {string} [business_country_timezone] - The bussiness country timezone.
|
|
201
|
+
* @property {Object} [business_country_currency] - This object represents the
|
|
202
|
+
* bussiness country currency.
|
|
203
|
+
* @property {Object} [meta] - This object represents the meta fields for company.
|
|
198
204
|
*/
|
|
199
205
|
|
|
200
206
|
/**
|
|
@@ -460,6 +466,8 @@ const Joi = require("joi");
|
|
|
460
466
|
* @property {boolean} [is_self_ship]
|
|
461
467
|
* @property {string} [mode]
|
|
462
468
|
* @property {boolean} [is_self_pickup]
|
|
469
|
+
* @property {Object} [shipment_meta] - This field represents the shipment meta details
|
|
470
|
+
* @property {Object} [order_meta] - This field represents the order meta details
|
|
463
471
|
* @property {string} [platform_name]
|
|
464
472
|
* @property {number} [amount_to_be_collected]
|
|
465
473
|
* @property {number} [amount_paid]
|
|
@@ -476,11 +484,12 @@ const Joi = require("joi");
|
|
|
476
484
|
|
|
477
485
|
/**
|
|
478
486
|
* @typedef DummyTemplateData
|
|
479
|
-
* @property {string} [_id]
|
|
480
|
-
*
|
|
487
|
+
* @property {string} [_id] - This field contains the unique identifier for the
|
|
488
|
+
* PDF payload.
|
|
489
|
+
* @property {number} [pdf_type_id] - This is invoice unique id
|
|
481
490
|
* @property {DummyTemplateDataPayload} payload
|
|
482
|
-
* @property {string} [country_code]
|
|
483
|
-
* @property {number} [__v]
|
|
491
|
+
* @property {string} [country_code] - This field represents the country code.
|
|
492
|
+
* @property {number} [__v] - This field holds the version number.
|
|
484
493
|
*/
|
|
485
494
|
|
|
486
495
|
/**
|
|
@@ -867,6 +876,7 @@ class FileStoragePlatformModel {
|
|
|
867
876
|
vat: Joi.string().allow(""),
|
|
868
877
|
business_country_timezone: Joi.string().allow(""),
|
|
869
878
|
business_country_currency: Joi.object().pattern(/\S/, Joi.any()),
|
|
879
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
870
880
|
});
|
|
871
881
|
}
|
|
872
882
|
|
|
@@ -1184,6 +1194,8 @@ class FileStoragePlatformModel {
|
|
|
1184
1194
|
is_self_ship: Joi.boolean(),
|
|
1185
1195
|
mode: Joi.string().allow(""),
|
|
1186
1196
|
is_self_pickup: Joi.boolean(),
|
|
1197
|
+
shipment_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1198
|
+
order_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1187
1199
|
platform_name: Joi.string().allow(""),
|
|
1188
1200
|
amount_to_be_collected: Joi.number(),
|
|
1189
1201
|
amount_paid: Joi.number(),
|
|
@@ -9,7 +9,7 @@ declare class Finance {
|
|
|
9
9
|
* @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
|
|
10
10
|
* Success response
|
|
11
11
|
* @name channelDisplayName
|
|
12
|
-
* @summary: Get channel display name
|
|
12
|
+
* @summary: Get channel display name
|
|
13
13
|
* @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
|
|
14
14
|
*/
|
|
15
15
|
channelDisplayName({ filterKey, requestHeaders }?: FinancePlatformValidator.ChannelDisplayNameParam, { responseHeaders }?: object): Promise<FinancePlatformModel.ChannelDisplayNameResponse>;
|
|
@@ -23,7 +23,7 @@ declare class Finance {
|
|
|
23
23
|
* - Success response
|
|
24
24
|
*
|
|
25
25
|
* @name createSellerCreditNoteConfig
|
|
26
|
-
* @summary: Create seller credit note config
|
|
26
|
+
* @summary: Create seller credit note config
|
|
27
27
|
* @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
|
|
28
28
|
*/
|
|
29
29
|
createSellerCreditNoteConfig({ body, requestHeaders }?: FinancePlatformValidator.CreateSellerCreditNoteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreateSellerCreditNoteConfigResponse>;
|
|
@@ -34,7 +34,7 @@ declare class Finance {
|
|
|
34
34
|
* @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name creditNoteDetails
|
|
37
|
-
* @summary: Get credit note details
|
|
37
|
+
* @summary: Get credit note details
|
|
38
38
|
* @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
|
|
39
39
|
*/
|
|
40
40
|
creditNoteDetails({ body, requestHeaders }?: FinancePlatformValidator.CreditNoteDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditNoteDetailsResponse>;
|
|
@@ -46,7 +46,7 @@ declare class Finance {
|
|
|
46
46
|
* - Success response
|
|
47
47
|
*
|
|
48
48
|
* @name creditlineDataplatform
|
|
49
|
-
* @summary: Access credit line data platform
|
|
49
|
+
* @summary: Access credit line data platform
|
|
50
50
|
* @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
|
|
51
51
|
*/
|
|
52
52
|
creditlineDataplatform({ body, requestHeaders }?: FinancePlatformValidator.CreditlineDataplatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditlineDataPlatformResponse>;
|
|
@@ -56,7 +56,7 @@ declare class Finance {
|
|
|
56
56
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
57
57
|
* @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
|
|
58
58
|
* @name deleteConfig
|
|
59
|
-
* @summary: Deletes credit note config
|
|
59
|
+
* @summary: Deletes credit note config
|
|
60
60
|
* @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
|
|
61
61
|
*/
|
|
62
62
|
deleteConfig({ body, requestHeaders }?: FinancePlatformValidator.DeleteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DeleteConfigResponse>;
|
|
@@ -68,7 +68,7 @@ declare class Finance {
|
|
|
68
68
|
* - Success response
|
|
69
69
|
*
|
|
70
70
|
* @name downloadCreditDebitNote
|
|
71
|
-
* @summary: Download credit/debit note
|
|
71
|
+
* @summary: Download credit/debit note
|
|
72
72
|
* @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
|
|
73
73
|
*/
|
|
74
74
|
downloadCreditDebitNote({ body, requestHeaders }?: FinancePlatformValidator.DownloadCreditDebitNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadCreditDebitNoteResponse>;
|
|
@@ -78,7 +78,7 @@ declare class Finance {
|
|
|
78
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
|
|
80
80
|
* @name downloadReport
|
|
81
|
-
* @summary: Download financial report
|
|
81
|
+
* @summary: Download financial report
|
|
82
82
|
* @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
|
|
83
83
|
*/
|
|
84
84
|
downloadReport({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportList>;
|
|
@@ -90,7 +90,7 @@ declare class Finance {
|
|
|
90
90
|
* - Success response
|
|
91
91
|
*
|
|
92
92
|
* @name downloadReportCustomerCn
|
|
93
|
-
* @summary: Download customer credit note report
|
|
93
|
+
* @summary: Download customer credit note report
|
|
94
94
|
* @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
|
|
95
95
|
*/
|
|
96
96
|
downloadReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportCustomerCnResponse>;
|
|
@@ -100,7 +100,7 @@ declare class Finance {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
|
|
102
102
|
* @name generateReport
|
|
103
|
-
* @summary: Generate financial report
|
|
103
|
+
* @summary: Generate financial report
|
|
104
104
|
* @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
|
|
105
105
|
*/
|
|
106
106
|
generateReport({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportJson>;
|
|
@@ -112,7 +112,7 @@ declare class Finance {
|
|
|
112
112
|
* - Success response
|
|
113
113
|
*
|
|
114
114
|
* @name generateReportCustomerCn
|
|
115
|
-
* @summary: Generate customer credit note report
|
|
115
|
+
* @summary: Generate customer credit note report
|
|
116
116
|
* @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
|
|
117
117
|
*/
|
|
118
118
|
generateReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportCustomerCnResponse>;
|
|
@@ -122,7 +122,7 @@ declare class Finance {
|
|
|
122
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
123
|
* @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
|
|
124
124
|
* @name getAffiliate
|
|
125
|
-
* @summary: Get affiliate details
|
|
125
|
+
* @summary: Get affiliate details
|
|
126
126
|
* @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
|
|
127
127
|
*/
|
|
128
128
|
getAffiliate({ body, requestHeaders }?: FinancePlatformValidator.GetAffiliateParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetAffiliateResponse>;
|
|
@@ -132,7 +132,7 @@ declare class Finance {
|
|
|
132
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
133
133
|
* @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
|
|
134
134
|
* @name getCnConfig
|
|
135
|
-
* @summary: Get credit note configuration
|
|
135
|
+
* @summary: Get credit note configuration
|
|
136
136
|
* @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
|
|
137
137
|
*/
|
|
138
138
|
getCnConfig({ body, requestHeaders }?: FinancePlatformValidator.GetCnConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCnConfigResponse>;
|
|
@@ -144,7 +144,7 @@ declare class Finance {
|
|
|
144
144
|
* - Success response
|
|
145
145
|
*
|
|
146
146
|
* @name getCustomerCreditBalance
|
|
147
|
-
* @summary: Get customer credit balance
|
|
147
|
+
* @summary: Get customer credit balance
|
|
148
148
|
* @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
|
|
149
149
|
*/
|
|
150
150
|
getCustomerCreditBalance({ body, requestHeaders }?: FinancePlatformValidator.GetCustomerCreditBalanceParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCustomerCreditBalanceResponse>;
|
|
@@ -154,7 +154,7 @@ declare class Finance {
|
|
|
154
154
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
155
155
|
* @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
|
|
156
156
|
* @name getData
|
|
157
|
-
* @summary: Get financial data
|
|
157
|
+
* @summary: Get financial data
|
|
158
158
|
* @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
|
|
159
159
|
*/
|
|
160
160
|
getData({ body, requestHeaders }?: FinancePlatformValidator.GetDataParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetEngineResponse>;
|
|
@@ -164,7 +164,7 @@ declare class Finance {
|
|
|
164
164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
165
|
* @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
|
|
166
166
|
* @name getPdfUrlView
|
|
167
|
-
* @summary: Get PDF URL view
|
|
167
|
+
* @summary: Get PDF URL view
|
|
168
168
|
* @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
|
|
169
169
|
*/
|
|
170
170
|
getPdfUrlView({ body, requestHeaders }?: FinancePlatformValidator.GetPdfUrlViewParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetPdfUrlViewResponse>;
|
|
@@ -174,7 +174,7 @@ declare class Finance {
|
|
|
174
174
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
175
|
* @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
|
|
176
176
|
* @name getReason
|
|
177
|
-
* @summary: Get transaction reason
|
|
177
|
+
* @summary: Get transaction reason
|
|
178
178
|
* @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
|
|
179
179
|
*/
|
|
180
180
|
getReason({ body, requestHeaders }?: FinancePlatformValidator.GetReasonParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReasonResponse>;
|
|
@@ -184,7 +184,7 @@ declare class Finance {
|
|
|
184
184
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
185
|
* @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
|
|
186
186
|
* @name getReportList
|
|
187
|
-
* @summary: Get report list
|
|
187
|
+
* @summary: Get report list
|
|
188
188
|
* @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
|
|
189
189
|
*/
|
|
190
190
|
getReportList({ body, requestHeaders }?: FinancePlatformValidator.GetReportListParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportListResponse>;
|
|
@@ -195,7 +195,7 @@ declare class Finance {
|
|
|
195
195
|
* @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
|
|
196
196
|
* Success response
|
|
197
197
|
* @name getReportingFilters
|
|
198
|
-
* @summary: Get reporting filters
|
|
198
|
+
* @summary: Get reporting filters
|
|
199
199
|
* @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
|
|
200
200
|
*/
|
|
201
201
|
getReportingFilters({ filterKey, affiliateId, requestHeaders }?: FinancePlatformValidator.GetReportingFiltersParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportingFiltersResponse>;
|
|
@@ -206,7 +206,7 @@ declare class Finance {
|
|
|
206
206
|
* @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
|
|
207
207
|
* Success response
|
|
208
208
|
* @name invoiceActivityLogs
|
|
209
|
-
* @summary: Display activity log details of an invoice
|
|
209
|
+
* @summary: Display activity log details of an invoice
|
|
210
210
|
* @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
|
|
211
211
|
*/
|
|
212
212
|
invoiceActivityLogs({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoiceActivityLogsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceActivityLogsResponse>;
|
|
@@ -216,8 +216,8 @@ declare class Finance {
|
|
|
216
216
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
217
217
|
* @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
|
|
218
218
|
* @name invoiceListing
|
|
219
|
-
* @summary:
|
|
220
|
-
* @description:
|
|
219
|
+
* @summary: List invoices
|
|
220
|
+
* @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
|
|
221
221
|
*/
|
|
222
222
|
invoiceListing({ body, requestHeaders }?: FinancePlatformValidator.InvoiceListingParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceListingResponse>;
|
|
223
223
|
/**
|
|
@@ -226,7 +226,7 @@ declare class Finance {
|
|
|
226
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
227
|
* @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
|
|
228
228
|
* @name invoicePDF
|
|
229
|
-
* @summary: Get invoice PDF
|
|
229
|
+
* @summary: Get invoice PDF
|
|
230
230
|
* @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
|
|
231
231
|
*/
|
|
232
232
|
invoicePDF({ body, requestHeaders }?: FinancePlatformValidator.InvoicePDFParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePdfResponse>;
|
|
@@ -237,7 +237,7 @@ declare class Finance {
|
|
|
237
237
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
|
|
238
238
|
* Success response
|
|
239
239
|
* @name invoicePaymentDetails
|
|
240
|
-
* @summary: Display payment details of an invoice
|
|
240
|
+
* @summary: Display payment details of an invoice
|
|
241
241
|
* @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
|
|
242
242
|
*/
|
|
243
243
|
invoicePaymentDetails({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoicePaymentDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>;
|
|
@@ -248,8 +248,8 @@ declare class Finance {
|
|
|
248
248
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>} -
|
|
249
249
|
* Success response
|
|
250
250
|
* @name invoicePaymentOptions
|
|
251
|
-
* @summary: Display all payment options for
|
|
252
|
-
* @description: Display all payment options for
|
|
251
|
+
* @summary: Display all payment options for invoice.
|
|
252
|
+
* @description: Display all payment options for invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentOptions/).
|
|
253
253
|
*/
|
|
254
254
|
invoicePaymentOptions({ body, requestHeaders }?: FinancePlatformValidator.InvoicePaymentOptionsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>;
|
|
255
255
|
/**
|
|
@@ -258,7 +258,7 @@ declare class Finance {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
|
|
260
260
|
* @name invoiceType
|
|
261
|
-
* @summary: Get invoice types
|
|
261
|
+
* @summary: Get invoice types
|
|
262
262
|
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
|
|
263
263
|
*/
|
|
264
264
|
invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
|
|
@@ -269,7 +269,7 @@ declare class Finance {
|
|
|
269
269
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
270
270
|
* Success response
|
|
271
271
|
* @name isCnRefundMethod
|
|
272
|
-
* @summary: Check
|
|
272
|
+
* @summary: Check refund method
|
|
273
273
|
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
274
274
|
*/
|
|
275
275
|
isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
|
|
@@ -280,7 +280,7 @@ declare class Finance {
|
|
|
280
280
|
* @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
|
|
281
281
|
* Success response
|
|
282
282
|
* @name isCreditlinePlatform
|
|
283
|
-
* @summary: Check credit line platform status
|
|
283
|
+
* @summary: Check credit line platform status
|
|
284
284
|
* @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
|
|
285
285
|
*/
|
|
286
286
|
isCreditlinePlatform({ body, requestHeaders }?: FinancePlatformValidator.IsCreditlinePlatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCreditlinePlatformResponse>;
|
|
@@ -300,7 +300,7 @@ declare class Finance {
|
|
|
300
300
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
301
301
|
* @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
|
|
302
302
|
* @name paymentProcess
|
|
303
|
-
* @summary: Process payments
|
|
303
|
+
* @summary: Process payments
|
|
304
304
|
* @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
|
|
305
305
|
*/
|
|
306
306
|
paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
|
|
@@ -311,7 +311,7 @@ declare class Finance {
|
|
|
311
311
|
* @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
|
|
312
312
|
* Success response
|
|
313
313
|
* @name unlockCreditNote
|
|
314
|
-
* @summary:
|
|
314
|
+
* @summary: Unlock credit notes
|
|
315
315
|
* @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
|
|
316
316
|
*/
|
|
317
317
|
unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;
|
|
@@ -21,7 +21,7 @@ class Finance {
|
|
|
21
21
|
* @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
|
|
22
22
|
* Success response
|
|
23
23
|
* @name channelDisplayName
|
|
24
|
-
* @summary: Get channel display name
|
|
24
|
+
* @summary: Get channel display name
|
|
25
25
|
* @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
|
|
26
26
|
*/
|
|
27
27
|
async channelDisplayName(
|
|
@@ -105,7 +105,7 @@ class Finance {
|
|
|
105
105
|
* - Success response
|
|
106
106
|
*
|
|
107
107
|
* @name createSellerCreditNoteConfig
|
|
108
|
-
* @summary: Create seller credit note config
|
|
108
|
+
* @summary: Create seller credit note config
|
|
109
109
|
* @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
|
|
110
110
|
*/
|
|
111
111
|
async createSellerCreditNoteConfig(
|
|
@@ -187,7 +187,7 @@ class Finance {
|
|
|
187
187
|
* @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
|
|
188
188
|
* Success response
|
|
189
189
|
* @name creditNoteDetails
|
|
190
|
-
* @summary: Get credit note details
|
|
190
|
+
* @summary: Get credit note details
|
|
191
191
|
* @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
|
|
192
192
|
*/
|
|
193
193
|
async creditNoteDetails(
|
|
@@ -268,7 +268,7 @@ class Finance {
|
|
|
268
268
|
* - Success response
|
|
269
269
|
*
|
|
270
270
|
* @name creditlineDataplatform
|
|
271
|
-
* @summary: Access credit line data platform
|
|
271
|
+
* @summary: Access credit line data platform
|
|
272
272
|
* @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
|
|
273
273
|
*/
|
|
274
274
|
async creditlineDataplatform(
|
|
@@ -349,7 +349,7 @@ class Finance {
|
|
|
349
349
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
350
350
|
* @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
|
|
351
351
|
* @name deleteConfig
|
|
352
|
-
* @summary: Deletes credit note config
|
|
352
|
+
* @summary: Deletes credit note config
|
|
353
353
|
* @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
|
|
354
354
|
*/
|
|
355
355
|
async deleteConfig(
|
|
@@ -430,7 +430,7 @@ class Finance {
|
|
|
430
430
|
* - Success response
|
|
431
431
|
*
|
|
432
432
|
* @name downloadCreditDebitNote
|
|
433
|
-
* @summary: Download credit/debit note
|
|
433
|
+
* @summary: Download credit/debit note
|
|
434
434
|
* @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
|
|
435
435
|
*/
|
|
436
436
|
async downloadCreditDebitNote(
|
|
@@ -511,7 +511,7 @@ class Finance {
|
|
|
511
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
512
512
|
* @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
|
|
513
513
|
* @name downloadReport
|
|
514
|
-
* @summary: Download financial report
|
|
514
|
+
* @summary: Download financial report
|
|
515
515
|
* @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
|
|
516
516
|
*/
|
|
517
517
|
async downloadReport(
|
|
@@ -592,7 +592,7 @@ class Finance {
|
|
|
592
592
|
* - Success response
|
|
593
593
|
*
|
|
594
594
|
* @name downloadReportCustomerCn
|
|
595
|
-
* @summary: Download customer credit note report
|
|
595
|
+
* @summary: Download customer credit note report
|
|
596
596
|
* @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
|
|
597
597
|
*/
|
|
598
598
|
async downloadReportCustomerCn(
|
|
@@ -673,7 +673,7 @@ class Finance {
|
|
|
673
673
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
674
674
|
* @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
|
|
675
675
|
* @name generateReport
|
|
676
|
-
* @summary: Generate financial report
|
|
676
|
+
* @summary: Generate financial report
|
|
677
677
|
* @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
|
|
678
678
|
*/
|
|
679
679
|
async generateReport(
|
|
@@ -754,7 +754,7 @@ class Finance {
|
|
|
754
754
|
* - Success response
|
|
755
755
|
*
|
|
756
756
|
* @name generateReportCustomerCn
|
|
757
|
-
* @summary: Generate customer credit note report
|
|
757
|
+
* @summary: Generate customer credit note report
|
|
758
758
|
* @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
|
|
759
759
|
*/
|
|
760
760
|
async generateReportCustomerCn(
|
|
@@ -835,7 +835,7 @@ class Finance {
|
|
|
835
835
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
836
836
|
* @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
|
|
837
837
|
* @name getAffiliate
|
|
838
|
-
* @summary: Get affiliate details
|
|
838
|
+
* @summary: Get affiliate details
|
|
839
839
|
* @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
|
|
840
840
|
*/
|
|
841
841
|
async getAffiliate(
|
|
@@ -914,7 +914,7 @@ class Finance {
|
|
|
914
914
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
915
915
|
* @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
|
|
916
916
|
* @name getCnConfig
|
|
917
|
-
* @summary: Get credit note configuration
|
|
917
|
+
* @summary: Get credit note configuration
|
|
918
918
|
* @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
|
|
919
919
|
*/
|
|
920
920
|
async getCnConfig(
|
|
@@ -993,7 +993,7 @@ class Finance {
|
|
|
993
993
|
* - Success response
|
|
994
994
|
*
|
|
995
995
|
* @name getCustomerCreditBalance
|
|
996
|
-
* @summary: Get customer credit balance
|
|
996
|
+
* @summary: Get customer credit balance
|
|
997
997
|
* @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
|
|
998
998
|
*/
|
|
999
999
|
async getCustomerCreditBalance(
|
|
@@ -1074,7 +1074,7 @@ class Finance {
|
|
|
1074
1074
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1075
1075
|
* @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
|
|
1076
1076
|
* @name getData
|
|
1077
|
-
* @summary: Get financial data
|
|
1077
|
+
* @summary: Get financial data
|
|
1078
1078
|
* @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
|
|
1079
1079
|
*/
|
|
1080
1080
|
async getData(
|
|
@@ -1151,7 +1151,7 @@ class Finance {
|
|
|
1151
1151
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1152
1152
|
* @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
|
|
1153
1153
|
* @name getPdfUrlView
|
|
1154
|
-
* @summary: Get PDF URL view
|
|
1154
|
+
* @summary: Get PDF URL view
|
|
1155
1155
|
* @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
|
|
1156
1156
|
*/
|
|
1157
1157
|
async getPdfUrlView(
|
|
@@ -1230,7 +1230,7 @@ class Finance {
|
|
|
1230
1230
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1231
1231
|
* @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
|
|
1232
1232
|
* @name getReason
|
|
1233
|
-
* @summary: Get transaction reason
|
|
1233
|
+
* @summary: Get transaction reason
|
|
1234
1234
|
* @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
|
|
1235
1235
|
*/
|
|
1236
1236
|
async getReason(
|
|
@@ -1307,7 +1307,7 @@ class Finance {
|
|
|
1307
1307
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1308
1308
|
* @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
|
|
1309
1309
|
* @name getReportList
|
|
1310
|
-
* @summary: Get report list
|
|
1310
|
+
* @summary: Get report list
|
|
1311
1311
|
* @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
|
|
1312
1312
|
*/
|
|
1313
1313
|
async getReportList(
|
|
@@ -1387,7 +1387,7 @@ class Finance {
|
|
|
1387
1387
|
* @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
|
|
1388
1388
|
* Success response
|
|
1389
1389
|
* @name getReportingFilters
|
|
1390
|
-
* @summary: Get reporting filters
|
|
1390
|
+
* @summary: Get reporting filters
|
|
1391
1391
|
* @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
|
|
1392
1392
|
*/
|
|
1393
1393
|
async getReportingFilters(
|
|
@@ -1471,7 +1471,7 @@ class Finance {
|
|
|
1471
1471
|
* @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
|
|
1472
1472
|
* Success response
|
|
1473
1473
|
* @name invoiceActivityLogs
|
|
1474
|
-
* @summary: Display activity log details of an invoice
|
|
1474
|
+
* @summary: Display activity log details of an invoice
|
|
1475
1475
|
* @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
|
|
1476
1476
|
*/
|
|
1477
1477
|
async invoiceActivityLogs(
|
|
@@ -1550,8 +1550,8 @@ class Finance {
|
|
|
1550
1550
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1551
1551
|
* @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
|
|
1552
1552
|
* @name invoiceListing
|
|
1553
|
-
* @summary:
|
|
1554
|
-
* @description:
|
|
1553
|
+
* @summary: List invoices
|
|
1554
|
+
* @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
|
|
1555
1555
|
*/
|
|
1556
1556
|
async invoiceListing(
|
|
1557
1557
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1629,7 +1629,7 @@ class Finance {
|
|
|
1629
1629
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1630
1630
|
* @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
|
|
1631
1631
|
* @name invoicePDF
|
|
1632
|
-
* @summary: Get invoice PDF
|
|
1632
|
+
* @summary: Get invoice PDF
|
|
1633
1633
|
* @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
|
|
1634
1634
|
*/
|
|
1635
1635
|
async invoicePDF(
|
|
@@ -1707,7 +1707,7 @@ class Finance {
|
|
|
1707
1707
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
|
|
1708
1708
|
* Success response
|
|
1709
1709
|
* @name invoicePaymentDetails
|
|
1710
|
-
* @summary: Display payment details of an invoice
|
|
1710
|
+
* @summary: Display payment details of an invoice
|
|
1711
1711
|
* @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
|
|
1712
1712
|
*/
|
|
1713
1713
|
async invoicePaymentDetails(
|
|
@@ -1787,8 +1787,8 @@ class Finance {
|
|
|
1787
1787
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>} -
|
|
1788
1788
|
* Success response
|
|
1789
1789
|
* @name invoicePaymentOptions
|
|
1790
|
-
* @summary: Display all payment options for
|
|
1791
|
-
* @description: Display all payment options for
|
|
1790
|
+
* @summary: Display all payment options for invoice.
|
|
1791
|
+
* @description: Display all payment options for invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentOptions/).
|
|
1792
1792
|
*/
|
|
1793
1793
|
async invoicePaymentOptions(
|
|
1794
1794
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1866,7 +1866,7 @@ class Finance {
|
|
|
1866
1866
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1867
1867
|
* @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
|
|
1868
1868
|
* @name invoiceType
|
|
1869
|
-
* @summary: Get invoice types
|
|
1869
|
+
* @summary: Get invoice types
|
|
1870
1870
|
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
|
|
1871
1871
|
*/
|
|
1872
1872
|
async invoiceType(
|
|
@@ -1944,7 +1944,7 @@ class Finance {
|
|
|
1944
1944
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
1945
1945
|
* Success response
|
|
1946
1946
|
* @name isCnRefundMethod
|
|
1947
|
-
* @summary: Check
|
|
1947
|
+
* @summary: Check refund method
|
|
1948
1948
|
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
1949
1949
|
*/
|
|
1950
1950
|
async isCnRefundMethod(
|
|
@@ -2024,7 +2024,7 @@ class Finance {
|
|
|
2024
2024
|
* @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
|
|
2025
2025
|
* Success response
|
|
2026
2026
|
* @name isCreditlinePlatform
|
|
2027
|
-
* @summary: Check credit line platform status
|
|
2027
|
+
* @summary: Check credit line platform status
|
|
2028
2028
|
* @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
|
|
2029
2029
|
*/
|
|
2030
2030
|
async isCreditlinePlatform(
|
|
@@ -2176,7 +2176,7 @@ class Finance {
|
|
|
2176
2176
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2177
2177
|
* @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
|
|
2178
2178
|
* @name paymentProcess
|
|
2179
|
-
* @summary: Process payments
|
|
2179
|
+
* @summary: Process payments
|
|
2180
2180
|
* @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
|
|
2181
2181
|
*/
|
|
2182
2182
|
async paymentProcess(
|
|
@@ -2256,7 +2256,7 @@ class Finance {
|
|
|
2256
2256
|
* @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
|
|
2257
2257
|
* Success response
|
|
2258
2258
|
* @name unlockCreditNote
|
|
2259
|
-
* @summary:
|
|
2259
|
+
* @summary: Unlock credit notes
|
|
2260
2260
|
* @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
|
|
2261
2261
|
*/
|
|
2262
2262
|
async unlockCreditNote(
|