pipedrive 36.0.1 → 36.1.0

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

@@ -11,7 +11,7 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
+import { RequestArgs, BaseAPI, ApiResponse } from '../base';
 import { AddNoteRequest } from '../models';
 import { CommentPostPutObject } from '../models';
 import { DeleteCommentResponse } from '../models';
@@ -146,6 +146,14 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addNote(AddNoteRequest?: AddNoteRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertNoteResponse>>;
+    /**
+     * Same as `addNote`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add a note
+     * @param {AddNoteRequest} [AddNoteRequest]
+
+     * @throws {RequiredError}
+     */
+    addNoteWithHttpInfo(AddNoteRequest?: AddNoteRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertNoteResponse>>>;
     /**
      * Adds a new comment to a note.
      * @summary Add a comment to a note
@@ -155,6 +163,15 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addNoteComment(id: number, CommentPostPutObject?: CommentPostPutObject): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertCommentResponse>>;
+    /**
+     * Same as `addNoteComment`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add a comment to a note
+     * @param {number} id The ID of the note
+     * @param {CommentPostPutObject} [CommentPostPutObject]
+
+     * @throws {RequiredError}
+     */
+    addNoteCommentWithHttpInfo(id: number, CommentPostPutObject?: CommentPostPutObject): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertCommentResponse>>>;
     /**
      * Deletes a comment.
      * @summary Delete a comment related to a note
@@ -164,6 +181,15 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteComment(id: number, commentId: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteCommentResponse>>;
+    /**
+     * Same as `deleteComment`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete a comment related to a note
+     * @param {number} id The ID of the note
+     * @param {string} commentId The ID of the comment
+
+     * @throws {RequiredError}
+     */
+    deleteCommentWithHttpInfo(id: number, commentId: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteCommentResponse>>>;
     /**
      * Deletes a specific note.
      * @summary Delete a note
@@ -172,6 +198,14 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteNote(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteNoteResponse>>;
+    /**
+     * Same as `deleteNote`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete a note
+     * @param {number} id The ID of the note
+
+     * @throws {RequiredError}
+     */
+    deleteNoteWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteNoteResponse>>>;
     /**
      * Returns the details of a comment.
      * @summary Get one comment
@@ -181,6 +215,15 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getComment(id: number, commentId: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertCommentResponse>>;
+    /**
+     * Same as `getComment`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one comment
+     * @param {number} id The ID of the note
+     * @param {string} commentId The ID of the comment
+
+     * @throws {RequiredError}
+     */
+    getCommentWithHttpInfo(id: number, commentId: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertCommentResponse>>>;
     /**
      * Returns details about a specific note.
      * @summary Get one note
@@ -189,6 +232,14 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getNote(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertNoteResponse>>;
+    /**
+     * Same as `getNote`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one note
+     * @param {number} id The ID of the note
+
+     * @throws {RequiredError}
+     */
+    getNoteWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertNoteResponse>>>;
     /**
      * Returns all comments associated with a note.
      * @summary Get all comments for a note
@@ -199,6 +250,16 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getNoteComments(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetCommentsResponse>>;
+    /**
+     * Same as `getNoteComments`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all comments for a note
+     * @param {number} id The ID of the note
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getNoteCommentsWithHttpInfo(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetCommentsResponse>>>;
     /**
      * Returns all notes.
      * @summary Get all notes
@@ -225,6 +286,32 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, task_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, pinned_to_task_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
+    /**
+     * Same as `getNotes`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all notes
+     * @param {number} [user_id] The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
+     * @param {string} [lead_id] The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
+     * @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} [task_id] The ID of the task which notes to fetch. If omitted, notes about all tasks 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;.
+     * @param {string} [start_date] The date in format of YYYY-MM-DD from which notes to fetch
+     * @param {string} [end_date] The date in format of YYYY-MM-DD until which notes to fetch to
+     * @param {string} [updated_since] If set, only notes with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
+     * @param {0 | 1} [pinned_to_lead_flag] If set, the results are filtered by note to lead pinning state
+     * @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
+     * @param {0 | 1} [pinned_to_task_flag] If set, the results are filtered by note to task pinning state
+
+     * @throws {RequiredError}
+     */
+    getNotesWithHttpInfo(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, task_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, pinned_to_task_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetNotesResponse>>>;
     /**
      * Updates a comment related to a note.
      * @summary Update a comment related to a note
@@ -235,6 +322,16 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateCommentForNote(id: number, commentId: string, CommentPostPutObject?: CommentPostPutObject): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertCommentResponse>>;
+    /**
+     * Same as `updateCommentForNote`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update a comment related to a note
+     * @param {number} id The ID of the note
+     * @param {string} commentId The ID of the comment
+     * @param {CommentPostPutObject} [CommentPostPutObject]
+
+     * @throws {RequiredError}
+     */
+    updateCommentForNoteWithHttpInfo(id: number, commentId: string, CommentPostPutObject?: CommentPostPutObject): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertCommentResponse>>>;
     /**
      * Updates a note.
      * @summary Update a note
@@ -244,6 +341,15 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateNote(id: number, NoteRequest?: NoteRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertNoteResponse>>;
+    /**
+     * Same as `updateNote`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update a note
+     * @param {number} id The ID of the note
+     * @param {NoteRequest} [NoteRequest]
+
+     * @throws {RequiredError}
+     */
+    updateNoteWithHttpInfo(id: number, NoteRequest?: NoteRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertNoteResponse>>>;
 };
 /**
  * NotesApi - factory interface
@@ -258,6 +364,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addNote(requestParameters?: NotesApiAddNoteRequest): Promise<UpsertNoteResponse>;
+    addNoteWithHttpInfo(requestParameters?: NotesApiAddNoteRequest): Promise<ApiResponse<UpsertNoteResponse>>;
     /**
      * Adds a new comment to a note.
      * @summary Add a comment to a note
@@ -266,6 +373,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addNoteComment(requestParameters: NotesApiAddNoteCommentRequest): Promise<UpsertCommentResponse>;
+    addNoteCommentWithHttpInfo(requestParameters: NotesApiAddNoteCommentRequest): Promise<ApiResponse<UpsertCommentResponse>>;
     /**
      * Deletes a comment.
      * @summary Delete a comment related to a note
@@ -274,6 +382,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteComment(requestParameters: NotesApiDeleteCommentRequest): Promise<DeleteCommentResponse>;
+    deleteCommentWithHttpInfo(requestParameters: NotesApiDeleteCommentRequest): Promise<ApiResponse<DeleteCommentResponse>>;
     /**
      * Deletes a specific note.
      * @summary Delete a note
@@ -282,6 +391,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteNote(requestParameters: NotesApiDeleteNoteRequest): Promise<DeleteNoteResponse>;
+    deleteNoteWithHttpInfo(requestParameters: NotesApiDeleteNoteRequest): Promise<ApiResponse<DeleteNoteResponse>>;
     /**
      * Returns the details of a comment.
      * @summary Get one comment
@@ -290,6 +400,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getComment(requestParameters: NotesApiGetCommentRequest): Promise<UpsertCommentResponse>;
+    getCommentWithHttpInfo(requestParameters: NotesApiGetCommentRequest): Promise<ApiResponse<UpsertCommentResponse>>;
     /**
      * Returns details about a specific note.
      * @summary Get one note
@@ -298,6 +409,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getNote(requestParameters: NotesApiGetNoteRequest): Promise<UpsertNoteResponse>;
+    getNoteWithHttpInfo(requestParameters: NotesApiGetNoteRequest): Promise<ApiResponse<UpsertNoteResponse>>;
     /**
      * Returns all comments associated with a note.
      * @summary Get all comments for a note
@@ -306,6 +418,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getNoteComments(requestParameters: NotesApiGetNoteCommentsRequest): Promise<GetCommentsResponse>;
+    getNoteCommentsWithHttpInfo(requestParameters: NotesApiGetNoteCommentsRequest): Promise<ApiResponse<GetCommentsResponse>>;
     /**
      * Returns all notes.
      * @summary Get all notes
@@ -314,6 +427,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getNotes(requestParameters?: NotesApiGetNotesRequest): Promise<GetNotesResponse>;
+    getNotesWithHttpInfo(requestParameters?: NotesApiGetNotesRequest): Promise<ApiResponse<GetNotesResponse>>;
     /**
      * Updates a comment related to a note.
      * @summary Update a comment related to a note
@@ -322,6 +436,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateCommentForNote(requestParameters: NotesApiUpdateCommentForNoteRequest): Promise<UpsertCommentResponse>;
+    updateCommentForNoteWithHttpInfo(requestParameters: NotesApiUpdateCommentForNoteRequest): Promise<ApiResponse<UpsertCommentResponse>>;
     /**
      * Updates a note.
      * @summary Update a note
@@ -330,6 +445,7 @@ export declare const NotesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateNote(requestParameters: NotesApiUpdateNoteRequest): Promise<UpsertNoteResponse>;
+    updateNoteWithHttpInfo(requestParameters: NotesApiUpdateNoteRequest): Promise<ApiResponse<UpsertNoteResponse>>;
 };
 /**
  * Request parameters for addNote operation in NotesApi.
@@ -633,6 +749,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     addNote(requestParameters?: NotesApiAddNoteRequest): Promise<UpsertNoteResponse>;
+    /**
+     * Same as `addNote`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiAddNoteRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    addNoteWithHttpInfo(requestParameters?: NotesApiAddNoteRequest): Promise<ApiResponse<UpsertNoteResponse>>;
     /**
      * Adds a new comment to a note.
      * @summary Add a comment to a note
@@ -642,6 +767,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     addNoteComment(requestParameters: NotesApiAddNoteCommentRequest): Promise<UpsertCommentResponse>;
+    /**
+     * Same as `addNoteComment`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiAddNoteCommentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    addNoteCommentWithHttpInfo(requestParameters: NotesApiAddNoteCommentRequest): Promise<ApiResponse<UpsertCommentResponse>>;
     /**
      * Deletes a comment.
      * @summary Delete a comment related to a note
@@ -651,6 +785,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     deleteComment(requestParameters: NotesApiDeleteCommentRequest): Promise<DeleteCommentResponse>;
+    /**
+     * Same as `deleteComment`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiDeleteCommentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    deleteCommentWithHttpInfo(requestParameters: NotesApiDeleteCommentRequest): Promise<ApiResponse<DeleteCommentResponse>>;
     /**
      * Deletes a specific note.
      * @summary Delete a note
@@ -660,6 +803,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     deleteNote(requestParameters: NotesApiDeleteNoteRequest): Promise<DeleteNoteResponse>;
+    /**
+     * Same as `deleteNote`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiDeleteNoteRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    deleteNoteWithHttpInfo(requestParameters: NotesApiDeleteNoteRequest): Promise<ApiResponse<DeleteNoteResponse>>;
     /**
      * Returns the details of a comment.
      * @summary Get one comment
@@ -669,6 +821,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     getComment(requestParameters: NotesApiGetCommentRequest): Promise<UpsertCommentResponse>;
+    /**
+     * Same as `getComment`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiGetCommentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    getCommentWithHttpInfo(requestParameters: NotesApiGetCommentRequest): Promise<ApiResponse<UpsertCommentResponse>>;
     /**
      * Returns details about a specific note.
      * @summary Get one note
@@ -678,6 +839,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     getNote(requestParameters: NotesApiGetNoteRequest): Promise<UpsertNoteResponse>;
+    /**
+     * Same as `getNote`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiGetNoteRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    getNoteWithHttpInfo(requestParameters: NotesApiGetNoteRequest): Promise<ApiResponse<UpsertNoteResponse>>;
     /**
      * Returns all comments associated with a note.
      * @summary Get all comments for a note
@@ -687,6 +857,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     getNoteComments(requestParameters: NotesApiGetNoteCommentsRequest): Promise<GetCommentsResponse>;
+    /**
+     * Same as `getNoteComments`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiGetNoteCommentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    getNoteCommentsWithHttpInfo(requestParameters: NotesApiGetNoteCommentsRequest): Promise<ApiResponse<GetCommentsResponse>>;
     /**
      * Returns all notes.
      * @summary Get all notes
@@ -696,6 +875,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     getNotes(requestParameters?: NotesApiGetNotesRequest): Promise<GetNotesResponse>;
+    /**
+     * Same as `getNotes`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiGetNotesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    getNotesWithHttpInfo(requestParameters?: NotesApiGetNotesRequest): Promise<ApiResponse<GetNotesResponse>>;
     /**
      * Updates a comment related to a note.
      * @summary Update a comment related to a note
@@ -705,6 +893,15 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     updateCommentForNote(requestParameters: NotesApiUpdateCommentForNoteRequest): Promise<UpsertCommentResponse>;
+    /**
+     * Same as `updateCommentForNote`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiUpdateCommentForNoteRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    updateCommentForNoteWithHttpInfo(requestParameters: NotesApiUpdateCommentForNoteRequest): Promise<ApiResponse<UpsertCommentResponse>>;
     /**
      * Updates a note.
      * @summary Update a note
@@ -714,4 +911,13 @@ export declare class NotesApi extends BaseAPI {
      * @memberof NotesApi
      */
     updateNote(requestParameters: NotesApiUpdateNoteRequest): Promise<UpsertNoteResponse>;
+    /**
+     * Same as `updateNote`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {NotesApiUpdateNoteRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof NotesApi
+     */
+    updateNoteWithHttpInfo(requestParameters: NotesApiUpdateNoteRequest): Promise<ApiResponse<UpsertNoteResponse>>;
 }