pipedrive 24.2.0 → 26.0.0

package/dist/esm/versions/v2/api/organizations-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 { AddOrganizationRequest } from '../models';
+import { DeleteFollowerResponse } from '../models';
 import { DeleteOrganizationResponse } from '../models';
+import { GetFollowerChangelogsResponse } from '../models';
+import { GetFollowersResponse } from '../models';
 import { GetOrganizationSearchResponse } from '../models';
 import { GetOrganizationsResponse } from '../models';
 import { UpdateOrganizationRequest } from '../models';
@@ -31,6 +36,15 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     addOrganization: (AddOrganizationRequest?: AddOrganizationRequest) => Promise<RequestArgs>;
+    /**
+     * Adds a user as a follower to the organization.
+     * @summary Add a follower to an organization
+     * @param {number} id The ID of the organization
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addOrganizationFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -39,6 +53,15 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     deleteOrganization: (id: number) => Promise<RequestArgs>;
+    /**
+     * Deletes a user follower from the organization.
+     * @summary Delete a follower from an organization
+     * @param {number} id The ID of the organization
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deleteOrganizationFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -49,6 +72,26 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     getOrganization: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_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', custom_fields?: string) => Promise<RequestArgs>;
+    /**
+     * Lists users who are following the organization.
+     * @summary List followers of an organization
+     * @param {number} id The ID of the organization
+     * @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}
+     */
+    getOrganizationFollowers: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    /**
+     * Lists changelogs about users have followed the organization.
+     * @summary List followers changelog of an organization
+     * @param {number} id The ID of the organization
+     * @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}
+     */
+    getOrganizationFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns data about all organizations.
      * @summary Get all organizations
@@ -102,6 +145,15 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addOrganization(AddOrganizationRequest?: AddOrganizationRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
+    /**
+     * Adds a user as a follower to the organization.
+     * @summary Add a follower to an organization
+     * @param {number} id The ID of the organization
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addOrganizationFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -110,6 +162,15 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteOrganization(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationResponse>>;
+    /**
+     * Deletes a user follower from the organization.
+     * @summary Delete a follower from an organization
+     * @param {number} id The ID of the organization
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deleteOrganizationFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -120,6 +181,26 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrganization(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_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', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
+    /**
+     * Lists users who are following the organization.
+     * @summary List followers of an organization
+     * @param {number} id The ID of the organization
+     * @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}
+     */
+    getOrganizationFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
+    /**
+     * Lists changelogs about users have followed the organization.
+     * @summary List followers changelog of an organization
+     * @param {number} id The ID of the organization
+     * @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}
+     */
+    getOrganizationFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
     /**
      * Returns data about all organizations.
      * @summary Get all organizations
@@ -173,6 +254,14 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     addOrganization(requestParameters?: OrganizationsApiAddOrganizationRequest): Promise<UpsertOrganizationResponse>;
+    /**
+     * Adds a user as a follower to the organization.
+     * @summary Add a follower to an organization
+     * @param {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addOrganizationFollower(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -181,6 +270,14 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest): Promise<DeleteOrganizationResponse>;
+    /**
+     * Deletes a user follower from the organization.
+     * @summary Delete a follower from an organization
+     * @param {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -189,6 +286,22 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest): Promise<UpsertOrganizationResponse>;
+    /**
+     * Lists users who are following the organization.
+     * @summary List followers of an organization
+     * @param {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getOrganizationFollowers(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the organization.
+     * @summary List followers changelog of an organization
+     * @param {OrganizationsApiGetOrganizationFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getOrganizationFollowersChangelog(requestParameters: OrganizationsApiGetOrganizationFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Returns data about all organizations.
      * @summary Get all organizations
@@ -227,6 +340,25 @@ export interface OrganizationsApiAddOrganizationRequest {
      */
     readonly AddOrganizationRequest?: AddOrganizationRequest;
 }
+/**
+ * Request parameters for addOrganizationFollower operation in OrganizationsApi.
+ * @export
+ * @interface OrganizationsApiAddOrganizationFollowerRequest
+ */
+export interface OrganizationsApiAddOrganizationFollowerRequest {
+    /**
+     * The ID of the organization
+     * @type {number}
+     * @memberof OrganizationsApiAddOrganizationFollower
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddDealFollowerRequest}
+     * @memberof OrganizationsApiAddOrganizationFollower
+     */
+    readonly AddDealFollowerRequest?: AddDealFollowerRequest;
+}
 /**
  * Request parameters for deleteOrganization operation in OrganizationsApi.
  * @export
@@ -240,6 +372,25 @@ export interface OrganizationsApiDeleteOrganizationRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for deleteOrganizationFollower operation in OrganizationsApi.
+ * @export
+ * @interface OrganizationsApiDeleteOrganizationFollowerRequest
+ */
+export interface OrganizationsApiDeleteOrganizationFollowerRequest {
+    /**
+     * The ID of the organization
+     * @type {number}
+     * @memberof OrganizationsApiDeleteOrganizationFollower
+     */
+    readonly id: number;
+    /**
+     * The ID of the following user
+     * @type {number}
+     * @memberof OrganizationsApiDeleteOrganizationFollower
+     */
+    readonly follower_id: number;
+}
 /**
  * Request parameters for getOrganization operation in OrganizationsApi.
  * @export
@@ -265,6 +416,56 @@ export interface OrganizationsApiGetOrganizationRequest {
      */
     readonly custom_fields?: string;
 }
+/**
+ * Request parameters for getOrganizationFollowers operation in OrganizationsApi.
+ * @export
+ * @interface OrganizationsApiGetOrganizationFollowersRequest
+ */
+export interface OrganizationsApiGetOrganizationFollowersRequest {
+    /**
+     * The ID of the organization
+     * @type {number}
+     * @memberof OrganizationsApiGetOrganizationFollowers
+     */
+    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 OrganizationsApiGetOrganizationFollowers
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof OrganizationsApiGetOrganizationFollowers
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for getOrganizationFollowersChangelog operation in OrganizationsApi.
+ * @export
+ * @interface OrganizationsApiGetOrganizationFollowersChangelogRequest
+ */
+export interface OrganizationsApiGetOrganizationFollowersChangelogRequest {
+    /**
+     * The ID of the organization
+     * @type {number}
+     * @memberof OrganizationsApiGetOrganizationFollowersChangelog
+     */
+    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 OrganizationsApiGetOrganizationFollowersChangelog
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof OrganizationsApiGetOrganizationFollowersChangelog
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for getOrganizations operation in OrganizationsApi.
  * @export
@@ -410,6 +611,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     addOrganization(requestParameters?: OrganizationsApiAddOrganizationRequest): Promise<UpsertOrganizationResponse>;
+    /**
+     * Adds a user as a follower to the organization.
+     * @summary Add a follower to an organization
+     * @param {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    addOrganizationFollower(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -419,6 +629,15 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest): Promise<DeleteOrganizationResponse>;
+    /**
+     * Deletes a user follower from the organization.
+     * @summary Delete a follower from an organization
+     * @param {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -428,6 +647,24 @@ export declare class OrganizationsApi extends BaseAPI {
      * @memberof OrganizationsApi
      */
     getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest): Promise<UpsertOrganizationResponse>;
+    /**
+     * Lists users who are following the organization.
+     * @summary List followers of an organization
+     * @param {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationFollowers(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the organization.
+     * @summary List followers changelog of an organization
+     * @param {OrganizationsApiGetOrganizationFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationFollowersChangelog(requestParameters: OrganizationsApiGetOrganizationFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Returns data about all organizations.
      * @summary Get all organizations