/** * Pipedrive API v1 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { AddOrganizationFollowerRequest } from '../models'; import { AddOrganizationFollowerResponse } from '../models'; import { DeleteOrganizationFollowerResponse } from '../models'; import { GetAssociatedFilesResponse } from '../models'; import { GetAssociatedFollowersResponse } from '../models'; import { GetAssociatedMailMessagesResponse } from '../models'; import { GetAssociatedOrganizationUpdatesResponse } from '../models'; import { GetChangelogResponse } from '../models'; import { GetPermittedUsersResponse1 } from '../models'; import { MergeOrganizationsRequest } from '../models'; import { MergeOrganizationsResponse } from '../models'; /** * OrganizationsApi - axios parameter creator * @export */ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a follower to an organization. * @summary Add a follower to an organization * @param {number} id The ID of the organization * @param {AddOrganizationFollowerRequest} [AddOrganizationFollowerRequest] * @throws {RequiredError} */ addOrganizationFollower: (id: number, AddOrganizationFollowerRequest?: AddOrganizationFollowerRequest) => Promise; /** * Deletes a follower from an organization. You can retrieve the `follower_id` from the List followers of an organization endpoint. * @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} */ deleteOrganizationFollower: (id: number, follower_id: number) => Promise; /** * Lists updates about field values of an organization. * @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} */ getOrganizationChangelog: (id: number, cursor?: string, limit?: number) => Promise; /** * Lists files associated with an organization. * @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: `id`, `update_time` * @throws {RequiredError} */ getOrganizationFiles: (id: number, start?: number, limit?: number, sort?: string) => Promise; /** * Lists the followers of an organization. * @summary List followers of an organization * @param {number} id The ID of the organization * @throws {RequiredError} */ getOrganizationFollowers: (id: number) => Promise; /** * Lists mail messages associated with an organization. * @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 * @throws {RequiredError} */ getOrganizationMailMessages: (id: number, start?: number, limit?: number) => Promise; /** * Lists updates about an organization. * @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 = Include custom field changes. If omitted, returns changes without custom field updates. * @param {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} */ getOrganizationUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise; /** * List users permitted to access an organization. * @summary List permitted users * @param {number} id The ID of the organization * @throws {RequiredError} */ getOrganizationUsers: (id: number) => Promise; /** * Merges an organization with another organization. For more information, see the tutorial for merging two organizations. * @summary Merge two organizations * @param {number} id The ID of the organization * @param {MergeOrganizationsRequest} [MergeOrganizationsRequest] * @throws {RequiredError} */ mergeOrganizations: (id: number, MergeOrganizationsRequest?: MergeOrganizationsRequest) => Promise; }; /** * OrganizationsApi - functional programming interface * @export */ export declare const OrganizationsApiFp: (configuration?: Configuration) => { /** * Adds a follower to an organization. * @summary Add a follower to an organization * @param {number} id The ID of the organization * @param {AddOrganizationFollowerRequest} [AddOrganizationFollowerRequest] * @throws {RequiredError} */ addOrganizationFollower(id: number, AddOrganizationFollowerRequest?: AddOrganizationFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Deletes a follower from an organization. You can retrieve the `follower_id` from the List followers of an organization endpoint. * @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} */ deleteOrganizationFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists updates about field values of an organization. * @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} */ getOrganizationChangelog(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists files associated with an organization. * @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: `id`, `update_time` * @throws {RequiredError} */ getOrganizationFiles(id: number, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists the followers of an organization. * @summary List followers of an organization * @param {number} id The ID of the organization * @throws {RequiredError} */ getOrganizationFollowers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists mail messages associated with an organization. * @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 * @throws {RequiredError} */ getOrganizationMailMessages(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Lists updates about an organization. * @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 = Include custom field changes. If omitted, returns changes without custom field updates. * @param {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} */ getOrganizationUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * List users permitted to access an organization. * @summary List permitted users * @param {number} id The ID of the organization * @throws {RequiredError} */ getOrganizationUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Merges an organization with another organization. For more information, see the tutorial for merging two organizations. * @summary Merge two organizations * @param {number} id The ID of the organization * @param {MergeOrganizationsRequest} [MergeOrganizationsRequest] * @throws {RequiredError} */ mergeOrganizations(id: number, MergeOrganizationsRequest?: MergeOrganizationsRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * OrganizationsApi - factory interface * @export */ export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a follower to an organization. * @summary Add a follower to an organization * @param {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} */ addOrganizationFollower(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise; /** * Deletes a follower from an organization. You can retrieve the `follower_id` from the List followers of an organization endpoint. * @summary Delete a follower from an organization * @param {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} */ deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise; /** * Lists updates about field values of an organization. * @summary List updates about organization field values * @param {OrganizationsApiGetOrganizationChangelogRequest} requestParameters Request parameters. * @throws {RequiredError} */ getOrganizationChangelog(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise; /** * Lists files associated with an organization. * @summary List files attached to an organization * @param {OrganizationsApiGetOrganizationFilesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getOrganizationFiles(requestParameters: OrganizationsApiGetOrganizationFilesRequest): Promise; /** * Lists the followers of an organization. * @summary List followers of an organization * @param {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters. * @throws {RequiredError} */ getOrganizationFollowers(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise; /** * Lists mail messages associated with an organization. * @summary List mail messages associated with an organization * @param {OrganizationsApiGetOrganizationMailMessagesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise; /** * Lists updates about an organization. * @summary List updates about an organization * @param {OrganizationsApiGetOrganizationUpdatesRequest} requestParameters Request parameters. * @throws {RequiredError} */ getOrganizationUpdates(requestParameters: OrganizationsApiGetOrganizationUpdatesRequest): Promise; /** * List users permitted to access an organization. * @summary List permitted users * @param {OrganizationsApiGetOrganizationUsersRequest} requestParameters Request parameters. * @throws {RequiredError} */ getOrganizationUsers(requestParameters: OrganizationsApiGetOrganizationUsersRequest): Promise; /** * Merges an organization with another organization. For more information, see the tutorial for merging two organizations. * @summary Merge two organizations * @param {OrganizationsApiMergeOrganizationsRequest} requestParameters Request parameters. * @throws {RequiredError} */ mergeOrganizations(requestParameters: OrganizationsApiMergeOrganizationsRequest): Promise; }; /** * 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 {AddOrganizationFollowerRequest} * @memberof OrganizationsApiAddOrganizationFollower */ readonly AddOrganizationFollowerRequest?: AddOrganizationFollowerRequest; } /** * 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 relationship between the follower and the organization * @type {number} * @memberof OrganizationsApiDeleteOrganizationFollower */ readonly follower_id: number; } /** * Request parameters for getOrganizationChangelog operation in OrganizationsApi. * @export * @interface OrganizationsApiGetOrganizationChangelogRequest */ export interface OrganizationsApiGetOrganizationChangelogRequest { /** * The ID of the organization * @type {number} * @memberof OrganizationsApiGetOrganizationChangelog */ readonly id: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof OrganizationsApiGetOrganizationChangelog */ readonly cursor?: string; /** * Items shown per page * @type {number} * @memberof OrganizationsApiGetOrganizationChangelog */ readonly limit?: number; } /** * Request parameters for getOrganizationFiles operation in OrganizationsApi. * @export * @interface OrganizationsApiGetOrganizationFilesRequest */ export interface OrganizationsApiGetOrganizationFilesRequest { /** * The ID of the organization * @type {number} * @memberof OrganizationsApiGetOrganizationFiles */ readonly id: number; /** * Pagination start * @type {number} * @memberof OrganizationsApiGetOrganizationFiles */ readonly start?: number; /** * Items shown per page. Please note that a maximum value of 100 is allowed. * @type {number} * @memberof OrganizationsApiGetOrganizationFiles */ readonly limit?: number; /** * Supported fields: `id`, `update_time` * @type {string} * @memberof OrganizationsApiGetOrganizationFiles */ readonly sort?: 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; } /** * Request parameters for getOrganizationMailMessages operation in OrganizationsApi. * @export * @interface OrganizationsApiGetOrganizationMailMessagesRequest */ export interface OrganizationsApiGetOrganizationMailMessagesRequest { /** * The ID of the organization * @type {number} * @memberof OrganizationsApiGetOrganizationMailMessages */ readonly id: number; /** * Pagination start * @type {number} * @memberof OrganizationsApiGetOrganizationMailMessages */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof OrganizationsApiGetOrganizationMailMessages */ readonly limit?: number; } /** * Request parameters for getOrganizationUpdates operation in OrganizationsApi. * @export * @interface OrganizationsApiGetOrganizationUpdatesRequest */ export interface OrganizationsApiGetOrganizationUpdatesRequest { /** * The ID of the organization * @type {number} * @memberof OrganizationsApiGetOrganizationUpdates */ readonly id: number; /** * Pagination start * @type {number} * @memberof OrganizationsApiGetOrganizationUpdates */ readonly start?: number; /** * Items shown per page * @type {number} * @memberof OrganizationsApiGetOrganizationUpdates */ readonly limit?: number; /** * Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates. * @type {string} * @memberof OrganizationsApiGetOrganizationUpdates */ readonly all_changes?: string; /** * 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). * @type {string} * @memberof OrganizationsApiGetOrganizationUpdates */ readonly items?: string; } /** * Request parameters for getOrganizationUsers operation in OrganizationsApi. * @export * @interface OrganizationsApiGetOrganizationUsersRequest */ export interface OrganizationsApiGetOrganizationUsersRequest { /** * The ID of the organization * @type {number} * @memberof OrganizationsApiGetOrganizationUsers */ readonly id: number; } /** * Request parameters for mergeOrganizations operation in OrganizationsApi. * @export * @interface OrganizationsApiMergeOrganizationsRequest */ export interface OrganizationsApiMergeOrganizationsRequest { /** * The ID of the organization * @type {number} * @memberof OrganizationsApiMergeOrganizations */ readonly id: number; /** * * @type {MergeOrganizationsRequest} * @memberof OrganizationsApiMergeOrganizations */ readonly MergeOrganizationsRequest?: MergeOrganizationsRequest; } /** * OrganizationsApi - object-oriented interface * @export * @class OrganizationsApi * @extends {BaseAPI} */ export declare class OrganizationsApi extends BaseAPI { /** * Adds a follower to an organization. * @summary Add a follower to an organization * @param {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ addOrganizationFollower(requestParameters: OrganizationsApiAddOrganizationFollowerRequest): Promise; /** * Deletes a follower from an organization. You can retrieve the `follower_id` from the List followers of an organization endpoint. * @summary Delete a follower from an organization * @param {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise; /** * Lists updates about field values of an organization. * @summary List updates about organization field values * @param {OrganizationsApiGetOrganizationChangelogRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganizationChangelog(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise; /** * Lists files associated with an organization. * @summary List files attached to an organization * @param {OrganizationsApiGetOrganizationFilesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganizationFiles(requestParameters: OrganizationsApiGetOrganizationFilesRequest): Promise; /** * Lists the followers of an organization. * @summary List followers of an organization * @param {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganizationFollowers(requestParameters: OrganizationsApiGetOrganizationFollowersRequest): Promise; /** * Lists mail messages associated with an organization. * @summary List mail messages associated with an organization * @param {OrganizationsApiGetOrganizationMailMessagesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise; /** * Lists updates about an organization. * @summary List updates about an organization * @param {OrganizationsApiGetOrganizationUpdatesRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganizationUpdates(requestParameters: OrganizationsApiGetOrganizationUpdatesRequest): Promise; /** * List users permitted to access an organization. * @summary List permitted users * @param {OrganizationsApiGetOrganizationUsersRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganizationUsers(requestParameters: OrganizationsApiGetOrganizationUsersRequest): Promise; /** * Merges an organization with another organization. For more information, see the tutorial for merging two organizations. * @summary Merge two organizations * @param {OrganizationsApiMergeOrganizationsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof OrganizationsApi */ mergeOrganizations(requestParameters: OrganizationsApiMergeOrganizationsRequest): Promise; }