pipedrive 24.2.0 → 25.0.0

package/dist/esm/versions/v2/api/deals-api.d.ts

@@ -15,18 +15,23 @@ import { RequestArgs, BaseAPI } from '../base';
 import { AddAInstallmentResponse } from '../models';
 import { AddAdditionalDiscountRequestBody } from '../models';
 import { AddAdditionalDiscountResponse } from '../models';
+import { AddDealFollowerRequest } from '../models';
 import { AddDealProductRequest } from '../models';
 import { AddDealProductResponse } from '../models';
 import { AddDealRequest } from '../models';
+import { AddFollowerResponse } from '../models';
 import { AddInstallmentRequestBody } from '../models';
 import { DeleteAdditionalDiscountResponse } from '../models';
 import { DeleteDealProductResponse } from '../models';
 import { DeleteDealResponse } from '../models';
+import { DeleteFollowerResponse } from '../models';
 import { DeleteInstallmentResponse } from '../models';
 import { GetAdditionalDiscountsResponse } from '../models';
 import { GetDealSearchResponse } from '../models';
 import { GetDealsProductsResponse } from '../models';
 import { GetDealsResponse } from '../models';
+import { GetFollowerChangelogsResponse } from '../models';
+import { GetFollowersResponse } from '../models';
 import { GetInstallmentsResponse } from '../models';
 import { UpdateAdditionalDiscountRequestBody } from '../models';
 import { UpdateAdditionalDiscountResponse } from '../models';
@@ -48,6 +53,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     addDeal: (AddDealRequest?: AddDealRequest) => Promise<RequestArgs>;
+    /**
+     * Adds a user as a follower to the deal.
+     * @summary Add a follower to a deal
+     * @param {number} id The ID of the deal
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addDealFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -74,6 +88,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteDeal: (id: number) => Promise<RequestArgs>;
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {number} id The ID of the deal
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deleteDealFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -110,6 +133,26 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string) => Promise<RequestArgs>;
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {number} id The ID of the deal
+     * @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.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    getDealFollowers: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {number} id The ID of the deal
+     * @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.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    getDealFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -256,6 +299,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
+    /**
+     * Adds a user as a follower to the deal.
+     * @summary Add a follower to a deal
+     * @param {number} id The ID of the deal
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addDealFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -282,6 +334,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {number} id The ID of the deal
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deleteDealFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -318,6 +379,26 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {number} id The ID of the deal
+     * @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.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    getDealFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {number} id The ID of the deal
+     * @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.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    getDealFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -464,6 +545,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * Adds a user as a follower to the deal.
+     * @summary Add a follower to a deal
+     * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -488,6 +577,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -520,6 +617,22 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -622,6 +735,25 @@ export interface DealsApiAddDealRequest {
      */
     readonly AddDealRequest?: AddDealRequest;
 }
+/**
+ * Request parameters for addDealFollower operation in DealsApi.
+ * @export
+ * @interface DealsApiAddDealFollowerRequest
+ */
+export interface DealsApiAddDealFollowerRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiAddDealFollower
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddDealFollowerRequest}
+     * @memberof DealsApiAddDealFollower
+     */
+    readonly AddDealFollowerRequest?: AddDealFollowerRequest;
+}
 /**
  * Request parameters for addDealProduct operation in DealsApi.
  * @export
@@ -673,6 +805,25 @@ export interface DealsApiDeleteDealRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for deleteDealFollower operation in DealsApi.
+ * @export
+ * @interface DealsApiDeleteDealFollowerRequest
+ */
+export interface DealsApiDeleteDealFollowerRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiDeleteDealFollower
+     */
+    readonly id: number;
+    /**
+     * The ID of the following user
+     * @type {number}
+     * @memberof DealsApiDeleteDealFollower
+     */
+    readonly follower_id: number;
+}
 /**
  * Request parameters for deleteDealProduct operation in DealsApi.
  * @export
@@ -749,6 +900,56 @@ export interface DealsApiGetDealRequest {
      */
     readonly custom_fields?: string;
 }
+/**
+ * Request parameters for getDealFollowers operation in DealsApi.
+ * @export
+ * @interface DealsApiGetDealFollowersRequest
+ */
+export interface DealsApiGetDealFollowersRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiGetDealFollowers
+     */
+    readonly id: number;
+    /**
+     * 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.
+     * @type {number}
+     * @memberof DealsApiGetDealFollowers
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealsApiGetDealFollowers
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for getDealFollowersChangelog operation in DealsApi.
+ * @export
+ * @interface DealsApiGetDealFollowersChangelogRequest
+ */
+export interface DealsApiGetDealFollowersChangelogRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiGetDealFollowersChangelog
+     */
+    readonly id: number;
+    /**
+     * 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.
+     * @type {number}
+     * @memberof DealsApiGetDealFollowersChangelog
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealsApiGetDealFollowersChangelog
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for getDealProducts operation in DealsApi.
  * @export
@@ -1172,6 +1373,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     addDeal(requestParameters?: DealsApiAddDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * Adds a user as a follower to the deal.
+     * @summary Add a follower to a deal
+     * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    addDealFollower(requestParameters: DealsApiAddDealFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -1199,6 +1409,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     deleteDeal(requestParameters: DealsApiDeleteDealRequest): Promise<DeleteDealResponse>;
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteDealFollower(requestParameters: DealsApiDeleteDealFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -1235,6 +1454,24 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     getDeal(requestParameters: DealsApiGetDealRequest): Promise<UpsertDealResponse>;
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowers(requestParameters: DealsApiGetDealFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowersChangelog(requestParameters: DealsApiGetDealFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal