pipedrive 36.0.1 → 36.1.0

package/dist/versions/v1/api/files-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 { AddFileResponse } from '../models';
 import { AddRemoteFileAndLinkItToItemResponse } from '../models';
 import { DeleteFileResponse } from '../models';
@@ -127,6 +127,21 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     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>>;
+    /**
+     * Same as `addFile`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add file
+     * @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
+     * @param {number} [deal_id] The ID of the deal to associate file(s) with
+     * @param {number} [person_id] The ID of the person to associate file(s) with
+     * @param {number} [org_id] The ID of the organization to associate file(s) with
+     * @param {number} [product_id] The ID of the product to associate file(s) with
+     * @param {number} [activity_id] The ID of the activity to associate file(s) with
+     * @param {string} [lead_id] The ID of the lead to associate file(s) with
+     * @param {number} [project_id] The ID of the project to associate file(s) with
+
+     * @throws {RequiredError}
+     */
+    addFileWithHttpInfo(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<ApiResponse<AddFileResponse>>>;
     /**
      * 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>.
      * @summary Create a remote file and link it to an item
@@ -139,6 +154,18 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addFileAndLinkIt(file_type: string, title: string, item_type: string, item_id: number, remote_location: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddRemoteFileAndLinkItToItemResponse>>;
+    /**
+     * Same as `addFileAndLinkIt`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Create a remote file and link it to an item
+     * @param {string} file_type The file type
+     * @param {string} title The title of the file
+     * @param {string} item_type The item type
+     * @param {number} item_id The ID of the item to associate the file with
+     * @param {string} remote_location The location type to send the file to. Only &#x60;googledrive&#x60; is supported at the moment.
+
+     * @throws {RequiredError}
+     */
+    addFileAndLinkItWithHttpInfo(file_type: string, title: string, item_type: string, item_id: number, remote_location: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddRemoteFileAndLinkItToItemResponse>>>;
     /**
      * Marks a file as deleted. After 30 days, the file will be permanently deleted.
      * @summary Delete a file
@@ -147,6 +174,14 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteFile(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFileResponse>>;
+    /**
+     * Same as `deleteFile`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete a file
+     * @param {number} id The ID of the file
+
+     * @throws {RequiredError}
+     */
+    deleteFileWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteFileResponse>>>;
     /**
      * Initializes a file download.
      * @summary Download one file
@@ -155,6 +190,14 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     downloadFile(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<string>>;
+    /**
+     * Same as `downloadFile`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Download one file
+     * @param {number} id The ID of the file
+
+     * @throws {RequiredError}
+     */
+    downloadFileWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<string>>>;
     /**
      * Returns data about a specific file.
      * @summary Get one file
@@ -163,6 +206,14 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getFile(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFileResponse>>;
+    /**
+     * Same as `getFile`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one file
+     * @param {number} id The ID of the file
+
+     * @throws {RequiredError}
+     */
+    getFileWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFileResponse>>>;
     /**
      * Returns data about all files.
      * @summary Get all files
@@ -173,6 +224,16 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getFiles(start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFilesResponse>>;
+    /**
+     * Same as `getFiles`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all files
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page. Please note that a maximum value of 100 is allowed.
+     * @param {string} [sort] Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;
+
+     * @throws {RequiredError}
+     */
+    getFilesWithHttpInfo(start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFilesResponse>>>;
     /**
      * Links an existing remote file (`googledrive`) 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>.
      * @summary Link a remote file to an item
@@ -184,6 +245,17 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     linkFileToItem(item_type: string, item_id: number, remote_id: string, remote_location: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLinkRemoteFileToItemResponse>>;
+    /**
+     * Same as `linkFileToItem`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Link a remote file to an item
+     * @param {string} item_type The item type
+     * @param {number} item_id The ID of the item to associate the file with
+     * @param {string} remote_id The remote item ID
+     * @param {string} remote_location The location type to send the file to. Only &#x60;googledrive&#x60; is supported at the moment.
+
+     * @throws {RequiredError}
+     */
+    linkFileToItemWithHttpInfo(item_type: string, item_id: number, remote_id: string, remote_location: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLinkRemoteFileToItemResponse>>>;
     /**
      * Updates the properties of a file.
      * @summary Update file details
@@ -194,6 +266,16 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateFile(id: number, name?: string, description?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateFileResponse>>;
+    /**
+     * Same as `updateFile`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update file details
+     * @param {number} id The ID of the file
+     * @param {string} [name] The visible name of the file
+     * @param {string} [description] The description of the file
+
+     * @throws {RequiredError}
+     */
+    updateFileWithHttpInfo(id: number, name?: string, description?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpdateFileResponse>>>;
 };
 /**
  * FilesApi - factory interface
@@ -208,6 +290,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addFile(requestParameters: FilesApiAddFileRequest): Promise<AddFileResponse>;
+    addFileWithHttpInfo(requestParameters: FilesApiAddFileRequest): Promise<ApiResponse<AddFileResponse>>;
     /**
      * 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>.
      * @summary Create a remote file and link it to an item
@@ -216,6 +299,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addFileAndLinkIt(requestParameters: FilesApiAddFileAndLinkItRequest): Promise<AddRemoteFileAndLinkItToItemResponse>;
+    addFileAndLinkItWithHttpInfo(requestParameters: FilesApiAddFileAndLinkItRequest): Promise<ApiResponse<AddRemoteFileAndLinkItToItemResponse>>;
     /**
      * Marks a file as deleted. After 30 days, the file will be permanently deleted.
      * @summary Delete a file
@@ -224,6 +308,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteFile(requestParameters: FilesApiDeleteFileRequest): Promise<DeleteFileResponse>;
+    deleteFileWithHttpInfo(requestParameters: FilesApiDeleteFileRequest): Promise<ApiResponse<DeleteFileResponse>>;
     /**
      * Initializes a file download.
      * @summary Download one file
@@ -232,6 +317,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     downloadFile(requestParameters: FilesApiDownloadFileRequest): Promise<string>;
+    downloadFileWithHttpInfo(requestParameters: FilesApiDownloadFileRequest): Promise<ApiResponse<string>>;
     /**
      * Returns data about a specific file.
      * @summary Get one file
@@ -240,6 +326,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getFile(requestParameters: FilesApiGetFileRequest): Promise<GetFileResponse>;
+    getFileWithHttpInfo(requestParameters: FilesApiGetFileRequest): Promise<ApiResponse<GetFileResponse>>;
     /**
      * Returns data about all files.
      * @summary Get all files
@@ -248,6 +335,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getFiles(requestParameters?: FilesApiGetFilesRequest): Promise<GetFilesResponse>;
+    getFilesWithHttpInfo(requestParameters?: FilesApiGetFilesRequest): Promise<ApiResponse<GetFilesResponse>>;
     /**
      * Links an existing remote file (`googledrive`) 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>.
      * @summary Link a remote file to an item
@@ -256,6 +344,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     linkFileToItem(requestParameters: FilesApiLinkFileToItemRequest): Promise<GetLinkRemoteFileToItemResponse>;
+    linkFileToItemWithHttpInfo(requestParameters: FilesApiLinkFileToItemRequest): Promise<ApiResponse<GetLinkRemoteFileToItemResponse>>;
     /**
      * Updates the properties of a file.
      * @summary Update file details
@@ -264,6 +353,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateFile(requestParameters: FilesApiUpdateFileRequest): Promise<UpdateFileResponse>;
+    updateFileWithHttpInfo(requestParameters: FilesApiUpdateFileRequest): Promise<ApiResponse<UpdateFileResponse>>;
 };
 /**
  * Request parameters for addFile operation in FilesApi.
@@ -493,6 +583,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     addFile(requestParameters: FilesApiAddFileRequest): Promise<AddFileResponse>;
+    /**
+     * Same as `addFile`, 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 {FilesApiAddFileRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    addFileWithHttpInfo(requestParameters: FilesApiAddFileRequest): Promise<ApiResponse<AddFileResponse>>;
     /**
      * 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>.
      * @summary Create a remote file and link it to an item
@@ -502,6 +601,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     addFileAndLinkIt(requestParameters: FilesApiAddFileAndLinkItRequest): Promise<AddRemoteFileAndLinkItToItemResponse>;
+    /**
+     * Same as `addFileAndLinkIt`, 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 {FilesApiAddFileAndLinkItRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    addFileAndLinkItWithHttpInfo(requestParameters: FilesApiAddFileAndLinkItRequest): Promise<ApiResponse<AddRemoteFileAndLinkItToItemResponse>>;
     /**
      * Marks a file as deleted. After 30 days, the file will be permanently deleted.
      * @summary Delete a file
@@ -511,6 +619,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     deleteFile(requestParameters: FilesApiDeleteFileRequest): Promise<DeleteFileResponse>;
+    /**
+     * Same as `deleteFile`, 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 {FilesApiDeleteFileRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    deleteFileWithHttpInfo(requestParameters: FilesApiDeleteFileRequest): Promise<ApiResponse<DeleteFileResponse>>;
     /**
      * Initializes a file download.
      * @summary Download one file
@@ -520,6 +637,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     downloadFile(requestParameters: FilesApiDownloadFileRequest): Promise<string>;
+    /**
+     * Same as `downloadFile`, 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 {FilesApiDownloadFileRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    downloadFileWithHttpInfo(requestParameters: FilesApiDownloadFileRequest): Promise<ApiResponse<string>>;
     /**
      * Returns data about a specific file.
      * @summary Get one file
@@ -529,6 +655,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     getFile(requestParameters: FilesApiGetFileRequest): Promise<GetFileResponse>;
+    /**
+     * Same as `getFile`, 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 {FilesApiGetFileRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    getFileWithHttpInfo(requestParameters: FilesApiGetFileRequest): Promise<ApiResponse<GetFileResponse>>;
     /**
      * Returns data about all files.
      * @summary Get all files
@@ -538,6 +673,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     getFiles(requestParameters?: FilesApiGetFilesRequest): Promise<GetFilesResponse>;
+    /**
+     * Same as `getFiles`, 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 {FilesApiGetFilesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    getFilesWithHttpInfo(requestParameters?: FilesApiGetFilesRequest): Promise<ApiResponse<GetFilesResponse>>;
     /**
      * Links an existing remote file (`googledrive`) 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>.
      * @summary Link a remote file to an item
@@ -547,6 +691,15 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     linkFileToItem(requestParameters: FilesApiLinkFileToItemRequest): Promise<GetLinkRemoteFileToItemResponse>;
+    /**
+     * Same as `linkFileToItem`, 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 {FilesApiLinkFileToItemRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    linkFileToItemWithHttpInfo(requestParameters: FilesApiLinkFileToItemRequest): Promise<ApiResponse<GetLinkRemoteFileToItemResponse>>;
     /**
      * Updates the properties of a file.
      * @summary Update file details
@@ -556,4 +709,13 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     updateFile(requestParameters: FilesApiUpdateFileRequest): Promise<UpdateFileResponse>;
+    /**
+     * Same as `updateFile`, 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 {FilesApiUpdateFileRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    updateFileWithHttpInfo(requestParameters: FilesApiUpdateFileRequest): Promise<ApiResponse<UpdateFileResponse>>;
 }