pipedrive 24.2.0 → 25.0.0

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

@@ -100,7 +100,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * Deletes a follower from a deal.
      * @summary Delete a follower from a deal
      * @param {number} id The ID of the deal
-     * @param {number} follower_id The ID of the follower
+     * @param {number} follower_id The ID of the relationship between the follower and the deal
 
      * @throws {RequiredError}
      */
@@ -413,7 +413,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * Deletes a follower from a deal.
      * @summary Delete a follower from a deal
      * @param {number} id The ID of the deal
-     * @param {number} follower_id The ID of the follower
+     * @param {number} follower_id The ID of the relationship between the follower and the deal
 
      * @throws {RequiredError}
      */
@@ -1016,7 +1016,7 @@ export interface DealsApiDeleteDealFollowerRequest {
      */
     readonly id: number;
     /**
-     * The ID of the follower
+     * The ID of the relationship between the follower and the deal
      * @type {number}
      * @memberof DealsApiDeleteDealFollower
      */

package/dist/esm/versions/v1/api/deals-api.js

@@ -214,7 +214,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * Deletes a follower from a deal.
          * @summary Delete a follower from a deal
          * @param {number} id The ID of the deal
-         * @param {number} follower_id The ID of the follower
+         * @param {number} follower_id The ID of the relationship between the follower and the deal
 
          * @throws {RequiredError}
          */
@@ -1408,7 +1408,7 @@ export const DealsApiFp = function (configuration) {
          * Deletes a follower from a deal.
          * @summary Delete a follower from a deal
          * @param {number} id The ID of the deal
-         * @param {number} follower_id The ID of the follower
+         * @param {number} follower_id The ID of the relationship between the follower and the deal
 
          * @throws {RequiredError}
          */

package/dist/esm/versions/v1/api/organizations-api.d.ts

@@ -70,7 +70,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      * 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
      * @param {number} id The ID of the organization
-     * @param {number} follower_id The ID of the follower
+     * @param {number} follower_id The ID of the relationship between the follower and the organization
 
      * @throws {RequiredError}
      */
@@ -276,7 +276,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      * 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
      * @param {number} id The ID of the organization
-     * @param {number} follower_id The ID of the follower
+     * @param {number} follower_id The ID of the relationship between the follower and the organization
 
      * @throws {RequiredError}
      */
@@ -672,7 +672,7 @@ export interface OrganizationsApiDeleteOrganizationFollowerRequest {
      */
     readonly id: number;
     /**
-     * The ID of the follower
+     * The ID of the relationship between the follower and the organization
      * @type {number}
      * @memberof OrganizationsApiDeleteOrganizationFollower
      */

package/dist/esm/versions/v1/api/organizations-api.js

@@ -140,7 +140,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
          * 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
          * @param {number} id The ID of the organization
-         * @param {number} follower_id The ID of the follower
+         * @param {number} follower_id The ID of the relationship between the follower and the organization
 
          * @throws {RequiredError}
          */
@@ -925,7 +925,7 @@ export const OrganizationsApiFp = function (configuration) {
          * 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
          * @param {number} id The ID of the organization
-         * @param {number} follower_id The ID of the follower
+         * @param {number} follower_id The ID of the relationship between the follower and the organization
 
          * @throws {RequiredError}
          */

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

@@ -83,7 +83,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
      * Deletes a follower from a person.
      * @summary Delete a follower from a person
      * @param {number} id The ID of the person
-     * @param {number} follower_id The ID of the follower
+     * @param {number} follower_id The ID of the relationship between the follower and the person
 
      * @throws {RequiredError}
      */
@@ -311,7 +311,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
      * Deletes a follower from a person.
      * @summary Delete a follower from a person
      * @param {number} id The ID of the person
-     * @param {number} follower_id The ID of the follower
+     * @param {number} follower_id The ID of the relationship between the follower and the person
 
      * @throws {RequiredError}
      */
@@ -775,7 +775,7 @@ export interface PersonsApiDeletePersonFollowerRequest {
      */
     readonly id: number;
     /**
-     * The ID of the follower
+     * The ID of the relationship between the follower and the person
      * @type {number}
      * @memberof PersonsApiDeletePersonFollower
      */

package/dist/esm/versions/v1/api/persons-api.js

@@ -199,7 +199,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
          * Deletes a follower from a person.
          * @summary Delete a follower from a person
          * @param {number} id The ID of the person
-         * @param {number} follower_id The ID of the follower
+         * @param {number} follower_id The ID of the relationship between the follower and the person
 
          * @throws {RequiredError}
          */
@@ -1040,7 +1040,7 @@ export const PersonsApiFp = function (configuration) {
          * Deletes a follower from a person.
          * @summary Delete a follower from a person
          * @param {number} id The ID of the person
-         * @param {number} follower_id The ID of the follower
+         * @param {number} follower_id The ID of the relationship between the follower and the person
 
          * @throws {RequiredError}
          */

package/dist/esm/versions/v1/api/subscriptions-api.d.ts

@@ -28,7 +28,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * Adds a new recurring subscription.
      * @summary Add a recurring subscription
      * @param {AddRecurringSubscriptionRequest} [AddRecurringSubscriptionRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addRecurringSubscription: (AddRecurringSubscriptionRequest?: AddRecurringSubscriptionRequest) => Promise<RequestArgs>;
@@ -36,7 +36,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * Adds a new installment subscription.
      * @summary Add an installment subscription
      * @param {AddSubscriptionInstallmentRequest} [AddSubscriptionInstallmentRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addSubscriptionInstallment: (AddSubscriptionInstallmentRequest?: AddSubscriptionInstallmentRequest) => Promise<RequestArgs>;
@@ -45,7 +45,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * @summary Cancel a recurring subscription
      * @param {number} id The ID of the subscription
      * @param {CancelRecurringSubscriptionRequest} [CancelRecurringSubscriptionRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     cancelRecurringSubscription: (id: number, CancelRecurringSubscriptionRequest?: CancelRecurringSubscriptionRequest) => Promise<RequestArgs>;
@@ -53,7 +53,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * Marks an installment or a recurring subscription as deleted.
      * @summary Delete a subscription
      * @param {number} id The ID of the subscription
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteSubscription: (id: number) => Promise<RequestArgs>;
@@ -61,7 +61,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * Returns details of an installment or a recurring subscription by the deal ID.
      * @summary Find subscription by deal
      * @param {number} dealId The ID of the deal
-
+     * @deprecated
      * @throws {RequiredError}
      */
     findSubscriptionByDeal: (dealId: number) => Promise<RequestArgs>;
@@ -69,7 +69,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * Returns details of an installment or a recurring subscription.
      * @summary Get details of a subscription
      * @param {number} id The ID of the subscription
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getSubscription: (id: number) => Promise<RequestArgs>;
@@ -77,7 +77,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * Returns all payments of an installment or recurring subscription.
      * @summary Get all payments of a subscription
      * @param {number} id The ID of the subscription
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getSubscriptionPayments: (id: number) => Promise<RequestArgs>;
@@ -86,7 +86,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * @summary Update a recurring subscription
      * @param {number} id The ID of the subscription
      * @param {UpdateRecurringSubscriptionRequest} [UpdateRecurringSubscriptionRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateRecurringSubscription: (id: number, UpdateRecurringSubscriptionRequest?: UpdateRecurringSubscriptionRequest) => Promise<RequestArgs>;
@@ -95,7 +95,7 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
      * @summary Update an installment subscription
      * @param {number} id The ID of the subscription
      * @param {UpdateSubscriptionInstallmentRequest} [UpdateSubscriptionInstallmentRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateSubscriptionInstallment: (id: number, UpdateSubscriptionInstallmentRequest?: UpdateSubscriptionInstallmentRequest) => Promise<RequestArgs>;
@@ -109,7 +109,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * Adds a new recurring subscription.
      * @summary Add a recurring subscription
      * @param {AddRecurringSubscriptionRequest} [AddRecurringSubscriptionRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addRecurringSubscription(AddRecurringSubscriptionRequest?: AddRecurringSubscriptionRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -117,7 +117,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * Adds a new installment subscription.
      * @summary Add an installment subscription
      * @param {AddSubscriptionInstallmentRequest} [AddSubscriptionInstallmentRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addSubscriptionInstallment(AddSubscriptionInstallmentRequest?: AddSubscriptionInstallmentRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -126,7 +126,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * @summary Cancel a recurring subscription
      * @param {number} id The ID of the subscription
      * @param {CancelRecurringSubscriptionRequest} [CancelRecurringSubscriptionRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     cancelRecurringSubscription(id: number, CancelRecurringSubscriptionRequest?: CancelRecurringSubscriptionRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -134,7 +134,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * Marks an installment or a recurring subscription as deleted.
      * @summary Delete a subscription
      * @param {number} id The ID of the subscription
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteSubscription(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -142,7 +142,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * Returns details of an installment or a recurring subscription by the deal ID.
      * @summary Find subscription by deal
      * @param {number} dealId The ID of the deal
-
+     * @deprecated
      * @throws {RequiredError}
      */
     findSubscriptionByDeal(dealId: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -150,7 +150,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * Returns details of an installment or a recurring subscription.
      * @summary Get details of a subscription
      * @param {number} id The ID of the subscription
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getSubscription(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -158,7 +158,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * Returns all payments of an installment or recurring subscription.
      * @summary Get all payments of a subscription
      * @param {number} id The ID of the subscription
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getSubscriptionPayments(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPaymentsResponse>>;
@@ -167,7 +167,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * @summary Update a recurring subscription
      * @param {number} id The ID of the subscription
      * @param {UpdateRecurringSubscriptionRequest} [UpdateRecurringSubscriptionRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateRecurringSubscription(id: number, UpdateRecurringSubscriptionRequest?: UpdateRecurringSubscriptionRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -176,7 +176,7 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
      * @summary Update an installment subscription
      * @param {number} id The ID of the subscription
      * @param {UpdateSubscriptionInstallmentRequest} [UpdateSubscriptionInstallmentRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateSubscriptionInstallment(id: number, UpdateSubscriptionInstallmentRequest?: UpdateSubscriptionInstallmentRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetSubscriptionsIdResponse>>;
@@ -190,7 +190,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Adds a new recurring subscription.
      * @summary Add a recurring subscription
      * @param {SubscriptionsApiAddRecurringSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addRecurringSubscription(requestParameters?: SubscriptionsApiAddRecurringSubscriptionRequest): Promise<GetSubscriptionsIdResponse>;
@@ -198,7 +198,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Adds a new installment subscription.
      * @summary Add an installment subscription
      * @param {SubscriptionsApiAddSubscriptionInstallmentRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addSubscriptionInstallment(requestParameters?: SubscriptionsApiAddSubscriptionInstallmentRequest): Promise<GetSubscriptionsIdResponse>;
@@ -206,7 +206,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Cancels a recurring subscription.
      * @summary Cancel a recurring subscription
      * @param {SubscriptionsApiCancelRecurringSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     cancelRecurringSubscription(requestParameters: SubscriptionsApiCancelRecurringSubscriptionRequest): Promise<GetSubscriptionsIdResponse>;
@@ -214,7 +214,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Marks an installment or a recurring subscription as deleted.
      * @summary Delete a subscription
      * @param {SubscriptionsApiDeleteSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteSubscription(requestParameters: SubscriptionsApiDeleteSubscriptionRequest): Promise<GetSubscriptionsIdResponse>;
@@ -222,7 +222,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Returns details of an installment or a recurring subscription by the deal ID.
      * @summary Find subscription by deal
      * @param {SubscriptionsApiFindSubscriptionByDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     findSubscriptionByDeal(requestParameters: SubscriptionsApiFindSubscriptionByDealRequest): Promise<GetSubscriptionsIdResponse>;
@@ -230,7 +230,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Returns details of an installment or a recurring subscription.
      * @summary Get details of a subscription
      * @param {SubscriptionsApiGetSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getSubscription(requestParameters: SubscriptionsApiGetSubscriptionRequest): Promise<GetSubscriptionsIdResponse>;
@@ -238,7 +238,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Returns all payments of an installment or recurring subscription.
      * @summary Get all payments of a subscription
      * @param {SubscriptionsApiGetSubscriptionPaymentsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getSubscriptionPayments(requestParameters: SubscriptionsApiGetSubscriptionPaymentsRequest): Promise<GetPaymentsResponse>;
@@ -246,7 +246,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Updates a recurring subscription.
      * @summary Update a recurring subscription
      * @param {SubscriptionsApiUpdateRecurringSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateRecurringSubscription(requestParameters: SubscriptionsApiUpdateRecurringSubscriptionRequest): Promise<GetSubscriptionsIdResponse>;
@@ -254,7 +254,7 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
      * Updates an installment subscription.
      * @summary Update an installment subscription
      * @param {SubscriptionsApiUpdateSubscriptionInstallmentRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateSubscriptionInstallment(requestParameters: SubscriptionsApiUpdateSubscriptionInstallmentRequest): Promise<GetSubscriptionsIdResponse>;
@@ -405,7 +405,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Adds a new recurring subscription.
      * @summary Add a recurring subscription
      * @param {SubscriptionsApiAddRecurringSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -414,7 +414,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Adds a new installment subscription.
      * @summary Add an installment subscription
      * @param {SubscriptionsApiAddSubscriptionInstallmentRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -423,7 +423,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Cancels a recurring subscription.
      * @summary Cancel a recurring subscription
      * @param {SubscriptionsApiCancelRecurringSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -432,7 +432,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Marks an installment or a recurring subscription as deleted.
      * @summary Delete a subscription
      * @param {SubscriptionsApiDeleteSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -441,7 +441,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Returns details of an installment or a recurring subscription by the deal ID.
      * @summary Find subscription by deal
      * @param {SubscriptionsApiFindSubscriptionByDealRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -450,7 +450,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Returns details of an installment or a recurring subscription.
      * @summary Get details of a subscription
      * @param {SubscriptionsApiGetSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -459,7 +459,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Returns all payments of an installment or recurring subscription.
      * @summary Get all payments of a subscription
      * @param {SubscriptionsApiGetSubscriptionPaymentsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -468,7 +468,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Updates a recurring subscription.
      * @summary Update a recurring subscription
      * @param {SubscriptionsApiUpdateRecurringSubscriptionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */
@@ -477,7 +477,7 @@ export declare class SubscriptionsApi extends BaseAPI {
      * Updates an installment subscription.
      * @summary Update an installment subscription
      * @param {SubscriptionsApiUpdateSubscriptionInstallmentRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SubscriptionsApi
      */