Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
### Fixed
- Fixed `GET /v1/deals/{id}/participants` and `POST /v1/deals/{id}/participants` response schemas to accurately represent the API response structure. Added `DealParticipantItem` schema with proper nesting of `email` and `phone` fields within `person_id` object, replacing incorrect `PersonItem` reference.

## [31.3.0] - 2026-02-06
### Added
Expand Down
8 changes: 4 additions & 4 deletions src/versions/v1/models/add-participants-response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@

// May contain unused imports in some cases
// @ts-ignore
import { AddParticipantsResponseData } from './add-participants-response-data';
import { AddParticipantsResponseRelatedObjects } from './add-participants-response-related-objects';
// May contain unused imports in some cases
// @ts-ignore
import { AddParticipantsResponseRelatedObjects } from './add-participants-response-related-objects';
import { DealParticipantItem } from './deal-participant-item';

/**
*
Expand All @@ -33,9 +33,9 @@ export interface AddParticipantsResponse {
'success'?: boolean;
/**
*
* @type {AddParticipantsResponseData}
* @type {DealParticipantItem}
*/
'data'?: AddParticipantsResponseData;
'data'?: DealParticipantItem;
/**
*
* @type {AddParticipantsResponseRelatedObjects}
Expand Down
2 changes: 1 addition & 1 deletion src/versions/v1/models/add-person-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { BasicPersonRequest } from './basic-person-request';
import { BasicPersonRequestEmailInner } from './basic-person-request-email-inner';
// May contain unused imports in some cases
// @ts-ignore
import { PersonAllOfPhoneInner } from './person-all-of-phone-inner';
import { DealParticipantItemPersonIdPhoneInner } from './deal-participant-item-person-id-phone-inner';

/**
* @type AddPersonRequest
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v1/models/basic-person-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import { BasicPersonRequestEmailInner } from './basic-person-request-email-inner';
// May contain unused imports in some cases
// @ts-ignore
import { PersonAllOfPhoneInner } from './person-all-of-phone-inner';
import { DealParticipantItemPersonIdPhoneInner } from './deal-participant-item-person-id-phone-inner';

/**
*
Expand All @@ -43,9 +43,9 @@ export interface BasicPersonRequest {
'email'?: Array<BasicPersonRequestEmailInner>;
/**
* A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required.
* @type {Array<PersonAllOfPhoneInner>}
* @type {Array<DealParticipantItemPersonIdPhoneInner>}
*/
'phone'?: Array<PersonAllOfPhoneInner>;
'phone'?: Array<DealParticipantItemPersonIdPhoneInner>;
/**
* The label assigned to the person. When the `label` field is updated, the `label_ids` field value will be overwritten by the `label` field value.
* @type {number}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/



/**
*
* @export
* @interface DealParticipantItemPersonIdEmailInner
*/
export interface DealParticipantItemPersonIdEmailInner {
/**
* The email address
* @type {string}
*/
'value'?: string;
/**
* Boolean that indicates if email is primary for the person or not
* @type {boolean}
*/
'primary'?: boolean;
/**
* The label that indicates the type of the email. (Possible values - work, home or other)
* @type {string}
*/
'label'?: string;
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/



/**
*
* @export
* @interface DealParticipantItemPersonIdPhoneInner
*/
export interface DealParticipantItemPersonIdPhoneInner {
/**
* The phone number
* @type {string}
*/
'value'?: string;
/**
* Boolean that indicates if phone number is primary for the person or not
* @type {boolean}
*/
'primary'?: boolean;
/**
* The label that indicates the type of the phone number. (Possible values - work, home, mobile or other)
* @type {string}
*/
'label'?: string;
}

65 changes: 65 additions & 0 deletions src/versions/v1/models/deal-participant-item-person-id.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/


// May contain unused imports in some cases
// @ts-ignore
import { DealParticipantItemPersonIdEmailInner } from './deal-participant-item-person-id-email-inner';
// May contain unused imports in some cases
// @ts-ignore
import { DealParticipantItemPersonIdPhoneInner } from './deal-participant-item-person-id-phone-inner';

/**
* The person data associated with the participant
* @export
* @interface DealParticipantItemPersonId
*/
export interface DealParticipantItemPersonId {
/**
* Whether the person is active or not
* @type {boolean}
*/
'active_flag'?: boolean;
/**
* The name of the person
* @type {string}
*/
'name'?: string;
/**
* An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" }]`. Please note that only `value` is required.
* @type {Array<DealParticipantItemPersonIdEmailInner>}
*/
'email'?: Array<DealParticipantItemPersonIdEmailInner>;
/**
* A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required.
* @type {Array<DealParticipantItemPersonIdPhoneInner>}
*/
'phone'?: Array<DealParticipantItemPersonIdPhoneInner>;
/**
* The ID of the owner of the person
* @type {number}
*/
'owner_id'?: number;
/**
* The ID of the company related to the person
* @type {number}
*/
'company_id'?: number;
/**
* The ID of the person
* @type {number}
*/
'value'?: number;
}

34 changes: 34 additions & 0 deletions src/versions/v1/models/deal-participant-item-related-item-data.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/



/**
* Information about the related deal
* @export
* @interface DealParticipantItemRelatedItemData
*/
export interface DealParticipantItemRelatedItemData {
/**
* The ID of the deal
* @type {number}
*/
'deal_id'?: number;
/**
* The title of the deal
* @type {string}
*/
'title'?: string;
}

81 changes: 81 additions & 0 deletions src/versions/v1/models/deal-participant-item.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/


// May contain unused imports in some cases
// @ts-ignore
import { DealParticipantItemPersonId } from './deal-participant-item-person-id';
// May contain unused imports in some cases
// @ts-ignore
import { DealParticipantItemRelatedItemData } from './deal-participant-item-related-item-data';
// May contain unused imports in some cases
// @ts-ignore
import { GetUserResponse } from './get-user-response';
// May contain unused imports in some cases
// @ts-ignore
import { Person } from './person';

/**
*
* @export
* @interface DealParticipantItem
*/
export interface DealParticipantItem {
/**
* The ID of the participant
* @type {number}
*/
'id'?: number;
/**
*
* @type {DealParticipantItemPersonId}
*/
'person_id'?: DealParticipantItemPersonId;
/**
* The date and time when the participant was added. Format: YYYY-MM-DD HH:MM:SS
* @type {string}
*/
'add_time'?: string;
/**
* Whether the participant is active or not
* @type {boolean}
*/
'active_flag'?: boolean;
/**
*
* @type {DealParticipantItemRelatedItemData}
*/
'related_item_data'?: DealParticipantItemRelatedItemData;
/**
*
* @type {Person}
*/
'person'?: Person;
/**
*
* @type {GetUserResponse}
*/
'added_by_user_id'?: GetUserResponse;
/**
* The type of the related item
* @type {string}
*/
'related_item_type'?: string;
/**
* The ID of the related item
* @type {number}
*/
'related_item_id'?: number;
}

10 changes: 5 additions & 5 deletions src/versions/v1/models/get-deal-participants-response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

// May contain unused imports in some cases
// @ts-ignore
import { GetDealsResponseRelatedObjects } from './get-deals-response-related-objects';
import { DealParticipantItem } from './deal-participant-item';
// May contain unused imports in some cases
// @ts-ignore
import { GetFieldsResponseAllOfAdditionalData } from './get-fields-response-all-of-additional-data';
import { GetDealsResponseRelatedObjects } from './get-deals-response-related-objects';
// May contain unused imports in some cases
// @ts-ignore
import { Person } from './person';
import { GetFieldsResponseAllOfAdditionalData } from './get-fields-response-all-of-additional-data';

/**
*
Expand All @@ -36,9 +36,9 @@ export interface GetDealParticipantsResponse {
'success'?: boolean;
/**
* The array of participants
* @type {Array<Person>}
* @type {Array<DealParticipantItem>}
*/
'data'?: Array<Person>;
'data'?: Array<DealParticipantItem>;
/**
*
* @type {GetFieldsResponseAllOfAdditionalData}
Expand Down
7 changes: 5 additions & 2 deletions src/versions/v1/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ export * from './add-organization-request-all-of';
export * from './add-organization-response';
export * from './add-organization-response-all-of';
export * from './add-participants-response';
export * from './add-participants-response-data';
export * from './add-participants-response-related-objects';
export * from './add-person-follower-request';
export * from './add-person-follower-response';
Expand Down Expand Up @@ -153,6 +152,11 @@ export * from './deal-non-strict-with-details-all-of-stay-in-pipeline-stages';
export * from './deal-organization-data-with-id';
export * from './deal-organization-data-with-id-all-of';
export * from './deal-organization-data-with-id-all-of1';
export * from './deal-participant-item';
export * from './deal-participant-item-person-id';
export * from './deal-participant-item-person-id-email-inner';
export * from './deal-participant-item-person-id-phone-inner';
export * from './deal-participant-item-related-item-data';
export * from './deal-person-data-with-id';
export * from './deal-person-data-with-id-all-of';
export * from './deal-person-data-with-id-all-of1';
Expand Down Expand Up @@ -622,7 +626,6 @@ export * from './permission-set';
export * from './person';
export * from './person-all-of';
export * from './person-all-of-email-inner';
export * from './person-all-of-phone-inner';
export * from './person-all-of-picture-id';
export * from './person-count-and-email-info';
export * from './person-count-and-email-info-all-of';
Expand Down
Loading
Loading