modulepackage
0.0.0-20220511154711-a987602965ba
Repository: https://github.com/polytomic/pipedrive-api.git
Documentation: pkg.go.dev
# README
Golang Pipedrive client
Requires Go version 1.7 or greater.
Supported resources
- Activities
- ActivityFields
- ActivityTypes
- Authorizations
- Currencies
- Deals
- DealFields
- Files
- Filters
- Goals
- Notes
- NoteFields
- Organizations
- OrganizationFields
- Persons
- PersonFields
- Pipelines
- Products
- ProductFields
- Recents
- SearchResults
- Stages
- Users
- User connections
- User settings
- Webhooks
Installation
go get -v github.com/genert/pipedrive-api/pipedrive
Usage
import "github.com/genert/pipedrive-api/pipedrive"
Construct a new Pipedrive client, then use the various services on the client to access different parts of the API. For example:
const apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client := pipedrive.New(&pipedrive.Config{
APIKey: apiKey,
})
// Return list of all fields for note
noteFields, _, _ := client.NoteFields.List()
// You can then access data like this:
fmt.Println("Success = ", noteFields.Success)
fmt.Println("First note field: ", noteFields.Data[0].Name)
Integration Tests
You can run integration tests from the test
directory. See the integration tests README.
Contributions & Issues
Contributions are welcome. Please clearly explain the purpose of the PR and follow the current style.
Issues can be resolved quickest if they are descriptive and include both a reduced test case and a set of steps to reproduce.
License
This library is distributed under the MIT license found in the LICENSE file.
# Packages
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
ActivitiesCreateOptions specifices the optional parameters to the ActivitiesService.Update method.
ActivitiesReponse represents multiple activities response.
Activity represents a Pipedrive activity.
ActivityField represents a Pipedrive activity field.
ActivityFieldsResponse represents multiple activity fields response.
ActivityResponse represents single activity response.
ActivityType represents a Pipedrive activity type.
ActivityTypeResponse represents single activity type response.
ActivityTypesAddOptions specifices the optional parameters to the ActivityTypesService.Create method.
ActivityTypesEditOptions specifices the optional parameters to the ActivityTypesService.Update method.
ActivityTypesResponse represents multiple activity types response.
No description provided by the author
Authorization represents a Pipedrive authorization.
AuthorizationsListOptions specifices the optional parameters to the AuthorizationsService.List method.
AuthorizationsResponse represents multiple authorizations response.
No description provided by the author
No description provided by the author
CreateRemoteLinkedFileOptions specifices the optional parameters to the FilesService.CreateRemoteLinkedFile method.
CurrenciesListOptions specifices the optional parameters to the CurrenciesService.List method.
CurrenciesResponse represents multiple currencies response.
Currency represents a Pipedrive currency.
Deal represents a Pipedrive deal.
DealCreateOptions specifices the optional parameters to the DealsService.Create method.
DealField represents a Pipedrive deal.
DealFieldCreateOptions specifices the optional parameters to the DealFieldsService.Create method.
DealFieldResponse represents single deal field response.
DealFieldsResponse represents multiple deal fields response.
DealFieldUpdateOptions specifices the optional parameters to the DealFieldsService.Update method.
DealResponse represents single deal response.
No description provided by the author
No description provided by the author
No description provided by the author
DealsMergeOptions specifices the optional parameters to the DealService.Merge method.
DealsResponse represents multiple deals response.
No description provided by the author
DealsUpdateOptions specifices the optional parameters to the DealService.Update method.
No description provided by the author
DeletePermissionSetAssignmentOptions specifices the optional parameters to the UsersService.DeletePermissionSetAssignment method.
DeleteRoleAssignmentOptions specifices the optional parameters to the UsersService.DeleteRoleAssignment method.
No description provided by the author
No description provided by the author
ErrorResponse reports one or more errors caused by an API request.
File represents a Pipedrive file.
FileResponse represents single file response.
FilesResponse represents multiple files response.
Filter represents a Pipedrive filter.
FilterConditions represents filter conditions.
FilterCreateOptions specifices the optional parameters to the FiltersService.Create method.
FilterResponse represents single filter response.
FiltersListOptions specifices the optional parameters to the FiltersService.List method.
FiltersResponse represents multiple filters response.
FilterUpdateOptions specifices the optional parameters to the FiltersService.Update method.
Goal represents a Pipedrive goal.
GoalCreateOptions specifices the optional parameters to the GoalsService.Create method.
GoalGetResultsByIDOptions specifices the optional parameters to the GoalGetResultsByIdOptions.GetResultsByID method.
GoalResponse represents single goal response.
GoalsListOptions specifices the optional parameters to the GoalsService.List method.
GoalsResponse represents multiple goals response.
LinkRemoteFileToItemOptions specifices the optional parameters to the FilesService.LinkRemoteFileToItem method.
Note represents a Pipedrive note.
NoteCreateOptions specifices the optional parameters to the NotesService.Create method.
NoteField represents a Pipedrive note field.
NoteFieldsResponse represents multiple note fields esponse.
NoteResponse represents a single note response.
NotesResponse represents multiple notes response.
NoteUpdateOptions specifices the optional parameters to the NotesService.Update method.
No description provided by the author
Organization represents a Pipedrive organization.
OrganizationCreateOptions specifices the optional parameters to the OrganizationsService.Create method.
OrganizationField represents a Pipedrive organization field.
OrganizationFieldCreateOptions specifices the optional parameters to the OrganizationFieldsService.Create method.
OrganizationFieldResponse represents single organization field response.
OrganizationFieldsResponse represents multiple organization fields response.
OrganizationFieldUpdateOptions specifices the optional parameters to the OrganizationFieldsService.Update method.
OrganizationResponse represents single organization response.
No description provided by the author
No description provided by the author
No description provided by the author
OrganizationsResponse represents multiple organizations response.
No description provided by the author
OrganizationUpdateOptions specifices the optional parameters to the OrganizationUpdateOptions.Update method.
No description provided by the author
No description provided by the author
Participants represents a Pipedrive participant.
Person represents a Pipedrive person.
PersonAddFollowerResponse represents add follower response.
PersonCreateOptions specifices the optional parameters to the PersonsService.Create method.
PersonField represents a Pipedrive person field.
PersonFieldCreateOptions specifices the optional parameters to the PersonFieldsService.Create method.
PersonFieldResponse represents single person field response.
PersonFieldsResponse represents multiple person fields response.
PersonFieldUpdateOptions specifices the optional parameters to the PersonFieldsService.Update method.
PersonResponse represents single person response.
No description provided by the author
No description provided by the author
No description provided by the author
PersonsResponse represents multiple persons response.
No description provided by the author
PersonUpdateOptions specifices the optional parameters to the PersonUpdateOptions.Update method.
Pipeline represents a Pipedrive pipeline.
PipelineCreateOptions specifices the optional parameters to the PipelineCreateOptions.Create method.
PipelineDealsConversionRateResponse represents conversion response.
PipelineDealsMovementResponse represents movement response.
PipelineResponse represents single pipeline response.
PipelinesResponse represents multiple pipelines response.
PipelineUpdateOptions specifices the optional parameters to the PipelinesService.Update method.
Product represents a Pipedrive product.
ProductAttachedDealsResponse represents attached deals response.
ProductCreateOptions specifices the optional parameters to the ProductsService.Create method.
ProductField represents a Pipedrive product field.
ProductFieldCreateOptions specifices the optional parameters to the ProductFieldsService.Create method.
ProductFieldResponse represents single product field response.
ProductFieldsResponse represents multiple product fields response.
ProductFieldUpdateOptions specifices the optional parameters to the ProductFieldsService.Update method.
ProductFindOptions specifices the optional parameters to the ProductFindOptions.Find method.
ProductResponse represents single product response.
ProductsResponse represents multiple products response.
ProductUpdateOptions specifices the optional parameters to the ProductsService.Update method.
No description provided by the author
RateLimitError occurs when Pipedrive returns 403 Forbidden response with a rate limit remaining value of 0.
RecentRecord represents a Pipedrive recent record.
RecentRecordDetails represents a Pipedrive recent record details.
RecentsListOptions specifices the optional parameters to the RecentsService.List method.
RecentsResponse represents multiple recents response.
No description provided by the author
Search.
SearchResult represents a Pipedrive search result.
SearchResults represents multiple search results response.
SearchResultsListOptions specifices the optional parameters to the SearchResultsService.Search method.
Stage represents a Pipedrive stage.
StageDealsResponse represents stage deals response.
StageResponse represents single stage response.
StagesCreateOptions specifices the optional parameters to the StagesService.Create method.
StagesGetDealsInStageOptions specifices the optional parameters to the StagesService.GetDealsInStage method.
StagesListOptions specifices the optional parameters to the StagesService.List method.
StagesResponse represents multiple stages response.
StagesUpdateOptions specifices the optional parameters to the StagesService.Update method.
No description provided by the author
UpdateFileDetailsOptions specifices the optional parameters to the FilesService.Update method.
User represents a Pipedrive user.
UserConnections represents a Pipedrive user connections.
UserCreateOptions specifices the optional parameters to the UsersService.Create method.
UserFollowersResponse represents user followers response.
UserPermissionsResponse represents user permissions response.
UserRoleSettingsResponse represents user role settings response.
UserSettings represents a Pipedrive user settings.
UsersFindByNameOptions specifices the optional parameters to the UsersService.FindByName method.
UserSingleResponse represents single user response.
UsersResponse represents multiple users response.
UsersUpdateUserDetailsOptions specifices the optional parameters to the UsersService.UpdateUserDetails method.
Webhook represents a Pipedrive webhook.
WebhookResponse represents single webhook response.
WebhooksCreateOptions specifices the optional parameters to the WebhooksService.Create method.
WebhooksResponse represents multiple webhooks response.
# Type aliases
Active flags.
ActivitiesService handles activities related methods of the Pipedrive API.
ActivityFieldsService handles activity fields related methods of the Pipedrive API.
ActivityTypesService handles activities related methods of the Pipedrive API.
AuthorizationsService handles authorization related methods of the Pipedrive API.
CurrenciesService handles currencies related methods of the Pipedrive API.
DealFieldsService handles deal fields related methods of the Pipedrive API.
Deal probability.
DealService handles deals related methods of the Pipedrive API.
Type of actions.
Type of objects.
Field types.
FilesService handles files related methods of the Pipedrive API.
FiltersService handles activities related methods of the Pipedrive API.
GoalsService handles goals related methods of the Pipedrive API.
NoteFieldsService handles note field related methods of the Pipedrive API.
NotesService handles activities related methods of the Pipedrive API.
OrganizationFieldsService handles organization fields related methods of the Pipedrive API.
OrganizationsService handles organization related methods of the Pipedrive API.
PersonFieldsService handles person fields related methods of the Pipedrive API.
PersonsService handles activities related methods of the Pipedrive API.
PipelinesService handles pipelines related methods of the Pipedrive API.
ProductFieldsService handles pipelines related methods of the Pipedrive API.
ProductsService handles pipelines related methods of the Pipedrive API.
RecentsService handles activities related methods of the Pipedrive API.
SearchResultsService handles search results related methods of the Pipedrive API.
StagesService handles stages related methods of the Pipedrive API.
UserConnectionsService handles activities related methods of the Pipedrive API.
UserSettingsService handles user settings related methods of the Pipedrive API.
UsersService handles users related methods of the Pipedrive API.
Visiblity.
WebhooksService handles webhooks related methods of the Pipedrive API.