pipedrive 24.2.0 → 26.0.0

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

@@ -12,8 +12,13 @@
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
+import { AddDealFollowerRequest } from '../models';
+import { AddFollowerResponse } from '../models';
 import { AddPersonRequest } from '../models';
+import { DeleteFollowerResponse } from '../models';
 import { DeletePersonResponse } from '../models';
+import { GetFollowerChangelogsResponse } from '../models';
+import { GetFollowersResponse } from '../models';
 import { GetPersonSearchResponse } from '../models';
 import { GetPersonsResponse } from '../models';
 import { UpdatePersonRequest } from '../models';
@@ -24,13 +29,22 @@ import { UpsertPersonResponse } from '../models';
  */
 export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Adds a new person.
+     * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Add a new person
      * @param {AddPersonRequest} [AddPersonRequest]
 
      * @throws {RequiredError}
      */
     addPerson: (AddPersonRequest?: AddPersonRequest) => Promise<RequestArgs>;
+    /**
+     * Adds a user as a follower to the person.
+     * @summary Add a follower to a person
+     * @param {number} id The ID of the person
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addPersonFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
     /**
      * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @summary Delete a person
@@ -39,6 +53,15 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     deletePerson: (id: number) => Promise<RequestArgs>;
+    /**
+     * Deletes a user follower from the person.
+     * @summary Delete a follower from a person
+     * @param {number} id The ID of the person
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deletePersonFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get details of a person
@@ -49,6 +72,26 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getPerson: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string) => Promise<RequestArgs>;
+    /**
+     * Lists users who are following the person.
+     * @summary List followers of a person
+     * @param {number} id The ID of the person
+     * @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}
+     */
+    getPersonFollowers: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    /**
+     * Lists changelogs about users have followed the person.
+     * @summary List followers changelog of a person
+     * @param {number} id The ID of the person
+     * @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}
+     */
+    getPersonFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get all persons
@@ -83,7 +126,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
      */
     searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
-     * Updates the properties of a person.
+     * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Update a person
      * @param {number} id The ID of the person
      * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -98,13 +141,22 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const PersonsApiFp: (configuration?: Configuration) => {
     /**
-     * Adds a new person.
+     * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Add a new person
      * @param {AddPersonRequest} [AddPersonRequest]
 
      * @throws {RequiredError}
      */
     addPerson(AddPersonRequest?: AddPersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
+    /**
+     * Adds a user as a follower to the person.
+     * @summary Add a follower to a person
+     * @param {number} id The ID of the person
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addPersonFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
     /**
      * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @summary Delete a person
@@ -113,6 +165,15 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deletePerson(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonResponse>>;
+    /**
+     * Deletes a user follower from the person.
+     * @summary Delete a follower from a person
+     * @param {number} id The ID of the person
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deletePersonFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
     /**
      * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get details of a person
@@ -123,6 +184,26 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPerson(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
+    /**
+     * Lists users who are following the person.
+     * @summary List followers of a person
+     * @param {number} id The ID of the person
+     * @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}
+     */
+    getPersonFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
+    /**
+     * Lists changelogs about users have followed the person.
+     * @summary List followers changelog of a person
+     * @param {number} id The ID of the person
+     * @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}
+     */
+    getPersonFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
     /**
      * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get all persons
@@ -157,7 +238,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
      */
     searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
     /**
-     * Updates the properties of a person.
+     * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Update a person
      * @param {number} id The ID of the person
      * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -172,13 +253,21 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
  */
 export declare const PersonsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Adds a new person.
+     * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Add a new person
      * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
 
      * @throws {RequiredError}
      */
     addPerson(requestParameters?: PersonsApiAddPersonRequest): Promise<UpsertPersonResponse>;
+    /**
+     * Adds a user as a follower to the person.
+     * @summary Add a follower to a person
+     * @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addPersonFollower(requestParameters: PersonsApiAddPersonFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @summary Delete a person
@@ -187,6 +276,14 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     deletePerson(requestParameters: PersonsApiDeletePersonRequest): Promise<DeletePersonResponse>;
+    /**
+     * Deletes a user follower from the person.
+     * @summary Delete a follower from a person
+     * @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deletePersonFollower(requestParameters: PersonsApiDeletePersonFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get details of a person
@@ -195,6 +292,22 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getPerson(requestParameters: PersonsApiGetPersonRequest): Promise<UpsertPersonResponse>;
+    /**
+     * Lists users who are following the person.
+     * @summary List followers of a person
+     * @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getPersonFollowers(requestParameters: PersonsApiGetPersonFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the person.
+     * @summary List followers changelog of a person
+     * @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getPersonFollowersChangelog(requestParameters: PersonsApiGetPersonFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get all persons
@@ -212,7 +325,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
      */
     searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
     /**
-     * Updates the properties of a person.
+     * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Update a person
      * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
 
@@ -233,6 +346,25 @@ export interface PersonsApiAddPersonRequest {
      */
     readonly AddPersonRequest?: AddPersonRequest;
 }
+/**
+ * Request parameters for addPersonFollower operation in PersonsApi.
+ * @export
+ * @interface PersonsApiAddPersonFollowerRequest
+ */
+export interface PersonsApiAddPersonFollowerRequest {
+    /**
+     * The ID of the person
+     * @type {number}
+     * @memberof PersonsApiAddPersonFollower
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddDealFollowerRequest}
+     * @memberof PersonsApiAddPersonFollower
+     */
+    readonly AddDealFollowerRequest?: AddDealFollowerRequest;
+}
 /**
  * Request parameters for deletePerson operation in PersonsApi.
  * @export
@@ -246,6 +378,25 @@ export interface PersonsApiDeletePersonRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for deletePersonFollower operation in PersonsApi.
+ * @export
+ * @interface PersonsApiDeletePersonFollowerRequest
+ */
+export interface PersonsApiDeletePersonFollowerRequest {
+    /**
+     * The ID of the person
+     * @type {number}
+     * @memberof PersonsApiDeletePersonFollower
+     */
+    readonly id: number;
+    /**
+     * The ID of the following user
+     * @type {number}
+     * @memberof PersonsApiDeletePersonFollower
+     */
+    readonly follower_id: number;
+}
 /**
  * Request parameters for getPerson operation in PersonsApi.
  * @export
@@ -271,6 +422,56 @@ export interface PersonsApiGetPersonRequest {
      */
     readonly custom_fields?: string;
 }
+/**
+ * Request parameters for getPersonFollowers operation in PersonsApi.
+ * @export
+ * @interface PersonsApiGetPersonFollowersRequest
+ */
+export interface PersonsApiGetPersonFollowersRequest {
+    /**
+     * The ID of the person
+     * @type {number}
+     * @memberof PersonsApiGetPersonFollowers
+     */
+    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 PersonsApiGetPersonFollowers
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof PersonsApiGetPersonFollowers
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for getPersonFollowersChangelog operation in PersonsApi.
+ * @export
+ * @interface PersonsApiGetPersonFollowersChangelogRequest
+ */
+export interface PersonsApiGetPersonFollowersChangelogRequest {
+    /**
+     * The ID of the person
+     * @type {number}
+     * @memberof PersonsApiGetPersonFollowersChangelog
+     */
+    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 PersonsApiGetPersonFollowersChangelog
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof PersonsApiGetPersonFollowersChangelog
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for getPersons operation in PersonsApi.
  * @export
@@ -426,7 +627,7 @@ export interface PersonsApiUpdatePersonRequest {
  */
 export declare class PersonsApi extends BaseAPI {
     /**
-     * Adds a new person.
+     * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Add a new person
      * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
 
@@ -434,6 +635,15 @@ export declare class PersonsApi extends BaseAPI {
      * @memberof PersonsApi
      */
     addPerson(requestParameters?: PersonsApiAddPersonRequest): Promise<UpsertPersonResponse>;
+    /**
+     * Adds a user as a follower to the person.
+     * @summary Add a follower to a person
+     * @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    addPersonFollower(requestParameters: PersonsApiAddPersonFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @summary Delete a person
@@ -443,6 +653,15 @@ export declare class PersonsApi extends BaseAPI {
      * @memberof PersonsApi
      */
     deletePerson(requestParameters: PersonsApiDeletePersonRequest): Promise<DeletePersonResponse>;
+    /**
+     * Deletes a user follower from the person.
+     * @summary Delete a follower from a person
+     * @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    deletePersonFollower(requestParameters: PersonsApiDeletePersonFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get details of a person
@@ -452,6 +671,24 @@ export declare class PersonsApi extends BaseAPI {
      * @memberof PersonsApi
      */
     getPerson(requestParameters: PersonsApiGetPersonRequest): Promise<UpsertPersonResponse>;
+    /**
+     * Lists users who are following the person.
+     * @summary List followers of a person
+     * @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    getPersonFollowers(requestParameters: PersonsApiGetPersonFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the person.
+     * @summary List followers changelog of a person
+     * @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    getPersonFollowersChangelog(requestParameters: PersonsApiGetPersonFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get all persons
@@ -471,7 +708,7 @@ export declare class PersonsApi extends BaseAPI {
      */
     searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
     /**
-     * Updates the properties of a person.
+     * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Update a person
      * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.