pipedrive 25.0.0 → 26.0.0

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

@@ -35,7 +35,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
      * @summary Add a product
      * @param {AddProductRequest} [AddProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addProduct: (AddProductRequest?: AddProductRequest) => Promise<RequestArgs>;
@@ -52,7 +52,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @summary Delete a product
      * @param {number} id The ID of the product
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteProduct: (id: number) => Promise<RequestArgs>;
@@ -69,7 +69,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * Returns data about a specific product.
      * @summary Get one product
      * @param {number} id The ID of the product
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getProduct: (id: number) => Promise<RequestArgs>;
@@ -123,7 +123,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @param {boolean} [get_summary] If supplied, the response will return the total numbers of products in the &#x60;additional_data.summary.total_count&#x60; property
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getProducts: (user_id?: number, filter_id?: number, ids?: Array<number>, first_char?: string, get_summary?: boolean, start?: number, limit?: number) => Promise<RequestArgs>;
@@ -136,7 +136,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchProducts: (term: string, fields?: 'code' | 'custom_fields' | 'name', exact_match?: boolean, include_fields?: 'product.price', start?: number, limit?: number) => Promise<RequestArgs>;
@@ -145,7 +145,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @summary Update a product
      * @param {number} id The ID of the product
      * @param {UpdateProductRequest} [UpdateProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProduct: (id: number, UpdateProductRequest?: UpdateProductRequest) => Promise<RequestArgs>;
@@ -159,7 +159,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
      * @summary Add a product
      * @param {AddProductRequest} [AddProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addProduct(AddProductRequest?: AddProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductResponse>>;
@@ -176,7 +176,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @summary Delete a product
      * @param {number} id The ID of the product
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteProduct(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductResponse>>;
@@ -193,7 +193,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * Returns data about a specific product.
      * @summary Get one product
      * @param {number} id The ID of the product
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getProduct(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductResponse>>;
@@ -247,7 +247,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @param {boolean} [get_summary] If supplied, the response will return the total numbers of products in the &#x60;additional_data.summary.total_count&#x60; property
      * @param {number} [start] Pagination start
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getProducts(user_id?: number, filter_id?: number, ids?: Array<number>, first_char?: string, get_summary?: boolean, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse1>>;
@@ -260,7 +260,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
      * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
      * @param {number} [limit] Items shown per page
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchProducts(term: string, fields?: 'code' | 'custom_fields' | 'name', exact_match?: boolean, include_fields?: 'product.price', start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductSearchResponse>>;
@@ -269,7 +269,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @summary Update a product
      * @param {number} id The ID of the product
      * @param {UpdateProductRequest} [UpdateProductRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProduct(id: number, UpdateProductRequest?: UpdateProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateProductResponse>>;
@@ -283,7 +283,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
      * @summary Add a product
      * @param {ProductsApiAddProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     addProduct(requestParameters?: ProductsApiAddProductRequest): Promise<GetProductResponse>;
@@ -299,7 +299,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @summary Delete a product
      * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     deleteProduct(requestParameters: ProductsApiDeleteProductRequest): Promise<DeleteProductResponse>;
@@ -315,7 +315,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Returns data about a specific product.
      * @summary Get one product
      * @param {ProductsApiGetProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getProduct(requestParameters: ProductsApiGetProductRequest): Promise<GetProductResponse>;
@@ -355,7 +355,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Returns data about all products.
      * @summary Get all products
      * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getProducts(requestParameters?: ProductsApiGetProductsRequest): Promise<GetProductsResponse1>;
@@ -363,7 +363,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
      * @summary Search products
      * @param {ProductsApiSearchProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     searchProducts(requestParameters: ProductsApiSearchProductsRequest): Promise<GetProductSearchResponse>;
@@ -371,7 +371,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * Updates product data.
      * @summary Update a product
      * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateProduct(requestParameters: ProductsApiUpdateProductRequest): Promise<UpdateProductResponse>;
@@ -675,7 +675,7 @@ export declare class ProductsApi extends BaseAPI {
      * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
      * @summary Add a product
      * @param {ProductsApiAddProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -693,7 +693,7 @@ export declare class ProductsApi extends BaseAPI {
      * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @summary Delete a product
      * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -711,7 +711,7 @@ export declare class ProductsApi extends BaseAPI {
      * Returns data about a specific product.
      * @summary Get one product
      * @param {ProductsApiGetProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -756,7 +756,7 @@ export declare class ProductsApi extends BaseAPI {
      * Returns data about all products.
      * @summary Get all products
      * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -765,7 +765,7 @@ export declare class ProductsApi extends BaseAPI {
      * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
      * @summary Search products
      * @param {ProductsApiSearchProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -774,7 +774,7 @@ export declare class ProductsApi extends BaseAPI {
      * Updates product data.
      * @summary Update a product
      * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */

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

@@ -36,7 +36,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
          * @summary Add a product
          * @param {AddProductRequest} [AddProductRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         addProduct: (AddProductRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -106,7 +106,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * Marks a product as deleted. After 30 days, the product will be permanently deleted.
          * @summary Delete a product
          * @param {number} id The ID of the product
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteProduct: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -178,7 +178,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * Returns data about a specific product.
          * @summary Get one product
          * @param {number} id The ID of the product
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getProduct: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -386,7 +386,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * @param {boolean} [get_summary] If supplied, the response will return the total numbers of products in the &#x60;additional_data.summary.total_count&#x60; property
          * @param {number} [start] Pagination start
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getProducts: (user_id, filter_id, ids, first_char, get_summary, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -443,7 +443,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
          * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchProducts: (term, fields, exact_match, include_fields, start, limit) => __awaiter(this, void 0, void 0, function* () {
@@ -495,7 +495,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
          * @summary Update a product
          * @param {number} id The ID of the product
          * @param {UpdateProductRequest} [UpdateProductRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         updateProduct: (id, UpdateProductRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -540,7 +540,7 @@ export const ProductsApiFp = function (configuration) {
          * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
          * @summary Add a product
          * @param {AddProductRequest} [AddProductRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         addProduct(AddProductRequest) {
@@ -567,7 +567,7 @@ export const ProductsApiFp = function (configuration) {
          * Marks a product as deleted. After 30 days, the product will be permanently deleted.
          * @summary Delete a product
          * @param {number} id The ID of the product
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteProduct(id) {
@@ -594,7 +594,7 @@ export const ProductsApiFp = function (configuration) {
          * Returns data about a specific product.
          * @summary Get one product
          * @param {number} id The ID of the product
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getProduct(id) {
@@ -673,7 +673,7 @@ export const ProductsApiFp = function (configuration) {
          * @param {boolean} [get_summary] If supplied, the response will return the total numbers of products in the &#x60;additional_data.summary.total_count&#x60; property
          * @param {number} [start] Pagination start
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getProducts(user_id, filter_id, ids, first_char, get_summary, start, limit) {
@@ -691,7 +691,7 @@ export const ProductsApiFp = function (configuration) {
          * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
          * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter.
          * @param {number} [limit] Items shown per page
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchProducts(term, fields, exact_match, include_fields, start, limit) {
@@ -705,7 +705,7 @@ export const ProductsApiFp = function (configuration) {
          * @summary Update a product
          * @param {number} id The ID of the product
          * @param {UpdateProductRequest} [UpdateProductRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         updateProduct(id, UpdateProductRequest) {
@@ -727,7 +727,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
          * @summary Add a product
          * @param {ProductsApiAddProductRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         addProduct(requestParameters = {}) {
@@ -747,7 +747,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * Marks a product as deleted. After 30 days, the product will be permanently deleted.
          * @summary Delete a product
          * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteProduct(requestParameters) {
@@ -767,7 +767,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * Returns data about a specific product.
          * @summary Get one product
          * @param {ProductsApiGetProductRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getProduct(requestParameters) {
@@ -817,7 +817,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * Returns data about all products.
          * @summary Get all products
          * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getProducts(requestParameters = {}) {
@@ -827,7 +827,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
          * @summary Search products
          * @param {ProductsApiSearchProductsRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         searchProducts(requestParameters) {
@@ -837,7 +837,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
          * Updates product data.
          * @summary Update a product
          * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         updateProduct(requestParameters) {
@@ -856,7 +856,7 @@ export class ProductsApi extends BaseAPI {
      * Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
      * @summary Add a product
      * @param {ProductsApiAddProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -878,7 +878,7 @@ export class ProductsApi extends BaseAPI {
      * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @summary Delete a product
      * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -900,7 +900,7 @@ export class ProductsApi extends BaseAPI {
      * Returns data about a specific product.
      * @summary Get one product
      * @param {ProductsApiGetProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -955,7 +955,7 @@ export class ProductsApi extends BaseAPI {
      * Returns data about all products.
      * @summary Get all products
      * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -966,7 +966,7 @@ export class ProductsApi extends BaseAPI {
      * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
      * @summary Search products
      * @param {ProductsApiSearchProductsRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
@@ -977,7 +977,7 @@ export class ProductsApi extends BaseAPI {
      * Updates product data.
      * @summary Update a product
      * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ProductsApi
      */