@emilgroup/public-api-sdk-node 1.27.1 → 1.29.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/.openapi-generator/FILES +9 -0
- package/README.md +18 -2
- package/api/booking-funnels-api.ts +165 -0
- package/api/documents-api.ts +56 -28
- package/api/leads-api.ts +4 -4
- package/api/named-ranges-api.ts +254 -0
- package/api/products-api.ts +65 -38
- package/api.ts +4 -0
- package/dist/api/booking-funnels-api.d.ts +96 -0
- package/dist/api/booking-funnels-api.js +227 -0
- package/dist/api/documents-api.d.ts +40 -22
- package/dist/api/documents-api.js +38 -26
- package/dist/api/leads-api.d.ts +4 -4
- package/dist/api/leads-api.js +4 -4
- package/dist/api/named-ranges-api.d.ts +150 -0
- package/dist/api/named-ranges-api.js +267 -0
- package/dist/api/products-api.d.ts +49 -31
- package/dist/api/products-api.js +47 -36
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/address-field-score-class.d.ts +10 -10
- package/dist/models/booking-funnel-class.d.ts +90 -0
- package/dist/models/booking-funnel-class.js +15 -0
- package/dist/models/create-account-request-dto.d.ts +1 -1
- package/dist/models/create-account-request-dto.js +1 -1
- package/dist/models/create-document-request-dto.d.ts +2 -2
- package/dist/models/create-lead-request-dto.d.ts +13 -1
- package/dist/models/create-presigned-post-request-dto.d.ts +2 -2
- package/dist/models/document-class.d.ts +1 -1
- package/dist/models/filter-named-range-response-class.d.ts +42 -0
- package/dist/models/filter-named-range-response-class.js +15 -0
- package/dist/models/get-booking-funnel-response-class.d.ts +25 -0
- package/dist/models/get-booking-funnel-response-class.js +15 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/initiate-email-verification-dto.d.ts +1 -1
- package/dist/models/insured-object-type-class.d.ts +1 -1
- package/dist/models/lead-account-class.d.ts +1 -1
- package/dist/models/lead-account-class.js +1 -1
- package/dist/models/lead-class.d.ts +7 -0
- package/dist/models/lead-policy-object-class.d.ts +2 -2
- package/dist/models/partner-class.d.ts +60 -0
- package/dist/models/partner-class.js +15 -0
- package/dist/models/partner-link-class.d.ts +86 -0
- package/dist/models/partner-link-class.js +15 -0
- package/dist/models/partner-role-class.d.ts +54 -0
- package/dist/models/partner-role-class.js +15 -0
- package/dist/models/product-class.d.ts +1 -1
- package/dist/models/product-document-class.d.ts +14 -2
- package/dist/models/product-factor-for-version-class.d.ts +4 -3
- package/dist/models/product-factor-value-for-version-class.d.ts +42 -0
- package/dist/models/product-factor-value-for-version-class.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +1 -1
- package/dist/models/update-lead-request-dto.d.ts +1 -1
- package/models/address-field-score-class.ts +10 -10
- package/models/booking-funnel-class.ts +96 -0
- package/models/create-account-request-dto.ts +1 -1
- package/models/create-document-request-dto.ts +2 -2
- package/models/create-lead-request-dto.ts +13 -1
- package/models/create-presigned-post-request-dto.ts +2 -2
- package/models/document-class.ts +1 -1
- package/models/filter-named-range-response-class.ts +48 -0
- package/models/get-booking-funnel-response-class.ts +31 -0
- package/models/index.ts +7 -0
- package/models/initiate-email-verification-dto.ts +1 -1
- package/models/insured-object-type-class.ts +1 -1
- package/models/lead-account-class.ts +1 -1
- package/models/lead-class.ts +7 -0
- package/models/lead-policy-object-class.ts +2 -2
- package/models/partner-class.ts +66 -0
- package/models/partner-link-class.ts +92 -0
- package/models/partner-role-class.ts +60 -0
- package/models/product-class.ts +1 -1
- package/models/product-document-class.ts +14 -2
- package/models/product-factor-for-version-class.ts +4 -3
- package/models/product-factor-value-for-version-class.ts +48 -0
- package/models/send-notification-request-dto.ts +1 -1
- package/models/update-lead-request-dto.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
6
|
api/address-completions-validations-api.ts
|
|
7
|
+
api/booking-funnels-api.ts
|
|
7
8
|
api/default-api.ts
|
|
8
9
|
api/documents-api.ts
|
|
9
10
|
api/leads-api.ts
|
|
11
|
+
api/named-ranges-api.ts
|
|
10
12
|
api/notifications-api.ts
|
|
11
13
|
api/payments-setup-api.ts
|
|
12
14
|
api/products-api.ts
|
|
@@ -18,6 +20,7 @@ index.ts
|
|
|
18
20
|
models/address-completion-item-class.ts
|
|
19
21
|
models/address-completion-response-class.ts
|
|
20
22
|
models/address-field-score-class.ts
|
|
23
|
+
models/booking-funnel-class.ts
|
|
21
24
|
models/calculate-product-fields-request-dto.ts
|
|
22
25
|
models/calculate-product-fields-response-class.ts
|
|
23
26
|
models/complete-braintree-payment-setup-request-dto.ts
|
|
@@ -40,6 +43,8 @@ models/create-payment-method-request-dto.ts
|
|
|
40
43
|
models/create-presigned-post-request-dto.ts
|
|
41
44
|
models/create-presigned-post-response-class.ts
|
|
42
45
|
models/document-class.ts
|
|
46
|
+
models/filter-named-range-response-class.ts
|
|
47
|
+
models/get-booking-funnel-response-class.ts
|
|
43
48
|
models/get-custom-css-response-class.ts
|
|
44
49
|
models/get-lead-response-class.ts
|
|
45
50
|
models/get-product-document-download-url-response-class.ts
|
|
@@ -69,6 +74,9 @@ models/lead-policy-object-class.ts
|
|
|
69
74
|
models/list-documents-response-class.ts
|
|
70
75
|
models/list-product-documents-response-class.ts
|
|
71
76
|
models/list-products-response-class.ts
|
|
77
|
+
models/partner-class.ts
|
|
78
|
+
models/partner-link-class.ts
|
|
79
|
+
models/partner-role-class.ts
|
|
72
80
|
models/payment-method-class.ts
|
|
73
81
|
models/policy-object-request-dto.ts
|
|
74
82
|
models/policy-object-response-class.ts
|
|
@@ -77,6 +85,7 @@ models/premium-override-request-dto.ts
|
|
|
77
85
|
models/product-class.ts
|
|
78
86
|
models/product-document-class.ts
|
|
79
87
|
models/product-factor-for-version-class.ts
|
|
88
|
+
models/product-factor-value-for-version-class.ts
|
|
80
89
|
models/product-field-class.ts
|
|
81
90
|
models/product-version-class.ts
|
|
82
91
|
models/send-notification-request-dto.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/public-api-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/public-api-sdk-node@1.29.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/public-api-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/public-api-sdk-node@1.29.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PublicApi`.
|
|
@@ -47,6 +47,22 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
|
|
|
47
47
|
export EMIL_PASSWORD=XXXXXXXXXXXXXX
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
+
## Base path
|
|
51
|
+
|
|
52
|
+
To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
import { PublicApi, Environment } from '@emilgroup/public-api-sdk-node'
|
|
56
|
+
|
|
57
|
+
const publicApi = new PublicApi();
|
|
58
|
+
|
|
59
|
+
// Allows you to simply choose environment. It will usually be Environment.Production.
|
|
60
|
+
publicApi.selectEnvironment(Environment.Production);
|
|
61
|
+
|
|
62
|
+
// For advanced users, use the custom baseUrl of the website you need to connect to.
|
|
63
|
+
publicApi.selectBasePath('https://my-custom-domain.com');
|
|
64
|
+
```
|
|
65
|
+
|
|
50
66
|
## Example
|
|
51
67
|
|
|
52
68
|
Here is a basic functionning example:
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Emil PublicAPI
|
|
5
|
+
* The Emil Public API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { GetBookingFunnelResponseClass } from '../models';
|
|
25
|
+
// URLSearchParams not necessarily used
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import { URL, URLSearchParams } from 'url';
|
|
28
|
+
const FormData = require('form-data');
|
|
29
|
+
/**
|
|
30
|
+
* BookingFunnelsApi - axios parameter creator
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
export const BookingFunnelsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
|
+
return {
|
|
35
|
+
/**
|
|
36
|
+
* Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
|
|
37
|
+
* @summary Retrieve the booking funnel
|
|
38
|
+
* @param {string} code Unique identifier for the object.
|
|
39
|
+
* @param {string} [authorization] Bearer Token
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
getBookingFunnel: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44
|
+
// verify required parameter 'code' is not null or undefined
|
|
45
|
+
assertParamExists('getBookingFunnel', 'code', code)
|
|
46
|
+
const localVarPath = `/publicapi/v1/booking-funnels/{code}`
|
|
47
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
48
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50
|
+
let baseOptions;
|
|
51
|
+
let baseAccessToken;
|
|
52
|
+
if (configuration) {
|
|
53
|
+
baseOptions = configuration.baseOptions;
|
|
54
|
+
baseAccessToken = configuration.accessToken;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
58
|
+
const localVarHeaderParameter = {} as any;
|
|
59
|
+
const localVarQueryParameter = {} as any;
|
|
60
|
+
|
|
61
|
+
// authentication bearer required
|
|
62
|
+
// http bearer authentication required
|
|
63
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
64
|
+
|
|
65
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
66
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
72
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
73
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
74
|
+
|
|
75
|
+
return {
|
|
76
|
+
url: toPathString(localVarUrlObj),
|
|
77
|
+
options: localVarRequestOptions,
|
|
78
|
+
};
|
|
79
|
+
},
|
|
80
|
+
}
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* BookingFunnelsApi - functional programming interface
|
|
85
|
+
* @export
|
|
86
|
+
*/
|
|
87
|
+
export const BookingFunnelsApiFp = function(configuration?: Configuration) {
|
|
88
|
+
const localVarAxiosParamCreator = BookingFunnelsApiAxiosParamCreator(configuration)
|
|
89
|
+
return {
|
|
90
|
+
/**
|
|
91
|
+
* Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
|
|
92
|
+
* @summary Retrieve the booking funnel
|
|
93
|
+
* @param {string} code Unique identifier for the object.
|
|
94
|
+
* @param {string} [authorization] Bearer Token
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
async getBookingFunnel(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBookingFunnelResponseClass>> {
|
|
99
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBookingFunnel(code, authorization, options);
|
|
100
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
101
|
+
},
|
|
102
|
+
}
|
|
103
|
+
};
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* BookingFunnelsApi - factory interface
|
|
107
|
+
* @export
|
|
108
|
+
*/
|
|
109
|
+
export const BookingFunnelsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
110
|
+
const localVarFp = BookingFunnelsApiFp(configuration)
|
|
111
|
+
return {
|
|
112
|
+
/**
|
|
113
|
+
* Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
|
|
114
|
+
* @summary Retrieve the booking funnel
|
|
115
|
+
* @param {string} code Unique identifier for the object.
|
|
116
|
+
* @param {string} [authorization] Bearer Token
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
getBookingFunnel(code: string, authorization?: string, options?: any): AxiosPromise<GetBookingFunnelResponseClass> {
|
|
121
|
+
return localVarFp.getBookingFunnel(code, authorization, options).then((request) => request(axios, basePath));
|
|
122
|
+
},
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Request parameters for getBookingFunnel operation in BookingFunnelsApi.
|
|
128
|
+
* @export
|
|
129
|
+
* @interface BookingFunnelsApiGetBookingFunnelRequest
|
|
130
|
+
*/
|
|
131
|
+
export interface BookingFunnelsApiGetBookingFunnelRequest {
|
|
132
|
+
/**
|
|
133
|
+
* Unique identifier for the object.
|
|
134
|
+
* @type {string}
|
|
135
|
+
* @memberof BookingFunnelsApiGetBookingFunnel
|
|
136
|
+
*/
|
|
137
|
+
readonly code: string
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Bearer Token
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof BookingFunnelsApiGetBookingFunnel
|
|
143
|
+
*/
|
|
144
|
+
readonly authorization?: string
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* BookingFunnelsApi - object-oriented interface
|
|
149
|
+
* @export
|
|
150
|
+
* @class BookingFunnelsApi
|
|
151
|
+
* @extends {BaseAPI}
|
|
152
|
+
*/
|
|
153
|
+
export class BookingFunnelsApi extends BaseAPI {
|
|
154
|
+
/**
|
|
155
|
+
* Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
|
|
156
|
+
* @summary Retrieve the booking funnel
|
|
157
|
+
* @param {BookingFunnelsApiGetBookingFunnelRequest} requestParameters Request parameters.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
* @memberof BookingFunnelsApi
|
|
161
|
+
*/
|
|
162
|
+
public getBookingFunnel(requestParameters: BookingFunnelsApiGetBookingFunnelRequest, options?: AxiosRequestConfig) {
|
|
163
|
+
return BookingFunnelsApiFp(this.configuration).getBookingFunnel(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
164
|
+
}
|
|
165
|
+
}
|
package/api/documents-api.ts
CHANGED
|
@@ -189,10 +189,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
189
189
|
* @param {string} productCode
|
|
190
190
|
* @param {string} code
|
|
191
191
|
* @param {string} [authorization] Bearer Token
|
|
192
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
192
193
|
* @param {*} [options] Override http request option.
|
|
193
194
|
* @throws {RequiredError}
|
|
194
195
|
*/
|
|
195
|
-
downloadProductDocumentUrl: async (productCode: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
|
+
downloadProductDocumentUrl: async (productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
197
|
// verify required parameter 'productCode' is not null or undefined
|
|
197
198
|
assertParamExists('downloadProductDocumentUrl', 'productCode', productCode)
|
|
198
199
|
// verify required parameter 'code' is not null or undefined
|
|
@@ -217,6 +218,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
217
218
|
// http bearer authentication required
|
|
218
219
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
219
220
|
|
|
221
|
+
if (contentDisposition !== undefined) {
|
|
222
|
+
localVarQueryParameter['contentDisposition'] = contentDisposition;
|
|
223
|
+
}
|
|
224
|
+
|
|
220
225
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
221
226
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
222
227
|
}
|
|
@@ -233,7 +238,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
233
238
|
};
|
|
234
239
|
},
|
|
235
240
|
/**
|
|
236
|
-
* Returns a list of documents you have previously created.
|
|
241
|
+
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
237
242
|
* @summary List documents
|
|
238
243
|
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
239
244
|
* @param {string} [authorization] Bearer Token
|
|
@@ -301,20 +306,21 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
301
306
|
};
|
|
302
307
|
},
|
|
303
308
|
/**
|
|
304
|
-
* Returns a list of product documents you have previously created.
|
|
309
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
305
310
|
* @summary List product documents
|
|
306
311
|
* @param {string} productCode
|
|
307
312
|
* @param {string} [authorization] Bearer Token
|
|
308
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
313
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
314
|
* @param {any} [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.
|
|
310
315
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
311
|
-
* @param {any} [search]
|
|
316
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
317
|
* @param {any} [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.
|
|
313
318
|
* @param {any} [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.
|
|
319
|
+
* @param {any} [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.
|
|
314
320
|
* @param {*} [options] Override http request option.
|
|
315
321
|
* @throws {RequiredError}
|
|
316
322
|
*/
|
|
317
|
-
listProductDocuments: async (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
323
|
+
listProductDocuments: async (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
318
324
|
// verify required parameter 'productCode' is not null or undefined
|
|
319
325
|
assertParamExists('listProductDocuments', 'productCode', productCode)
|
|
320
326
|
const localVarPath = `/publicapi/v1/documents/{productCode}`
|
|
@@ -360,6 +366,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
360
366
|
localVarQueryParameter['expand'] = expand;
|
|
361
367
|
}
|
|
362
368
|
|
|
369
|
+
if (filters !== undefined) {
|
|
370
|
+
localVarQueryParameter['filters'] = filters;
|
|
371
|
+
}
|
|
372
|
+
|
|
363
373
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
364
374
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
365
375
|
}
|
|
@@ -475,15 +485,16 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
475
485
|
* @param {string} productCode
|
|
476
486
|
* @param {string} code
|
|
477
487
|
* @param {string} [authorization] Bearer Token
|
|
488
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
478
489
|
* @param {*} [options] Override http request option.
|
|
479
490
|
* @throws {RequiredError}
|
|
480
491
|
*/
|
|
481
|
-
async downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
482
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, options);
|
|
492
|
+
async downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
493
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options);
|
|
483
494
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
484
495
|
},
|
|
485
496
|
/**
|
|
486
|
-
* Returns a list of documents you have previously created.
|
|
497
|
+
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
487
498
|
* @summary List documents
|
|
488
499
|
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
489
500
|
* @param {string} [authorization] Bearer Token
|
|
@@ -499,21 +510,22 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
499
510
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
500
511
|
},
|
|
501
512
|
/**
|
|
502
|
-
* Returns a list of product documents you have previously created.
|
|
513
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
503
514
|
* @summary List product documents
|
|
504
515
|
* @param {string} productCode
|
|
505
516
|
* @param {string} [authorization] Bearer Token
|
|
506
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
517
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
507
518
|
* @param {any} [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.
|
|
508
519
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
509
|
-
* @param {any} [search]
|
|
520
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
510
521
|
* @param {any} [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.
|
|
511
522
|
* @param {any} [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.
|
|
523
|
+
* @param {any} [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.
|
|
512
524
|
* @param {*} [options] Override http request option.
|
|
513
525
|
* @throws {RequiredError}
|
|
514
526
|
*/
|
|
515
|
-
async listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
|
|
516
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
527
|
+
async listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
|
|
528
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
517
529
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
518
530
|
},
|
|
519
531
|
/**
|
|
@@ -578,14 +590,15 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
578
590
|
* @param {string} productCode
|
|
579
591
|
* @param {string} code
|
|
580
592
|
* @param {string} [authorization] Bearer Token
|
|
593
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
581
594
|
* @param {*} [options] Override http request option.
|
|
582
595
|
* @throws {RequiredError}
|
|
583
596
|
*/
|
|
584
|
-
downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
585
|
-
return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, options).then((request) => request(axios, basePath));
|
|
597
|
+
downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
598
|
+
return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
586
599
|
},
|
|
587
600
|
/**
|
|
588
|
-
* Returns a list of documents you have previously created.
|
|
601
|
+
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
589
602
|
* @summary List documents
|
|
590
603
|
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
591
604
|
* @param {string} [authorization] Bearer Token
|
|
@@ -600,21 +613,22 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
600
613
|
return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then((request) => request(axios, basePath));
|
|
601
614
|
},
|
|
602
615
|
/**
|
|
603
|
-
* Returns a list of product documents you have previously created.
|
|
616
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
604
617
|
* @summary List product documents
|
|
605
618
|
* @param {string} productCode
|
|
606
619
|
* @param {string} [authorization] Bearer Token
|
|
607
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
620
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
608
621
|
* @param {any} [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.
|
|
609
622
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
610
|
-
* @param {any} [search]
|
|
623
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
611
624
|
* @param {any} [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.
|
|
612
625
|
* @param {any} [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.
|
|
626
|
+
* @param {any} [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.
|
|
613
627
|
* @param {*} [options] Override http request option.
|
|
614
628
|
* @throws {RequiredError}
|
|
615
629
|
*/
|
|
616
|
-
listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
617
|
-
return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
630
|
+
listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
631
|
+
return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
618
632
|
},
|
|
619
633
|
/**
|
|
620
634
|
* This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
|
|
@@ -726,6 +740,13 @@ export interface DocumentsApiDownloadProductDocumentUrlRequest {
|
|
|
726
740
|
* @memberof DocumentsApiDownloadProductDocumentUrl
|
|
727
741
|
*/
|
|
728
742
|
readonly authorization?: string
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* Content disposition override. Default will be depending on the document type.
|
|
746
|
+
* @type {'attachment' | 'inline'}
|
|
747
|
+
* @memberof DocumentsApiDownloadProductDocumentUrl
|
|
748
|
+
*/
|
|
749
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
729
750
|
}
|
|
730
751
|
|
|
731
752
|
/**
|
|
@@ -798,7 +819,7 @@ export interface DocumentsApiListProductDocumentsRequest {
|
|
|
798
819
|
readonly authorization?: string
|
|
799
820
|
|
|
800
821
|
/**
|
|
801
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
822
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
802
823
|
* @type {any}
|
|
803
824
|
* @memberof DocumentsApiListProductDocuments
|
|
804
825
|
*/
|
|
@@ -819,7 +840,7 @@ export interface DocumentsApiListProductDocumentsRequest {
|
|
|
819
840
|
readonly filter?: any
|
|
820
841
|
|
|
821
842
|
/**
|
|
822
|
-
*
|
|
843
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
823
844
|
* @type {any}
|
|
824
845
|
* @memberof DocumentsApiListProductDocuments
|
|
825
846
|
*/
|
|
@@ -838,6 +859,13 @@ export interface DocumentsApiListProductDocumentsRequest {
|
|
|
838
859
|
* @memberof DocumentsApiListProductDocuments
|
|
839
860
|
*/
|
|
840
861
|
readonly expand?: any
|
|
862
|
+
|
|
863
|
+
/**
|
|
864
|
+
* 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.
|
|
865
|
+
* @type {any}
|
|
866
|
+
* @memberof DocumentsApiListProductDocuments
|
|
867
|
+
*/
|
|
868
|
+
readonly filters?: any
|
|
841
869
|
}
|
|
842
870
|
|
|
843
871
|
/**
|
|
@@ -913,11 +941,11 @@ export class DocumentsApi extends BaseAPI {
|
|
|
913
941
|
* @memberof DocumentsApi
|
|
914
942
|
*/
|
|
915
943
|
public downloadProductDocumentUrl(requestParameters: DocumentsApiDownloadProductDocumentUrlRequest, options?: AxiosRequestConfig) {
|
|
916
|
-
return DocumentsApiFp(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
944
|
+
return DocumentsApiFp(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
|
|
917
945
|
}
|
|
918
946
|
|
|
919
947
|
/**
|
|
920
|
-
* Returns a list of documents you have previously created.
|
|
948
|
+
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
921
949
|
* @summary List documents
|
|
922
950
|
* @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
|
|
923
951
|
* @param {*} [options] Override http request option.
|
|
@@ -929,7 +957,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
929
957
|
}
|
|
930
958
|
|
|
931
959
|
/**
|
|
932
|
-
* Returns a list of product documents you have previously created.
|
|
960
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
933
961
|
* @summary List product documents
|
|
934
962
|
* @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
935
963
|
* @param {*} [options] Override http request option.
|
|
@@ -937,7 +965,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
937
965
|
* @memberof DocumentsApi
|
|
938
966
|
*/
|
|
939
967
|
public listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
|
|
940
|
-
return DocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
968
|
+
return DocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
941
969
|
}
|
|
942
970
|
|
|
943
971
|
/**
|
package/api/leads-api.ts
CHANGED
|
@@ -186,7 +186,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
186
186
|
};
|
|
187
187
|
},
|
|
188
188
|
/**
|
|
189
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
189
|
+
* 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.
|
|
190
190
|
* @summary Retrieve the lead
|
|
191
191
|
* @param {string} code Unique identifier for the object.
|
|
192
192
|
* @param {string} [authorization] Bearer Token
|
|
@@ -420,7 +420,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
|
|
|
420
420
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
423
|
+
* 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.
|
|
424
424
|
* @summary Retrieve the lead
|
|
425
425
|
* @param {string} code Unique identifier for the object.
|
|
426
426
|
* @param {string} [authorization] Bearer Token
|
|
@@ -512,7 +512,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
|
|
|
512
512
|
return localVarFp.createLeadSync(createLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
513
513
|
},
|
|
514
514
|
/**
|
|
515
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
515
|
+
* 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.
|
|
516
516
|
* @summary Retrieve the lead
|
|
517
517
|
* @param {string} code Unique identifier for the object.
|
|
518
518
|
* @param {string} [authorization] Bearer Token
|
|
@@ -757,7 +757,7 @@ export class LeadsApi extends BaseAPI {
|
|
|
757
757
|
}
|
|
758
758
|
|
|
759
759
|
/**
|
|
760
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
760
|
+
* 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.
|
|
761
761
|
* @summary Retrieve the lead
|
|
762
762
|
* @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
|
|
763
763
|
* @param {*} [options] Override http request option.
|