@emilgroup/customer-sdk-node 1.44.1-beta.0 → 1.46.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/claims-api.ts +40 -40
- package/api/customers-api.ts +40 -40
- package/api/documents-api.ts +40 -40
- package/api/invites-api.ts +4 -4
- package/api/invoices-api.ts +40 -40
- package/api/leads-api.ts +70 -70
- package/api/policies-api.ts +40 -40
- package/api/products-api.ts +40 -40
- package/base.ts +1 -1
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/authentication-api.js +60 -23
- package/dist/api/claims-api.d.ts +40 -40
- package/dist/api/claims-api.js +67 -38
- package/dist/api/customers-api.d.ts +40 -40
- package/dist/api/customers-api.js +74 -41
- package/dist/api/default-api.js +18 -5
- package/dist/api/documents-api.d.ts +43 -43
- package/dist/api/documents-api.js +53 -32
- package/dist/api/invites-api.d.ts +4 -4
- package/dist/api/invites-api.js +43 -18
- package/dist/api/invoices-api.d.ts +40 -40
- package/dist/api/invoices-api.js +39 -26
- package/dist/api/leads-api.d.ts +56 -56
- package/dist/api/leads-api.js +84 -59
- package/dist/api/payments-api.js +25 -8
- package/dist/api/policies-api.d.ts +40 -40
- package/dist/api/policies-api.js +81 -44
- package/dist/api/products-api.d.ts +40 -40
- package/dist/api/products-api.js +46 -29
- package/dist/base.js +25 -15
- package/dist/common.d.ts +1 -1
- package/dist/common.js +4 -4
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/dist/models/policy-class.d.ts +48 -0
- package/models/policy-class.ts +48 -0
- package/package.json +4 -4
- package/tsconfig.json +1 -0
package/api/invoices-api.ts
CHANGED
|
@@ -36,18 +36,18 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
36
36
|
* List all the invoices of a customer.
|
|
37
37
|
* @summary List invoices of a customer
|
|
38
38
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
39
|
-
* @param {
|
|
40
|
-
* @param {
|
|
41
|
-
* @param {
|
|
42
|
-
* @param {
|
|
43
|
-
* @param {
|
|
44
|
-
* @param {
|
|
45
|
-
* @param {
|
|
39
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
40
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
41
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
42
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
43
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
44
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
45
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
46
46
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
47
47
|
* @param {*} [options] Override http request option.
|
|
48
48
|
* @throws {RequiredError}
|
|
49
49
|
*/
|
|
50
|
-
listInvoices: async (customerCode: string, pageSize?:
|
|
50
|
+
listInvoices: async (customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51
51
|
// verify required parameter 'customerCode' is not null or undefined
|
|
52
52
|
assertParamExists('listInvoices', 'customerCode', customerCode)
|
|
53
53
|
const localVarPath = `/v1/customers/{customerCode}/invoices`
|
|
@@ -122,18 +122,18 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
122
122
|
* List all the invoices of a customer.
|
|
123
123
|
* @summary List invoices of a customer
|
|
124
124
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
125
|
-
* @param {
|
|
126
|
-
* @param {
|
|
127
|
-
* @param {
|
|
128
|
-
* @param {
|
|
129
|
-
* @param {
|
|
130
|
-
* @param {
|
|
131
|
-
* @param {
|
|
125
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
126
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
127
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
128
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
129
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
130
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
131
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
132
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
134
134
|
* @throws {RequiredError}
|
|
135
135
|
*/
|
|
136
|
-
async listInvoices(customerCode: string, pageSize?:
|
|
136
|
+
async listInvoices(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>> {
|
|
137
137
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listInvoices(customerCode, pageSize, pageToken, filter, search, order, expand, filters, authorization, options);
|
|
138
138
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
139
139
|
},
|
|
@@ -151,18 +151,18 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
151
151
|
* List all the invoices of a customer.
|
|
152
152
|
* @summary List invoices of a customer
|
|
153
153
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
154
|
-
* @param {
|
|
155
|
-
* @param {
|
|
156
|
-
* @param {
|
|
157
|
-
* @param {
|
|
158
|
-
* @param {
|
|
159
|
-
* @param {
|
|
160
|
-
* @param {
|
|
154
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
156
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
157
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
159
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
160
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
161
161
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
162
|
* @param {*} [options] Override http request option.
|
|
163
163
|
* @throws {RequiredError}
|
|
164
164
|
*/
|
|
165
|
-
listInvoices(customerCode: string, pageSize?:
|
|
165
|
+
listInvoices(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListInvoicesResponseClass> {
|
|
166
166
|
return localVarFp.listInvoices(customerCode, pageSize, pageToken, filter, search, order, expand, filters, authorization, options).then((request) => request(axios, basePath));
|
|
167
167
|
},
|
|
168
168
|
};
|
|
@@ -183,52 +183,52 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
183
183
|
|
|
184
184
|
/**
|
|
185
185
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
|
-
* @type {
|
|
186
|
+
* @type {number}
|
|
187
187
|
* @memberof InvoicesApiListInvoices
|
|
188
188
|
*/
|
|
189
|
-
readonly pageSize?:
|
|
189
|
+
readonly pageSize?: number
|
|
190
190
|
|
|
191
191
|
/**
|
|
192
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
193
|
-
* @type {
|
|
192
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
|
+
* @type {string}
|
|
194
194
|
* @memberof InvoicesApiListInvoices
|
|
195
195
|
*/
|
|
196
|
-
readonly pageToken?:
|
|
196
|
+
readonly pageToken?: string
|
|
197
197
|
|
|
198
198
|
/**
|
|
199
199
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
200
|
-
* @type {
|
|
200
|
+
* @type {string}
|
|
201
201
|
* @memberof InvoicesApiListInvoices
|
|
202
202
|
*/
|
|
203
|
-
readonly filter?:
|
|
203
|
+
readonly filter?: string
|
|
204
204
|
|
|
205
205
|
/**
|
|
206
206
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
207
|
-
* @type {
|
|
207
|
+
* @type {string}
|
|
208
208
|
* @memberof InvoicesApiListInvoices
|
|
209
209
|
*/
|
|
210
|
-
readonly search?:
|
|
210
|
+
readonly search?: string
|
|
211
211
|
|
|
212
212
|
/**
|
|
213
213
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
214
|
-
* @type {
|
|
214
|
+
* @type {string}
|
|
215
215
|
* @memberof InvoicesApiListInvoices
|
|
216
216
|
*/
|
|
217
|
-
readonly order?:
|
|
217
|
+
readonly order?: string
|
|
218
218
|
|
|
219
219
|
/**
|
|
220
|
-
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in
|
|
221
|
-
* @type {
|
|
220
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
221
|
+
* @type {string}
|
|
222
222
|
* @memberof InvoicesApiListInvoices
|
|
223
223
|
*/
|
|
224
|
-
readonly expand?:
|
|
224
|
+
readonly expand?: string
|
|
225
225
|
|
|
226
226
|
/**
|
|
227
227
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
228
|
-
* @type {
|
|
228
|
+
* @type {string}
|
|
229
229
|
* @memberof InvoicesApiListInvoices
|
|
230
230
|
*/
|
|
231
|
-
readonly filters?:
|
|
231
|
+
readonly filters?: string
|
|
232
232
|
|
|
233
233
|
/**
|
|
234
234
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
package/api/leads-api.ts
CHANGED
|
@@ -96,20 +96,20 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
96
96
|
/**
|
|
97
97
|
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
98
98
|
* @summary Retrieve the lead
|
|
99
|
-
* @param {string}
|
|
99
|
+
* @param {string} code Unique identifier for the object.
|
|
100
100
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
101
101
|
* @param {string} [authorization] Bearer Token
|
|
102
102
|
* @param {string} [expand]
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
104
104
|
* @throws {RequiredError}
|
|
105
105
|
*/
|
|
106
|
-
getLead: async (
|
|
107
|
-
// verify required parameter '
|
|
108
|
-
assertParamExists('getLead', '
|
|
106
|
+
getLead: async (code: string, customerCode: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
107
|
+
// verify required parameter 'code' is not null or undefined
|
|
108
|
+
assertParamExists('getLead', 'code', code)
|
|
109
109
|
// verify required parameter 'customerCode' is not null or undefined
|
|
110
110
|
assertParamExists('getLead', 'customerCode', customerCode)
|
|
111
|
-
const localVarPath = `/v1/customers/{customerCode}/leads/{
|
|
112
|
-
.replace(`{${"
|
|
111
|
+
const localVarPath = `/v1/customers/{customerCode}/leads/{code}`
|
|
112
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
113
113
|
.replace(`{${"customerCode"}}`, encodeURIComponent(String(customerCode)));
|
|
114
114
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
115
115
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -152,17 +152,17 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
152
152
|
* @summary List leads
|
|
153
153
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
154
154
|
* @param {string} [authorization] Bearer Token
|
|
155
|
-
* @param {
|
|
156
|
-
* @param {
|
|
157
|
-
* @param {
|
|
158
|
-
* @param {
|
|
159
|
-
* @param {
|
|
160
|
-
* @param {
|
|
161
|
-
* @param {
|
|
155
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
156
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
157
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
158
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
159
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
160
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
161
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
162
162
|
* @param {*} [options] Override http request option.
|
|
163
163
|
* @throws {RequiredError}
|
|
164
164
|
*/
|
|
165
|
-
listLeads: async (customerCode: string, authorization?: string, pageSize?:
|
|
165
|
+
listLeads: async (customerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
166
166
|
// verify required parameter 'customerCode' is not null or undefined
|
|
167
167
|
assertParamExists('listLeads', 'customerCode', customerCode)
|
|
168
168
|
const localVarPath = `/v1/customers/{customerCode}/leads`
|
|
@@ -230,22 +230,22 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
230
230
|
/**
|
|
231
231
|
* Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
232
232
|
* @summary Update the lead
|
|
233
|
-
* @param {string}
|
|
233
|
+
* @param {string} code Unique identifier for the object.
|
|
234
234
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
235
235
|
* @param {UpdateLeadRequestDto} updateLeadRequestDto
|
|
236
236
|
* @param {string} [authorization] Bearer Token
|
|
237
237
|
* @param {*} [options] Override http request option.
|
|
238
238
|
* @throws {RequiredError}
|
|
239
239
|
*/
|
|
240
|
-
updateLead: async (
|
|
241
|
-
// verify required parameter '
|
|
242
|
-
assertParamExists('updateLead', '
|
|
240
|
+
updateLead: async (code: string, customerCode: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
241
|
+
// verify required parameter 'code' is not null or undefined
|
|
242
|
+
assertParamExists('updateLead', 'code', code)
|
|
243
243
|
// verify required parameter 'customerCode' is not null or undefined
|
|
244
244
|
assertParamExists('updateLead', 'customerCode', customerCode)
|
|
245
245
|
// verify required parameter 'updateLeadRequestDto' is not null or undefined
|
|
246
246
|
assertParamExists('updateLead', 'updateLeadRequestDto', updateLeadRequestDto)
|
|
247
|
-
const localVarPath = `/v1/customers/{customerCode}/leads/{
|
|
248
|
-
.replace(`{${"
|
|
247
|
+
const localVarPath = `/v1/customers/{customerCode}/leads/{code}`
|
|
248
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
249
249
|
.replace(`{${"customerCode"}}`, encodeURIComponent(String(customerCode)));
|
|
250
250
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
251
251
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -308,15 +308,15 @@ export const LeadsApiFp = function(configuration?: Configuration) {
|
|
|
308
308
|
/**
|
|
309
309
|
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
310
310
|
* @summary Retrieve the lead
|
|
311
|
-
* @param {string}
|
|
311
|
+
* @param {string} code Unique identifier for the object.
|
|
312
312
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
313
313
|
* @param {string} [authorization] Bearer Token
|
|
314
314
|
* @param {string} [expand]
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
async getLead(
|
|
319
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getLead(
|
|
318
|
+
async getLead(code: string, customerCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadResponseClass>> {
|
|
319
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getLead(code, customerCode, authorization, expand, options);
|
|
320
320
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
321
321
|
},
|
|
322
322
|
/**
|
|
@@ -324,32 +324,32 @@ export const LeadsApiFp = function(configuration?: Configuration) {
|
|
|
324
324
|
* @summary List leads
|
|
325
325
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
326
326
|
* @param {string} [authorization] Bearer Token
|
|
327
|
-
* @param {
|
|
328
|
-
* @param {
|
|
329
|
-
* @param {
|
|
330
|
-
* @param {
|
|
331
|
-
* @param {
|
|
332
|
-
* @param {
|
|
333
|
-
* @param {
|
|
327
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
328
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
329
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
330
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
331
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
332
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
333
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
334
334
|
* @param {*} [options] Override http request option.
|
|
335
335
|
* @throws {RequiredError}
|
|
336
336
|
*/
|
|
337
|
-
async listLeads(customerCode: string, authorization?: string, pageSize?:
|
|
337
|
+
async listLeads(customerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadsResponseClass>> {
|
|
338
338
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listLeads(customerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
339
339
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
340
|
},
|
|
341
341
|
/**
|
|
342
342
|
* Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
343
343
|
* @summary Update the lead
|
|
344
|
-
* @param {string}
|
|
344
|
+
* @param {string} code Unique identifier for the object.
|
|
345
345
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
346
346
|
* @param {UpdateLeadRequestDto} updateLeadRequestDto
|
|
347
347
|
* @param {string} [authorization] Bearer Token
|
|
348
348
|
* @param {*} [options] Override http request option.
|
|
349
349
|
* @throws {RequiredError}
|
|
350
350
|
*/
|
|
351
|
-
async updateLead(
|
|
352
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateLead(
|
|
351
|
+
async updateLead(code: string, customerCode: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLeadResponseClass>> {
|
|
352
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateLead(code, customerCode, updateLeadRequestDto, authorization, options);
|
|
353
353
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
354
354
|
},
|
|
355
355
|
}
|
|
@@ -377,46 +377,46 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
|
|
|
377
377
|
/**
|
|
378
378
|
* Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
|
|
379
379
|
* @summary Retrieve the lead
|
|
380
|
-
* @param {string}
|
|
380
|
+
* @param {string} code Unique identifier for the object.
|
|
381
381
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
382
382
|
* @param {string} [authorization] Bearer Token
|
|
383
383
|
* @param {string} [expand]
|
|
384
384
|
* @param {*} [options] Override http request option.
|
|
385
385
|
* @throws {RequiredError}
|
|
386
386
|
*/
|
|
387
|
-
getLead(
|
|
388
|
-
return localVarFp.getLead(
|
|
387
|
+
getLead(code: string, customerCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetLeadResponseClass> {
|
|
388
|
+
return localVarFp.getLead(code, customerCode, authorization, expand, options).then((request) => request(axios, basePath));
|
|
389
389
|
},
|
|
390
390
|
/**
|
|
391
391
|
* Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
392
392
|
* @summary List leads
|
|
393
393
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
394
394
|
* @param {string} [authorization] Bearer Token
|
|
395
|
-
* @param {
|
|
396
|
-
* @param {
|
|
397
|
-
* @param {
|
|
398
|
-
* @param {
|
|
399
|
-
* @param {
|
|
400
|
-
* @param {
|
|
401
|
-
* @param {
|
|
395
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
396
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
397
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
398
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
399
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
400
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
401
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
402
402
|
* @param {*} [options] Override http request option.
|
|
403
403
|
* @throws {RequiredError}
|
|
404
404
|
*/
|
|
405
|
-
listLeads(customerCode: string, authorization?: string, pageSize?:
|
|
405
|
+
listLeads(customerCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLeadsResponseClass> {
|
|
406
406
|
return localVarFp.listLeads(customerCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
407
407
|
},
|
|
408
408
|
/**
|
|
409
409
|
* Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
410
410
|
* @summary Update the lead
|
|
411
|
-
* @param {string}
|
|
411
|
+
* @param {string} code Unique identifier for the object.
|
|
412
412
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
413
413
|
* @param {UpdateLeadRequestDto} updateLeadRequestDto
|
|
414
414
|
* @param {string} [authorization] Bearer Token
|
|
415
415
|
* @param {*} [options] Override http request option.
|
|
416
416
|
* @throws {RequiredError}
|
|
417
417
|
*/
|
|
418
|
-
updateLead(
|
|
419
|
-
return localVarFp.updateLead(
|
|
418
|
+
updateLead(code: string, customerCode: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLeadResponseClass> {
|
|
419
|
+
return localVarFp.updateLead(code, customerCode, updateLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
420
420
|
},
|
|
421
421
|
};
|
|
422
422
|
};
|
|
@@ -456,11 +456,11 @@ export interface LeadsApiCreateLeadRequest {
|
|
|
456
456
|
*/
|
|
457
457
|
export interface LeadsApiGetLeadRequest {
|
|
458
458
|
/**
|
|
459
|
-
*
|
|
459
|
+
* Unique identifier for the object.
|
|
460
460
|
* @type {string}
|
|
461
461
|
* @memberof LeadsApiGetLead
|
|
462
462
|
*/
|
|
463
|
-
readonly
|
|
463
|
+
readonly code: string
|
|
464
464
|
|
|
465
465
|
/**
|
|
466
466
|
* The customer code or \"me\" for the currently logged in customer.
|
|
@@ -506,52 +506,52 @@ export interface LeadsApiListLeadsRequest {
|
|
|
506
506
|
|
|
507
507
|
/**
|
|
508
508
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
509
|
-
* @type {
|
|
509
|
+
* @type {number}
|
|
510
510
|
* @memberof LeadsApiListLeads
|
|
511
511
|
*/
|
|
512
|
-
readonly pageSize?:
|
|
512
|
+
readonly pageSize?: number
|
|
513
513
|
|
|
514
514
|
/**
|
|
515
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
516
|
-
* @type {
|
|
515
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
516
|
+
* @type {string}
|
|
517
517
|
* @memberof LeadsApiListLeads
|
|
518
518
|
*/
|
|
519
|
-
readonly pageToken?:
|
|
519
|
+
readonly pageToken?: string
|
|
520
520
|
|
|
521
521
|
/**
|
|
522
522
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
523
|
-
* @type {
|
|
523
|
+
* @type {string}
|
|
524
524
|
* @memberof LeadsApiListLeads
|
|
525
525
|
*/
|
|
526
|
-
readonly filter?:
|
|
526
|
+
readonly filter?: string
|
|
527
527
|
|
|
528
528
|
/**
|
|
529
529
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
530
|
-
* @type {
|
|
530
|
+
* @type {string}
|
|
531
531
|
* @memberof LeadsApiListLeads
|
|
532
532
|
*/
|
|
533
|
-
readonly search?:
|
|
533
|
+
readonly search?: string
|
|
534
534
|
|
|
535
535
|
/**
|
|
536
536
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
537
|
-
* @type {
|
|
537
|
+
* @type {string}
|
|
538
538
|
* @memberof LeadsApiListLeads
|
|
539
539
|
*/
|
|
540
|
-
readonly order?:
|
|
540
|
+
readonly order?: string
|
|
541
541
|
|
|
542
542
|
/**
|
|
543
|
-
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in
|
|
544
|
-
* @type {
|
|
543
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
544
|
+
* @type {string}
|
|
545
545
|
* @memberof LeadsApiListLeads
|
|
546
546
|
*/
|
|
547
|
-
readonly expand?:
|
|
547
|
+
readonly expand?: string
|
|
548
548
|
|
|
549
549
|
/**
|
|
550
550
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
551
|
-
* @type {
|
|
551
|
+
* @type {string}
|
|
552
552
|
* @memberof LeadsApiListLeads
|
|
553
553
|
*/
|
|
554
|
-
readonly filters?:
|
|
554
|
+
readonly filters?: string
|
|
555
555
|
}
|
|
556
556
|
|
|
557
557
|
/**
|
|
@@ -561,11 +561,11 @@ export interface LeadsApiListLeadsRequest {
|
|
|
561
561
|
*/
|
|
562
562
|
export interface LeadsApiUpdateLeadRequest {
|
|
563
563
|
/**
|
|
564
|
-
*
|
|
564
|
+
* Unique identifier for the object.
|
|
565
565
|
* @type {string}
|
|
566
566
|
* @memberof LeadsApiUpdateLead
|
|
567
567
|
*/
|
|
568
|
-
readonly
|
|
568
|
+
readonly code: string
|
|
569
569
|
|
|
570
570
|
/**
|
|
571
571
|
* The customer code or \"me\" for the currently logged in customer.
|
|
@@ -617,7 +617,7 @@ export class LeadsApi extends BaseAPI {
|
|
|
617
617
|
* @memberof LeadsApi
|
|
618
618
|
*/
|
|
619
619
|
public getLead(requestParameters: LeadsApiGetLeadRequest, options?: AxiosRequestConfig) {
|
|
620
|
-
return LeadsApiFp(this.configuration).getLead(requestParameters.
|
|
620
|
+
return LeadsApiFp(this.configuration).getLead(requestParameters.code, requestParameters.customerCode, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
621
621
|
}
|
|
622
622
|
|
|
623
623
|
/**
|
|
@@ -641,6 +641,6 @@ export class LeadsApi extends BaseAPI {
|
|
|
641
641
|
* @memberof LeadsApi
|
|
642
642
|
*/
|
|
643
643
|
public updateLead(requestParameters: LeadsApiUpdateLeadRequest, options?: AxiosRequestConfig) {
|
|
644
|
-
return LeadsApiFp(this.configuration).updateLead(requestParameters.
|
|
644
|
+
return LeadsApiFp(this.configuration).updateLead(requestParameters.code, requestParameters.customerCode, requestParameters.updateLeadRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
645
645
|
}
|
|
646
646
|
}
|