pipedrive 24.2.0 → 26.0.0

package/dist/versions/v1/api/notes-api.d.ts

@@ -95,6 +95,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
      * @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
      * @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
+     * @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
      * @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`.
@@ -104,10 +105,11 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
      * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
      * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
      * @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
+     * @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
 
      * @throws {RequiredError}
      */
-    getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_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) => Promise<RequestArgs>;
+    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>;
     /**
      * Updates a comment related to a note.
      * @summary Update a comment related to a note
@@ -202,6 +204,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
      * @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
      * @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
+     * @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
      * @param {string} [sort] The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys). Supported fields: &#x60;id&#x60;, &#x60;user_id&#x60;, &#x60;deal_id&#x60;, &#x60;person_id&#x60;, &#x60;org_id&#x60;, &#x60;content&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
@@ -211,10 +214,11 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
      * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
      * @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
+     * @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
 
      * @throws {RequiredError}
      */
-    getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_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): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
+    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>>;
     /**
      * Updates a comment related to a note.
      * @summary Update a comment related to a note
@@ -478,6 +482,12 @@ export interface NotesApiGetNotesRequest {
      * @memberof NotesApiGetNotes
      */
     readonly org_id?: number;
+    /**
+     * The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
+     * @type {number}
+     * @memberof NotesApiGetNotes
+     */
+    readonly project_id?: number;
     /**
      * Pagination start
      * @type {number}
@@ -532,6 +542,12 @@ export interface NotesApiGetNotesRequest {
      * @memberof NotesApiGetNotes
      */
     readonly pinned_to_person_flag?: 0 | 1;
+    /**
+     * If set, the results are filtered by note to project pinning state
+     * @type {0 | 1}
+     * @memberof NotesApiGetNotes
+     */
+    readonly pinned_to_project_flag?: 0 | 1;
 }
 /**
  * Request parameters for updateCommentForNote operation in NotesApi.

package/dist/versions/v1/api/notes-api.js

@@ -302,6 +302,7 @@ const NotesApiAxiosParamCreator = function (configuration) {
          * @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
          * @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
          * @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
+         * @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
          * @param {number} [start] Pagination start
          * @param {number} [limit] Items shown per page
          * @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`.
@@ -311,10 +312,11 @@ const NotesApiAxiosParamCreator = function (configuration) {
          * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
          * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
          * @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
+         * @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
 
          * @throws {RequiredError}
          */
-        getNotes: (user_id, lead_id, deal_id, person_id, org_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag) => __awaiter(this, void 0, void 0, function* () {
+        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* () {
             const localVarPath = `/notes`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -345,6 +347,9 @@ const NotesApiAxiosParamCreator = function (configuration) {
             if (org_id !== undefined) {
                 localVarQueryParameter['org_id'] = org_id;
             }
+            if (project_id !== undefined) {
+                localVarQueryParameter['project_id'] = project_id;
+            }
             if (start !== undefined) {
                 localVarQueryParameter['start'] = start;
             }
@@ -376,6 +381,9 @@ const NotesApiAxiosParamCreator = function (configuration) {
             if (pinned_to_person_flag !== undefined) {
                 localVarQueryParameter['pinned_to_person_flag'] = pinned_to_person_flag;
             }
+            if (pinned_to_project_flag !== undefined) {
+                localVarQueryParameter['pinned_to_project_flag'] = pinned_to_project_flag;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
@@ -576,6 +584,7 @@ const NotesApiFp = function (configuration) {
          * @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
          * @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
          * @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
+         * @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
          * @param {number} [start] Pagination start
          * @param {number} [limit] Items shown per page
          * @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`.
@@ -585,12 +594,13 @@ const NotesApiFp = function (configuration) {
          * @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
          * @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
          * @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
+         * @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
 
          * @throws {RequiredError}
          */
-        getNotes(user_id, lead_id, deal_id, person_id, org_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag) {
+        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) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotes(user_id, lead_id, deal_id, person_id, org_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag);
+                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);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -711,7 +721,7 @@ const NotesApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getNotes(requestParameters = {}) {
-            return localVarFp.getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_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).then((request) => request(axios, basePath));
+            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));
         },
         /**
          * Updates a comment related to a note.
@@ -829,7 +839,7 @@ class NotesApi extends base_1.BaseAPI {
      * @memberof NotesApi
      */
     getNotes(requestParameters = {}) {
-        return (0, exports.NotesApiFp)(this.configuration).getNotes(requestParameters.user_id, requestParameters.lead_id, requestParameters.deal_id, requestParameters.person_id, requestParameters.org_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).then((request) => request(this.axios, this.basePath));
+        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));
     }
     /**
      * Updates a comment related to a note.