From dac223db5c1a65671a15d4c19a49148584f695b3 Mon Sep 17 00:00:00 2001 From: pipedrive-bot Date: Mon, 6 Oct 2025 09:15:03 +0000 Subject: [PATCH] Build 287 - version-minor --- CHANGELOG.md | 2 + src/versions/v1/models/add-team-request.ts | 2 +- src/versions/v1/models/add-team-request1.ts | 2 +- .../v1/models/get-permitted-users-response.ts | 4 +- .../v1/models/get-products-response1.ts | 8 +- src/versions/v1/models/index.ts | 2 - src/versions/v2/api/deals-api.ts | 28 +++---- ...als-products-response-data-inner-all-of.ts | 5 ++ src/versions/v2/models/index.ts | 2 +- src/versions/v2/models/stage-item1.ts | 74 +++++++++++++++++++ .../v2/models/upsert-stage-response.ts | 6 +- 11 files changed, 107 insertions(+), 28 deletions(-) create mode 100644 src/versions/v2/models/stage-item1.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 4dc51615..4b10ecda 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +## Added +- Added `is_archived` field in search response schemas for deals and leads ## [30.1.0] - 2025-10-06 ### Added diff --git a/src/versions/v1/models/add-team-request.ts b/src/versions/v1/models/add-team-request.ts index d6ea75a1..a39ee141 100644 --- a/src/versions/v1/models/add-team-request.ts +++ b/src/versions/v1/models/add-team-request.ts @@ -36,7 +36,7 @@ export interface AddTeamRequest { */ 'manager_id'?: number; /** - * The IDs of the users that belong to the team + * The list of user IDs * @type {Array} */ 'users'?: Array; diff --git a/src/versions/v1/models/add-team-request1.ts b/src/versions/v1/models/add-team-request1.ts index 1dbdacec..56f32c3f 100644 --- a/src/versions/v1/models/add-team-request1.ts +++ b/src/versions/v1/models/add-team-request1.ts @@ -36,7 +36,7 @@ export interface AddTeamRequest1 { */ 'description'?: string; /** - * The IDs of the users that belong to the team + * The list of user IDs * @type {Array} */ 'users'?: Array; diff --git a/src/versions/v1/models/get-permitted-users-response.ts b/src/versions/v1/models/get-permitted-users-response.ts index 0f4ee4db..e53945fc 100644 --- a/src/versions/v1/models/get-permitted-users-response.ts +++ b/src/versions/v1/models/get-permitted-users-response.ts @@ -15,12 +15,12 @@ // May contain unused imports in some cases // @ts-ignore -import { BaseResponse1 } from './base-response1'; +import { BaseResponse } from './base-response'; /** * @type GetPermittedUsersResponse * @export */ -export type GetPermittedUsersResponse = BaseResponse1; +export type GetPermittedUsersResponse = BaseResponse; diff --git a/src/versions/v1/models/get-products-response1.ts b/src/versions/v1/models/get-products-response1.ts index 60ca6018..ef66728c 100644 --- a/src/versions/v1/models/get-products-response1.ts +++ b/src/versions/v1/models/get-products-response1.ts @@ -18,10 +18,10 @@ import { GetActivitiesResponseRelatedObjects } from './get-activities-response-related-objects'; // May contain unused imports in some cases // @ts-ignore -import { GetProductResponse } from './get-product-response'; +import { GetFieldsResponseAllOfAdditionalData } from './get-fields-response-all-of-additional-data'; // May contain unused imports in some cases // @ts-ignore -import { GetProductsResponse1AdditionalData } from './get-products-response1-additional-data'; +import { GetProductResponse } from './get-product-response'; /** * @@ -41,9 +41,9 @@ export interface GetProductsResponse1 { 'data': Array; /** * - * @type {GetProductsResponse1AdditionalData} + * @type {GetFieldsResponseAllOfAdditionalData} */ - 'additional_data': GetProductsResponse1AdditionalData; + 'additional_data': GetFieldsResponseAllOfAdditionalData; /** * * @type {GetActivitiesResponseRelatedObjects} diff --git a/src/versions/v1/models/index.ts b/src/versions/v1/models/index.ts index 92fde7a0..8e473bc4 100644 --- a/src/versions/v1/models/index.ts +++ b/src/versions/v1/models/index.ts @@ -112,7 +112,6 @@ export * from './base-pipeline-with-selected-flag'; export * from './base-pipeline-with-selected-flag-all-of'; export * from './base-product'; export * from './base-response'; -export * from './base-response1'; export * from './base-response-all-of'; export * from './base-role-request'; export * from './base-stage'; @@ -497,7 +496,6 @@ export * from './get-product-search-response-all-of-data-items-inner-item'; export * from './get-product-search-response-all-of-data-items-inner-item-owner'; export * from './get-products-response'; export * from './get-products-response1'; -export * from './get-products-response1-additional-data'; export * from './get-products-response-all-of'; export * from './get-products-response-all-of-additional-data'; export * from './get-products-response-all-of-additional-data-all-of'; diff --git a/src/versions/v2/api/deals-api.ts b/src/versions/v2/api/deals-api.ts index b7f8cacb..7a54af14 100644 --- a/src/versions/v2/api/deals-api.ts +++ b/src/versions/v2/api/deals-api.ts @@ -941,12 +941,12 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} id The ID of the deal * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @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 {'id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`. + * @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. * @throws {RequiredError} */ - getDealProducts: async (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', ): Promise => { + getDealProducts: async (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc', ): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getDealProducts', 'id', id) const localVarPath = `/deals/{id}/products` @@ -1119,12 +1119,12 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {Array} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @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 {'id' | 'deal_id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`. + * @param {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. * @throws {RequiredError} */ - getDealsProducts: async (deal_ids: Array, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', ): Promise => { + getDealsProducts: async (deal_ids: Array, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc', ): Promise => { // verify required parameter 'deal_ids' is not null or undefined assertParamExists('getDealsProducts', 'deal_ids', deal_ids) const localVarPath = `/deals/products`; @@ -1841,12 +1841,12 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {number} id The ID of the deal * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @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 {'id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`. + * @param {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. * @throws {RequiredError} */ - async getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + async getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDealProducts(id, cursor, limit, sort_by, sort_direction, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -1882,12 +1882,12 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {Array} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @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 {'id' | 'deal_id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`. + * @param {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`. * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`. * @throws {RequiredError} */ - async getDealsProducts(deal_ids: Array, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + async getDealsProducts(deal_ids: Array, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDealsProducts(deal_ids, cursor, limit, sort_by, sort_direction, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -2769,11 +2769,11 @@ export interface DealsApiGetDealProductsRequest { readonly limit?: number /** - * The field to sort by. Supported fields: `id`, `add_time`, `update_time`. - * @type {'id' | 'add_time' | 'update_time'} + * The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`. + * @type {'id' | 'add_time' | 'update_time' | 'order_nr'} * @memberof DealsApiGetDealProducts */ - readonly sort_by?: 'id' | 'add_time' | 'update_time' + readonly sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr' /** * The sorting direction. Supported values: `asc`, `desc`. @@ -2930,11 +2930,11 @@ export interface DealsApiGetDealsProductsRequest { readonly limit?: number /** - * The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`. - * @type {'id' | 'deal_id' | 'add_time' | 'update_time'} + * The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`. + * @type {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} * @memberof DealsApiGetDealsProducts */ - readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' + readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr' /** * The sorting direction. Supported values: `asc`, `desc`. diff --git a/src/versions/v2/models/get-deals-products-response-data-inner-all-of.ts b/src/versions/v2/models/get-deals-products-response-data-inner-all-of.ts index 09ad593e..dcf8b9b5 100644 --- a/src/versions/v2/models/get-deals-products-response-data-inner-all-of.ts +++ b/src/versions/v2/models/get-deals-products-response-data-inner-all-of.ts @@ -56,6 +56,11 @@ export interface GetDealsProductsResponseDataInnerAllOf { */ 'product_variation_id'?: number | null; /** + * The order number of the product within the deal + * @type {number} + */ + 'order_nr'?: number | null; + /** * The date and time when the product was added to the deal * @type {string} */ diff --git a/src/versions/v2/models/index.ts b/src/versions/v2/models/index.ts index 2d2470aa..6f36ceca 100644 --- a/src/versions/v2/models/index.ts +++ b/src/versions/v2/models/index.ts @@ -160,8 +160,8 @@ export * from './organization-item1'; export * from './organization-item-address'; export * from './prices-array'; export * from './product-request'; -export * from './stage'; export * from './stage-item'; +export * from './stage-item1'; export * from './update-additional-discount-request-body'; export * from './update-additional-discount-response'; export * from './update-deal-product-request'; diff --git a/src/versions/v2/models/stage-item1.ts b/src/versions/v2/models/stage-item1.ts new file mode 100644 index 00000000..2e5f7d1b --- /dev/null +++ b/src/versions/v2/models/stage-item1.ts @@ -0,0 +1,74 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Pipedrive API v2 + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 2.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. + */ + + + +/** +* The stage object +* @export +* @interface StageItem1 +*/ +export interface StageItem1 { + /** + * The ID of the stage + * @type {number} + */ + 'id'?: number; + /** + * Defines the order of the stage + * @type {number} + */ + 'order_nr'?: number; + /** + * The name of the stage + * @type {string} + */ + 'name'?: string; + /** + * Whether the stage is marked as deleted or not + * @type {boolean} + */ + 'is_deleted'?: boolean; + /** + * The success probability percentage of the deal. Used/shown when the deal weighted values are used. + * @type {number} + */ + 'deal_probability'?: number; + /** + * The ID of the pipeline to add the stage to + * @type {number} + */ + 'pipeline_id'?: number; + /** + * Whether deals in this stage can become rotten + * @type {boolean} + */ + 'is_deal_rot_enabled'?: boolean; + /** + * The number of days the deals not updated in this stage would become rotten. Applies only if the `is_deal_rot_enabled` is set. + * @type {number} + */ + 'days_to_rotten'?: number | null; + /** + * The stage creation time + * @type {string} + */ + 'add_time'?: string; + /** + * The stage update time + * @type {string} + */ + 'update_time'?: string; +} + diff --git a/src/versions/v2/models/upsert-stage-response.ts b/src/versions/v2/models/upsert-stage-response.ts index 9dd0306a..f3914063 100644 --- a/src/versions/v2/models/upsert-stage-response.ts +++ b/src/versions/v2/models/upsert-stage-response.ts @@ -15,7 +15,7 @@ // May contain unused imports in some cases // @ts-ignore -import { Stage } from './stage'; +import { StageItem1 } from './stage-item1'; /** * @@ -30,8 +30,8 @@ export interface UpsertStageResponse { 'success'?: boolean; /** * - * @type {Stage} + * @type {StageItem1} */ - 'data'?: Stage; + 'data'?: StageItem1; }