pipedrive 33.1.1 → 33.3.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.
@@ -34,10 +34,11 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration)
34
34
  * @param {number} [product_id] The ID of the product to associate file(s) with
35
35
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
36
36
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
37
+ * @param {number} [project_id] The ID of the project to associate file(s) with
37
38
 
38
39
  * @throws {RequiredError}
39
40
  */
40
- addFile: (file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string) => Promise<RequestArgs>;
41
+ addFile: (file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string, project_id?: number) => Promise<RequestArgs>;
41
42
  /**
42
43
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
43
44
  * @summary Create a remote file and link it to an item
@@ -121,10 +122,11 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
121
122
  * @param {number} [product_id] The ID of the product to associate file(s) with
122
123
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
123
124
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
125
+ * @param {number} [project_id] The ID of the project to associate file(s) with
124
126
 
125
127
  * @throws {RequiredError}
126
128
  */
127
- addFile(file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFileResponse>>;
129
+ addFile(file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string, project_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFileResponse>>;
128
130
  /**
129
131
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
130
132
  * @summary Create a remote file and link it to an item
@@ -311,6 +313,12 @@ export interface FilesApiAddFileRequest {
311
313
  * @memberof FilesApiAddFile
312
314
  */
313
315
  readonly lead_id?: string;
316
+ /**
317
+ * The ID of the project to associate file(s) with
318
+ * @type {number}
319
+ * @memberof FilesApiAddFile
320
+ */
321
+ readonly project_id?: number;
314
322
  }
315
323
  /**
316
324
  * Request parameters for addFileAndLinkIt operation in FilesApi.
@@ -42,10 +42,11 @@ export const FilesApiAxiosParamCreator = function (configuration) {
42
42
  * @param {number} [product_id] The ID of the product to associate file(s) with
43
43
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
44
44
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
45
+ * @param {number} [project_id] The ID of the project to associate file(s) with
45
46
 
46
47
  * @throws {RequiredError}
47
48
  */
48
- addFile: (file, deal_id, person_id, org_id, product_id, activity_id, lead_id) => __awaiter(this, void 0, void 0, function* () {
49
+ addFile: (file, deal_id, person_id, org_id, product_id, activity_id, lead_id, project_id) => __awaiter(this, void 0, void 0, function* () {
49
50
  // verify required parameter 'file' is not null or undefined
50
51
  assertParamExists('addFile', 'file', file);
51
52
  const localVarPath = `/files`;
@@ -85,6 +86,9 @@ export const FilesApiAxiosParamCreator = function (configuration) {
85
86
  if (lead_id !== undefined) {
86
87
  localVarFormParams.append('lead_id', lead_id);
87
88
  }
89
+ if (project_id !== undefined) {
90
+ localVarFormParams.append('project_id', project_id);
91
+ }
88
92
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
89
93
  setSearchParams(localVarUrlObj, localVarQueryParameter);
90
94
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -423,12 +427,13 @@ export const FilesApiFp = function (configuration) {
423
427
  * @param {number} [product_id] The ID of the product to associate file(s) with
424
428
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
425
429
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
430
+ * @param {number} [project_id] The ID of the project to associate file(s) with
426
431
 
427
432
  * @throws {RequiredError}
428
433
  */
429
- addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id) {
434
+ addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id, project_id) {
430
435
  return __awaiter(this, void 0, void 0, function* () {
431
- const localVarAxiosArgs = yield localVarAxiosParamCreator.addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id);
436
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id, project_id);
432
437
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
433
438
  });
434
439
  },
@@ -551,7 +556,7 @@ export const FilesApiFactory = function (configuration, basePath, axios) {
551
556
  * @throws {RequiredError}
552
557
  */
553
558
  addFile(requestParameters) {
554
- return localVarFp.addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id).then((request) => request(axios, basePath));
559
+ return localVarFp.addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id, requestParameters.project_id).then((request) => request(axios, basePath));
555
560
  },
556
561
  /**
557
562
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
@@ -641,7 +646,7 @@ export class FilesApi extends BaseAPI {
641
646
  * @memberof FilesApi
642
647
  */
643
648
  addFile(requestParameters) {
644
- return FilesApiFp(this.configuration).addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id).then((request) => request(this.axios, this.basePath));
649
+ return FilesApiFp(this.configuration).addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id, requestParameters.project_id).then((request) => request(this.axios, this.basePath));
645
650
  }
646
651
  /**
647
652
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
@@ -56,6 +56,11 @@ export interface GetFilesResponseDataInner {
56
56
  */
57
57
  'lead_id'?: string;
58
58
  /**
59
+ * The ID of the project to associate the file with
60
+ * @type {number}
61
+ */
62
+ 'project_id'?: number;
63
+ /**
59
64
  * The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS
60
65
  * @type {string}
61
66
  */
@@ -141,6 +146,11 @@ export interface GetFilesResponseDataInner {
141
146
  */
142
147
  'lead_name'?: string;
143
148
  /**
149
+ * The name of the project associated with the file
150
+ * @type {string}
151
+ */
152
+ 'project_name'?: string;
153
+ /**
144
154
  * The URL of the download file
145
155
  * @type {string}
146
156
  */
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * DealProductsApi - axios parameter creator
31
31
  * @export
@@ -262,7 +262,7 @@ export const DealProductsApiAxiosParamCreator = function (configuration) {
262
262
  // oauth required
263
263
  yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full", "deals:read", "deals:full"], configuration);
264
264
  if (deal_ids) {
265
- localVarQueryParameter['deal_ids'] = deal_ids;
265
+ localVarQueryParameter['deal_ids'] = deal_ids.join(COLLECTION_FORMATS.csv);
266
266
  }
267
267
  if (cursor !== undefined) {
268
268
  localVarQueryParameter['cursor'] = cursor;
@@ -93,12 +93,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
93
93
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
94
94
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
95
95
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
96
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
97
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
98
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
96
99
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
97
100
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
98
101
 
99
102
  * @throws {RequiredError}
100
103
  */
101
- getProjects: (filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
104
+ getProjects: (filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
102
105
  /**
103
106
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
104
107
  * @summary Search projects
@@ -196,12 +199,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
196
199
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
197
200
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
198
201
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
202
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
203
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
204
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
199
205
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
200
206
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
201
207
 
202
208
  * @throws {RequiredError}
203
209
  */
204
- getProjects(filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
210
+ getProjects(filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
205
211
  /**
206
212
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
207
213
  * @summary Search projects
@@ -463,6 +469,24 @@ export interface ProjectsApiGetProjectsRequest {
463
469
  * @memberof ProjectsApiGetProjects
464
470
  */
465
471
  readonly phase_id?: number;
472
+ /**
473
+ * If supplied, only projects associated with the specified deal are returned
474
+ * @type {number}
475
+ * @memberof ProjectsApiGetProjects
476
+ */
477
+ readonly deal_id?: number;
478
+ /**
479
+ * If supplied, only projects associated with the specified person are returned
480
+ * @type {number}
481
+ * @memberof ProjectsApiGetProjects
482
+ */
483
+ readonly person_id?: number;
484
+ /**
485
+ * If supplied, only projects associated with the specified organization are returned
486
+ * @type {number}
487
+ * @memberof ProjectsApiGetProjects
488
+ */
489
+ readonly org_id?: number;
466
490
  /**
467
491
  * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
468
492
  * @type {number}
@@ -301,12 +301,15 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
301
301
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
302
302
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
303
303
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
304
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
305
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
306
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
304
307
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
305
308
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
306
309
 
307
310
  * @throws {RequiredError}
308
311
  */
309
- getProjects: (filter_id, status, phase_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
312
+ getProjects: (filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
310
313
  const localVarPath = `/projects`;
311
314
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
312
315
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -331,6 +334,15 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
331
334
  if (phase_id !== undefined) {
332
335
  localVarQueryParameter['phase_id'] = phase_id;
333
336
  }
337
+ if (deal_id !== undefined) {
338
+ localVarQueryParameter['deal_id'] = deal_id;
339
+ }
340
+ if (person_id !== undefined) {
341
+ localVarQueryParameter['person_id'] = person_id;
342
+ }
343
+ if (org_id !== undefined) {
344
+ localVarQueryParameter['org_id'] = org_id;
345
+ }
334
346
  if (limit !== undefined) {
335
347
  localVarQueryParameter['limit'] = limit;
336
348
  }
@@ -554,14 +566,17 @@ export const ProjectsApiFp = function (configuration) {
554
566
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
555
567
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
556
568
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
569
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
570
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
571
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
557
572
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
558
573
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
559
574
 
560
575
  * @throws {RequiredError}
561
576
  */
562
- getProjects(filter_id, status, phase_id, limit, cursor) {
577
+ getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) {
563
578
  return __awaiter(this, void 0, void 0, function* () {
564
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, limit, cursor);
579
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor);
565
580
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
566
581
  });
567
582
  },
@@ -685,7 +700,7 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
685
700
  * @throws {RequiredError}
686
701
  */
687
702
  getProjects(requestParameters = {}) {
688
- return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
703
+ return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
689
704
  },
690
705
  /**
691
706
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
@@ -802,7 +817,7 @@ export class ProjectsApi extends BaseAPI {
802
817
  * @memberof ProjectsApi
803
818
  */
804
819
  getProjects(requestParameters = {}) {
805
- return ProjectsApiFp(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
820
+ return ProjectsApiFp(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
806
821
  }
807
822
  /**
808
823
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
@@ -62,6 +62,31 @@ export interface OrganizationItem {
62
62
  */
63
63
  'label_ids'?: Array<number>;
64
64
  /**
65
+ * The website of the organization
66
+ * @type {string}
67
+ */
68
+ 'website'?: string | null;
69
+ /**
70
+ * The LinkedIn profile URL of the organization
71
+ * @type {string}
72
+ */
73
+ 'linkedin'?: string | null;
74
+ /**
75
+ * The industry the organization belongs to
76
+ * @type {number}
77
+ */
78
+ 'industry'?: number | null;
79
+ /**
80
+ * The annual revenue of the organization
81
+ * @type {number}
82
+ */
83
+ 'annual_revenue'?: number | null;
84
+ /**
85
+ * The number of employees in the organization
86
+ * @type {number}
87
+ */
88
+ 'employee_count'?: number | null;
89
+ /**
65
90
  * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
66
91
  * @type {{ [key: string]: any | undefined; }}
67
92
  */
@@ -34,10 +34,11 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration)
34
34
  * @param {number} [product_id] The ID of the product to associate file(s) with
35
35
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
36
36
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
37
+ * @param {number} [project_id] The ID of the project to associate file(s) with
37
38
 
38
39
  * @throws {RequiredError}
39
40
  */
40
- addFile: (file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string) => Promise<RequestArgs>;
41
+ addFile: (file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string, project_id?: number) => Promise<RequestArgs>;
41
42
  /**
42
43
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
43
44
  * @summary Create a remote file and link it to an item
@@ -121,10 +122,11 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
121
122
  * @param {number} [product_id] The ID of the product to associate file(s) with
122
123
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
123
124
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
125
+ * @param {number} [project_id] The ID of the project to associate file(s) with
124
126
 
125
127
  * @throws {RequiredError}
126
128
  */
127
- addFile(file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFileResponse>>;
129
+ addFile(file: File, deal_id?: number, person_id?: number, org_id?: number, product_id?: number, activity_id?: number, lead_id?: string, project_id?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFileResponse>>;
128
130
  /**
129
131
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
130
132
  * @summary Create a remote file and link it to an item
@@ -311,6 +313,12 @@ export interface FilesApiAddFileRequest {
311
313
  * @memberof FilesApiAddFile
312
314
  */
313
315
  readonly lead_id?: string;
316
+ /**
317
+ * The ID of the project to associate file(s) with
318
+ * @type {number}
319
+ * @memberof FilesApiAddFile
320
+ */
321
+ readonly project_id?: number;
314
322
  }
315
323
  /**
316
324
  * Request parameters for addFileAndLinkIt operation in FilesApi.
@@ -48,10 +48,11 @@ const FilesApiAxiosParamCreator = function (configuration) {
48
48
  * @param {number} [product_id] The ID of the product to associate file(s) with
49
49
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
50
50
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
51
+ * @param {number} [project_id] The ID of the project to associate file(s) with
51
52
 
52
53
  * @throws {RequiredError}
53
54
  */
54
- addFile: (file, deal_id, person_id, org_id, product_id, activity_id, lead_id) => __awaiter(this, void 0, void 0, function* () {
55
+ addFile: (file, deal_id, person_id, org_id, product_id, activity_id, lead_id, project_id) => __awaiter(this, void 0, void 0, function* () {
55
56
  // verify required parameter 'file' is not null or undefined
56
57
  (0, common_1.assertParamExists)('addFile', 'file', file);
57
58
  const localVarPath = `/files`;
@@ -91,6 +92,9 @@ const FilesApiAxiosParamCreator = function (configuration) {
91
92
  if (lead_id !== undefined) {
92
93
  localVarFormParams.append('lead_id', lead_id);
93
94
  }
95
+ if (project_id !== undefined) {
96
+ localVarFormParams.append('project_id', project_id);
97
+ }
94
98
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
95
99
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
96
100
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -430,12 +434,13 @@ const FilesApiFp = function (configuration) {
430
434
  * @param {number} [product_id] The ID of the product to associate file(s) with
431
435
  * @param {number} [activity_id] The ID of the activity to associate file(s) with
432
436
  * @param {string} [lead_id] The ID of the lead to associate file(s) with
437
+ * @param {number} [project_id] The ID of the project to associate file(s) with
433
438
 
434
439
  * @throws {RequiredError}
435
440
  */
436
- addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id) {
441
+ addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id, project_id) {
437
442
  return __awaiter(this, void 0, void 0, function* () {
438
- const localVarAxiosArgs = yield localVarAxiosParamCreator.addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id);
443
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.addFile(file, deal_id, person_id, org_id, product_id, activity_id, lead_id, project_id);
439
444
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
440
445
  });
441
446
  },
@@ -559,7 +564,7 @@ const FilesApiFactory = function (configuration, basePath, axios) {
559
564
  * @throws {RequiredError}
560
565
  */
561
566
  addFile(requestParameters) {
562
- return localVarFp.addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id).then((request) => request(axios, basePath));
567
+ return localVarFp.addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id, requestParameters.project_id).then((request) => request(axios, basePath));
563
568
  },
564
569
  /**
565
570
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
@@ -650,7 +655,7 @@ class FilesApi extends base_1.BaseAPI {
650
655
  * @memberof FilesApi
651
656
  */
652
657
  addFile(requestParameters) {
653
- return (0, exports.FilesApiFp)(this.configuration).addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id).then((request) => request(this.axios, this.basePath));
658
+ return (0, exports.FilesApiFp)(this.configuration).addFile(requestParameters.file, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.product_id, requestParameters.activity_id, requestParameters.lead_id, requestParameters.project_id).then((request) => request(this.axios, this.basePath));
654
659
  }
655
660
  /**
656
661
  * Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
@@ -56,6 +56,11 @@ export interface GetFilesResponseDataInner {
56
56
  */
57
57
  'lead_id'?: string;
58
58
  /**
59
+ * The ID of the project to associate the file with
60
+ * @type {number}
61
+ */
62
+ 'project_id'?: number;
63
+ /**
59
64
  * The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS
60
65
  * @type {string}
61
66
  */
@@ -141,6 +146,11 @@ export interface GetFilesResponseDataInner {
141
146
  */
142
147
  'lead_name'?: string;
143
148
  /**
149
+ * The name of the project associated with the file
150
+ * @type {string}
151
+ */
152
+ 'project_name'?: string;
153
+ /**
144
154
  * The URL of the download file
145
155
  * @type {string}
146
156
  */
@@ -268,7 +268,7 @@ const DealProductsApiAxiosParamCreator = function (configuration) {
268
268
  // oauth required
269
269
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["products:read", "products:full", "deals:read", "deals:full"], configuration);
270
270
  if (deal_ids) {
271
- localVarQueryParameter['deal_ids'] = deal_ids;
271
+ localVarQueryParameter['deal_ids'] = deal_ids.join(base_1.COLLECTION_FORMATS.csv);
272
272
  }
273
273
  if (cursor !== undefined) {
274
274
  localVarQueryParameter['cursor'] = cursor;
@@ -93,12 +93,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
93
93
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
94
94
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
95
95
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
96
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
97
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
98
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
96
99
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
97
100
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
98
101
 
99
102
  * @throws {RequiredError}
100
103
  */
101
- getProjects: (filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
104
+ getProjects: (filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
102
105
  /**
103
106
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
104
107
  * @summary Search projects
@@ -196,12 +199,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
196
199
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
197
200
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
198
201
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
202
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
203
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
204
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
199
205
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
200
206
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
201
207
 
202
208
  * @throws {RequiredError}
203
209
  */
204
- getProjects(filter_id?: number, status?: string, phase_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
210
+ getProjects(filter_id?: number, status?: string, phase_id?: number, deal_id?: number, person_id?: number, org_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectsResponse>>;
205
211
  /**
206
212
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
207
213
  * @summary Search projects
@@ -463,6 +469,24 @@ export interface ProjectsApiGetProjectsRequest {
463
469
  * @memberof ProjectsApiGetProjects
464
470
  */
465
471
  readonly phase_id?: number;
472
+ /**
473
+ * If supplied, only projects associated with the specified deal are returned
474
+ * @type {number}
475
+ * @memberof ProjectsApiGetProjects
476
+ */
477
+ readonly deal_id?: number;
478
+ /**
479
+ * If supplied, only projects associated with the specified person are returned
480
+ * @type {number}
481
+ * @memberof ProjectsApiGetProjects
482
+ */
483
+ readonly person_id?: number;
484
+ /**
485
+ * If supplied, only projects associated with the specified organization are returned
486
+ * @type {number}
487
+ * @memberof ProjectsApiGetProjects
488
+ */
489
+ readonly org_id?: number;
466
490
  /**
467
491
  * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
468
492
  * @type {number}
@@ -307,12 +307,15 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
307
307
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
308
308
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
309
309
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
310
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
311
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
312
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
310
313
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
311
314
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
312
315
 
313
316
  * @throws {RequiredError}
314
317
  */
315
- getProjects: (filter_id, status, phase_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
318
+ getProjects: (filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
316
319
  const localVarPath = `/projects`;
317
320
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
318
321
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -337,6 +340,15 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
337
340
  if (phase_id !== undefined) {
338
341
  localVarQueryParameter['phase_id'] = phase_id;
339
342
  }
343
+ if (deal_id !== undefined) {
344
+ localVarQueryParameter['deal_id'] = deal_id;
345
+ }
346
+ if (person_id !== undefined) {
347
+ localVarQueryParameter['person_id'] = person_id;
348
+ }
349
+ if (org_id !== undefined) {
350
+ localVarQueryParameter['org_id'] = org_id;
351
+ }
340
352
  if (limit !== undefined) {
341
353
  localVarQueryParameter['limit'] = limit;
342
354
  }
@@ -561,14 +573,17 @@ const ProjectsApiFp = function (configuration) {
561
573
  * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
562
574
  * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
563
575
  * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
576
+ * @param {number} [deal_id] If supplied, only projects associated with the specified deal are returned
577
+ * @param {number} [person_id] If supplied, only projects associated with the specified person are returned
578
+ * @param {number} [org_id] If supplied, only projects associated with the specified organization are returned
564
579
  * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
565
580
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
566
581
 
567
582
  * @throws {RequiredError}
568
583
  */
569
- getProjects(filter_id, status, phase_id, limit, cursor) {
584
+ getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor) {
570
585
  return __awaiter(this, void 0, void 0, function* () {
571
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, limit, cursor);
586
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, deal_id, person_id, org_id, limit, cursor);
572
587
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
573
588
  });
574
589
  },
@@ -693,7 +708,7 @@ const ProjectsApiFactory = function (configuration, basePath, axios) {
693
708
  * @throws {RequiredError}
694
709
  */
695
710
  getProjects(requestParameters = {}) {
696
- return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
711
+ return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
697
712
  },
698
713
  /**
699
714
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
@@ -811,7 +826,7 @@ class ProjectsApi extends base_1.BaseAPI {
811
826
  * @memberof ProjectsApi
812
827
  */
813
828
  getProjects(requestParameters = {}) {
814
- return (0, exports.ProjectsApiFp)(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
829
+ return (0, exports.ProjectsApiFp)(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
815
830
  }
816
831
  /**
817
832
  * Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
@@ -62,6 +62,31 @@ export interface OrganizationItem {
62
62
  */
63
63
  'label_ids'?: Array<number>;
64
64
  /**
65
+ * The website of the organization
66
+ * @type {string}
67
+ */
68
+ 'website'?: string | null;
69
+ /**
70
+ * The LinkedIn profile URL of the organization
71
+ * @type {string}
72
+ */
73
+ 'linkedin'?: string | null;
74
+ /**
75
+ * The industry the organization belongs to
76
+ * @type {number}
77
+ */
78
+ 'industry'?: number | null;
79
+ /**
80
+ * The annual revenue of the organization
81
+ * @type {number}
82
+ */
83
+ 'annual_revenue'?: number | null;
84
+ /**
85
+ * The number of employees in the organization
86
+ * @type {number}
87
+ */
88
+ 'employee_count'?: number | null;
89
+ /**
65
90
  * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
66
91
  * @type {{ [key: string]: any | undefined; }}
67
92
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "33.1.1",
3
+ "version": "33.3.0",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "homepage": "https://developers.pipedrive.com",