pipedrive 36.0.1 → 36.1.0

package/dist/versions/v1/api/organizations-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 { AddOrganizationFollowerRequest } from '../models';
 import { AddOrganizationFollowerResponse } from '../models';
 import { DeleteOrganizationFollowerResponse } from '../models';
@@ -130,6 +130,15 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addOrganizationFollower(id: number, AddOrganizationFollowerRequest?: AddOrganizationFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationFollowerResponse>>;
+    /**
+     * Same as `addOrganizationFollower`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add a follower to an organization
+     * @param {number} id The ID of the organization
+     * @param {AddOrganizationFollowerRequest} [AddOrganizationFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addOrganizationFollowerWithHttpInfo(id: number, AddOrganizationFollowerRequest?: AddOrganizationFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddOrganizationFollowerResponse>>>;
     /**
      * Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers\">List followers of an organization</a> endpoint.
      * @summary Delete a follower from an organization
@@ -139,6 +148,15 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteOrganizationFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationFollowerResponse>>;
+    /**
+     * Same as `deleteOrganizationFollower`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete a follower from an organization
+     * @param {number} id The ID of the organization
+     * @param {number} follower_id The ID of the relationship between the follower and the organization
+
+     * @throws {RequiredError}
+     */
+    deleteOrganizationFollowerWithHttpInfo(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteOrganizationFollowerResponse>>>;
     /**
      * Lists updates about field values of an organization.
      * @summary List updates about organization field values
@@ -149,6 +167,16 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganizationChangelog(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetChangelogResponse>>;
+    /**
+     * Same as `getOrganizationChangelog`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List updates about organization field values
+     * @param {number} id The ID of the organization
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getOrganizationChangelogWithHttpInfo(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetChangelogResponse>>>;
     /**
      * Lists files associated with an organization.
      * @summary List files attached to an organization
@@ -160,6 +188,17 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganizationFiles(id: number, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedFilesResponse>>;
+    /**
+     * Same as `getOrganizationFiles`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List files attached to an organization
+     * @param {number} id The ID of the organization
+     * @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}
+     */
+    getOrganizationFilesWithHttpInfo(id: number, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAssociatedFilesResponse>>>;
     /**
      * Lists the followers of an organization.
      * @summary List followers of an organization
@@ -168,6 +207,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganizationFollowers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedFollowersResponse>>;
+    /**
+     * Same as `getOrganizationFollowers`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List followers of an organization
+     * @param {number} id The ID of the organization
+
+     * @throws {RequiredError}
+     */
+    getOrganizationFollowersWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAssociatedFollowersResponse>>>;
     /**
      * Lists mail messages associated with an organization.
      * @summary List mail messages associated with an organization
@@ -179,6 +226,17 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganizationMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
+    /**
+     * Same as `getOrganizationMailMessages`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List mail messages associated with an organization
+     * @param {number} id The ID of the organization
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+     * @param {0 | 1} [include_body] Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
+
+     * @throws {RequiredError}
+     */
+    getOrganizationMailMessagesWithHttpInfo(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAssociatedMailMessagesResponse>>>;
     /**
      * Lists updates about an organization.
      * @summary List updates about an organization
@@ -191,6 +249,18 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganizationUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedOrganizationUpdatesResponse>>;
+    /**
+     * Same as `getOrganizationUpdates`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List updates about an organization
+     * @param {number} id The ID of the organization
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+     * @param {string} [all_changes] Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted, returns changes without custom field updates.
+     * @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
+
+     * @throws {RequiredError}
+     */
+    getOrganizationUpdatesWithHttpInfo(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetAssociatedOrganizationUpdatesResponse>>>;
     /**
      * List users permitted to access an organization.
      * @summary List permitted users
@@ -199,6 +269,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganizationUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPermittedUsersResponse1>>;
+    /**
+     * Same as `getOrganizationUsers`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List permitted users
+     * @param {number} id The ID of the organization
+
+     * @throws {RequiredError}
+     */
+    getOrganizationUsersWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetPermittedUsersResponse1>>>;
     /**
      * Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
      * @summary Merge two organizations
@@ -208,6 +286,15 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     mergeOrganizations(id: number, MergeOrganizationsRequest?: MergeOrganizationsRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<MergeOrganizationsResponse>>;
+    /**
+     * Same as `mergeOrganizations`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Merge two organizations
+     * @param {number} id The ID of the organization
+     * @param {MergeOrganizationsRequest} [MergeOrganizationsRequest]
+
+     * @throws {RequiredError}
+     */
+    mergeOrganizationsWithHttpInfo(id: number, MergeOrganizationsRequest?: MergeOrganizationsRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<MergeOrganizationsResponse>>>;
 };
 /**
  * OrganizationsApi - factory interface
@@ -222,6 +309,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     addOrganizationFollower(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise<AddOrganizationFollowerResponse>;
+    addOrganizationFollowerWithHttpInfo(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise<ApiResponse<AddOrganizationFollowerResponse>>;
     /**
      * Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers\">List followers of an organization</a> endpoint.
      * @summary Delete a follower from an organization
@@ -230,6 +318,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteOrganizationFollowerResponse>;
+    deleteOrganizationFollowerWithHttpInfo(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<ApiResponse<DeleteOrganizationFollowerResponse>>;
     /**
      * Lists updates about field values of an organization.
      * @summary List updates about organization field values
@@ -238,6 +327,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganizationChangelog(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise<GetChangelogResponse>;
+    getOrganizationChangelogWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise<ApiResponse<GetChangelogResponse>>;
     /**
      * Lists files associated with an organization.
      * @summary List files attached to an organization
@@ -246,6 +336,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganizationFiles(requestParameters: OrganizationsApiGetOrganizationFilesRequest): Promise<GetAssociatedFilesResponse>;
+    getOrganizationFilesWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationFilesRequest): Promise<ApiResponse<GetAssociatedFilesResponse>>;
     /**
      * Lists the followers of an organization.
      * @summary List followers of an organization
@@ -254,6 +345,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganizationFollowers(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise<GetAssociatedFollowersResponse>;
+    getOrganizationFollowersWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise<ApiResponse<GetAssociatedFollowersResponse>>;
     /**
      * Lists mail messages associated with an organization.
      * @summary List mail messages associated with an organization
@@ -262,6 +354,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise<GetAssociatedMailMessagesResponse>;
+    getOrganizationMailMessagesWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise<ApiResponse<GetAssociatedMailMessagesResponse>>;
     /**
      * Lists updates about an organization.
      * @summary List updates about an organization
@@ -270,6 +363,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganizationUpdates(requestParameters: OrganizationsApiGetOrganizationUpdatesRequest): Promise<GetAssociatedOrganizationUpdatesResponse>;
+    getOrganizationUpdatesWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationUpdatesRequest): Promise<ApiResponse<GetAssociatedOrganizationUpdatesResponse>>;
     /**
      * List users permitted to access an organization.
      * @summary List permitted users
@@ -278,6 +372,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganizationUsers(requestParameters: OrganizationsApiGetOrganizationUsersRequest): Promise<GetPermittedUsersResponse1>;
+    getOrganizationUsersWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationUsersRequest): Promise<ApiResponse<GetPermittedUsersResponse1>>;
     /**
      * Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
      * @summary Merge two organizations
@@ -286,6 +381,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     mergeOrganizations(requestParameters: OrganizationsApiMergeOrganizationsRequest): Promise<MergeOrganizationsResponse>;
+    mergeOrganizationsWithHttpInfo(requestParameters: OrganizationsApiMergeOrganizationsRequest): Promise<ApiResponse<MergeOrganizationsResponse>>;
 };
 /**
  * Request parameters for addOrganizationFollower operation in OrganizationsApi.
@@ -510,6 +606,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     addOrganizationFollower(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise<AddOrganizationFollowerResponse>;
+    /**
+     * Same as `addOrganizationFollower`, 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 {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    addOrganizationFollowerWithHttpInfo(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise<ApiResponse<AddOrganizationFollowerResponse>>;
     /**
      * Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers\">List followers of an organization</a> endpoint.
      * @summary Delete a follower from an organization
@@ -519,6 +624,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteOrganizationFollowerResponse>;
+    /**
+     * Same as `deleteOrganizationFollower`, 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 {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    deleteOrganizationFollowerWithHttpInfo(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<ApiResponse<DeleteOrganizationFollowerResponse>>;
     /**
      * Lists updates about field values of an organization.
      * @summary List updates about organization field values
@@ -528,6 +642,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganizationChangelog(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise<GetChangelogResponse>;
+    /**
+     * Same as `getOrganizationChangelog`, 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 {OrganizationsApiGetOrganizationChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationChangelogWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise<ApiResponse<GetChangelogResponse>>;
     /**
      * Lists files associated with an organization.
      * @summary List files attached to an organization
@@ -537,6 +660,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganizationFiles(requestParameters: OrganizationsApiGetOrganizationFilesRequest): Promise<GetAssociatedFilesResponse>;
+    /**
+     * Same as `getOrganizationFiles`, 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 {OrganizationsApiGetOrganizationFilesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationFilesWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationFilesRequest): Promise<ApiResponse<GetAssociatedFilesResponse>>;
     /**
      * Lists the followers of an organization.
      * @summary List followers of an organization
@@ -546,6 +678,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganizationFollowers(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise<GetAssociatedFollowersResponse>;
+    /**
+     * Same as `getOrganizationFollowers`, 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 {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationFollowersWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise<ApiResponse<GetAssociatedFollowersResponse>>;
     /**
      * Lists mail messages associated with an organization.
      * @summary List mail messages associated with an organization
@@ -555,6 +696,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise<GetAssociatedMailMessagesResponse>;
+    /**
+     * Same as `getOrganizationMailMessages`, 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 {OrganizationsApiGetOrganizationMailMessagesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationMailMessagesWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise<ApiResponse<GetAssociatedMailMessagesResponse>>;
     /**
      * Lists updates about an organization.
      * @summary List updates about an organization
@@ -564,6 +714,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganizationUpdates(requestParameters: OrganizationsApiGetOrganizationUpdatesRequest): Promise<GetAssociatedOrganizationUpdatesResponse>;
+    /**
+     * Same as `getOrganizationUpdates`, 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 {OrganizationsApiGetOrganizationUpdatesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationUpdatesWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationUpdatesRequest): Promise<ApiResponse<GetAssociatedOrganizationUpdatesResponse>>;
     /**
      * List users permitted to access an organization.
      * @summary List permitted users
@@ -573,6 +732,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganizationUsers(requestParameters: OrganizationsApiGetOrganizationUsersRequest): Promise<GetPermittedUsersResponse1>;
+    /**
+     * Same as `getOrganizationUsers`, 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 {OrganizationsApiGetOrganizationUsersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationUsersWithHttpInfo(requestParameters: OrganizationsApiGetOrganizationUsersRequest): Promise<ApiResponse<GetPermittedUsersResponse1>>;
     /**
      * Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
      * @summary Merge two organizations
@@ -582,4 +750,13 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     mergeOrganizations(requestParameters: OrganizationsApiMergeOrganizationsRequest): Promise<MergeOrganizationsResponse>;
+    /**
+     * Same as `mergeOrganizations`, 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 {OrganizationsApiMergeOrganizationsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    mergeOrganizationsWithHttpInfo(requestParameters: OrganizationsApiMergeOrganizationsRequest): Promise<ApiResponse<MergeOrganizationsResponse>>;
 }