pipedrive 32.1.0 → 32.2.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/dist/esm/versions/v1/api/filters-api.d.ts +30 -6
- package/dist/esm/versions/v1/api/filters-api.js +30 -15
- package/dist/esm/versions/v1/models/filter-conditions-conditions-inner-conditions-inner.d.ts +53 -0
- package/dist/esm/versions/v1/models/filter-conditions-conditions-inner-conditions-inner.js +14 -0
- package/dist/esm/versions/v1/models/filter-conditions-conditions-inner.d.ts +34 -0
- package/dist/esm/versions/{v2/models/update-person-request.js → v1/models/filter-conditions-conditions-inner.js} +5 -7
- package/dist/esm/versions/v1/models/filter-conditions.d.ts +33 -0
- package/dist/esm/versions/v1/models/filter-conditions.js +16 -0
- package/dist/esm/versions/v1/models/filter.d.ts +40 -17
- package/dist/esm/versions/v1/models/filter.js +6 -0
- package/dist/esm/versions/v1/models/get-filters-response-all-of-data-inner.d.ts +45 -8
- package/dist/esm/versions/v1/models/get-filters-response-all-of-data-inner.js +15 -1
- package/dist/esm/versions/v1/models/get-filters-response1-all-of-data.d.ts +106 -0
- package/dist/esm/versions/v1/models/get-filters-response1-all-of-data.js +28 -0
- package/dist/esm/versions/v1/models/get-filters-response1-all-of.d.ts +3 -3
- package/dist/esm/versions/v1/models/index.d.ts +4 -0
- package/dist/esm/versions/v1/models/index.js +4 -0
- package/dist/esm/versions/v1/models/user-access.d.ts +3 -3
- package/dist/esm/versions/v1/models/user-access1.d.ts +3 -3
- package/dist/esm/versions/v2/api/persons-api.d.ts +6 -7
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/models/add-organization-field-request.d.ts +0 -5
- package/dist/esm/versions/v2/models/add-person-field-request.d.ts +0 -5
- package/dist/esm/versions/v2/models/add-product-field-request.d.ts +0 -5
- package/dist/esm/versions/v2/models/create-many-deal-product-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/index.d.ts +0 -1
- package/dist/esm/versions/v2/models/index.js +0 -1
- package/dist/esm/versions/v2/models/update-person-field-request.d.ts +0 -5
- package/dist/esm/versions/v2/models/update-product-field-request.d.ts +0 -5
- package/dist/versions/v1/api/filters-api.d.ts +30 -6
- package/dist/versions/v1/api/filters-api.js +30 -15
- package/dist/versions/v1/models/filter-conditions-conditions-inner-conditions-inner.d.ts +53 -0
- package/dist/versions/v1/models/filter-conditions-conditions-inner-conditions-inner.js +15 -0
- package/dist/versions/v1/models/filter-conditions-conditions-inner.d.ts +34 -0
- package/dist/versions/{v2/models/update-person-request.js → v1/models/filter-conditions-conditions-inner.js} +6 -8
- package/dist/versions/v1/models/filter-conditions.d.ts +33 -0
- package/dist/versions/v1/models/filter-conditions.js +19 -0
- package/dist/versions/v1/models/filter.d.ts +40 -17
- package/dist/versions/v1/models/filter.js +7 -1
- package/dist/versions/v1/models/get-filters-response-all-of-data-inner.d.ts +45 -8
- package/dist/versions/v1/models/get-filters-response-all-of-data-inner.js +16 -0
- package/dist/versions/v1/models/get-filters-response1-all-of-data.d.ts +106 -0
- package/dist/versions/v1/models/get-filters-response1-all-of-data.js +31 -0
- package/dist/versions/v1/models/get-filters-response1-all-of.d.ts +3 -3
- package/dist/versions/v1/models/index.d.ts +4 -0
- package/dist/versions/v1/models/index.js +4 -0
- package/dist/versions/v1/models/user-access.d.ts +3 -3
- package/dist/versions/v1/models/user-access1.d.ts +3 -3
- package/dist/versions/v2/api/persons-api.d.ts +6 -7
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/models/add-organization-field-request.d.ts +0 -5
- package/dist/versions/v2/models/add-person-field-request.d.ts +0 -5
- package/dist/versions/v2/models/add-product-field-request.d.ts +0 -5
- package/dist/versions/v2/models/create-many-deal-product-request.d.ts +1 -1
- package/dist/versions/v2/models/index.d.ts +0 -1
- package/dist/versions/v2/models/index.js +0 -1
- package/dist/versions/v2/models/update-person-field-request.d.ts +0 -5
- package/dist/versions/v2/models/update-product-field-request.d.ts +0 -5
- package/package.json +1 -1
- package/dist/esm/versions/v2/models/update-person-request.d.ts +0 -84
- package/dist/versions/v2/models/update-person-request.d.ts +0 -84
|
@@ -27,11 +27,12 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
27
27
|
/**
|
|
28
28
|
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
29
29
|
* @summary Add a new filter
|
|
30
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
30
31
|
* @param {AddFilterRequest} [AddFilterRequest]
|
|
31
32
|
|
|
32
33
|
* @throws {RequiredError}
|
|
33
34
|
*/
|
|
34
|
-
addFilter: (AddFilterRequest?: AddFilterRequest) => Promise<RequestArgs>;
|
|
35
|
+
addFilter: (include_field_code?: boolean, AddFilterRequest?: AddFilterRequest) => Promise<RequestArgs>;
|
|
35
36
|
/**
|
|
36
37
|
* Marks a filter as deleted.
|
|
37
38
|
* @summary Delete a filter
|
|
@@ -52,10 +53,11 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
52
53
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
53
54
|
* @summary Get one filter
|
|
54
55
|
* @param {number} id The ID of the filter
|
|
56
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
55
57
|
|
|
56
58
|
* @throws {RequiredError}
|
|
57
59
|
*/
|
|
58
|
-
getFilter: (id: number) => Promise<RequestArgs>;
|
|
60
|
+
getFilter: (id: number, include_field_code?: boolean) => Promise<RequestArgs>;
|
|
59
61
|
/**
|
|
60
62
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
61
63
|
* @summary Get all filter helpers
|
|
@@ -75,11 +77,12 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75
77
|
* Updates an existing filter.
|
|
76
78
|
* @summary Update filter
|
|
77
79
|
* @param {number} id The ID of the filter
|
|
80
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
78
81
|
* @param {UpdateFilterRequest} [UpdateFilterRequest]
|
|
79
82
|
|
|
80
83
|
* @throws {RequiredError}
|
|
81
84
|
*/
|
|
82
|
-
updateFilter: (id: number, UpdateFilterRequest?: UpdateFilterRequest) => Promise<RequestArgs>;
|
|
85
|
+
updateFilter: (id: number, include_field_code?: boolean, UpdateFilterRequest?: UpdateFilterRequest) => Promise<RequestArgs>;
|
|
83
86
|
};
|
|
84
87
|
/**
|
|
85
88
|
* FiltersApi - functional programming interface
|
|
@@ -89,11 +92,12 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
|
|
|
89
92
|
/**
|
|
90
93
|
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
91
94
|
* @summary Add a new filter
|
|
95
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
92
96
|
* @param {AddFilterRequest} [AddFilterRequest]
|
|
93
97
|
|
|
94
98
|
* @throws {RequiredError}
|
|
95
99
|
*/
|
|
96
|
-
addFilter(AddFilterRequest?: AddFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
|
|
100
|
+
addFilter(include_field_code?: boolean, AddFilterRequest?: AddFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
|
|
97
101
|
/**
|
|
98
102
|
* Marks a filter as deleted.
|
|
99
103
|
* @summary Delete a filter
|
|
@@ -114,10 +118,11 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
|
|
|
114
118
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
115
119
|
* @summary Get one filter
|
|
116
120
|
* @param {number} id The ID of the filter
|
|
121
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
117
122
|
|
|
118
123
|
* @throws {RequiredError}
|
|
119
124
|
*/
|
|
120
|
-
getFilter(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFiltersResponse1>>;
|
|
125
|
+
getFilter(id: number, include_field_code?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFiltersResponse1>>;
|
|
121
126
|
/**
|
|
122
127
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
123
128
|
* @summary Get all filter helpers
|
|
@@ -137,11 +142,12 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
|
|
|
137
142
|
* Updates an existing filter.
|
|
138
143
|
* @summary Update filter
|
|
139
144
|
* @param {number} id The ID of the filter
|
|
145
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
140
146
|
* @param {UpdateFilterRequest} [UpdateFilterRequest]
|
|
141
147
|
|
|
142
148
|
* @throws {RequiredError}
|
|
143
149
|
*/
|
|
144
|
-
updateFilter(id: number, UpdateFilterRequest?: UpdateFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
|
|
150
|
+
updateFilter(id: number, include_field_code?: boolean, UpdateFilterRequest?: UpdateFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
|
|
145
151
|
};
|
|
146
152
|
/**
|
|
147
153
|
* FiltersApi - factory interface
|
|
@@ -210,6 +216,12 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
|
|
|
210
216
|
* @interface FiltersApiAddFilterRequest
|
|
211
217
|
*/
|
|
212
218
|
export interface FiltersApiAddFilterRequest {
|
|
219
|
+
/**
|
|
220
|
+
* If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
221
|
+
* @type {boolean}
|
|
222
|
+
* @memberof FiltersApiAddFilter
|
|
223
|
+
*/
|
|
224
|
+
readonly include_field_code?: boolean;
|
|
213
225
|
/**
|
|
214
226
|
*
|
|
215
227
|
* @type {AddFilterRequest}
|
|
@@ -255,6 +267,12 @@ export interface FiltersApiGetFilterRequest {
|
|
|
255
267
|
* @memberof FiltersApiGetFilter
|
|
256
268
|
*/
|
|
257
269
|
readonly id: number;
|
|
270
|
+
/**
|
|
271
|
+
* If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
272
|
+
* @type {boolean}
|
|
273
|
+
* @memberof FiltersApiGetFilter
|
|
274
|
+
*/
|
|
275
|
+
readonly include_field_code?: boolean;
|
|
258
276
|
}
|
|
259
277
|
/**
|
|
260
278
|
* Request parameters for getFilters operation in FiltersApi.
|
|
@@ -281,6 +299,12 @@ export interface FiltersApiUpdateFilterRequest {
|
|
|
281
299
|
* @memberof FiltersApiUpdateFilter
|
|
282
300
|
*/
|
|
283
301
|
readonly id: number;
|
|
302
|
+
/**
|
|
303
|
+
* If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
304
|
+
* @type {boolean}
|
|
305
|
+
* @memberof FiltersApiUpdateFilter
|
|
306
|
+
*/
|
|
307
|
+
readonly include_field_code?: boolean;
|
|
284
308
|
/**
|
|
285
309
|
*
|
|
286
310
|
* @type {UpdateFilterRequest}
|
|
@@ -35,11 +35,12 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
|
35
35
|
/**
|
|
36
36
|
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
37
37
|
* @summary Add a new filter
|
|
38
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
38
39
|
* @param {AddFilterRequest} [AddFilterRequest]
|
|
39
40
|
|
|
40
41
|
* @throws {RequiredError}
|
|
41
42
|
*/
|
|
42
|
-
addFilter: (AddFilterRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
43
|
+
addFilter: (include_field_code, AddFilterRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
43
44
|
const localVarPath = `/filters`;
|
|
44
45
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45
46
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -55,6 +56,9 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
|
55
56
|
// authentication oauth2 required
|
|
56
57
|
// oauth required
|
|
57
58
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "activities:full", "contacts:full"], configuration);
|
|
59
|
+
if (include_field_code !== undefined) {
|
|
60
|
+
localVarQueryParameter['include_field_code'] = include_field_code;
|
|
61
|
+
}
|
|
58
62
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59
63
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60
64
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -139,10 +143,11 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
|
139
143
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
140
144
|
* @summary Get one filter
|
|
141
145
|
* @param {number} id The ID of the filter
|
|
146
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
142
147
|
|
|
143
148
|
* @throws {RequiredError}
|
|
144
149
|
*/
|
|
145
|
-
getFilter: (id) => __awaiter(this, void 0, void 0, function* () {
|
|
150
|
+
getFilter: (id, include_field_code) => __awaiter(this, void 0, void 0, function* () {
|
|
146
151
|
// verify required parameter 'id' is not null or undefined
|
|
147
152
|
assertParamExists('getFilter', 'id', id);
|
|
148
153
|
const localVarPath = `/filters/{id}`
|
|
@@ -161,6 +166,9 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
|
161
166
|
// authentication oauth2 required
|
|
162
167
|
// oauth required
|
|
163
168
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "activities:read", "activities:full", "contacts:read", "contacts:full"], configuration);
|
|
169
|
+
if (include_field_code !== undefined) {
|
|
170
|
+
localVarQueryParameter['include_field_code'] = include_field_code;
|
|
171
|
+
}
|
|
164
172
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
165
173
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
166
174
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -237,11 +245,12 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
|
237
245
|
* Updates an existing filter.
|
|
238
246
|
* @summary Update filter
|
|
239
247
|
* @param {number} id The ID of the filter
|
|
248
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
240
249
|
* @param {UpdateFilterRequest} [UpdateFilterRequest]
|
|
241
250
|
|
|
242
251
|
* @throws {RequiredError}
|
|
243
252
|
*/
|
|
244
|
-
updateFilter: (id, UpdateFilterRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
253
|
+
updateFilter: (id, include_field_code, UpdateFilterRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
245
254
|
// verify required parameter 'id' is not null or undefined
|
|
246
255
|
assertParamExists('updateFilter', 'id', id);
|
|
247
256
|
const localVarPath = `/filters/{id}`
|
|
@@ -260,6 +269,9 @@ export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
|
260
269
|
// authentication oauth2 required
|
|
261
270
|
// oauth required
|
|
262
271
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "activities:full", "contacts:full"], configuration);
|
|
272
|
+
if (include_field_code !== undefined) {
|
|
273
|
+
localVarQueryParameter['include_field_code'] = include_field_code;
|
|
274
|
+
}
|
|
263
275
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
264
276
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
265
277
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -282,13 +294,14 @@ export const FiltersApiFp = function (configuration) {
|
|
|
282
294
|
/**
|
|
283
295
|
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
284
296
|
* @summary Add a new filter
|
|
297
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
285
298
|
* @param {AddFilterRequest} [AddFilterRequest]
|
|
286
299
|
|
|
287
300
|
* @throws {RequiredError}
|
|
288
301
|
*/
|
|
289
|
-
addFilter(AddFilterRequest) {
|
|
302
|
+
addFilter(include_field_code, AddFilterRequest) {
|
|
290
303
|
return __awaiter(this, void 0, void 0, function* () {
|
|
291
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.addFilter(AddFilterRequest);
|
|
304
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addFilter(include_field_code, AddFilterRequest);
|
|
292
305
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
293
306
|
});
|
|
294
307
|
},
|
|
@@ -322,12 +335,13 @@ export const FiltersApiFp = function (configuration) {
|
|
|
322
335
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
323
336
|
* @summary Get one filter
|
|
324
337
|
* @param {number} id The ID of the filter
|
|
338
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
325
339
|
|
|
326
340
|
* @throws {RequiredError}
|
|
327
341
|
*/
|
|
328
|
-
getFilter(id) {
|
|
342
|
+
getFilter(id, include_field_code) {
|
|
329
343
|
return __awaiter(this, void 0, void 0, function* () {
|
|
330
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilter(id);
|
|
344
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilter(id, include_field_code);
|
|
331
345
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
346
|
});
|
|
333
347
|
},
|
|
@@ -360,13 +374,14 @@ export const FiltersApiFp = function (configuration) {
|
|
|
360
374
|
* Updates an existing filter.
|
|
361
375
|
* @summary Update filter
|
|
362
376
|
* @param {number} id The ID of the filter
|
|
377
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
363
378
|
* @param {UpdateFilterRequest} [UpdateFilterRequest]
|
|
364
379
|
|
|
365
380
|
* @throws {RequiredError}
|
|
366
381
|
*/
|
|
367
|
-
updateFilter(id, UpdateFilterRequest) {
|
|
382
|
+
updateFilter(id, include_field_code, UpdateFilterRequest) {
|
|
368
383
|
return __awaiter(this, void 0, void 0, function* () {
|
|
369
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFilter(id, UpdateFilterRequest);
|
|
384
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFilter(id, include_field_code, UpdateFilterRequest);
|
|
370
385
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
371
386
|
});
|
|
372
387
|
},
|
|
@@ -387,7 +402,7 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
387
402
|
* @throws {RequiredError}
|
|
388
403
|
*/
|
|
389
404
|
addFilter(requestParameters = {}) {
|
|
390
|
-
return localVarFp.addFilter(requestParameters.AddFilterRequest).then((request) => request(axios, basePath));
|
|
405
|
+
return localVarFp.addFilter(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(axios, basePath));
|
|
391
406
|
},
|
|
392
407
|
/**
|
|
393
408
|
* Marks a filter as deleted.
|
|
@@ -417,7 +432,7 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
417
432
|
* @throws {RequiredError}
|
|
418
433
|
*/
|
|
419
434
|
getFilter(requestParameters) {
|
|
420
|
-
return localVarFp.getFilter(requestParameters.id).then((request) => request(axios, basePath));
|
|
435
|
+
return localVarFp.getFilter(requestParameters.id, requestParameters.include_field_code).then((request) => request(axios, basePath));
|
|
421
436
|
},
|
|
422
437
|
/**
|
|
423
438
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
@@ -446,7 +461,7 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
446
461
|
* @throws {RequiredError}
|
|
447
462
|
*/
|
|
448
463
|
updateFilter(requestParameters) {
|
|
449
|
-
return localVarFp.updateFilter(requestParameters.id, requestParameters.UpdateFilterRequest).then((request) => request(axios, basePath));
|
|
464
|
+
return localVarFp.updateFilter(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(axios, basePath));
|
|
450
465
|
},
|
|
451
466
|
};
|
|
452
467
|
};
|
|
@@ -466,7 +481,7 @@ export class FiltersApi extends BaseAPI {
|
|
|
466
481
|
* @memberof FiltersApi
|
|
467
482
|
*/
|
|
468
483
|
addFilter(requestParameters = {}) {
|
|
469
|
-
return FiltersApiFp(this.configuration).addFilter(requestParameters.AddFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
484
|
+
return FiltersApiFp(this.configuration).addFilter(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
470
485
|
}
|
|
471
486
|
/**
|
|
472
487
|
* Marks a filter as deleted.
|
|
@@ -499,7 +514,7 @@ export class FiltersApi extends BaseAPI {
|
|
|
499
514
|
* @memberof FiltersApi
|
|
500
515
|
*/
|
|
501
516
|
getFilter(requestParameters) {
|
|
502
|
-
return FiltersApiFp(this.configuration).getFilter(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
517
|
+
return FiltersApiFp(this.configuration).getFilter(requestParameters.id, requestParameters.include_field_code).then((request) => request(this.axios, this.basePath));
|
|
503
518
|
}
|
|
504
519
|
/**
|
|
505
520
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
@@ -531,6 +546,6 @@ export class FiltersApi extends BaseAPI {
|
|
|
531
546
|
* @memberof FiltersApi
|
|
532
547
|
*/
|
|
533
548
|
updateFilter(requestParameters) {
|
|
534
|
-
return FiltersApiFp(this.configuration).updateFilter(requestParameters.id, requestParameters.UpdateFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
549
|
+
return FiltersApiFp(this.configuration).updateFilter(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
535
550
|
}
|
|
536
551
|
}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v1
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A single filter condition
|
|
14
|
+
* @export
|
|
15
|
+
* @interface FilterConditionsConditionsInnerConditionsInner
|
|
16
|
+
*/
|
|
17
|
+
export interface FilterConditionsConditionsInnerConditionsInner {
|
|
18
|
+
/**
|
|
19
|
+
* The type of entity the condition applies to (e.g. \"deal\", \"person\")
|
|
20
|
+
* @type {string}
|
|
21
|
+
*/
|
|
22
|
+
'object'?: string;
|
|
23
|
+
/**
|
|
24
|
+
* The ID of the field
|
|
25
|
+
* @type {string}
|
|
26
|
+
*/
|
|
27
|
+
'field_id'?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The operator used in the condition (e.g. \"=\", \"IS NOT NULL\")
|
|
30
|
+
* @type {string}
|
|
31
|
+
*/
|
|
32
|
+
'operator'?: string;
|
|
33
|
+
/**
|
|
34
|
+
* The value of the condition
|
|
35
|
+
* @type {string}
|
|
36
|
+
*/
|
|
37
|
+
'value'?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* An extra value for conditions that require two values
|
|
40
|
+
* @type {string}
|
|
41
|
+
*/
|
|
42
|
+
'extra_value'?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Whether the value is JSON-encoded
|
|
45
|
+
* @type {boolean}
|
|
46
|
+
*/
|
|
47
|
+
'json_value_flag'?: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* The code name of the field. Present when `include_field_code=true` is passed as a query parameter; `null` if the field code cannot be resolved
|
|
50
|
+
* @type {string}
|
|
51
|
+
*/
|
|
52
|
+
'field_code'?: string | null;
|
|
53
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Pipedrive API v1
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
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
|
+
export {};
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v1
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { FilterConditionsConditionsInnerConditionsInner } from './filter-conditions-conditions-inner-conditions-inner';
|
|
13
|
+
/**
|
|
14
|
+
* A group of conditions joined by a logical operator
|
|
15
|
+
* @export
|
|
16
|
+
* @interface FilterConditionsConditionsInner
|
|
17
|
+
*/
|
|
18
|
+
export interface FilterConditionsConditionsInner {
|
|
19
|
+
/**
|
|
20
|
+
* The logical operator joining conditions within this group
|
|
21
|
+
* @type {string}
|
|
22
|
+
*/
|
|
23
|
+
'glue'?: FilterConditionsConditionsInnerGlueConst;
|
|
24
|
+
/**
|
|
25
|
+
* The individual conditions in this group
|
|
26
|
+
* @type {Array<FilterConditionsConditionsInnerConditionsInner>}
|
|
27
|
+
*/
|
|
28
|
+
'conditions'?: Array<FilterConditionsConditionsInnerConditionsInner>;
|
|
29
|
+
}
|
|
30
|
+
export declare const FilterConditionsConditionsInnerGlueConst: {
|
|
31
|
+
readonly and: "and";
|
|
32
|
+
readonly or: "or";
|
|
33
|
+
};
|
|
34
|
+
export type FilterConditionsConditionsInnerGlueConst = typeof FilterConditionsConditionsInnerGlueConst[keyof typeof FilterConditionsConditionsInnerGlueConst];
|
|
@@ -1,19 +1,17 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
* Pipedrive API
|
|
4
|
+
* Pipedrive API v1
|
|
5
5
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
export const
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
subscribed: 'subscribed',
|
|
18
|
-
archived: 'archived'
|
|
14
|
+
export const FilterConditionsConditionsInnerGlueConst = {
|
|
15
|
+
and: 'and',
|
|
16
|
+
or: 'or'
|
|
19
17
|
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v1
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { FilterConditionsConditionsInner } from './filter-conditions-conditions-inner';
|
|
13
|
+
/**
|
|
14
|
+
* The conditions object of a filter
|
|
15
|
+
* @export
|
|
16
|
+
* @interface FilterConditions
|
|
17
|
+
*/
|
|
18
|
+
export interface FilterConditions {
|
|
19
|
+
/**
|
|
20
|
+
* The top-level glue is always \"and\"
|
|
21
|
+
* @type {string}
|
|
22
|
+
*/
|
|
23
|
+
'glue'?: FilterConditionsGlueConst;
|
|
24
|
+
/**
|
|
25
|
+
* The condition groups
|
|
26
|
+
* @type {Array<FilterConditionsConditionsInner>}
|
|
27
|
+
*/
|
|
28
|
+
'conditions'?: Array<FilterConditionsConditionsInner>;
|
|
29
|
+
}
|
|
30
|
+
export declare const FilterConditionsGlueConst: {
|
|
31
|
+
readonly and: "and";
|
|
32
|
+
};
|
|
33
|
+
export type FilterConditionsGlueConst = typeof FilterConditionsGlueConst[keyof typeof FilterConditionsGlueConst];
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Pipedrive API v1
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
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
|
+
export const FilterConditionsGlueConst = {
|
|
15
|
+
and: 'and'
|
|
16
|
+
};
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { FilterConditions } from './filter-conditions';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -16,17 +17,27 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface Filter {
|
|
18
19
|
/**
|
|
19
|
-
* The ID of the
|
|
20
|
+
* The ID of the filter
|
|
20
21
|
* @type {number}
|
|
21
22
|
*/
|
|
22
23
|
'id'?: number;
|
|
23
24
|
/**
|
|
24
|
-
* The name of the
|
|
25
|
+
* The name of the filter
|
|
25
26
|
* @type {string}
|
|
26
27
|
*/
|
|
27
28
|
'name'?: string;
|
|
28
29
|
/**
|
|
29
|
-
* The
|
|
30
|
+
* The system code of the filter
|
|
31
|
+
* @type {string}
|
|
32
|
+
*/
|
|
33
|
+
'filter_code'?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Whether the filter can be edited by the requesting user
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
*/
|
|
38
|
+
'is_editable'?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* The activity flag of the filter
|
|
30
41
|
* @type {boolean}
|
|
31
42
|
*/
|
|
32
43
|
'active_flag'?: boolean;
|
|
@@ -36,40 +47,45 @@ export interface Filter {
|
|
|
36
47
|
*/
|
|
37
48
|
'type'?: FilterTypeConst;
|
|
38
49
|
/**
|
|
39
|
-
*
|
|
50
|
+
* Whether the filter is temporary
|
|
40
51
|
* @type {boolean}
|
|
41
52
|
*/
|
|
42
|
-
'temporary_flag'?: boolean;
|
|
53
|
+
'temporary_flag'?: boolean | null;
|
|
43
54
|
/**
|
|
44
|
-
* The user ID of the
|
|
55
|
+
* The user ID of the filter owner
|
|
45
56
|
* @type {number}
|
|
46
57
|
*/
|
|
47
58
|
'user_id'?: number;
|
|
48
59
|
/**
|
|
49
|
-
* The
|
|
60
|
+
* The date and time when the filter was added
|
|
50
61
|
* @type {string}
|
|
51
62
|
*/
|
|
52
63
|
'add_time'?: string;
|
|
53
64
|
/**
|
|
54
|
-
* The
|
|
65
|
+
* The date and time when the filter was last updated
|
|
55
66
|
* @type {string}
|
|
56
67
|
*/
|
|
57
|
-
'update_time'?: string;
|
|
68
|
+
'update_time'?: string | null;
|
|
58
69
|
/**
|
|
59
|
-
*
|
|
60
|
-
* @type {
|
|
70
|
+
*
|
|
71
|
+
* @type {string}
|
|
61
72
|
*/
|
|
62
|
-
'visible_to'?:
|
|
73
|
+
'visible_to'?: FilterVisibleToConst;
|
|
63
74
|
/**
|
|
64
|
-
* The
|
|
75
|
+
* The date and time when the filter was last used
|
|
76
|
+
* @type {string}
|
|
77
|
+
*/
|
|
78
|
+
'last_used_time'?: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* The custom view ID linked to the filter
|
|
65
81
|
* @type {number}
|
|
66
82
|
*/
|
|
67
|
-
'custom_view_id'?: number;
|
|
83
|
+
'custom_view_id'?: number | null;
|
|
68
84
|
/**
|
|
69
|
-
*
|
|
70
|
-
* @type {
|
|
85
|
+
*
|
|
86
|
+
* @type {FilterConditions}
|
|
71
87
|
*/
|
|
72
|
-
'conditions'?:
|
|
88
|
+
'conditions'?: FilterConditions;
|
|
73
89
|
}
|
|
74
90
|
export declare const FilterTypeConst: {
|
|
75
91
|
readonly deals: "deals";
|
|
@@ -81,3 +97,10 @@ export declare const FilterTypeConst: {
|
|
|
81
97
|
readonly projects: "projects";
|
|
82
98
|
};
|
|
83
99
|
export type FilterTypeConst = typeof FilterTypeConst[keyof typeof FilterTypeConst];
|
|
100
|
+
export declare const FilterVisibleToConst: {
|
|
101
|
+
readonly _1: "1";
|
|
102
|
+
readonly _3: "3";
|
|
103
|
+
readonly _5: "5";
|
|
104
|
+
readonly _7: "7";
|
|
105
|
+
};
|
|
106
|
+
export type FilterVisibleToConst = typeof FilterVisibleToConst[keyof typeof FilterVisibleToConst];
|