Skip to content
Merged
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an

## [Unreleased]

## 14.0.0
### Changed
- Moved `v1/teams*` endpoints to `v1/legacyTeams*` as they're being deprecated because we are preparing for an upgraded version of the Teams API, which requires migrating the current functionality to a new path URL `v1/legacyTeams*`.
The functionality and [OAuth scopes](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations) of all the Teams API endpoints will remain the same.

## 13.3.4
### Changed
- Updated `PUT /productFields/{id}`: parameter `name` is not
Expand Down
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,10 @@ Class | Method | HTTP request | Description
*Pipedrive.CallLogsApi* | [**deleteCallLog**](docs/CallLogsApi.md#deleteCallLog) | **DELETE** /callLogs/{id} | Delete a call log
*Pipedrive.CallLogsApi* | [**getCallLog**](docs/CallLogsApi.md#getCallLog) | **GET** /callLogs/{id} | Get details of a call log
*Pipedrive.CallLogsApi* | [**getUserCallLogs**](docs/CallLogsApi.md#getUserCallLogs) | **GET** /callLogs | Get all call logs assigned to a particular user
*Pipedrive.ChannelsApi* | [**addChannel**](docs/ChannelsApi.md#addChannel) | **POST** /channels | Add a channel
*Pipedrive.ChannelsApi* | [**deleteChannel**](docs/ChannelsApi.md#deleteChannel) | **DELETE** /channels/{id} | Delete a channel
*Pipedrive.ChannelsApi* | [**deleteConversation**](docs/ChannelsApi.md#deleteConversation) | **DELETE** /channels/{channel-id}/conversations/{conversation-id} | Delete a conversation
*Pipedrive.ChannelsApi* | [**receiveMessage**](docs/ChannelsApi.md#receiveMessage) | **POST** /channels/messages/receive | Receives an incoming message
*Pipedrive.CurrenciesApi* | [**getCurrencies**](docs/CurrenciesApi.md#getCurrencies) | **GET** /currencies | Get all supported currencies
*Pipedrive.DealFieldsApi* | [**addDealField**](docs/DealFieldsApi.md#addDealField) | **POST** /dealFields | Add a new deal field
*Pipedrive.DealFieldsApi* | [**deleteDealField**](docs/DealFieldsApi.md#deleteDealField) | **DELETE** /dealFields/{id} | Delete a deal field
Expand Down Expand Up @@ -351,6 +355,14 @@ Class | Method | HTTP request | Description
*Pipedrive.LeadsApi* | [**getLeads**](docs/LeadsApi.md#getLeads) | **GET** /leads | Get all leads
*Pipedrive.LeadsApi* | [**searchLeads**](docs/LeadsApi.md#searchLeads) | **GET** /leads/search | Search leads
*Pipedrive.LeadsApi* | [**updateLead**](docs/LeadsApi.md#updateLead) | **PATCH** /leads/{id} | Update a lead
*Pipedrive.LegacyTeamsApi* | [**addTeam**](docs/LegacyTeamsApi.md#addTeam) | **POST** /legacyTeams | Add a new team
*Pipedrive.LegacyTeamsApi* | [**addTeamUser**](docs/LegacyTeamsApi.md#addTeamUser) | **POST** /legacyTeams/{id}/users | Add users to a team
*Pipedrive.LegacyTeamsApi* | [**deleteTeamUser**](docs/LegacyTeamsApi.md#deleteTeamUser) | **DELETE** /legacyTeams/{id}/users | Delete users from a team
*Pipedrive.LegacyTeamsApi* | [**getTeam**](docs/LegacyTeamsApi.md#getTeam) | **GET** /legacyTeams/{id} | Get a single team
*Pipedrive.LegacyTeamsApi* | [**getTeamUsers**](docs/LegacyTeamsApi.md#getTeamUsers) | **GET** /legacyTeams/{id}/users | Get all users in a team
*Pipedrive.LegacyTeamsApi* | [**getTeams**](docs/LegacyTeamsApi.md#getTeams) | **GET** /legacyTeams | Get all teams
*Pipedrive.LegacyTeamsApi* | [**getUserTeams**](docs/LegacyTeamsApi.md#getUserTeams) | **GET** /legacyTeams/user/{id} | Get all teams of a user
*Pipedrive.LegacyTeamsApi* | [**updateTeam**](docs/LegacyTeamsApi.md#updateTeam) | **PUT** /legacyTeams/{id} | Update a team
*Pipedrive.MailboxApi* | [**deleteMailThread**](docs/MailboxApi.md#deleteMailThread) | **DELETE** /mailbox/mailThreads/{id} | Delete mail thread
*Pipedrive.MailboxApi* | [**getMailMessage**](docs/MailboxApi.md#getMailMessage) | **GET** /mailbox/mailMessages/{id} | Get one mail message
*Pipedrive.MailboxApi* | [**getMailThread**](docs/MailboxApi.md#getMailThread) | **GET** /mailbox/mailThreads/{id} | Get one mail thread
Expand Down Expand Up @@ -480,14 +492,6 @@ Class | Method | HTTP request | Description
*Pipedrive.SubscriptionsApi* | [**getSubscriptionPayments**](docs/SubscriptionsApi.md#getSubscriptionPayments) | **GET** /subscriptions/{id}/payments | Get all payments of a subscription
*Pipedrive.SubscriptionsApi* | [**updateRecurringSubscription**](docs/SubscriptionsApi.md#updateRecurringSubscription) | **PUT** /subscriptions/recurring/{id} | Update a recurring subscription
*Pipedrive.SubscriptionsApi* | [**updateSubscriptionInstallment**](docs/SubscriptionsApi.md#updateSubscriptionInstallment) | **PUT** /subscriptions/installment/{id} | Update an installment subscription
*Pipedrive.TeamsApi* | [**addTeam**](docs/TeamsApi.md#addTeam) | **POST** /teams | Add a new team
*Pipedrive.TeamsApi* | [**addTeamUser**](docs/TeamsApi.md#addTeamUser) | **POST** /teams/{id}/users | Add users to a team
*Pipedrive.TeamsApi* | [**deleteTeamUser**](docs/TeamsApi.md#deleteTeamUser) | **DELETE** /teams/{id}/users | Delete users from a team
*Pipedrive.TeamsApi* | [**getTeam**](docs/TeamsApi.md#getTeam) | **GET** /teams/{id} | Get a single team
*Pipedrive.TeamsApi* | [**getTeamUsers**](docs/TeamsApi.md#getTeamUsers) | **GET** /teams/{id}/users | Get all users in a team
*Pipedrive.TeamsApi* | [**getTeams**](docs/TeamsApi.md#getTeams) | **GET** /teams | Get all teams
*Pipedrive.TeamsApi* | [**getUserTeams**](docs/TeamsApi.md#getUserTeams) | **GET** /teams/user/{id} | Get all teams of a user
*Pipedrive.TeamsApi* | [**updateTeam**](docs/TeamsApi.md#updateTeam) | **PUT** /teams/{id} | Update a team
*Pipedrive.UserConnectionsApi* | [**getUserConnections**](docs/UserConnectionsApi.md#getUserConnections) | **GET** /userConnections | Get all user connections
*Pipedrive.UserSettingsApi* | [**getUserSettings**](docs/UserSettingsApi.md#getUserSettings) | **GET** /userSettings | List settings of an authorized user
*Pipedrive.UsersApi* | [**addUser**](docs/UsersApi.md#addUser) | **POST** /users | Add a new user
Expand Down Expand Up @@ -631,6 +635,9 @@ Class | Method | HTTP request | Description
- [Pipedrive.CallLogResponse409](docs/CallLogResponse409.md)
- [Pipedrive.CallLogResponse410](docs/CallLogResponse410.md)
- [Pipedrive.CallLogResponse500](docs/CallLogResponse500.md)
- [Pipedrive.ChannelObject](docs/ChannelObject.md)
- [Pipedrive.ChannelObjectResponse](docs/ChannelObjectResponse.md)
- [Pipedrive.ChannelObjectResponseData](docs/ChannelObjectResponseData.md)
- [Pipedrive.CommentPostPutObject](docs/CommentPostPutObject.md)
- [Pipedrive.CommonMailThread](docs/CommonMailThread.md)
- [Pipedrive.CreateRemoteFileAndLinkItToItem](docs/CreateRemoteFileAndLinkItToItem.md)
Expand Down Expand Up @@ -695,7 +702,9 @@ Class | Method | HTTP request | Description
- [Pipedrive.DeleteActivitiesResponse200Data](docs/DeleteActivitiesResponse200Data.md)
- [Pipedrive.DeleteActivityResponse200](docs/DeleteActivityResponse200.md)
- [Pipedrive.DeleteActivityResponse200Data](docs/DeleteActivityResponse200Data.md)
- [Pipedrive.DeleteChannelSuccess](docs/DeleteChannelSuccess.md)
- [Pipedrive.DeleteComment](docs/DeleteComment.md)
- [Pipedrive.DeleteConversationSuccess](docs/DeleteConversationSuccess.md)
- [Pipedrive.DeleteDeal](docs/DeleteDeal.md)
- [Pipedrive.DeleteDealData](docs/DeleteDealData.md)
- [Pipedrive.DeleteDealFollower](docs/DeleteDealFollower.md)
Expand Down Expand Up @@ -857,6 +866,16 @@ Class | Method | HTTP request | Description
- [Pipedrive.GoalType](docs/GoalType.md)
- [Pipedrive.GoalsResponseComponent](docs/GoalsResponseComponent.md)
- [Pipedrive.IconKey](docs/IconKey.md)
- [Pipedrive.InlineResponse400](docs/InlineResponse400.md)
- [Pipedrive.InlineResponse4001](docs/InlineResponse4001.md)
- [Pipedrive.InlineResponse4001AdditionalData](docs/InlineResponse4001AdditionalData.md)
- [Pipedrive.InlineResponse400AdditionalData](docs/InlineResponse400AdditionalData.md)
- [Pipedrive.InlineResponse403](docs/InlineResponse403.md)
- [Pipedrive.InlineResponse4031](docs/InlineResponse4031.md)
- [Pipedrive.InlineResponse4031AdditionalData](docs/InlineResponse4031AdditionalData.md)
- [Pipedrive.InlineResponse403AdditionalData](docs/InlineResponse403AdditionalData.md)
- [Pipedrive.InlineResponse404](docs/InlineResponse404.md)
- [Pipedrive.InlineResponse404AdditionalData](docs/InlineResponse404AdditionalData.md)
- [Pipedrive.ItemSearchAdditionalData](docs/ItemSearchAdditionalData.md)
- [Pipedrive.ItemSearchAdditionalDataPagination](docs/ItemSearchAdditionalDataPagination.md)
- [Pipedrive.ItemSearchFieldResponse](docs/ItemSearchFieldResponse.md)
Expand Down Expand Up @@ -942,6 +961,8 @@ Class | Method | HTTP request | Description
- [Pipedrive.MergePersonsRequest](docs/MergePersonsRequest.md)
- [Pipedrive.MergePersonsResponse](docs/MergePersonsResponse.md)
- [Pipedrive.MergePersonsResponseAllOf](docs/MergePersonsResponseAllOf.md)
- [Pipedrive.MessageObject](docs/MessageObject.md)
- [Pipedrive.MessageObjectAttachments](docs/MessageObjectAttachments.md)
- [Pipedrive.NewDeal](docs/NewDeal.md)
- [Pipedrive.NewDealAllOf](docs/NewDealAllOf.md)
- [Pipedrive.NewDealProduct](docs/NewDealProduct.md)
Expand Down Expand Up @@ -1240,7 +1261,7 @@ Class | Method | HTTP request | Description
- mail:full: Read, update and delete mail threads. Also grants read access to mail messages.
- products:read: Read products, its fields, files, followers and products connected to a deal.
- products:full: Create, read, update and delete products and its fields; add products to deals
- users:read: Read data about users (people with access to a Pipedrive account), their permissions, roles and followers, as well as about teams.
- users:read: Read data about users (people with access to a Pipedrive account), their permissions, roles and followers, as well as about legacy teams.
- base: Read settings of the authorized user and currencies in an account.
- phone-integration: Create, read and delete call logs and its audio recordings.

26 changes: 26 additions & 0 deletions docs/ChannelObject.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Pipedrive.ChannelObject

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name of the channel |
**providerChannelId** | **String** | The channel ID |
**avatarUrl** | **String** | The URL for an icon that represents your channel | [optional]
**templateSupport** | **Boolean** | If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension). | [optional] [default to false]
**providerType** | **String** | It controls the icons (like the icon next to the conversation) | [optional] [default to 'other']



## Enum: ProviderTypeEnum


* `facebook` (value: `"facebook"`)

* `whatsapp` (value: `"whatsapp"`)

* `other` (value: `"other"`)




10 changes: 10 additions & 0 deletions docs/ChannelObjectResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Pipedrive.ChannelObjectResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **Boolean** | | [optional]
**data** | [**[ChannelObjectResponseData]**](ChannelObjectResponseData.md) | | [optional]


31 changes: 31 additions & 0 deletions docs/ChannelObjectResponseData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Pipedrive.ChannelObjectResponseData

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | The unique channel ID used internally in omnichannel-api and the frontend of the extension | [optional]
**name** | **String** | The name of the channel | [optional]
**avatarUrl** | **String** | The URL for an icon that represents your channel | [optional]
**providerChannelId** | **String** | The channel ID you specified while creating the channel | [optional]
**marketplaceClientId** | **String** | The client_id of your app in Pipedrive marketplace | [optional]
**pdCompanyId** | **Number** | The ID of the user's company in Pipedrive | [optional]
**pdUserId** | **Number** | The ID of the user in Pipedrive | [optional]
**createdAt** | **Date** | The date and time when your channel was created in the API | [optional]
**providerType** | **String** | Value of the provider_type sent to this endpoint | [optional]
**templateSupport** | **Boolean** | Value of the template_support sent to this endpoint | [optional]



## Enum: ProviderTypeEnum


* `facebook` (value: `"facebook"`)

* `whatsapp` (value: `"whatsapp"`)

* `other` (value: `"other"`)




Loading