@emilgroup/public-api-sdk 1.25.1 → 1.27.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 +2 -2
- package/api/booking-funnels-api.ts +161 -0
- package/api/documents-api.ts +56 -28
- package/api/leads-api.ts +4 -4
- package/api/named-ranges-api.ts +250 -0
- package/api/products-api.ts +65 -38
- package/api.ts +4 -0
- package/base.ts +6 -1
- package/dist/api/booking-funnels-api.d.ts +96 -0
- package/dist/api/booking-funnels-api.js +223 -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 +263 -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/base.d.ts +1 -0
- package/dist/base.js +5 -1
- 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@1.
|
|
20
|
+
npm install @emilgroup/public-api-sdk@1.27.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/public-api-sdk@1.
|
|
24
|
+
yarn add @emilgroup/public-api-sdk@1.27.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PublicApi`.
|
|
@@ -0,0 +1,161 @@
|
|
|
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
|
+
/**
|
|
26
|
+
* BookingFunnelsApi - axios parameter creator
|
|
27
|
+
* @export
|
|
28
|
+
*/
|
|
29
|
+
export const BookingFunnelsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
30
|
+
return {
|
|
31
|
+
/**
|
|
32
|
+
* 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.
|
|
33
|
+
* @summary Retrieve the booking funnel
|
|
34
|
+
* @param {string} code Unique identifier for the object.
|
|
35
|
+
* @param {string} [authorization] Bearer Token
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
getBookingFunnel: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40
|
+
// verify required parameter 'code' is not null or undefined
|
|
41
|
+
assertParamExists('getBookingFunnel', 'code', code)
|
|
42
|
+
const localVarPath = `/publicapi/v1/booking-funnels/{code}`
|
|
43
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
44
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46
|
+
let baseOptions;
|
|
47
|
+
let baseAccessToken;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
baseAccessToken = configuration.accessToken;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
54
|
+
const localVarHeaderParameter = {} as any;
|
|
55
|
+
const localVarQueryParameter = {} as any;
|
|
56
|
+
|
|
57
|
+
// authentication bearer required
|
|
58
|
+
// http bearer authentication required
|
|
59
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60
|
+
|
|
61
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
62
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
68
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
69
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
70
|
+
|
|
71
|
+
return {
|
|
72
|
+
url: toPathString(localVarUrlObj),
|
|
73
|
+
options: localVarRequestOptions,
|
|
74
|
+
};
|
|
75
|
+
},
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* BookingFunnelsApi - functional programming interface
|
|
81
|
+
* @export
|
|
82
|
+
*/
|
|
83
|
+
export const BookingFunnelsApiFp = function(configuration?: Configuration) {
|
|
84
|
+
const localVarAxiosParamCreator = BookingFunnelsApiAxiosParamCreator(configuration)
|
|
85
|
+
return {
|
|
86
|
+
/**
|
|
87
|
+
* 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.
|
|
88
|
+
* @summary Retrieve the booking funnel
|
|
89
|
+
* @param {string} code Unique identifier for the object.
|
|
90
|
+
* @param {string} [authorization] Bearer Token
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
async getBookingFunnel(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBookingFunnelResponseClass>> {
|
|
95
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBookingFunnel(code, authorization, options);
|
|
96
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
97
|
+
},
|
|
98
|
+
}
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* BookingFunnelsApi - factory interface
|
|
103
|
+
* @export
|
|
104
|
+
*/
|
|
105
|
+
export const BookingFunnelsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
106
|
+
const localVarFp = BookingFunnelsApiFp(configuration)
|
|
107
|
+
return {
|
|
108
|
+
/**
|
|
109
|
+
* 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.
|
|
110
|
+
* @summary Retrieve the booking funnel
|
|
111
|
+
* @param {string} code Unique identifier for the object.
|
|
112
|
+
* @param {string} [authorization] Bearer Token
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
*/
|
|
116
|
+
getBookingFunnel(code: string, authorization?: string, options?: any): AxiosPromise<GetBookingFunnelResponseClass> {
|
|
117
|
+
return localVarFp.getBookingFunnel(code, authorization, options).then((request) => request(axios, basePath));
|
|
118
|
+
},
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Request parameters for getBookingFunnel operation in BookingFunnelsApi.
|
|
124
|
+
* @export
|
|
125
|
+
* @interface BookingFunnelsApiGetBookingFunnelRequest
|
|
126
|
+
*/
|
|
127
|
+
export interface BookingFunnelsApiGetBookingFunnelRequest {
|
|
128
|
+
/**
|
|
129
|
+
* Unique identifier for the object.
|
|
130
|
+
* @type {string}
|
|
131
|
+
* @memberof BookingFunnelsApiGetBookingFunnel
|
|
132
|
+
*/
|
|
133
|
+
readonly code: string
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Bearer Token
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof BookingFunnelsApiGetBookingFunnel
|
|
139
|
+
*/
|
|
140
|
+
readonly authorization?: string
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* BookingFunnelsApi - object-oriented interface
|
|
145
|
+
* @export
|
|
146
|
+
* @class BookingFunnelsApi
|
|
147
|
+
* @extends {BaseAPI}
|
|
148
|
+
*/
|
|
149
|
+
export class BookingFunnelsApi extends BaseAPI {
|
|
150
|
+
/**
|
|
151
|
+
* 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.
|
|
152
|
+
* @summary Retrieve the booking funnel
|
|
153
|
+
* @param {BookingFunnelsApiGetBookingFunnelRequest} requestParameters Request parameters.
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
* @memberof BookingFunnelsApi
|
|
157
|
+
*/
|
|
158
|
+
public getBookingFunnel(requestParameters: BookingFunnelsApiGetBookingFunnelRequest, options?: AxiosRequestConfig) {
|
|
159
|
+
return BookingFunnelsApiFp(this.configuration).getBookingFunnel(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
160
|
+
}
|
|
161
|
+
}
|
package/api/documents-api.ts
CHANGED
|
@@ -185,10 +185,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
185
185
|
* @param {string} productCode
|
|
186
186
|
* @param {string} code
|
|
187
187
|
* @param {string} [authorization] Bearer Token
|
|
188
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
188
189
|
* @param {*} [options] Override http request option.
|
|
189
190
|
* @throws {RequiredError}
|
|
190
191
|
*/
|
|
191
|
-
downloadProductDocumentUrl: async (productCode: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
192
|
+
downloadProductDocumentUrl: async (productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
192
193
|
// verify required parameter 'productCode' is not null or undefined
|
|
193
194
|
assertParamExists('downloadProductDocumentUrl', 'productCode', productCode)
|
|
194
195
|
// verify required parameter 'code' is not null or undefined
|
|
@@ -213,6 +214,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
213
214
|
// http bearer authentication required
|
|
214
215
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
215
216
|
|
|
217
|
+
if (contentDisposition !== undefined) {
|
|
218
|
+
localVarQueryParameter['contentDisposition'] = contentDisposition;
|
|
219
|
+
}
|
|
220
|
+
|
|
216
221
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
217
222
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
218
223
|
}
|
|
@@ -229,7 +234,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
229
234
|
};
|
|
230
235
|
},
|
|
231
236
|
/**
|
|
232
|
-
* Returns a list of documents you have previously created.
|
|
237
|
+
* 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.
|
|
233
238
|
* @summary List documents
|
|
234
239
|
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
235
240
|
* @param {string} [authorization] Bearer Token
|
|
@@ -297,20 +302,21 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
297
302
|
};
|
|
298
303
|
},
|
|
299
304
|
/**
|
|
300
|
-
* Returns a list of product documents you have previously created.
|
|
305
|
+
* 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.
|
|
301
306
|
* @summary List product documents
|
|
302
307
|
* @param {string} productCode
|
|
303
308
|
* @param {string} [authorization] Bearer Token
|
|
304
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
309
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
305
310
|
* @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.
|
|
306
311
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
307
|
-
* @param {any} [search]
|
|
312
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
308
313
|
* @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.
|
|
309
314
|
* @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.
|
|
315
|
+
* @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.
|
|
310
316
|
* @param {*} [options] Override http request option.
|
|
311
317
|
* @throws {RequiredError}
|
|
312
318
|
*/
|
|
313
|
-
listProductDocuments: async (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
319
|
+
listProductDocuments: async (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
314
320
|
// verify required parameter 'productCode' is not null or undefined
|
|
315
321
|
assertParamExists('listProductDocuments', 'productCode', productCode)
|
|
316
322
|
const localVarPath = `/publicapi/v1/documents/{productCode}`
|
|
@@ -356,6 +362,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
356
362
|
localVarQueryParameter['expand'] = expand;
|
|
357
363
|
}
|
|
358
364
|
|
|
365
|
+
if (filters !== undefined) {
|
|
366
|
+
localVarQueryParameter['filters'] = filters;
|
|
367
|
+
}
|
|
368
|
+
|
|
359
369
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
360
370
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
361
371
|
}
|
|
@@ -471,15 +481,16 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
471
481
|
* @param {string} productCode
|
|
472
482
|
* @param {string} code
|
|
473
483
|
* @param {string} [authorization] Bearer Token
|
|
484
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
474
485
|
* @param {*} [options] Override http request option.
|
|
475
486
|
* @throws {RequiredError}
|
|
476
487
|
*/
|
|
477
|
-
async downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
478
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, options);
|
|
488
|
+
async downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
489
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options);
|
|
479
490
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
480
491
|
},
|
|
481
492
|
/**
|
|
482
|
-
* Returns a list of documents you have previously created.
|
|
493
|
+
* 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.
|
|
483
494
|
* @summary List documents
|
|
484
495
|
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
485
496
|
* @param {string} [authorization] Bearer Token
|
|
@@ -495,21 +506,22 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
495
506
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
496
507
|
},
|
|
497
508
|
/**
|
|
498
|
-
* Returns a list of product documents you have previously created.
|
|
509
|
+
* 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.
|
|
499
510
|
* @summary List product documents
|
|
500
511
|
* @param {string} productCode
|
|
501
512
|
* @param {string} [authorization] Bearer Token
|
|
502
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
513
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
503
514
|
* @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.
|
|
504
515
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
505
|
-
* @param {any} [search]
|
|
516
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
506
517
|
* @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.
|
|
507
518
|
* @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.
|
|
519
|
+
* @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.
|
|
508
520
|
* @param {*} [options] Override http request option.
|
|
509
521
|
* @throws {RequiredError}
|
|
510
522
|
*/
|
|
511
|
-
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>> {
|
|
512
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
523
|
+
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>> {
|
|
524
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
513
525
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
514
526
|
},
|
|
515
527
|
/**
|
|
@@ -574,14 +586,15 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
574
586
|
* @param {string} productCode
|
|
575
587
|
* @param {string} code
|
|
576
588
|
* @param {string} [authorization] Bearer Token
|
|
589
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
577
590
|
* @param {*} [options] Override http request option.
|
|
578
591
|
* @throws {RequiredError}
|
|
579
592
|
*/
|
|
580
|
-
downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
581
|
-
return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, options).then((request) => request(axios, basePath));
|
|
593
|
+
downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
594
|
+
return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
582
595
|
},
|
|
583
596
|
/**
|
|
584
|
-
* Returns a list of documents you have previously created.
|
|
597
|
+
* 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.
|
|
585
598
|
* @summary List documents
|
|
586
599
|
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
587
600
|
* @param {string} [authorization] Bearer Token
|
|
@@ -596,21 +609,22 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
596
609
|
return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then((request) => request(axios, basePath));
|
|
597
610
|
},
|
|
598
611
|
/**
|
|
599
|
-
* Returns a list of product documents you have previously created.
|
|
612
|
+
* 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.
|
|
600
613
|
* @summary List product documents
|
|
601
614
|
* @param {string} productCode
|
|
602
615
|
* @param {string} [authorization] Bearer Token
|
|
603
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
616
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
604
617
|
* @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.
|
|
605
618
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
606
|
-
* @param {any} [search]
|
|
619
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
607
620
|
* @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.
|
|
608
621
|
* @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.
|
|
622
|
+
* @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.
|
|
609
623
|
* @param {*} [options] Override http request option.
|
|
610
624
|
* @throws {RequiredError}
|
|
611
625
|
*/
|
|
612
|
-
listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
613
|
-
return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
626
|
+
listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
627
|
+
return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
614
628
|
},
|
|
615
629
|
/**
|
|
616
630
|
* This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
|
|
@@ -722,6 +736,13 @@ export interface DocumentsApiDownloadProductDocumentUrlRequest {
|
|
|
722
736
|
* @memberof DocumentsApiDownloadProductDocumentUrl
|
|
723
737
|
*/
|
|
724
738
|
readonly authorization?: string
|
|
739
|
+
|
|
740
|
+
/**
|
|
741
|
+
* Content disposition override. Default will be depending on the document type.
|
|
742
|
+
* @type {'attachment' | 'inline'}
|
|
743
|
+
* @memberof DocumentsApiDownloadProductDocumentUrl
|
|
744
|
+
*/
|
|
745
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
725
746
|
}
|
|
726
747
|
|
|
727
748
|
/**
|
|
@@ -794,7 +815,7 @@ export interface DocumentsApiListProductDocumentsRequest {
|
|
|
794
815
|
readonly authorization?: string
|
|
795
816
|
|
|
796
817
|
/**
|
|
797
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
818
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
798
819
|
* @type {any}
|
|
799
820
|
* @memberof DocumentsApiListProductDocuments
|
|
800
821
|
*/
|
|
@@ -815,7 +836,7 @@ export interface DocumentsApiListProductDocumentsRequest {
|
|
|
815
836
|
readonly filter?: any
|
|
816
837
|
|
|
817
838
|
/**
|
|
818
|
-
*
|
|
839
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
819
840
|
* @type {any}
|
|
820
841
|
* @memberof DocumentsApiListProductDocuments
|
|
821
842
|
*/
|
|
@@ -834,6 +855,13 @@ export interface DocumentsApiListProductDocumentsRequest {
|
|
|
834
855
|
* @memberof DocumentsApiListProductDocuments
|
|
835
856
|
*/
|
|
836
857
|
readonly expand?: any
|
|
858
|
+
|
|
859
|
+
/**
|
|
860
|
+
* 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.
|
|
861
|
+
* @type {any}
|
|
862
|
+
* @memberof DocumentsApiListProductDocuments
|
|
863
|
+
*/
|
|
864
|
+
readonly filters?: any
|
|
837
865
|
}
|
|
838
866
|
|
|
839
867
|
/**
|
|
@@ -909,11 +937,11 @@ export class DocumentsApi extends BaseAPI {
|
|
|
909
937
|
* @memberof DocumentsApi
|
|
910
938
|
*/
|
|
911
939
|
public downloadProductDocumentUrl(requestParameters: DocumentsApiDownloadProductDocumentUrlRequest, options?: AxiosRequestConfig) {
|
|
912
|
-
return DocumentsApiFp(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
940
|
+
return DocumentsApiFp(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
|
|
913
941
|
}
|
|
914
942
|
|
|
915
943
|
/**
|
|
916
|
-
* Returns a list of documents you have previously created.
|
|
944
|
+
* 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.
|
|
917
945
|
* @summary List documents
|
|
918
946
|
* @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
|
|
919
947
|
* @param {*} [options] Override http request option.
|
|
@@ -925,7 +953,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
925
953
|
}
|
|
926
954
|
|
|
927
955
|
/**
|
|
928
|
-
* Returns a list of product documents you have previously created.
|
|
956
|
+
* 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.
|
|
929
957
|
* @summary List product documents
|
|
930
958
|
* @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
931
959
|
* @param {*} [options] Override http request option.
|
|
@@ -933,7 +961,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
933
961
|
* @memberof DocumentsApi
|
|
934
962
|
*/
|
|
935
963
|
public listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
|
|
936
|
-
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));
|
|
964
|
+
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));
|
|
937
965
|
}
|
|
938
966
|
|
|
939
967
|
/**
|
package/api/leads-api.ts
CHANGED
|
@@ -182,7 +182,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
182
182
|
};
|
|
183
183
|
},
|
|
184
184
|
/**
|
|
185
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
185
|
+
* 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.
|
|
186
186
|
* @summary Retrieve the lead
|
|
187
187
|
* @param {string} code Unique identifier for the object.
|
|
188
188
|
* @param {string} [authorization] Bearer Token
|
|
@@ -416,7 +416,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
|
|
|
416
416
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
417
417
|
},
|
|
418
418
|
/**
|
|
419
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
419
|
+
* 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.
|
|
420
420
|
* @summary Retrieve the lead
|
|
421
421
|
* @param {string} code Unique identifier for the object.
|
|
422
422
|
* @param {string} [authorization] Bearer Token
|
|
@@ -508,7 +508,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
|
|
|
508
508
|
return localVarFp.createLeadSync(createLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
509
509
|
},
|
|
510
510
|
/**
|
|
511
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
511
|
+
* 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.
|
|
512
512
|
* @summary Retrieve the lead
|
|
513
513
|
* @param {string} code Unique identifier for the object.
|
|
514
514
|
* @param {string} [authorization] Bearer Token
|
|
@@ -753,7 +753,7 @@ export class LeadsApi extends BaseAPI {
|
|
|
753
753
|
}
|
|
754
754
|
|
|
755
755
|
/**
|
|
756
|
-
* Retrieves the details of the lead that was previously created. Supply the unique lead code
|
|
756
|
+
* 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.
|
|
757
757
|
* @summary Retrieve the lead
|
|
758
758
|
* @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
|
|
759
759
|
* @param {*} [options] Override http request option.
|