@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
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 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -9,8 +9,8 @@ declare class Finance {
|
|
|
9
9
|
* @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
|
|
10
10
|
* Success response
|
|
11
11
|
* @name channelDisplayName
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Get channel display name.
|
|
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>;
|
|
16
16
|
/**
|
|
@@ -23,8 +23,8 @@ declare class Finance {
|
|
|
23
23
|
* - Success response
|
|
24
24
|
*
|
|
25
25
|
* @name createSellerCreditNoteConfig
|
|
26
|
-
* @summary:
|
|
27
|
-
* @description:
|
|
26
|
+
* @summary: Create seller credit note config.
|
|
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>;
|
|
30
30
|
/**
|
|
@@ -34,8 +34,8 @@ declare class Finance {
|
|
|
34
34
|
* @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name creditNoteDetails
|
|
37
|
-
* @summary:
|
|
38
|
-
* @description:
|
|
37
|
+
* @summary: Get credit note details.
|
|
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>;
|
|
41
41
|
/**
|
|
@@ -46,8 +46,8 @@ declare class Finance {
|
|
|
46
46
|
* - Success response
|
|
47
47
|
*
|
|
48
48
|
* @name creditlineDataplatform
|
|
49
|
-
* @summary:
|
|
50
|
-
* @description:
|
|
49
|
+
* @summary: Access credit line data platform.
|
|
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>;
|
|
53
53
|
/**
|
|
@@ -68,8 +68,8 @@ declare class Finance {
|
|
|
68
68
|
* - Success response
|
|
69
69
|
*
|
|
70
70
|
* @name downloadCreditDebitNote
|
|
71
|
-
* @summary: Download credit
|
|
72
|
-
* @description:
|
|
71
|
+
* @summary: Download credit/debit note.
|
|
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>;
|
|
75
75
|
/**
|
|
@@ -78,8 +78,8 @@ declare class Finance {
|
|
|
78
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
|
|
80
80
|
* @name downloadReport
|
|
81
|
-
* @summary:
|
|
82
|
-
* @description:
|
|
81
|
+
* @summary: Download financial report.
|
|
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>;
|
|
85
85
|
/**
|
|
@@ -90,8 +90,8 @@ declare class Finance {
|
|
|
90
90
|
* - Success response
|
|
91
91
|
*
|
|
92
92
|
* @name downloadReportCustomerCn
|
|
93
|
-
* @summary:
|
|
94
|
-
* @description:
|
|
93
|
+
* @summary: Download customer credit note report.
|
|
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>;
|
|
97
97
|
/**
|
|
@@ -100,8 +100,8 @@ 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
|
|
104
|
-
* @description:
|
|
103
|
+
* @summary: Generate financial report.
|
|
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>;
|
|
107
107
|
/**
|
|
@@ -112,8 +112,8 @@ declare class Finance {
|
|
|
112
112
|
* - Success response
|
|
113
113
|
*
|
|
114
114
|
* @name generateReportCustomerCn
|
|
115
|
-
* @summary: Generate
|
|
116
|
-
* @description:
|
|
115
|
+
* @summary: Generate customer credit note report.
|
|
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>;
|
|
119
119
|
/**
|
|
@@ -122,8 +122,8 @@ declare class Finance {
|
|
|
122
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
123
|
* @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
|
|
124
124
|
* @name getAffiliate
|
|
125
|
-
* @summary:
|
|
126
|
-
* @description:
|
|
125
|
+
* @summary: Get affiliate details.
|
|
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>;
|
|
129
129
|
/**
|
|
@@ -132,8 +132,8 @@ declare class Finance {
|
|
|
132
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
133
133
|
* @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
|
|
134
134
|
* @name getCnConfig
|
|
135
|
-
* @summary:
|
|
136
|
-
* @description:
|
|
135
|
+
* @summary: Get credit note configuration.
|
|
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>;
|
|
139
139
|
/**
|
|
@@ -144,8 +144,8 @@ declare class Finance {
|
|
|
144
144
|
* - Success response
|
|
145
145
|
*
|
|
146
146
|
* @name getCustomerCreditBalance
|
|
147
|
-
* @summary:
|
|
148
|
-
* @description:
|
|
147
|
+
* @summary: Get customer credit balance.
|
|
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>;
|
|
151
151
|
/**
|
|
@@ -154,8 +154,8 @@ declare class Finance {
|
|
|
154
154
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
155
155
|
* @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
|
|
156
156
|
* @name getData
|
|
157
|
-
* @summary:
|
|
158
|
-
* @description:
|
|
157
|
+
* @summary: Get financial data.
|
|
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>;
|
|
161
161
|
/**
|
|
@@ -164,8 +164,8 @@ declare class Finance {
|
|
|
164
164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
165
|
* @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
|
|
166
166
|
* @name getPdfUrlView
|
|
167
|
-
* @summary:
|
|
168
|
-
* @description:
|
|
167
|
+
* @summary: Get PDF URL view.
|
|
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>;
|
|
171
171
|
/**
|
|
@@ -174,8 +174,8 @@ declare class Finance {
|
|
|
174
174
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
175
|
* @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
|
|
176
176
|
* @name getReason
|
|
177
|
-
* @summary:
|
|
178
|
-
* @description:
|
|
177
|
+
* @summary: Get transaction reason.
|
|
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>;
|
|
181
181
|
/**
|
|
@@ -184,8 +184,8 @@ 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
|
|
188
|
-
* @description:
|
|
187
|
+
* @summary: Get report list.
|
|
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>;
|
|
191
191
|
/**
|
|
@@ -195,8 +195,8 @@ declare class Finance {
|
|
|
195
195
|
* @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
|
|
196
196
|
* Success response
|
|
197
197
|
* @name getReportingFilters
|
|
198
|
-
* @summary:
|
|
199
|
-
* @description:
|
|
198
|
+
* @summary: Get reporting filters.
|
|
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>;
|
|
202
202
|
/**
|
|
@@ -226,8 +226,8 @@ declare class Finance {
|
|
|
226
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
227
|
* @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
|
|
228
228
|
* @name invoicePDF
|
|
229
|
-
* @summary:
|
|
230
|
-
* @description:
|
|
229
|
+
* @summary: Get invoice PDF.
|
|
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>;
|
|
233
233
|
/**
|
|
@@ -247,8 +247,8 @@ declare class Finance {
|
|
|
247
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
248
248
|
* @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
|
|
249
249
|
* @name invoiceType
|
|
250
|
-
* @summary:
|
|
251
|
-
* @description:
|
|
250
|
+
* @summary: Get invoice types.
|
|
251
|
+
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
|
|
252
252
|
*/
|
|
253
253
|
invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
|
|
254
254
|
/**
|
|
@@ -258,8 +258,8 @@ declare class Finance {
|
|
|
258
258
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
259
259
|
* Success response
|
|
260
260
|
* @name isCnRefundMethod
|
|
261
|
-
* @summary:
|
|
262
|
-
* @description:
|
|
261
|
+
* @summary: Check CN refund method.
|
|
262
|
+
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
263
263
|
*/
|
|
264
264
|
isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
|
|
265
265
|
/**
|
|
@@ -269,8 +269,8 @@ declare class Finance {
|
|
|
269
269
|
* @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
|
|
270
270
|
* Success response
|
|
271
271
|
* @name isCreditlinePlatform
|
|
272
|
-
* @summary:
|
|
273
|
-
* @description:
|
|
272
|
+
* @summary: Check credit line platform status.
|
|
273
|
+
* @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
|
|
274
274
|
*/
|
|
275
275
|
isCreditlinePlatform({ body, requestHeaders }?: FinancePlatformValidator.IsCreditlinePlatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCreditlinePlatformResponse>;
|
|
276
276
|
/**
|
|
@@ -279,8 +279,8 @@ declare class Finance {
|
|
|
279
279
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
280
|
* @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
|
|
281
281
|
* @name paymentProcess
|
|
282
|
-
* @summary:
|
|
283
|
-
* @description:
|
|
282
|
+
* @summary: Process payments.
|
|
283
|
+
* @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
|
|
284
284
|
*/
|
|
285
285
|
paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
|
|
286
286
|
/**
|
|
@@ -21,8 +21,8 @@ class Finance {
|
|
|
21
21
|
* @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
|
|
22
22
|
* Success response
|
|
23
23
|
* @name channelDisplayName
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Get channel display name.
|
|
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(
|
|
28
28
|
{ filterKey, requestHeaders } = { requestHeaders: {} },
|
|
@@ -105,8 +105,8 @@ class Finance {
|
|
|
105
105
|
* - Success response
|
|
106
106
|
*
|
|
107
107
|
* @name createSellerCreditNoteConfig
|
|
108
|
-
* @summary:
|
|
109
|
-
* @description:
|
|
108
|
+
* @summary: Create seller credit note config.
|
|
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(
|
|
112
112
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -187,8 +187,8 @@ class Finance {
|
|
|
187
187
|
* @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
|
|
188
188
|
* Success response
|
|
189
189
|
* @name creditNoteDetails
|
|
190
|
-
* @summary:
|
|
191
|
-
* @description:
|
|
190
|
+
* @summary: Get credit note details.
|
|
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(
|
|
194
194
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -268,8 +268,8 @@ class Finance {
|
|
|
268
268
|
* - Success response
|
|
269
269
|
*
|
|
270
270
|
* @name creditlineDataplatform
|
|
271
|
-
* @summary:
|
|
272
|
-
* @description:
|
|
271
|
+
* @summary: Access credit line data platform.
|
|
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(
|
|
275
275
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -430,8 +430,8 @@ class Finance {
|
|
|
430
430
|
* - Success response
|
|
431
431
|
*
|
|
432
432
|
* @name downloadCreditDebitNote
|
|
433
|
-
* @summary: Download credit
|
|
434
|
-
* @description:
|
|
433
|
+
* @summary: Download credit/debit note.
|
|
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(
|
|
437
437
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -511,8 +511,8 @@ class Finance {
|
|
|
511
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
512
512
|
* @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
|
|
513
513
|
* @name downloadReport
|
|
514
|
-
* @summary:
|
|
515
|
-
* @description:
|
|
514
|
+
* @summary: Download financial report.
|
|
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(
|
|
518
518
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -592,8 +592,8 @@ class Finance {
|
|
|
592
592
|
* - Success response
|
|
593
593
|
*
|
|
594
594
|
* @name downloadReportCustomerCn
|
|
595
|
-
* @summary:
|
|
596
|
-
* @description:
|
|
595
|
+
* @summary: Download customer credit note report.
|
|
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(
|
|
599
599
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -673,8 +673,8 @@ class Finance {
|
|
|
673
673
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
674
674
|
* @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
|
|
675
675
|
* @name generateReport
|
|
676
|
-
* @summary: Generate
|
|
677
|
-
* @description:
|
|
676
|
+
* @summary: Generate financial report.
|
|
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(
|
|
680
680
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -754,8 +754,8 @@ class Finance {
|
|
|
754
754
|
* - Success response
|
|
755
755
|
*
|
|
756
756
|
* @name generateReportCustomerCn
|
|
757
|
-
* @summary: Generate
|
|
758
|
-
* @description:
|
|
757
|
+
* @summary: Generate customer credit note report.
|
|
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(
|
|
761
761
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -835,8 +835,8 @@ class Finance {
|
|
|
835
835
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
836
836
|
* @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
|
|
837
837
|
* @name getAffiliate
|
|
838
|
-
* @summary:
|
|
839
|
-
* @description:
|
|
838
|
+
* @summary: Get affiliate details.
|
|
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(
|
|
842
842
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -914,8 +914,8 @@ class Finance {
|
|
|
914
914
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
915
915
|
* @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
|
|
916
916
|
* @name getCnConfig
|
|
917
|
-
* @summary:
|
|
918
|
-
* @description:
|
|
917
|
+
* @summary: Get credit note configuration.
|
|
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(
|
|
921
921
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -993,8 +993,8 @@ class Finance {
|
|
|
993
993
|
* - Success response
|
|
994
994
|
*
|
|
995
995
|
* @name getCustomerCreditBalance
|
|
996
|
-
* @summary:
|
|
997
|
-
* @description:
|
|
996
|
+
* @summary: Get customer credit balance.
|
|
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(
|
|
1000
1000
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1074,8 +1074,8 @@ class Finance {
|
|
|
1074
1074
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1075
1075
|
* @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
|
|
1076
1076
|
* @name getData
|
|
1077
|
-
* @summary:
|
|
1078
|
-
* @description:
|
|
1077
|
+
* @summary: Get financial data.
|
|
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(
|
|
1081
1081
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1151,8 +1151,8 @@ class Finance {
|
|
|
1151
1151
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1152
1152
|
* @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
|
|
1153
1153
|
* @name getPdfUrlView
|
|
1154
|
-
* @summary:
|
|
1155
|
-
* @description:
|
|
1154
|
+
* @summary: Get PDF URL view.
|
|
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(
|
|
1158
1158
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1230,8 +1230,8 @@ class Finance {
|
|
|
1230
1230
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1231
1231
|
* @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
|
|
1232
1232
|
* @name getReason
|
|
1233
|
-
* @summary:
|
|
1234
|
-
* @description:
|
|
1233
|
+
* @summary: Get transaction reason.
|
|
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(
|
|
1237
1237
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1307,8 +1307,8 @@ class Finance {
|
|
|
1307
1307
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1308
1308
|
* @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
|
|
1309
1309
|
* @name getReportList
|
|
1310
|
-
* @summary: Get
|
|
1311
|
-
* @description:
|
|
1310
|
+
* @summary: Get report list.
|
|
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(
|
|
1314
1314
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1387,8 +1387,8 @@ class Finance {
|
|
|
1387
1387
|
* @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
|
|
1388
1388
|
* Success response
|
|
1389
1389
|
* @name getReportingFilters
|
|
1390
|
-
* @summary:
|
|
1391
|
-
* @description:
|
|
1390
|
+
* @summary: Get reporting filters.
|
|
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(
|
|
1394
1394
|
{ filterKey, affiliateId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1629,8 +1629,8 @@ class Finance {
|
|
|
1629
1629
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1630
1630
|
* @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
|
|
1631
1631
|
* @name invoicePDF
|
|
1632
|
-
* @summary:
|
|
1633
|
-
* @description:
|
|
1632
|
+
* @summary: Get invoice PDF.
|
|
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(
|
|
1636
1636
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1786,8 +1786,8 @@ class Finance {
|
|
|
1786
1786
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1787
1787
|
* @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
|
|
1788
1788
|
* @name invoiceType
|
|
1789
|
-
* @summary:
|
|
1790
|
-
* @description:
|
|
1789
|
+
* @summary: Get invoice types.
|
|
1790
|
+
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
|
|
1791
1791
|
*/
|
|
1792
1792
|
async invoiceType(
|
|
1793
1793
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1864,8 +1864,8 @@ class Finance {
|
|
|
1864
1864
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
1865
1865
|
* Success response
|
|
1866
1866
|
* @name isCnRefundMethod
|
|
1867
|
-
* @summary:
|
|
1868
|
-
* @description:
|
|
1867
|
+
* @summary: Check CN refund method.
|
|
1868
|
+
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
1869
1869
|
*/
|
|
1870
1870
|
async isCnRefundMethod(
|
|
1871
1871
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1944,8 +1944,8 @@ class Finance {
|
|
|
1944
1944
|
* @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
|
|
1945
1945
|
* Success response
|
|
1946
1946
|
* @name isCreditlinePlatform
|
|
1947
|
-
* @summary:
|
|
1948
|
-
* @description:
|
|
1947
|
+
* @summary: Check credit line platform status.
|
|
1948
|
+
* @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
|
|
1949
1949
|
*/
|
|
1950
1950
|
async isCreditlinePlatform(
|
|
1951
1951
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2023,8 +2023,8 @@ class Finance {
|
|
|
2023
2023
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2024
2024
|
* @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
|
|
2025
2025
|
* @name paymentProcess
|
|
2026
|
-
* @summary:
|
|
2027
|
-
* @description:
|
|
2026
|
+
* @summary: Process payments.
|
|
2027
|
+
* @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
|
|
2028
2028
|
*/
|
|
2029
2029
|
async paymentProcess(
|
|
2030
2030
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -9,8 +9,8 @@ declare class Lead {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
11
11
|
* @name closeVideoRoom
|
|
12
|
-
* @summary: Close
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Close video room.
|
|
13
|
+
* @description: Terminate and close an active video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
|
|
14
14
|
*/
|
|
15
15
|
closeVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
|
|
16
16
|
/**
|
|
@@ -19,8 +19,8 @@ declare class Lead {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
21
21
|
* @name createCustomForm
|
|
22
|
-
* @summary:
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Create custom form.
|
|
23
|
+
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
|
|
24
24
|
*/
|
|
25
25
|
createCustomForm({ body, requestHeaders }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
26
26
|
/**
|
|
@@ -49,8 +49,8 @@ declare class Lead {
|
|
|
49
49
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
50
50
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
51
51
|
* @name editCustomForm
|
|
52
|
-
* @summary: Edit
|
|
53
|
-
* @description:
|
|
52
|
+
* @summary: Edit custom form.
|
|
53
|
+
* @description: Modify the content and assosciated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
54
54
|
*/
|
|
55
55
|
editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
56
56
|
/**
|
|
@@ -69,8 +69,8 @@ declare class Lead {
|
|
|
69
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
70
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
71
71
|
* @name getCustomForm
|
|
72
|
-
* @summary: Get
|
|
73
|
-
* @description:
|
|
72
|
+
* @summary: Get custom form.
|
|
73
|
+
* @description: Retrieve information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
74
74
|
*/
|
|
75
75
|
getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
76
76
|
/**
|
|
@@ -79,8 +79,8 @@ declare class Lead {
|
|
|
79
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
80
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
81
81
|
* @name getCustomForms
|
|
82
|
-
* @summary: Get
|
|
83
|
-
* @description:
|
|
82
|
+
* @summary: Get custom forms.
|
|
83
|
+
* @description: Retrieve a list of available custom forms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
84
84
|
*/
|
|
85
85
|
getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
|
|
86
86
|
/**
|
|
@@ -146,8 +146,8 @@ declare class Lead {
|
|
|
146
146
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
147
|
* @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
|
|
148
148
|
* @name openVideoRoom
|
|
149
|
-
* @summary: Open
|
|
150
|
-
* @description:
|
|
149
|
+
* @summary: Open video room.
|
|
150
|
+
* @description: Initiate and open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
|
|
151
151
|
*/
|
|
152
152
|
openVideoRoom({ body, requestHeaders }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CreateVideoRoomResponse>;
|
|
153
153
|
}
|
|
@@ -21,8 +21,8 @@ class Lead {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
23
23
|
* @name closeVideoRoom
|
|
24
|
-
* @summary: Close
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Close video room.
|
|
25
|
+
* @description: Terminate and close an active video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
|
|
26
26
|
*/
|
|
27
27
|
async closeVideoRoom(
|
|
28
28
|
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -100,8 +100,8 @@ class Lead {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
102
102
|
* @name createCustomForm
|
|
103
|
-
* @summary:
|
|
104
|
-
* @description:
|
|
103
|
+
* @summary: Create custom form.
|
|
104
|
+
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
|
|
105
105
|
*/
|
|
106
106
|
async createCustomForm(
|
|
107
107
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -339,8 +339,8 @@ class Lead {
|
|
|
339
339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
340
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
341
341
|
* @name editCustomForm
|
|
342
|
-
* @summary: Edit
|
|
343
|
-
* @description:
|
|
342
|
+
* @summary: Edit custom form.
|
|
343
|
+
* @description: Modify the content and assosciated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
344
344
|
*/
|
|
345
345
|
async editCustomForm(
|
|
346
346
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -499,8 +499,8 @@ class Lead {
|
|
|
499
499
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
500
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
501
501
|
* @name getCustomForm
|
|
502
|
-
* @summary: Get
|
|
503
|
-
* @description:
|
|
502
|
+
* @summary: Get custom form.
|
|
503
|
+
* @description: Retrieve information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
504
504
|
*/
|
|
505
505
|
async getCustomForm(
|
|
506
506
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -576,8 +576,8 @@ class Lead {
|
|
|
576
576
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
577
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
578
578
|
* @name getCustomForms
|
|
579
|
-
* @summary: Get
|
|
580
|
-
* @description:
|
|
579
|
+
* @summary: Get custom forms.
|
|
580
|
+
* @description: Retrieve a list of available custom forms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
581
581
|
*/
|
|
582
582
|
async getCustomForms(
|
|
583
583
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1067,8 +1067,8 @@ class Lead {
|
|
|
1067
1067
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1068
1068
|
* @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
|
|
1069
1069
|
* @name openVideoRoom
|
|
1070
|
-
* @summary: Open
|
|
1071
|
-
* @description:
|
|
1070
|
+
* @summary: Open video room.
|
|
1071
|
+
* @description: Initiate and open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
|
|
1072
1072
|
*/
|
|
1073
1073
|
async openVideoRoom(
|
|
1074
1074
|
{ body, requestHeaders } = { requestHeaders: {} },
|