pipedrive 24.1.1 → 25.0.0

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

@@ -12,10 +12,15 @@
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
+import { AddDealFollowerRequest } from '../models';
+import { AddFollowerResponse } from '../models';
 import { AddProductRequest } from '../models';
 import { AddProductVariationRequest } from '../models';
+import { DeleteFollowerResponse } from '../models';
 import { DeleteProductResponse } from '../models';
 import { DeleteProductVariationResponse } from '../models';
+import { GetFollowerChangelogsResponse } from '../models';
+import { GetFollowersResponse } from '../models';
 import { GetProductResponse } from '../models';
 import { GetProductSearchResponse } from '../models';
 import { GetProductVariationResponse } from '../models';
@@ -37,6 +42,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     addProduct: (AddProductRequest?: AddProductRequest) => Promise<RequestArgs>;
+    /**
+     * Adds a user as a follower to the product.
+     * @summary Add a follower to a product
+     * @param {number} id The ID of the product
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addProductFollower: (id: number, AddDealFollowerRequest?: AddDealFollowerRequest) => Promise<RequestArgs>;
     /**
      * Adds a new product variation.
      * @summary Add a product variation
@@ -54,6 +68,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteProduct: (id: number) => Promise<RequestArgs>;
+    /**
+     * Deletes a user follower from the product.
+     * @summary Delete a follower from a product
+     * @param {number} id The ID of the product
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deleteProductFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -71,6 +94,26 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getProduct: (id: number) => Promise<RequestArgs>;
+    /**
+     * Lists users who are following the product.
+     * @summary List followers of a product
+     * @param {number} id The ID of the product
+     * @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}
+     */
+    getProductFollowers: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
+    /**
+     * Lists changelogs about users have followed the product.
+     * @summary List followers changelog of a product
+     * @param {number} id The ID of the product
+     * @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}
+     */
+    getProductFollowersChangelog: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -142,6 +185,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addProduct(AddProductRequest?: AddProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductResponse>>;
+    /**
+     * Adds a user as a follower to the product.
+     * @summary Add a follower to a product
+     * @param {number} id The ID of the product
+     * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+     * @throws {RequiredError}
+     */
+    addProductFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
     /**
      * Adds a new product variation.
      * @summary Add a product variation
@@ -159,6 +211,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProduct(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductResponse>>;
+    /**
+     * Deletes a user follower from the product.
+     * @summary Delete a follower from a product
+     * @param {number} id The ID of the product
+     * @param {number} follower_id The ID of the following user
+
+     * @throws {RequiredError}
+     */
+    deleteProductFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -176,6 +237,26 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProduct(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductResponse>>;
+    /**
+     * Lists users who are following the product.
+     * @summary List followers of a product
+     * @param {number} id The ID of the product
+     * @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}
+     */
+    getProductFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
+    /**
+     * Lists changelogs about users have followed the product.
+     * @summary List followers changelog of a product
+     * @param {number} id The ID of the product
+     * @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}
+     */
+    getProductFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -247,6 +328,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     addProduct(requestParameters?: ProductsApiAddProductRequest): Promise<GetProductResponse>;
+    /**
+     * Adds a user as a follower to the product.
+     * @summary Add a follower to a product
+     * @param {ProductsApiAddProductFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addProductFollower(requestParameters: ProductsApiAddProductFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Adds a new product variation.
      * @summary Add a product variation
@@ -263,6 +352,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteProduct(requestParameters: ProductsApiDeleteProductRequest): Promise<DeleteProductResponse>;
+    /**
+     * Deletes a user follower from the product.
+     * @summary Delete a follower from a product
+     * @param {ProductsApiDeleteProductFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteProductFollower(requestParameters: ProductsApiDeleteProductFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -279,6 +376,22 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getProduct(requestParameters: ProductsApiGetProductRequest): Promise<GetProductResponse>;
+    /**
+     * Lists users who are following the product.
+     * @summary List followers of a product
+     * @param {ProductsApiGetProductFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProductFollowers(requestParameters: ProductsApiGetProductFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the product.
+     * @summary List followers changelog of a product
+     * @param {ProductsApiGetProductFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProductFollowersChangelog(requestParameters: ProductsApiGetProductFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations
@@ -333,6 +446,25 @@ export interface ProductsApiAddProductRequest {
      */
     readonly AddProductRequest?: AddProductRequest;
 }
+/**
+ * Request parameters for addProductFollower operation in ProductsApi.
+ * @export
+ * @interface ProductsApiAddProductFollowerRequest
+ */
+export interface ProductsApiAddProductFollowerRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiAddProductFollower
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddDealFollowerRequest}
+     * @memberof ProductsApiAddProductFollower
+     */
+    readonly AddDealFollowerRequest?: AddDealFollowerRequest;
+}
 /**
  * Request parameters for addProductVariation operation in ProductsApi.
  * @export
@@ -365,6 +497,25 @@ export interface ProductsApiDeleteProductRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for deleteProductFollower operation in ProductsApi.
+ * @export
+ * @interface ProductsApiDeleteProductFollowerRequest
+ */
+export interface ProductsApiDeleteProductFollowerRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiDeleteProductFollower
+     */
+    readonly id: number;
+    /**
+     * The ID of the following user
+     * @type {number}
+     * @memberof ProductsApiDeleteProductFollower
+     */
+    readonly follower_id: number;
+}
 /**
  * Request parameters for deleteProductVariation operation in ProductsApi.
  * @export
@@ -397,6 +548,56 @@ export interface ProductsApiGetProductRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for getProductFollowers operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductFollowersRequest
+ */
+export interface ProductsApiGetProductFollowersRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiGetProductFollowers
+     */
+    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 ProductsApiGetProductFollowers
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof ProductsApiGetProductFollowers
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for getProductFollowersChangelog operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductFollowersChangelogRequest
+ */
+export interface ProductsApiGetProductFollowersChangelogRequest {
+    /**
+     * The ID of the product
+     * @type {number}
+     * @memberof ProductsApiGetProductFollowersChangelog
+     */
+    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 ProductsApiGetProductFollowersChangelog
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof ProductsApiGetProductFollowersChangelog
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for getProductVariations operation in ProductsApi.
  * @export
@@ -580,6 +781,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     addProduct(requestParameters?: ProductsApiAddProductRequest): Promise<GetProductResponse>;
+    /**
+     * Adds a user as a follower to the product.
+     * @summary Add a follower to a product
+     * @param {ProductsApiAddProductFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    addProductFollower(requestParameters: ProductsApiAddProductFollowerRequest): Promise<AddFollowerResponse>;
     /**
      * Adds a new product variation.
      * @summary Add a product variation
@@ -598,6 +808,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     deleteProduct(requestParameters: ProductsApiDeleteProductRequest): Promise<DeleteProductResponse>;
+    /**
+     * Deletes a user follower from the product.
+     * @summary Delete a follower from a product
+     * @param {ProductsApiDeleteProductFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    deleteProductFollower(requestParameters: ProductsApiDeleteProductFollowerRequest): Promise<DeleteFollowerResponse>;
     /**
      * Deletes a product variation.
      * @summary Delete a product variation
@@ -616,6 +835,24 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     getProduct(requestParameters: ProductsApiGetProductRequest): Promise<GetProductResponse>;
+    /**
+     * Lists users who are following the product.
+     * @summary List followers of a product
+     * @param {ProductsApiGetProductFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    getProductFollowers(requestParameters: ProductsApiGetProductFollowersRequest): Promise<GetFollowersResponse>;
+    /**
+     * Lists changelogs about users have followed the product.
+     * @summary List followers changelog of a product
+     * @param {ProductsApiGetProductFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    getProductFollowersChangelog(requestParameters: ProductsApiGetProductFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
     /**
      * Returns data about all product variations.
      * @summary Get all product variations