pipedrive 30.11.0 → 31.1.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/activities-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/activities-api.js +0 -70
- package/dist/esm/versions/v1/api/activity-types-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/activity-types-api.js +0 -70
- package/dist/esm/versions/v1/api/deals-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/deals-api.js +0 -70
- package/dist/esm/versions/v1/api/leads-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/leads-api.js +10 -5
- package/dist/esm/versions/v1/api/notes-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/notes-api.js +12 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/organizations-api.js +0 -70
- package/dist/esm/versions/v1/api/persons-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/persons-api.js +0 -70
- package/dist/esm/versions/v1/api/stages-api.d.ts +0 -47
- package/dist/esm/versions/v1/api/stages-api.js +0 -70
- package/dist/esm/versions/v1/models/add-deal-request.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-task-request.d.ts +2 -2
- package/dist/esm/versions/v1/models/index.d.ts +2 -16
- package/dist/esm/versions/v1/models/index.js +2 -16
- package/dist/esm/versions/v1/models/required-post-project-parameters1.d.ts +28 -0
- package/dist/esm/versions/v1/models/required-post-project-parameters1.js +14 -0
- package/dist/esm/versions/v1/models/required-title-parameter.d.ts +23 -0
- package/dist/esm/versions/v1/models/required-title-parameter.js +14 -0
- package/dist/versions/v1/api/activities-api.d.ts +0 -47
- package/dist/versions/v1/api/activities-api.js +0 -70
- package/dist/versions/v1/api/activity-types-api.d.ts +0 -47
- package/dist/versions/v1/api/activity-types-api.js +0 -70
- package/dist/versions/v1/api/deals-api.d.ts +0 -47
- package/dist/versions/v1/api/deals-api.js +0 -70
- package/dist/versions/v1/api/leads-api.d.ts +10 -2
- package/dist/versions/v1/api/leads-api.js +10 -5
- package/dist/versions/v1/api/notes-api.d.ts +10 -2
- package/dist/versions/v1/api/notes-api.js +12 -5
- package/dist/versions/v1/api/organizations-api.d.ts +0 -47
- package/dist/versions/v1/api/organizations-api.js +0 -70
- package/dist/versions/v1/api/persons-api.d.ts +0 -47
- package/dist/versions/v1/api/persons-api.js +0 -70
- package/dist/versions/v1/api/stages-api.d.ts +0 -47
- package/dist/versions/v1/api/stages-api.js +0 -70
- package/dist/versions/v1/models/add-deal-request.d.ts +2 -2
- package/dist/versions/v1/models/add-task-request.d.ts +2 -2
- package/dist/versions/v1/models/index.d.ts +2 -16
- package/dist/versions/v1/models/index.js +2 -16
- package/dist/versions/v1/models/required-post-project-parameters1.d.ts +28 -0
- package/dist/versions/v1/models/required-post-project-parameters1.js +15 -0
- package/dist/versions/v1/models/required-title-parameter.d.ts +23 -0
- package/dist/versions/v1/models/required-title-parameter.js +15 -0
- package/package.json +1 -1
|
@@ -13,7 +13,6 @@ import type { Configuration } from '../configuration';
|
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { AddActivityTypeRequest } from '../models';
|
|
16
|
-
import { DeleteActivityTypesResponse } from '../models';
|
|
17
16
|
import { GetActivityTypesResponse } from '../models';
|
|
18
17
|
import { UpdateActivityTypeRequest } from '../models';
|
|
19
18
|
import { UpsertActivityTypeResponse } from '../models';
|
|
@@ -38,14 +37,6 @@ export declare const ActivityTypesApiAxiosParamCreator: (configuration?: Configu
|
|
|
38
37
|
* @throws {RequiredError}
|
|
39
38
|
*/
|
|
40
39
|
deleteActivityType: (id: number) => Promise<RequestArgs>;
|
|
41
|
-
/**
|
|
42
|
-
* Marks multiple activity types as deleted.
|
|
43
|
-
* @summary Delete multiple activity types in bulk
|
|
44
|
-
* @param {string} ids The comma-separated activity type IDs
|
|
45
|
-
|
|
46
|
-
* @throws {RequiredError}
|
|
47
|
-
*/
|
|
48
|
-
deleteActivityTypes: (ids: string) => Promise<RequestArgs>;
|
|
49
40
|
/**
|
|
50
41
|
* Returns all activity types.
|
|
51
42
|
* @summary Get all activity types
|
|
@@ -84,14 +75,6 @@ export declare const ActivityTypesApiFp: (configuration?: Configuration) => {
|
|
|
84
75
|
* @throws {RequiredError}
|
|
85
76
|
*/
|
|
86
77
|
deleteActivityType(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityTypeResponse>>;
|
|
87
|
-
/**
|
|
88
|
-
* Marks multiple activity types as deleted.
|
|
89
|
-
* @summary Delete multiple activity types in bulk
|
|
90
|
-
* @param {string} ids The comma-separated activity type IDs
|
|
91
|
-
|
|
92
|
-
* @throws {RequiredError}
|
|
93
|
-
*/
|
|
94
|
-
deleteActivityTypes(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteActivityTypesResponse>>;
|
|
95
78
|
/**
|
|
96
79
|
* Returns all activity types.
|
|
97
80
|
* @summary Get all activity types
|
|
@@ -130,14 +113,6 @@ export declare const ActivityTypesApiFactory: (configuration?: Configuration, ba
|
|
|
130
113
|
* @throws {RequiredError}
|
|
131
114
|
*/
|
|
132
115
|
deleteActivityType(requestParameters: ActivityTypesApiDeleteActivityTypeRequest): Promise<UpsertActivityTypeResponse>;
|
|
133
|
-
/**
|
|
134
|
-
* Marks multiple activity types as deleted.
|
|
135
|
-
* @summary Delete multiple activity types in bulk
|
|
136
|
-
* @param {ActivityTypesApiDeleteActivityTypesRequest} requestParameters Request parameters.
|
|
137
|
-
|
|
138
|
-
* @throws {RequiredError}
|
|
139
|
-
*/
|
|
140
|
-
deleteActivityTypes(requestParameters: ActivityTypesApiDeleteActivityTypesRequest): Promise<DeleteActivityTypesResponse>;
|
|
141
116
|
/**
|
|
142
117
|
* Returns all activity types.
|
|
143
118
|
* @summary Get all activity types
|
|
@@ -180,19 +155,6 @@ export interface ActivityTypesApiDeleteActivityTypeRequest {
|
|
|
180
155
|
*/
|
|
181
156
|
readonly id: number;
|
|
182
157
|
}
|
|
183
|
-
/**
|
|
184
|
-
* Request parameters for deleteActivityTypes operation in ActivityTypesApi.
|
|
185
|
-
* @export
|
|
186
|
-
* @interface ActivityTypesApiDeleteActivityTypesRequest
|
|
187
|
-
*/
|
|
188
|
-
export interface ActivityTypesApiDeleteActivityTypesRequest {
|
|
189
|
-
/**
|
|
190
|
-
* The comma-separated activity type IDs
|
|
191
|
-
* @type {string}
|
|
192
|
-
* @memberof ActivityTypesApiDeleteActivityTypes
|
|
193
|
-
*/
|
|
194
|
-
readonly ids: string;
|
|
195
|
-
}
|
|
196
158
|
/**
|
|
197
159
|
* Request parameters for updateActivityType operation in ActivityTypesApi.
|
|
198
160
|
* @export
|
|
@@ -237,15 +199,6 @@ export declare class ActivityTypesApi extends BaseAPI {
|
|
|
237
199
|
* @memberof ActivityTypesApi
|
|
238
200
|
*/
|
|
239
201
|
deleteActivityType(requestParameters: ActivityTypesApiDeleteActivityTypeRequest): Promise<UpsertActivityTypeResponse>;
|
|
240
|
-
/**
|
|
241
|
-
* Marks multiple activity types as deleted.
|
|
242
|
-
* @summary Delete multiple activity types in bulk
|
|
243
|
-
* @param {ActivityTypesApiDeleteActivityTypesRequest} requestParameters Request parameters.
|
|
244
|
-
|
|
245
|
-
* @throws {RequiredError}
|
|
246
|
-
* @memberof ActivityTypesApi
|
|
247
|
-
*/
|
|
248
|
-
deleteActivityTypes(requestParameters: ActivityTypesApiDeleteActivityTypesRequest): Promise<DeleteActivityTypesResponse>;
|
|
249
202
|
/**
|
|
250
203
|
* Returns all activity types.
|
|
251
204
|
* @summary Get all activity types
|
|
@@ -105,42 +105,6 @@ const ActivityTypesApiAxiosParamCreator = function (configuration) {
|
|
|
105
105
|
options: localVarRequestOptions,
|
|
106
106
|
};
|
|
107
107
|
}),
|
|
108
|
-
/**
|
|
109
|
-
* Marks multiple activity types as deleted.
|
|
110
|
-
* @summary Delete multiple activity types in bulk
|
|
111
|
-
* @param {string} ids The comma-separated activity type IDs
|
|
112
|
-
|
|
113
|
-
* @throws {RequiredError}
|
|
114
|
-
*/
|
|
115
|
-
deleteActivityTypes: (ids) => __awaiter(this, void 0, void 0, function* () {
|
|
116
|
-
// verify required parameter 'ids' is not null or undefined
|
|
117
|
-
(0, common_1.assertParamExists)('deleteActivityTypes', 'ids', ids);
|
|
118
|
-
const localVarPath = `/activityTypes`;
|
|
119
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
120
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
121
|
-
let baseOptions;
|
|
122
|
-
if (configuration) {
|
|
123
|
-
baseOptions = configuration.baseOptions;
|
|
124
|
-
}
|
|
125
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
126
|
-
const localVarHeaderParameter = {};
|
|
127
|
-
const localVarQueryParameter = {};
|
|
128
|
-
// authentication api_key required
|
|
129
|
-
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
|
130
|
-
// authentication oauth2 required
|
|
131
|
-
// oauth required
|
|
132
|
-
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
|
133
|
-
if (ids !== undefined) {
|
|
134
|
-
localVarQueryParameter['ids'] = ids;
|
|
135
|
-
}
|
|
136
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
139
|
-
return {
|
|
140
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
141
|
-
options: localVarRequestOptions,
|
|
142
|
-
};
|
|
143
|
-
}),
|
|
144
108
|
/**
|
|
145
109
|
* Returns all activity types.
|
|
146
110
|
* @summary Get all activity types
|
|
@@ -244,19 +208,6 @@ const ActivityTypesApiFp = function (configuration) {
|
|
|
244
208
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
245
209
|
});
|
|
246
210
|
},
|
|
247
|
-
/**
|
|
248
|
-
* Marks multiple activity types as deleted.
|
|
249
|
-
* @summary Delete multiple activity types in bulk
|
|
250
|
-
* @param {string} ids The comma-separated activity type IDs
|
|
251
|
-
|
|
252
|
-
* @throws {RequiredError}
|
|
253
|
-
*/
|
|
254
|
-
deleteActivityTypes(ids) {
|
|
255
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
256
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteActivityTypes(ids);
|
|
257
|
-
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
258
|
-
});
|
|
259
|
-
},
|
|
260
211
|
/**
|
|
261
212
|
* Returns all activity types.
|
|
262
213
|
* @summary Get all activity types
|
|
@@ -313,16 +264,6 @@ const ActivityTypesApiFactory = function (configuration, basePath, axios) {
|
|
|
313
264
|
deleteActivityType(requestParameters) {
|
|
314
265
|
return localVarFp.deleteActivityType(requestParameters.id).then((request) => request(axios, basePath));
|
|
315
266
|
},
|
|
316
|
-
/**
|
|
317
|
-
* Marks multiple activity types as deleted.
|
|
318
|
-
* @summary Delete multiple activity types in bulk
|
|
319
|
-
* @param {ActivityTypesApiDeleteActivityTypesRequest} requestParameters Request parameters.
|
|
320
|
-
|
|
321
|
-
* @throws {RequiredError}
|
|
322
|
-
*/
|
|
323
|
-
deleteActivityTypes(requestParameters) {
|
|
324
|
-
return localVarFp.deleteActivityTypes(requestParameters.ids).then((request) => request(axios, basePath));
|
|
325
|
-
},
|
|
326
267
|
/**
|
|
327
268
|
* Returns all activity types.
|
|
328
269
|
* @summary Get all activity types
|
|
@@ -374,17 +315,6 @@ class ActivityTypesApi extends base_1.BaseAPI {
|
|
|
374
315
|
deleteActivityType(requestParameters) {
|
|
375
316
|
return (0, exports.ActivityTypesApiFp)(this.configuration).deleteActivityType(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
376
317
|
}
|
|
377
|
-
/**
|
|
378
|
-
* Marks multiple activity types as deleted.
|
|
379
|
-
* @summary Delete multiple activity types in bulk
|
|
380
|
-
* @param {ActivityTypesApiDeleteActivityTypesRequest} requestParameters Request parameters.
|
|
381
|
-
|
|
382
|
-
* @throws {RequiredError}
|
|
383
|
-
* @memberof ActivityTypesApi
|
|
384
|
-
*/
|
|
385
|
-
deleteActivityTypes(requestParameters) {
|
|
386
|
-
return (0, exports.ActivityTypesApiFp)(this.configuration).deleteActivityTypes(requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
387
|
-
}
|
|
388
318
|
/**
|
|
389
319
|
* Returns all activity types.
|
|
390
320
|
* @summary Get all activity types
|
|
@@ -22,7 +22,6 @@ import { DeleteDealFollowerResponse } from '../models';
|
|
|
22
22
|
import { DeleteDealParticipantResponse } from '../models';
|
|
23
23
|
import { DeleteDealProductResponse } from '../models';
|
|
24
24
|
import { DeleteDealResponse } from '../models';
|
|
25
|
-
import { DeleteDealsResponse } from '../models';
|
|
26
25
|
import { GetAddProductAttachmentDetailsResponse } from '../models';
|
|
27
26
|
import { GetAddedDealResponse } from '../models';
|
|
28
27
|
import { GetAssociatedFilesResponse } from '../models';
|
|
@@ -123,14 +122,6 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
123
122
|
* @throws {RequiredError}
|
|
124
123
|
*/
|
|
125
124
|
deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
|
|
126
|
-
/**
|
|
127
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
128
|
-
* @summary Delete multiple deals in bulk
|
|
129
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
130
|
-
* @deprecated
|
|
131
|
-
* @throws {RequiredError}
|
|
132
|
-
*/
|
|
133
|
-
deleteDeals: (ids: string) => Promise<RequestArgs>;
|
|
134
125
|
/**
|
|
135
126
|
* Duplicates a deal.
|
|
136
127
|
* @summary Duplicate deal
|
|
@@ -483,14 +474,6 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
483
474
|
* @throws {RequiredError}
|
|
484
475
|
*/
|
|
485
476
|
deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
|
|
486
|
-
/**
|
|
487
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
488
|
-
* @summary Delete multiple deals in bulk
|
|
489
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
490
|
-
* @deprecated
|
|
491
|
-
* @throws {RequiredError}
|
|
492
|
-
*/
|
|
493
|
-
deleteDeals(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealsResponse>>;
|
|
494
477
|
/**
|
|
495
478
|
* Duplicates a deal.
|
|
496
479
|
* @summary Duplicate deal
|
|
@@ -837,14 +820,6 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
837
820
|
* @throws {RequiredError}
|
|
838
821
|
*/
|
|
839
822
|
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
|
840
|
-
/**
|
|
841
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
842
|
-
* @summary Delete multiple deals in bulk
|
|
843
|
-
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
|
844
|
-
* @deprecated
|
|
845
|
-
* @throws {RequiredError}
|
|
846
|
-
*/
|
|
847
|
-
deleteDeals(requestParameters: DealsApiDeleteDealsRequest): Promise<DeleteDealsResponse>;
|
|
848
823
|
/**
|
|
849
824
|
* Duplicates a deal.
|
|
850
825
|
* @summary Duplicate deal
|
|
@@ -1178,19 +1153,6 @@ export interface DealsApiDeleteDealProductRequest {
|
|
|
1178
1153
|
*/
|
|
1179
1154
|
readonly product_attachment_id: number;
|
|
1180
1155
|
}
|
|
1181
|
-
/**
|
|
1182
|
-
* Request parameters for deleteDeals operation in DealsApi.
|
|
1183
|
-
* @export
|
|
1184
|
-
* @interface DealsApiDeleteDealsRequest
|
|
1185
|
-
*/
|
|
1186
|
-
export interface DealsApiDeleteDealsRequest {
|
|
1187
|
-
/**
|
|
1188
|
-
* The comma-separated IDs that will be deleted
|
|
1189
|
-
* @type {string}
|
|
1190
|
-
* @memberof DealsApiDeleteDeals
|
|
1191
|
-
*/
|
|
1192
|
-
readonly ids: string;
|
|
1193
|
-
}
|
|
1194
1156
|
/**
|
|
1195
1157
|
* Request parameters for duplicateDeal operation in DealsApi.
|
|
1196
1158
|
* @export
|
|
@@ -2086,15 +2048,6 @@ export declare class DealsApi extends BaseAPI {
|
|
|
2086
2048
|
* @memberof DealsApi
|
|
2087
2049
|
*/
|
|
2088
2050
|
deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
|
|
2089
|
-
/**
|
|
2090
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
2091
|
-
* @summary Delete multiple deals in bulk
|
|
2092
|
-
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
|
2093
|
-
* @deprecated
|
|
2094
|
-
* @throws {RequiredError}
|
|
2095
|
-
* @memberof DealsApi
|
|
2096
|
-
*/
|
|
2097
|
-
deleteDeals(requestParameters: DealsApiDeleteDealsRequest): Promise<DeleteDealsResponse>;
|
|
2098
2051
|
/**
|
|
2099
2052
|
* Duplicates a deal.
|
|
2100
2053
|
* @summary Duplicate deal
|
|
@@ -330,42 +330,6 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
330
330
|
options: localVarRequestOptions,
|
|
331
331
|
};
|
|
332
332
|
}),
|
|
333
|
-
/**
|
|
334
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
335
|
-
* @summary Delete multiple deals in bulk
|
|
336
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
337
|
-
* @deprecated
|
|
338
|
-
* @throws {RequiredError}
|
|
339
|
-
*/
|
|
340
|
-
deleteDeals: (ids) => __awaiter(this, void 0, void 0, function* () {
|
|
341
|
-
// verify required parameter 'ids' is not null or undefined
|
|
342
|
-
(0, common_1.assertParamExists)('deleteDeals', 'ids', ids);
|
|
343
|
-
const localVarPath = `/deals`;
|
|
344
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
345
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
346
|
-
let baseOptions;
|
|
347
|
-
if (configuration) {
|
|
348
|
-
baseOptions = configuration.baseOptions;
|
|
349
|
-
}
|
|
350
|
-
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
|
351
|
-
const localVarHeaderParameter = {};
|
|
352
|
-
const localVarQueryParameter = {};
|
|
353
|
-
// authentication api_key required
|
|
354
|
-
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
|
355
|
-
// authentication oauth2 required
|
|
356
|
-
// oauth required
|
|
357
|
-
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:full"], configuration);
|
|
358
|
-
if (ids !== undefined) {
|
|
359
|
-
localVarQueryParameter['ids'] = ids;
|
|
360
|
-
}
|
|
361
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
362
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
363
|
-
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
364
|
-
return {
|
|
365
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
366
|
-
options: localVarRequestOptions,
|
|
367
|
-
};
|
|
368
|
-
}),
|
|
369
333
|
/**
|
|
370
334
|
* Duplicates a deal.
|
|
371
335
|
* @summary Duplicate deal
|
|
@@ -1657,19 +1621,6 @@ const DealsApiFp = function (configuration) {
|
|
|
1657
1621
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1658
1622
|
});
|
|
1659
1623
|
},
|
|
1660
|
-
/**
|
|
1661
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
1662
|
-
* @summary Delete multiple deals in bulk
|
|
1663
|
-
* @param {string} ids The comma-separated IDs that will be deleted
|
|
1664
|
-
* @deprecated
|
|
1665
|
-
* @throws {RequiredError}
|
|
1666
|
-
*/
|
|
1667
|
-
deleteDeals(ids) {
|
|
1668
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1669
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDeals(ids);
|
|
1670
|
-
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1671
|
-
});
|
|
1672
|
-
},
|
|
1673
1624
|
/**
|
|
1674
1625
|
* Duplicates a deal.
|
|
1675
1626
|
* @summary Duplicate deal
|
|
@@ -2156,16 +2107,6 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
2156
2107
|
deleteDealProduct(requestParameters) {
|
|
2157
2108
|
return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
|
|
2158
2109
|
},
|
|
2159
|
-
/**
|
|
2160
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
2161
|
-
* @summary Delete multiple deals in bulk
|
|
2162
|
-
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
|
2163
|
-
* @deprecated
|
|
2164
|
-
* @throws {RequiredError}
|
|
2165
|
-
*/
|
|
2166
|
-
deleteDeals(requestParameters) {
|
|
2167
|
-
return localVarFp.deleteDeals(requestParameters.ids).then((request) => request(axios, basePath));
|
|
2168
|
-
},
|
|
2169
2110
|
/**
|
|
2170
2111
|
* Duplicates a deal.
|
|
2171
2112
|
* @summary Duplicate deal
|
|
@@ -2504,17 +2445,6 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
2504
2445
|
deleteDealProduct(requestParameters) {
|
|
2505
2446
|
return (0, exports.DealsApiFp)(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
|
|
2506
2447
|
}
|
|
2507
|
-
/**
|
|
2508
|
-
* Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/deals/{id}</a> instead.
|
|
2509
|
-
* @summary Delete multiple deals in bulk
|
|
2510
|
-
* @param {DealsApiDeleteDealsRequest} requestParameters Request parameters.
|
|
2511
|
-
* @deprecated
|
|
2512
|
-
* @throws {RequiredError}
|
|
2513
|
-
* @memberof DealsApi
|
|
2514
|
-
*/
|
|
2515
|
-
deleteDeals(requestParameters) {
|
|
2516
|
-
return (0, exports.DealsApiFp)(this.configuration).deleteDeals(requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
2517
|
-
}
|
|
2518
2448
|
/**
|
|
2519
2449
|
* Duplicates a deal.
|
|
2520
2450
|
* @summary Duplicate deal
|
|
@@ -79,11 +79,12 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
79
79
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
80
80
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
81
81
|
* @param {number} [filter_id] The ID of the filter to use
|
|
82
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
82
83
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
83
84
|
|
|
84
85
|
* @throws {RequiredError}
|
|
85
86
|
*/
|
|
86
|
-
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
|
|
87
|
+
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time') => Promise<RequestArgs>;
|
|
87
88
|
/**
|
|
88
89
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
89
90
|
* @summary Search leads
|
|
@@ -169,11 +170,12 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
169
170
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
170
171
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
171
172
|
* @param {number} [filter_id] The ID of the filter to use
|
|
173
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
172
174
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
173
175
|
|
|
174
176
|
* @throws {RequiredError}
|
|
175
177
|
*/
|
|
176
|
-
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
178
|
+
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: 'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
177
179
|
/**
|
|
178
180
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
179
181
|
* @summary Search leads
|
|
@@ -412,6 +414,12 @@ export interface LeadsApiGetLeadsRequest {
|
|
|
412
414
|
* @memberof LeadsApiGetLeads
|
|
413
415
|
*/
|
|
414
416
|
readonly filter_id?: number;
|
|
417
|
+
/**
|
|
418
|
+
* If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
419
|
+
* @type {string}
|
|
420
|
+
* @memberof LeadsApiGetLeads
|
|
421
|
+
*/
|
|
422
|
+
readonly updated_since?: string;
|
|
415
423
|
/**
|
|
416
424
|
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
417
425
|
* @type {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'}
|
|
@@ -240,11 +240,12 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
240
240
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
241
241
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
242
242
|
* @param {number} [filter_id] The ID of the filter to use
|
|
243
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
243
244
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
244
245
|
|
|
245
246
|
* @throws {RequiredError}
|
|
246
247
|
*/
|
|
247
|
-
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) => __awaiter(this, void 0, void 0, function* () {
|
|
248
249
|
const localVarPath = `/leads`;
|
|
249
250
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
250
251
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -278,6 +279,9 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
278
279
|
if (filter_id !== undefined) {
|
|
279
280
|
localVarQueryParameter['filter_id'] = filter_id;
|
|
280
281
|
}
|
|
282
|
+
if (updated_since !== undefined) {
|
|
283
|
+
localVarQueryParameter['updated_since'] = updated_since;
|
|
284
|
+
}
|
|
281
285
|
if (sort !== undefined) {
|
|
282
286
|
localVarQueryParameter['sort'] = sort;
|
|
283
287
|
}
|
|
@@ -480,13 +484,14 @@ const LeadsApiFp = function (configuration) {
|
|
|
480
484
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
|
481
485
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
482
486
|
* @param {number} [filter_id] The ID of the filter to use
|
|
487
|
+
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
483
488
|
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
484
489
|
|
|
485
490
|
* @throws {RequiredError}
|
|
486
491
|
*/
|
|
487
|
-
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
|
492
|
+
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort) {
|
|
488
493
|
return __awaiter(this, void 0, void 0, function* () {
|
|
489
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
|
494
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, updated_since, sort);
|
|
490
495
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
491
496
|
});
|
|
492
497
|
},
|
|
@@ -592,7 +597,7 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
|
592
597
|
* @throws {RequiredError}
|
|
593
598
|
*/
|
|
594
599
|
getLeads(requestParameters = {}) {
|
|
595
|
-
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
|
600
|
+
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(axios, basePath));
|
|
596
601
|
},
|
|
597
602
|
/**
|
|
598
603
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
@@ -688,7 +693,7 @@ class LeadsApi extends base_1.BaseAPI {
|
|
|
688
693
|
* @memberof LeadsApi
|
|
689
694
|
*/
|
|
690
695
|
getLeads(requestParameters = {}) {
|
|
691
|
-
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
696
|
+
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.updated_since, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
|
692
697
|
}
|
|
693
698
|
/**
|
|
694
699
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
@@ -101,6 +101,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
101
101
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
102
102
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
103
103
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
104
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
104
105
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
105
106
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
106
107
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -109,7 +110,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
109
110
|
|
|
110
111
|
* @throws {RequiredError}
|
|
111
112
|
*/
|
|
112
|
-
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
|
113
|
+
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
|
113
114
|
/**
|
|
114
115
|
* Updates a comment related to a note.
|
|
115
116
|
* @summary Update a comment related to a note
|
|
@@ -210,6 +211,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
|
210
211
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
211
212
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
212
213
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
214
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
213
215
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
214
216
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
215
217
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -218,7 +220,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
|
218
220
|
|
|
219
221
|
* @throws {RequiredError}
|
|
220
222
|
*/
|
|
221
|
-
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
|
223
|
+
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, updated_since?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
|
222
224
|
/**
|
|
223
225
|
* Updates a comment related to a note.
|
|
224
226
|
* @summary Update a comment related to a note
|
|
@@ -518,6 +520,12 @@ export interface NotesApiGetNotesRequest {
|
|
|
518
520
|
* @memberof NotesApiGetNotes
|
|
519
521
|
*/
|
|
520
522
|
readonly end_date?: string;
|
|
523
|
+
/**
|
|
524
|
+
* If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
525
|
+
* @type {string}
|
|
526
|
+
* @memberof NotesApiGetNotes
|
|
527
|
+
*/
|
|
528
|
+
readonly updated_since?: string;
|
|
521
529
|
/**
|
|
522
530
|
* If set, the results are filtered by note to lead pinning state
|
|
523
531
|
* @type {0 | 1}
|
|
@@ -308,6 +308,7 @@ const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
308
308
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
309
309
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
310
310
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
311
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
311
312
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
312
313
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
313
314
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -316,7 +317,7 @@ const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
316
317
|
|
|
317
318
|
* @throws {RequiredError}
|
|
318
319
|
*/
|
|
319
|
-
getNotes: (user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) => __awaiter(this, void 0, void 0, function* () {
|
|
320
|
+
getNotes: (user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) => __awaiter(this, void 0, void 0, function* () {
|
|
320
321
|
const localVarPath = `/notes`;
|
|
321
322
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
322
323
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -369,6 +370,11 @@ const NotesApiAxiosParamCreator = function (configuration) {
|
|
|
369
370
|
end_date.toISOString().substr(0, 10) :
|
|
370
371
|
end_date;
|
|
371
372
|
}
|
|
373
|
+
if (updated_since !== undefined) {
|
|
374
|
+
localVarQueryParameter['updated_since'] = (updated_since instanceof Date) ?
|
|
375
|
+
updated_since.toISOString() :
|
|
376
|
+
updated_since;
|
|
377
|
+
}
|
|
372
378
|
if (pinned_to_lead_flag !== undefined) {
|
|
373
379
|
localVarQueryParameter['pinned_to_lead_flag'] = pinned_to_lead_flag;
|
|
374
380
|
}
|
|
@@ -590,6 +596,7 @@ const NotesApiFp = function (configuration) {
|
|
|
590
596
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
|
591
597
|
* @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
|
|
592
598
|
* @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
|
|
599
|
+
* @param {string} [updated_since] If set, only notes with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
593
600
|
* @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
|
|
594
601
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
|
595
602
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
|
@@ -598,9 +605,9 @@ const NotesApiFp = function (configuration) {
|
|
|
598
605
|
|
|
599
606
|
* @throws {RequiredError}
|
|
600
607
|
*/
|
|
601
|
-
getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) {
|
|
608
|
+
getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag) {
|
|
602
609
|
return __awaiter(this, void 0, void 0, function* () {
|
|
603
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag);
|
|
610
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, project_id, start, limit, sort, start_date, end_date, updated_since, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, pinned_to_project_flag);
|
|
604
611
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
605
612
|
});
|
|
606
613
|
},
|
|
@@ -721,7 +728,7 @@ const NotesApiFactory = function (configuration, basePath, axios) {
|
|
|
721
728
|
* @throws {RequiredError}
|
|
722
729
|
*/
|
|
723
730
|
getNotes(requestParameters = {}) {
|
|
724
|
-
return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(axios, basePath));
|
|
731
|
+
return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(axios, basePath));
|
|
725
732
|
},
|
|
726
733
|
/**
|
|
727
734
|
* Updates a comment related to a note.
|
|
@@ -839,7 +846,7 @@ class NotesApi extends base_1.BaseAPI {
|
|
|
839
846
|
* @memberof NotesApi
|
|
840
847
|
*/
|
|
841
848
|
getNotes(requestParameters = {}) {
|
|
842
|
-
return (0, exports.NotesApiFp)(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(this.axios, this.basePath));
|
|
849
|
+
return (0, exports.NotesApiFp)(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.project_id, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.start_date, requestParameters.end_date, requestParameters.updated_since, requestParameters.pinned_to_lead_flag, requestParameters.pinned_to_deal_flag, requestParameters.pinned_to_organization_flag, requestParameters.pinned_to_person_flag, requestParameters.pinned_to_project_flag).then((request) => request(this.axios, this.basePath));
|
|
843
850
|
}
|
|
844
851
|
/**
|
|
845
852
|
* Updates a comment related to a note.
|