@emilgroup/insurance-sdk-node 1.47.0 → 1.48.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 +10 -0
- package/README.md +2 -2
- package/api/booking-funnel-versions-api.ts +375 -0
- package/api/booking-funnels-api.ts +4 -4
- package/api/lead-versions-api.ts +4 -4
- package/api/leads-api.ts +4 -4
- package/api/policies-api.ts +123 -123
- package/api/policy-partner-roles-api.ts +683 -0
- package/api/status-transition-rules-api.ts +4 -4
- package/api.ts +4 -0
- package/dist/api/booking-funnel-versions-api.d.ts +222 -0
- package/dist/api/booking-funnel-versions-api.js +367 -0
- package/dist/api/booking-funnels-api.d.ts +4 -4
- package/dist/api/booking-funnels-api.js +3 -3
- package/dist/api/lead-versions-api.d.ts +4 -4
- package/dist/api/lead-versions-api.js +3 -3
- package/dist/api/leads-api.d.ts +4 -4
- package/dist/api/leads-api.js +3 -3
- package/dist/api/policies-api.d.ts +123 -123
- package/dist/api/policies-api.js +60 -60
- package/dist/api/policy-partner-roles-api.d.ts +385 -0
- package/dist/api/policy-partner-roles-api.js +640 -0
- package/dist/api/status-transition-rules-api.d.ts +4 -4
- package/dist/api/status-transition-rules-api.js +3 -3
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/booking-funnel-class.d.ts +6 -0
- package/dist/models/create-policy-partner-role-request-dto.d.ts +30 -0
- package/dist/models/create-policy-partner-role-request-dto.js +15 -0
- package/dist/models/create-policy-partner-role-response-class.d.ts +25 -0
- package/dist/models/create-policy-partner-role-response-class.js +15 -0
- package/dist/models/get-booking-funnel-version-request-dto.d.ts +30 -0
- package/dist/models/get-booking-funnel-version-request-dto.js +15 -0
- package/dist/models/get-policy-partner-role-response-class.d.ts +25 -0
- package/dist/models/get-policy-partner-role-response-class.js +15 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/list-policy-partner-roles-response-class.d.ts +31 -0
- package/dist/models/list-policy-partner-roles-response-class.js +15 -0
- package/dist/models/policy-partner-role-class.d.ts +54 -0
- package/dist/models/policy-partner-role-class.js +15 -0
- package/dist/models/update-policy-partner-role-request-dto.d.ts +30 -0
- package/dist/models/update-policy-partner-role-request-dto.js +15 -0
- package/dist/models/update-policy-partner-role-response-class.d.ts +25 -0
- package/dist/models/update-policy-partner-role-response-class.js +15 -0
- package/models/booking-funnel-class.ts +6 -0
- package/models/create-policy-partner-role-request-dto.ts +36 -0
- package/models/create-policy-partner-role-response-class.ts +31 -0
- package/models/get-booking-funnel-version-request-dto.ts +36 -0
- package/models/get-policy-partner-role-response-class.ts +31 -0
- package/models/index.ts +8 -0
- package/models/list-policy-partner-roles-response-class.ts +37 -0
- package/models/policy-partner-role-class.ts +60 -0
- package/models/update-policy-partner-role-request-dto.ts +36 -0
- package/models/update-policy-partner-role-response-class.ts +31 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
|
+
api/booking-funnel-versions-api.ts
|
|
6
7
|
api/booking-funnels-api.ts
|
|
7
8
|
api/default-api.ts
|
|
8
9
|
api/insured-object-types-api.ts
|
|
@@ -12,6 +13,7 @@ api/lead-versions-api.ts
|
|
|
12
13
|
api/leads-api.ts
|
|
13
14
|
api/named-ranges-api.ts
|
|
14
15
|
api/policies-api.ts
|
|
16
|
+
api/policy-partner-roles-api.ts
|
|
15
17
|
api/premium-formulas-api.ts
|
|
16
18
|
api/product-factors-api.ts
|
|
17
19
|
api/product-fields-api.ts
|
|
@@ -48,6 +50,8 @@ models/create-named-range-request-dto.ts
|
|
|
48
50
|
models/create-named-range-response-class.ts
|
|
49
51
|
models/create-named-request-s3-data-class.ts
|
|
50
52
|
models/create-payment-method-request-dto.ts
|
|
53
|
+
models/create-policy-partner-role-request-dto.ts
|
|
54
|
+
models/create-policy-partner-role-response-class.ts
|
|
51
55
|
models/create-policy-request-dto.ts
|
|
52
56
|
models/create-policy-response-class.ts
|
|
53
57
|
models/create-premium-formula-request-dto.ts
|
|
@@ -64,6 +68,7 @@ models/delete-response-class.ts
|
|
|
64
68
|
models/empty-response-class.ts
|
|
65
69
|
models/filter-named-range-request-dto.ts
|
|
66
70
|
models/filter-named-range-response-class.ts
|
|
71
|
+
models/get-booking-funnel-version-request-dto.ts
|
|
67
72
|
models/get-draft-policy-request-dto.ts
|
|
68
73
|
models/get-insured-object-response-class.ts
|
|
69
74
|
models/get-lead-response-class.ts
|
|
@@ -72,6 +77,7 @@ models/get-lead-version-request-dto.ts
|
|
|
72
77
|
models/get-lead-version-response-class.ts
|
|
73
78
|
models/get-named-range-response-class.ts
|
|
74
79
|
models/get-policy-data-by-date-request-dto.ts
|
|
80
|
+
models/get-policy-partner-role-response-class.ts
|
|
75
81
|
models/get-policy-request-dto.ts
|
|
76
82
|
models/get-policy-response-class.ts
|
|
77
83
|
models/get-premium-formula-request-dto.ts
|
|
@@ -112,6 +118,7 @@ models/list-leads-response-class.ts
|
|
|
112
118
|
models/list-named-ranges-response-class.ts
|
|
113
119
|
models/list-policies-response-class.ts
|
|
114
120
|
models/list-policy-objects-response-class.ts
|
|
121
|
+
models/list-policy-partner-roles-response-class.ts
|
|
115
122
|
models/list-policy-version-response-class.ts
|
|
116
123
|
models/list-policy-versions-request-dto.ts
|
|
117
124
|
models/list-premium-formulas-response-class.ts
|
|
@@ -133,6 +140,7 @@ models/patch-status-transition-rule-response-class.ts
|
|
|
133
140
|
models/policy-class.ts
|
|
134
141
|
models/policy-object-class.ts
|
|
135
142
|
models/policy-object-dto.ts
|
|
143
|
+
models/policy-partner-role-class.ts
|
|
136
144
|
models/policy-premium-class.ts
|
|
137
145
|
models/policy-premium-item-class.ts
|
|
138
146
|
models/policy-version-class.ts
|
|
@@ -170,6 +178,8 @@ models/update-lead-request-dto.ts
|
|
|
170
178
|
models/update-lead-response-class.ts
|
|
171
179
|
models/update-named-range-request-dto.ts
|
|
172
180
|
models/update-named-range-response-class.ts
|
|
181
|
+
models/update-policy-partner-role-request-dto.ts
|
|
182
|
+
models/update-policy-partner-role-response-class.ts
|
|
173
183
|
models/update-policy-request-dto.ts
|
|
174
184
|
models/update-policy-response-class.ts
|
|
175
185
|
models/update-premium-formula-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/insurance-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/insurance-sdk-node@1.48.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/insurance-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/insurance-sdk-node@1.48.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PoliciesApi`.
|
|
@@ -0,0 +1,375 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL InsuranceService
|
|
5
|
+
* The EMIL InsuranceService 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
|
+
// URLSearchParams not necessarily used
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import { URL, URLSearchParams } from 'url';
|
|
26
|
+
const FormData = require('form-data');
|
|
27
|
+
/**
|
|
28
|
+
* BookingFunnelVersionsApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const BookingFunnelVersionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* Retrieves the details of the booking funnel version that was previously created. Supply the unique booking funnel version code that was returned when you created it and Emil Api will return the corresponding booking funnel version information.
|
|
35
|
+
* @summary Retrieve the booking funnel version
|
|
36
|
+
* @param {string} code
|
|
37
|
+
* @param {number} version
|
|
38
|
+
* @param {string} [authorization] Bearer Token
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
getBookingFunnelVersion: async (code: string, version: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43
|
+
// verify required parameter 'code' is not null or undefined
|
|
44
|
+
assertParamExists('getBookingFunnelVersion', 'code', code)
|
|
45
|
+
// verify required parameter 'version' is not null or undefined
|
|
46
|
+
assertParamExists('getBookingFunnelVersion', 'version', version)
|
|
47
|
+
const localVarPath = `/insuranceservice/v1/booking-funnels/{code}/versions/{version}`
|
|
48
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
49
|
+
.replace(`{${"version"}}`, encodeURIComponent(String(version)));
|
|
50
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
52
|
+
let baseOptions;
|
|
53
|
+
let baseAccessToken;
|
|
54
|
+
if (configuration) {
|
|
55
|
+
baseOptions = configuration.baseOptions;
|
|
56
|
+
baseAccessToken = configuration.accessToken;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
60
|
+
const localVarHeaderParameter = {} as any;
|
|
61
|
+
const localVarQueryParameter = {} as any;
|
|
62
|
+
|
|
63
|
+
// authentication bearer required
|
|
64
|
+
// http bearer authentication required
|
|
65
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
66
|
+
|
|
67
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
68
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
74
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
75
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
76
|
+
|
|
77
|
+
return {
|
|
78
|
+
url: toPathString(localVarUrlObj),
|
|
79
|
+
options: localVarRequestOptions,
|
|
80
|
+
};
|
|
81
|
+
},
|
|
82
|
+
/**
|
|
83
|
+
* Returns a list of booking funnel versions you have previously created. The booking funnel versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
84
|
+
* @summary List booking funnel versions
|
|
85
|
+
* @param {string} code
|
|
86
|
+
* @param {string} [authorization] Bearer Token
|
|
87
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
|
+
* @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.
|
|
89
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
90
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
91
|
+
* @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.
|
|
92
|
+
* @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.
|
|
93
|
+
* @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.
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
listBookingFunnelVersions: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
98
|
+
// verify required parameter 'code' is not null or undefined
|
|
99
|
+
assertParamExists('listBookingFunnelVersions', 'code', code)
|
|
100
|
+
const localVarPath = `/insuranceservice/v1/booking-funnels/{code}/versions`
|
|
101
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
102
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
103
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
104
|
+
let baseOptions;
|
|
105
|
+
let baseAccessToken;
|
|
106
|
+
if (configuration) {
|
|
107
|
+
baseOptions = configuration.baseOptions;
|
|
108
|
+
baseAccessToken = configuration.accessToken;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
112
|
+
const localVarHeaderParameter = {} as any;
|
|
113
|
+
const localVarQueryParameter = {} as any;
|
|
114
|
+
|
|
115
|
+
// authentication bearer required
|
|
116
|
+
// http bearer authentication required
|
|
117
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
118
|
+
|
|
119
|
+
if (pageSize !== undefined) {
|
|
120
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
if (pageToken !== undefined) {
|
|
124
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (filter !== undefined) {
|
|
128
|
+
localVarQueryParameter['filter'] = filter;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (search !== undefined) {
|
|
132
|
+
localVarQueryParameter['search'] = search;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (order !== undefined) {
|
|
136
|
+
localVarQueryParameter['order'] = order;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (expand !== undefined) {
|
|
140
|
+
localVarQueryParameter['expand'] = expand;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
if (filters !== undefined) {
|
|
144
|
+
localVarQueryParameter['filters'] = filters;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
148
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
155
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
156
|
+
|
|
157
|
+
return {
|
|
158
|
+
url: toPathString(localVarUrlObj),
|
|
159
|
+
options: localVarRequestOptions,
|
|
160
|
+
};
|
|
161
|
+
},
|
|
162
|
+
}
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* BookingFunnelVersionsApi - functional programming interface
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export const BookingFunnelVersionsApiFp = function(configuration?: Configuration) {
|
|
170
|
+
const localVarAxiosParamCreator = BookingFunnelVersionsApiAxiosParamCreator(configuration)
|
|
171
|
+
return {
|
|
172
|
+
/**
|
|
173
|
+
* Retrieves the details of the booking funnel version that was previously created. Supply the unique booking funnel version code that was returned when you created it and Emil Api will return the corresponding booking funnel version information.
|
|
174
|
+
* @summary Retrieve the booking funnel version
|
|
175
|
+
* @param {string} code
|
|
176
|
+
* @param {number} version
|
|
177
|
+
* @param {string} [authorization] Bearer Token
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
*/
|
|
181
|
+
async getBookingFunnelVersion(code: string, version: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
182
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBookingFunnelVersion(code, version, authorization, options);
|
|
183
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
184
|
+
},
|
|
185
|
+
/**
|
|
186
|
+
* Returns a list of booking funnel versions you have previously created. The booking funnel versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
187
|
+
* @summary List booking funnel versions
|
|
188
|
+
* @param {string} code
|
|
189
|
+
* @param {string} [authorization] Bearer Token
|
|
190
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
191
|
+
* @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.
|
|
192
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
193
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
|
+
* @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.
|
|
195
|
+
* @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.
|
|
196
|
+
* @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.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
async listBookingFunnelVersions(code: 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<void>> {
|
|
201
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingFunnelVersions(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
202
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
203
|
+
},
|
|
204
|
+
}
|
|
205
|
+
};
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* BookingFunnelVersionsApi - factory interface
|
|
209
|
+
* @export
|
|
210
|
+
*/
|
|
211
|
+
export const BookingFunnelVersionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
212
|
+
const localVarFp = BookingFunnelVersionsApiFp(configuration)
|
|
213
|
+
return {
|
|
214
|
+
/**
|
|
215
|
+
* Retrieves the details of the booking funnel version that was previously created. Supply the unique booking funnel version code that was returned when you created it and Emil Api will return the corresponding booking funnel version information.
|
|
216
|
+
* @summary Retrieve the booking funnel version
|
|
217
|
+
* @param {string} code
|
|
218
|
+
* @param {number} version
|
|
219
|
+
* @param {string} [authorization] Bearer Token
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
getBookingFunnelVersion(code: string, version: number, authorization?: string, options?: any): AxiosPromise<void> {
|
|
224
|
+
return localVarFp.getBookingFunnelVersion(code, version, authorization, options).then((request) => request(axios, basePath));
|
|
225
|
+
},
|
|
226
|
+
/**
|
|
227
|
+
* Returns a list of booking funnel versions you have previously created. The booking funnel versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
228
|
+
* @summary List booking funnel versions
|
|
229
|
+
* @param {string} code
|
|
230
|
+
* @param {string} [authorization] Bearer Token
|
|
231
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
|
+
* @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.
|
|
233
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
234
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
|
+
* @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.
|
|
236
|
+
* @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.
|
|
237
|
+
* @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.
|
|
238
|
+
* @param {*} [options] Override http request option.
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
*/
|
|
241
|
+
listBookingFunnelVersions(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void> {
|
|
242
|
+
return localVarFp.listBookingFunnelVersions(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
243
|
+
},
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Request parameters for getBookingFunnelVersion operation in BookingFunnelVersionsApi.
|
|
249
|
+
* @export
|
|
250
|
+
* @interface BookingFunnelVersionsApiGetBookingFunnelVersionRequest
|
|
251
|
+
*/
|
|
252
|
+
export interface BookingFunnelVersionsApiGetBookingFunnelVersionRequest {
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof BookingFunnelVersionsApiGetBookingFunnelVersion
|
|
257
|
+
*/
|
|
258
|
+
readonly code: string
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
*
|
|
262
|
+
* @type {number}
|
|
263
|
+
* @memberof BookingFunnelVersionsApiGetBookingFunnelVersion
|
|
264
|
+
*/
|
|
265
|
+
readonly version: number
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Bearer Token
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof BookingFunnelVersionsApiGetBookingFunnelVersion
|
|
271
|
+
*/
|
|
272
|
+
readonly authorization?: string
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Request parameters for listBookingFunnelVersions operation in BookingFunnelVersionsApi.
|
|
277
|
+
* @export
|
|
278
|
+
* @interface BookingFunnelVersionsApiListBookingFunnelVersionsRequest
|
|
279
|
+
*/
|
|
280
|
+
export interface BookingFunnelVersionsApiListBookingFunnelVersionsRequest {
|
|
281
|
+
/**
|
|
282
|
+
*
|
|
283
|
+
* @type {string}
|
|
284
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
285
|
+
*/
|
|
286
|
+
readonly code: string
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Bearer Token
|
|
290
|
+
* @type {string}
|
|
291
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
292
|
+
*/
|
|
293
|
+
readonly authorization?: string
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
297
|
+
* @type {any}
|
|
298
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
299
|
+
*/
|
|
300
|
+
readonly pageSize?: any
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* 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.
|
|
304
|
+
* @type {any}
|
|
305
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
306
|
+
*/
|
|
307
|
+
readonly pageToken?: any
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
311
|
+
* @type {any}
|
|
312
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
313
|
+
*/
|
|
314
|
+
readonly filter?: any
|
|
315
|
+
|
|
316
|
+
/**
|
|
317
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
318
|
+
* @type {any}
|
|
319
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
320
|
+
*/
|
|
321
|
+
readonly search?: any
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* 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.
|
|
325
|
+
* @type {any}
|
|
326
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
327
|
+
*/
|
|
328
|
+
readonly order?: any
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* 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.
|
|
332
|
+
* @type {any}
|
|
333
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
334
|
+
*/
|
|
335
|
+
readonly expand?: any
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* 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.
|
|
339
|
+
* @type {any}
|
|
340
|
+
* @memberof BookingFunnelVersionsApiListBookingFunnelVersions
|
|
341
|
+
*/
|
|
342
|
+
readonly filters?: any
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* BookingFunnelVersionsApi - object-oriented interface
|
|
347
|
+
* @export
|
|
348
|
+
* @class BookingFunnelVersionsApi
|
|
349
|
+
* @extends {BaseAPI}
|
|
350
|
+
*/
|
|
351
|
+
export class BookingFunnelVersionsApi extends BaseAPI {
|
|
352
|
+
/**
|
|
353
|
+
* Retrieves the details of the booking funnel version that was previously created. Supply the unique booking funnel version code that was returned when you created it and Emil Api will return the corresponding booking funnel version information.
|
|
354
|
+
* @summary Retrieve the booking funnel version
|
|
355
|
+
* @param {BookingFunnelVersionsApiGetBookingFunnelVersionRequest} requestParameters Request parameters.
|
|
356
|
+
* @param {*} [options] Override http request option.
|
|
357
|
+
* @throws {RequiredError}
|
|
358
|
+
* @memberof BookingFunnelVersionsApi
|
|
359
|
+
*/
|
|
360
|
+
public getBookingFunnelVersion(requestParameters: BookingFunnelVersionsApiGetBookingFunnelVersionRequest, options?: AxiosRequestConfig) {
|
|
361
|
+
return BookingFunnelVersionsApiFp(this.configuration).getBookingFunnelVersion(requestParameters.code, requestParameters.version, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Returns a list of booking funnel versions you have previously created. The booking funnel versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
366
|
+
* @summary List booking funnel versions
|
|
367
|
+
* @param {BookingFunnelVersionsApiListBookingFunnelVersionsRequest} requestParameters Request parameters.
|
|
368
|
+
* @param {*} [options] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
* @memberof BookingFunnelVersionsApi
|
|
371
|
+
*/
|
|
372
|
+
public listBookingFunnelVersions(requestParameters: BookingFunnelVersionsApiListBookingFunnelVersionsRequest, options?: AxiosRequestConfig) {
|
|
373
|
+
return BookingFunnelVersionsApiFp(this.configuration).listBookingFunnelVersions(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
374
|
+
}
|
|
375
|
+
}
|
|
@@ -184,7 +184,7 @@ export const BookingFunnelsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
184
184
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
185
185
|
* @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.
|
|
186
186
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
187
|
-
* @param {any} [search]
|
|
187
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
188
188
|
* @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.
|
|
189
189
|
* @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.
|
|
190
190
|
* @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.
|
|
@@ -407,7 +407,7 @@ export const BookingFunnelsApiFp = function(configuration?: Configuration) {
|
|
|
407
407
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
408
408
|
* @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.
|
|
409
409
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
410
|
-
* @param {any} [search]
|
|
410
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
411
411
|
* @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.
|
|
412
412
|
* @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.
|
|
413
413
|
* @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.
|
|
@@ -493,7 +493,7 @@ export const BookingFunnelsApiFactory = function (configuration?: Configuration,
|
|
|
493
493
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
494
494
|
* @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.
|
|
495
495
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
496
|
-
* @param {any} [search]
|
|
496
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
497
497
|
* @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.
|
|
498
498
|
* @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.
|
|
499
499
|
* @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.
|
|
@@ -627,7 +627,7 @@ export interface BookingFunnelsApiListBookingFunnelsRequest {
|
|
|
627
627
|
readonly filter?: any
|
|
628
628
|
|
|
629
629
|
/**
|
|
630
|
-
*
|
|
630
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
631
631
|
* @type {any}
|
|
632
632
|
* @memberof BookingFunnelsApiListBookingFunnels
|
|
633
633
|
*/
|
package/api/lead-versions-api.ts
CHANGED
|
@@ -91,7 +91,7 @@ export const LeadVersionsApiAxiosParamCreator = function (configuration?: Config
|
|
|
91
91
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
92
92
|
* @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.
|
|
93
93
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
94
|
-
* @param {any} [search]
|
|
94
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
95
95
|
* @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.
|
|
96
96
|
* @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.
|
|
97
97
|
* @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.
|
|
@@ -194,7 +194,7 @@ export const LeadVersionsApiFp = function(configuration?: Configuration) {
|
|
|
194
194
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
195
195
|
* @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.
|
|
196
196
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
197
|
-
* @param {any} [search]
|
|
197
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
198
198
|
* @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.
|
|
199
199
|
* @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.
|
|
200
200
|
* @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.
|
|
@@ -235,7 +235,7 @@ export const LeadVersionsApiFactory = function (configuration?: Configuration, b
|
|
|
235
235
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
236
|
* @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.
|
|
237
237
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
238
|
-
* @param {any} [search]
|
|
238
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
239
|
* @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.
|
|
240
240
|
* @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.
|
|
241
241
|
* @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.
|
|
@@ -318,7 +318,7 @@ export interface LeadVersionsApiListLeadVersionsRequest {
|
|
|
318
318
|
readonly filter?: any
|
|
319
319
|
|
|
320
320
|
/**
|
|
321
|
-
*
|
|
321
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
322
322
|
* @type {any}
|
|
323
323
|
* @memberof LeadVersionsApiListLeadVersions
|
|
324
324
|
*/
|
package/api/leads-api.ts
CHANGED
|
@@ -293,7 +293,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
293
293
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
294
294
|
* @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.
|
|
295
295
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
296
|
-
* @param {any} [search]
|
|
296
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
297
297
|
* @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.
|
|
298
298
|
* @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.
|
|
299
299
|
* @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.
|
|
@@ -593,7 +593,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
|
|
|
593
593
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
594
594
|
* @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.
|
|
595
595
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
596
|
-
* @param {any} [search]
|
|
596
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
597
597
|
* @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.
|
|
598
598
|
* @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.
|
|
599
599
|
* @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.
|
|
@@ -716,7 +716,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
|
|
|
716
716
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
717
717
|
* @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.
|
|
718
718
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
719
|
-
* @param {any} [search]
|
|
719
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
720
720
|
* @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.
|
|
721
721
|
* @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.
|
|
722
722
|
* @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.
|
|
@@ -912,7 +912,7 @@ export interface LeadsApiListLeadsRequest {
|
|
|
912
912
|
readonly filter?: any
|
|
913
913
|
|
|
914
914
|
/**
|
|
915
|
-
*
|
|
915
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
916
916
|
* @type {any}
|
|
917
917
|
* @memberof LeadsApiListLeads
|
|
918
918
|
*/
|