pipedrive-openapi-client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +68 -0
- data/LICENSE +201 -0
- data/README.md +669 -0
- data/Rakefile +10 -0
- data/docs/ActivitiesApi.md +372 -0
- data/docs/Activity.md +47 -0
- data/docs/ActivityFieldsApi.md +61 -0
- data/docs/ActivityTypesApi.md +305 -0
- data/docs/AddFile.md +19 -0
- data/docs/AddNewPipeline.md +19 -0
- data/docs/AddNewPipelineAllOf.md +17 -0
- data/docs/AddedDealFollower.md +19 -0
- data/docs/AddedDealFollowerData.md +23 -0
- data/docs/AdditionalData.md +21 -0
- data/docs/AdditionalDataWithPaginationDetails.md +17 -0
- data/docs/BaseCurrency.md +29 -0
- data/docs/BaseDeal.md +119 -0
- data/docs/BaseMailThread.md +89 -0
- data/docs/BaseMailThreadAllOf.md +59 -0
- data/docs/BaseMailThreadAllOfParties.md +19 -0
- data/docs/BaseMailThreadMessages.md +71 -0
- data/docs/BaseMailThreadMessagesAllOf.md +41 -0
- data/docs/BaseNote.md +49 -0
- data/docs/BaseNoteDealTitle.md +17 -0
- data/docs/BaseNoteOrganization.md +17 -0
- data/docs/BaseNotePerson.md +17 -0
- data/docs/BaseResponse.md +17 -0
- data/docs/BaseRole.md +19 -0
- data/docs/BaseStage.md +35 -0
- data/docs/BaseTeam.md +33 -0
- data/docs/BaseTeamAllOf.md +17 -0
- data/docs/BaseTeamAllOf1.md +19 -0
- data/docs/BaseUser.md +55 -0
- data/docs/BaseUserMe.md +67 -0
- data/docs/BaseUserMeAllOf.md +27 -0
- data/docs/BaseUserMeAllOfLanguage.md +19 -0
- data/docs/BasicDeal.md +37 -0
- data/docs/BasicDealProduct.md +29 -0
- data/docs/BasicGoal.md +27 -0
- data/docs/BasicOrganization.md +21 -0
- data/docs/BasicPerson.md +27 -0
- data/docs/BasicPersonField.md +19 -0
- data/docs/BasicProductField.md +19 -0
- data/docs/CallLogsApi.md +296 -0
- data/docs/CommonMailThread.md +45 -0
- data/docs/CreateRemoteFileAndLinkItToItem.md +19 -0
- data/docs/CreateTeam.md +23 -0
- data/docs/Currencies.md +19 -0
- data/docs/CurrenciesApi.md +68 -0
- data/docs/DealFieldsApi.md +356 -0
- data/docs/DealNonStrictModeFields.md +25 -0
- data/docs/DealNonStrictModeFieldsCreatorUserId.md +29 -0
- data/docs/DealOrganizationData.md +27 -0
- data/docs/DealPersonData.md +23 -0
- data/docs/DealPersonDataEmail.md +21 -0
- data/docs/DealPersonDataPhone.md +21 -0
- data/docs/DealStrictModeFields.md +25 -0
- data/docs/DealSummary.md +23 -0
- data/docs/DealSummaryPerCurrency.md +17 -0
- data/docs/DealSummaryPerCurrencyFull.md +17 -0
- data/docs/DealSummaryPerCurrencyFullCURRENCYID.md +19 -0
- data/docs/DealSummaryPerStages.md +17 -0
- data/docs/DealSummaryPerStagesSTAGEID.md +17 -0
- data/docs/DealSummaryPerStagesSTAGEIDCURRENCYID.md +25 -0
- data/docs/DealUserData.md +27 -0
- data/docs/DealsApi.md +1777 -0
- data/docs/DeleteDeal.md +19 -0
- data/docs/DeleteDealData.md +17 -0
- data/docs/DeleteDealFollower.md +19 -0
- data/docs/DeleteDealFollowerData.md +17 -0
- data/docs/DeleteDealParticipant.md +19 -0
- data/docs/DeleteDealParticipantData.md +17 -0
- data/docs/DeleteDealProduct.md +19 -0
- data/docs/DeleteDealProductData.md +19 -0
- data/docs/DeleteFile.md +19 -0
- data/docs/DeleteFileData.md +17 -0
- data/docs/DeleteMultipleDeals.md +16 -0
- data/docs/DeleteMultipleDealsAllOf.md +19 -0
- data/docs/DeleteMultipleDealsAllOfData.md +17 -0
- data/docs/DeleteMultipleProductFieldsResponse.md +19 -0
- data/docs/DeleteMultipleProductFieldsResponseData.md +17 -0
- data/docs/DeleteNote.md +19 -0
- data/docs/DeleteProductFieldResponse.md +19 -0
- data/docs/DeleteProductFieldResponseData.md +17 -0
- data/docs/DeleteProductFollowerResponse.md +19 -0
- data/docs/DeleteProductFollowerResponseData.md +17 -0
- data/docs/DeleteRole.md +19 -0
- data/docs/DeleteRoleAllOf.md +17 -0
- data/docs/DeleteRoleAllOfData.md +17 -0
- data/docs/DeleteRoleAssignment.md +19 -0
- data/docs/DeleteRoleAssignmentAllOf.md +17 -0
- data/docs/DeleteRoleAssignmentAllOfData.md +17 -0
- data/docs/EditPipeline.md +19 -0
- data/docs/EditPipelineAllOf.md +17 -0
- data/docs/FailResponse.md +19 -0
- data/docs/FieldType.md +17 -0
- data/docs/FileData.md +67 -0
- data/docs/FilesApi.md +509 -0
- data/docs/FilterType.md +16 -0
- data/docs/FiltersApi.md +408 -0
- data/docs/FindProductsByNameResponse.md +21 -0
- data/docs/FindProductsByNameResponseData.md +29 -0
- data/docs/FullRole.md +29 -0
- data/docs/FullRoleAllOf.md +17 -0
- data/docs/GetAddProductAttachementDetails.md +19 -0
- data/docs/GetAddUpdateStage.md +19 -0
- data/docs/GetAddedDeal.md +23 -0
- data/docs/GetAddedDealAdditionalData.md +17 -0
- data/docs/GetAddedDealRelatedObjects.md +21 -0
- data/docs/GetAllFiles.md +21 -0
- data/docs/GetAllPipelines.md +19 -0
- data/docs/GetAllPipelinesAllOf.md +17 -0
- data/docs/GetAllProductFieldsResponse.md +21 -0
- data/docs/GetDeal.md +23 -0
- data/docs/GetDealAdditionalData.md +17 -0
- data/docs/GetDeals.md +23 -0
- data/docs/GetDealsByName.md +21 -0
- data/docs/GetDealsByNameAdditionalData.md +17 -0
- data/docs/GetDealsByNameData.md +41 -0
- data/docs/GetDealsConversionRatesInPipeline.md +19 -0
- data/docs/GetDealsConversionRatesInPipelineAllOf.md +17 -0
- data/docs/GetDealsConversionRatesInPipelineAllOfData.md +21 -0
- data/docs/GetDealsConversionRatesInPipelineAllOfDataStageConversions.md +21 -0
- data/docs/GetDealsMovementsInPipeline.md +19 -0
- data/docs/GetDealsMovementsInPipelineAllOf.md +17 -0
- data/docs/GetDealsMovementsInPipelineAllOfData.md +27 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md +19 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md +19 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.md +17 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataNewDeals.md +23 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataNewDealsFormattedValues.md +17 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataNewDealsValues.md +17 -0
- data/docs/GetDealsSummary.md +19 -0
- data/docs/GetDealsSummaryData.md +29 -0
- data/docs/GetDealsSummaryDataValuesTotal.md +25 -0
- data/docs/GetDealsSummaryDataWeightedValuesTotal.md +21 -0
- data/docs/GetDealsTimeline.md +19 -0
- data/docs/GetDealsTimelineData.md +23 -0
- data/docs/GetDealsTimelineDataTotals.md +31 -0
- data/docs/GetDuplicatedDeal.md +19 -0
- data/docs/GetMergedDeal.md +19 -0
- data/docs/GetNotes.md +21 -0
- data/docs/GetOneFile.md +19 -0
- data/docs/GetOnePipeline.md +19 -0
- data/docs/GetOnePipelineAllOf.md +17 -0
- data/docs/GetOneStage.md +19 -0
- data/docs/GetProductAttachementDetails.md +19 -0
- data/docs/GetProductFieldResponse.md +19 -0
- data/docs/GetRole.md +21 -0
- data/docs/GetRoleAllOf.md +19 -0
- data/docs/GetRoleAllOfAdditionalData.md +17 -0
- data/docs/GetRoleAssignments.md +21 -0
- data/docs/GetRoleAssignmentsAllOf.md +19 -0
- data/docs/GetRoleSettings.md +19 -0
- data/docs/GetRoleSettingsAllOf.md +17 -0
- data/docs/GetRoleSubroles.md +21 -0
- data/docs/GetRoleSubrolesAllOf.md +19 -0
- data/docs/GetRoles.md +21 -0
- data/docs/GetRolesAllOf.md +19 -0
- data/docs/GetStageDeals.md +21 -0
- data/docs/GetStages.md +19 -0
- data/docs/GlobalMessageBaseResponse.md +17 -0
- data/docs/GlobalMessageData.md +27 -0
- data/docs/GlobalMessageDelete.md +23 -0
- data/docs/GlobalMessageDeleteAllOf.md +21 -0
- data/docs/GlobalMessageGet.md +23 -0
- data/docs/GlobalMessageGetAllOf.md +21 -0
- data/docs/GlobalMessageUserData.md +21 -0
- data/docs/GlobalMessagesApi.md +120 -0
- data/docs/GoalsApi.md +318 -0
- data/docs/IconKey.md +16 -0
- data/docs/InlineObject.md +21 -0
- data/docs/InlineObject1.md +23 -0
- data/docs/InlineObject10.md +23 -0
- data/docs/InlineObject11.md +19 -0
- data/docs/InlineObject12.md +21 -0
- data/docs/InlineObject13.md +19 -0
- data/docs/InlineObject14.md +31 -0
- data/docs/InlineObject15.md +33 -0
- data/docs/InlineObject16.md +19 -0
- data/docs/InlineObject17.md +19 -0
- data/docs/InlineObject18.md +23 -0
- data/docs/InlineObject19.md +17 -0
- data/docs/InlineObject2.md +37 -0
- data/docs/InlineObject20.md +17 -0
- data/docs/InlineObject21.md +17 -0
- data/docs/InlineObject22.md +17 -0
- data/docs/InlineObject23.md +25 -0
- data/docs/InlineObject24.md +17 -0
- data/docs/InlineObject25.md +17 -0
- data/docs/InlineObject26.md +19 -0
- data/docs/InlineObject27.md +17 -0
- data/docs/InlineObject28.md +17 -0
- data/docs/InlineObject29.md +21 -0
- data/docs/InlineObject3.md +17 -0
- data/docs/InlineObject30.md +17 -0
- data/docs/InlineObject31.md +17 -0
- data/docs/InlineObject32.md +17 -0
- data/docs/InlineObject33.md +27 -0
- data/docs/InlineObject4.md +17 -0
- data/docs/InlineObject5.md +17 -0
- data/docs/InlineObject6.md +17 -0
- data/docs/InlineObject7.md +19 -0
- data/docs/InlineObject8.md +27 -0
- data/docs/InlineObject9.md +25 -0
- data/docs/InlineResponse200.md +21 -0
- data/docs/InlineResponse2001.md +19 -0
- data/docs/InlineResponse20010.md +19 -0
- data/docs/InlineResponse20010Data.md +17 -0
- data/docs/InlineResponse20011.md +19 -0
- data/docs/InlineResponse20011Data.md +17 -0
- data/docs/InlineResponse2002.md +19 -0
- data/docs/InlineResponse2003.md +17 -0
- data/docs/InlineResponse2004.md +21 -0
- data/docs/InlineResponse2005.md +17 -0
- data/docs/InlineResponse2006.md +19 -0
- data/docs/InlineResponse2007.md +19 -0
- data/docs/InlineResponse2007Data.md +25 -0
- data/docs/InlineResponse2008.md +19 -0
- data/docs/InlineResponse2008Data.md +17 -0
- data/docs/InlineResponse2009.md +19 -0
- data/docs/InlineResponse2009Data.md +17 -0
- data/docs/InlineResponse200AdditionalData.md +21 -0
- data/docs/InlineResponse201.md +19 -0
- data/docs/InlineResponse201Data.md +47 -0
- data/docs/InlineResponse400.md +25 -0
- data/docs/InlineResponse403.md +25 -0
- data/docs/InlineResponse404.md +25 -0
- data/docs/InlineResponse4041.md +25 -0
- data/docs/InlineResponse409.md +25 -0
- data/docs/InlineResponse410.md +25 -0
- data/docs/InlineResponse500.md +25 -0
- data/docs/ItemSearchApi.md +154 -0
- data/docs/LeadsApi.md +651 -0
- data/docs/LeadsValue.md +19 -0
- data/docs/LinkRemoteFileToItem.md +19 -0
- data/docs/MailMessage.md +25 -0
- data/docs/MailMessageAllOf.md +17 -0
- data/docs/MailMessageData.md +73 -0
- data/docs/MailMessagesApi.md +70 -0
- data/docs/MailParticipant.md +27 -0
- data/docs/MailServiceBaseResponse.md +23 -0
- data/docs/MailThread.md +19 -0
- data/docs/MailThreadAllOf.md +17 -0
- data/docs/MailThreadDelete.md +19 -0
- data/docs/MailThreadDeleteAllOf.md +17 -0
- data/docs/MailThreadMessages.md +19 -0
- data/docs/MailThreadMessagesAllOf.md +17 -0
- data/docs/MailThreadOne.md +19 -0
- data/docs/MailThreadOneAllOf.md +17 -0
- data/docs/MailThreadParticipant.md +33 -0
- data/docs/MailThreadPut.md +19 -0
- data/docs/MailThreadsApi.md +314 -0
- data/docs/NewDeal.md +39 -0
- data/docs/NewDealAllOf.md +17 -0
- data/docs/NewDealProduct.md +31 -0
- data/docs/NewDealProductAllOf.md +17 -0
- data/docs/NewFollowerResponse.md +19 -0
- data/docs/NewFollowerResponseData.md +23 -0
- data/docs/NewGoal.md +16 -0
- data/docs/NewOrganization.md +23 -0
- data/docs/NewOrganizationAllOf.md +17 -0
- data/docs/NewOrganizationField.md +21 -0
- data/docs/NewPerson.md +29 -0
- data/docs/NewPersonAllOf.md +17 -0
- data/docs/NewPersonField.md +21 -0
- data/docs/NewProductField.md +21 -0
- data/docs/NewProductFieldAllOf.md +21 -0
- data/docs/Note.md +33 -0
- data/docs/NoteCreatorUser.md +23 -0
- data/docs/NoteFieldsApi.md +61 -0
- data/docs/NotesApi.md +360 -0
- data/docs/NumberBoolean.md +16 -0
- data/docs/NumberBooleanDefault0.md +16 -0
- data/docs/NumberBooleanDefault1.md +16 -0
- data/docs/OrganizationFieldsApi.md +348 -0
- data/docs/OrganizationRelationship.md +23 -0
- data/docs/OrganizationRelationshipsApi.md +303 -0
- data/docs/OrganizationsApi.md +1178 -0
- data/docs/PermissionSets.md +19 -0
- data/docs/PermissionSetsAllOf.md +17 -0
- data/docs/PermissionSetsApi.md +171 -0
- data/docs/PermissionSetsItem.md +21 -0
- data/docs/PersonFieldsApi.md +348 -0
- data/docs/PersonsApi.md +1311 -0
- data/docs/Pipeline.md +23 -0
- data/docs/PipelinesApi.md +524 -0
- data/docs/PostNote.md +19 -0
- data/docs/PostRoleAssignment.md +19 -0
- data/docs/PostRoleAssignmentAllOf.md +17 -0
- data/docs/PostRoleAssignmentAllOfData.md +19 -0
- data/docs/PostRoleSettings.md +19 -0
- data/docs/PostRoleSettingsAllOf.md +17 -0
- data/docs/PostRoleSettingsAllOfData.md +19 -0
- data/docs/PostRoles.md +19 -0
- data/docs/PostRolesAllOf.md +17 -0
- data/docs/PostRolesAllOfData.md +17 -0
- data/docs/Product.md +31 -0
- data/docs/ProductAttachementFields.md +41 -0
- data/docs/ProductField.md +51 -0
- data/docs/ProductFieldAllOf.md +45 -0
- data/docs/ProductFieldsApi.md +358 -0
- data/docs/ProductsApi.md +809 -0
- data/docs/PutRole.md +19 -0
- data/docs/PutRoleAllOf.md +17 -0
- data/docs/PutRoleAllOfData.md +17 -0
- data/docs/RecentsApi.md +73 -0
- data/docs/RoleAssignment.md +27 -0
- data/docs/RoleAssignmentAllOf.md +23 -0
- data/docs/RoleSettings.md +31 -0
- data/docs/RolesAdditionalData.md +17 -0
- data/docs/RolesAdditionalDataPagination.md +21 -0
- data/docs/RolesApi.md +623 -0
- data/docs/SearchResultsApi.md +148 -0
- data/docs/SinglePermissionSetsItem.md +23 -0
- data/docs/SinglePermissionSetsItemAllOf.md +17 -0
- data/docs/Stage.md +25 -0
- data/docs/StagesApi.md +424 -0
- data/docs/SubRole.md +27 -0
- data/docs/SubRoleAllOf.md +23 -0
- data/docs/Teams.md +19 -0
- data/docs/TeamsAllOf.md +17 -0
- data/docs/TeamsApi.md +498 -0
- data/docs/Unauthorized.md +21 -0
- data/docs/UpdateFile.md +19 -0
- data/docs/UpdateTeam.md +27 -0
- data/docs/UpdateTeamAllOf.md +19 -0
- data/docs/User.md +19 -0
- data/docs/UserAllOf.md +17 -0
- data/docs/UserAssignmentToPermissionSet.md +23 -0
- data/docs/UserAssignmentsToPermissionSet.md +19 -0
- data/docs/UserAssignmentsToPermissionSetAllOf.md +17 -0
- data/docs/UserConnections.md +19 -0
- data/docs/UserConnectionsAllOf.md +17 -0
- data/docs/UserConnectionsAllOfData.md +17 -0
- data/docs/UserConnectionsApi.md +62 -0
- data/docs/UserIDs.md +19 -0
- data/docs/UserIDsAllOf.md +17 -0
- data/docs/UserMe.md +19 -0
- data/docs/UserMeAllOf.md +17 -0
- data/docs/UserSettings.md +19 -0
- data/docs/UserSettingsAllOf.md +17 -0
- data/docs/UserSettingsApi.md +62 -0
- data/docs/UserSettingsItem.md +35 -0
- data/docs/Users.md +19 -0
- data/docs/UsersAllOf.md +17 -0
- data/docs/UsersApi.md +818 -0
- data/docs/VisibleTo.md +16 -0
- data/docs/WebhooksApi.md +190 -0
- data/git_push.sh +58 -0
- data/lib/pipedrive-openapi-client.rb +384 -0
- data/lib/pipedrive-openapi-client/api/activities_api.rb +403 -0
- data/lib/pipedrive-openapi-client/api/activity_fields_api.rb +76 -0
- data/lib/pipedrive-openapi-client/api/activity_types_api.rb +344 -0
- data/lib/pipedrive-openapi-client/api/call_logs_api.rb +339 -0
- data/lib/pipedrive-openapi-client/api/currencies_api.rb +81 -0
- data/lib/pipedrive-openapi-client/api/deal_fields_api.rb +391 -0
- data/lib/pipedrive-openapi-client/api/deals_api.rb +2018 -0
- data/lib/pipedrive-openapi-client/api/files_api.rb +630 -0
- data/lib/pipedrive-openapi-client/api/filters_api.rb +436 -0
- data/lib/pipedrive-openapi-client/api/global_messages_api.rb +143 -0
- data/lib/pipedrive-openapi-client/api/goals_api.rb +405 -0
- data/lib/pipedrive-openapi-client/api/item_search_api.rb +228 -0
- data/lib/pipedrive-openapi-client/api/leads_api.rb +697 -0
- data/lib/pipedrive-openapi-client/api/mail_messages_api.rb +87 -0
- data/lib/pipedrive-openapi-client/api/mail_threads_api.rb +358 -0
- data/lib/pipedrive-openapi-client/api/note_fields_api.rb +76 -0
- data/lib/pipedrive-openapi-client/api/notes_api.rb +422 -0
- data/lib/pipedrive-openapi-client/api/organization_fields_api.rb +385 -0
- data/lib/pipedrive-openapi-client/api/organization_relationships_api.rb +340 -0
- data/lib/pipedrive-openapi-client/api/organizations_api.rb +1303 -0
- data/lib/pipedrive-openapi-client/api/permission_sets_api.rb +204 -0
- data/lib/pipedrive-openapi-client/api/person_fields_api.rb +385 -0
- data/lib/pipedrive-openapi-client/api/persons_api.rb +1448 -0
- data/lib/pipedrive-openapi-client/api/pipelines_api.rb +595 -0
- data/lib/pipedrive-openapi-client/api/product_fields_api.rb +391 -0
- data/lib/pipedrive-openapi-client/api/products_api.rb +904 -0
- data/lib/pipedrive-openapi-client/api/recents_api.rb +96 -0
- data/lib/pipedrive-openapi-client/api/roles_api.rb +741 -0
- data/lib/pipedrive-openapi-client/api/search_results_api.rb +194 -0
- data/lib/pipedrive-openapi-client/api/stages_api.rb +467 -0
- data/lib/pipedrive-openapi-client/api/teams_api.rb +571 -0
- data/lib/pipedrive-openapi-client/api/user_connections_api.rb +78 -0
- data/lib/pipedrive-openapi-client/api/user_settings_api.rb +78 -0
- data/lib/pipedrive-openapi-client/api/users_api.rb +925 -0
- data/lib/pipedrive-openapi-client/api/webhooks_api.rb +238 -0
- data/lib/pipedrive-openapi-client/api_client.rb +404 -0
- data/lib/pipedrive-openapi-client/api_error.rb +57 -0
- data/lib/pipedrive-openapi-client/configuration.rb +250 -0
- data/lib/pipedrive-openapi-client/models/activity.rb +404 -0
- data/lib/pipedrive-openapi-client/models/add_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/add_new_pipeline.rb +224 -0
- data/lib/pipedrive-openapi-client/models/add_new_pipeline_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/added_deal_follower.rb +216 -0
- data/lib/pipedrive-openapi-client/models/added_deal_follower_data.rb +237 -0
- data/lib/pipedrive-openapi-client/models/additional_data.rb +228 -0
- data/lib/pipedrive-openapi-client/models/additional_data_with_pagination_details.rb +207 -0
- data/lib/pipedrive-openapi-client/models/base_currency.rb +267 -0
- data/lib/pipedrive-openapi-client/models/base_deal.rb +724 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread.rb +582 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_all_of.rb +423 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_all_of_parties.rb +222 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_messages.rb +495 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_messages_all_of.rb +336 -0
- data/lib/pipedrive-openapi-client/models/base_note.rb +363 -0
- data/lib/pipedrive-openapi-client/models/base_note_deal_title.rb +208 -0
- data/lib/pipedrive-openapi-client/models/base_note_organization.rb +208 -0
- data/lib/pipedrive-openapi-client/models/base_note_person.rb +208 -0
- data/lib/pipedrive-openapi-client/models/base_response.rb +207 -0
- data/lib/pipedrive-openapi-client/models/base_role.rb +218 -0
- data/lib/pipedrive-openapi-client/models/base_stage.rb +331 -0
- data/lib/pipedrive-openapi-client/models/base_team.rb +306 -0
- data/lib/pipedrive-openapi-client/models/base_team_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/base_team_all_of1.rb +217 -0
- data/lib/pipedrive-openapi-client/models/base_user.rb +399 -0
- data/lib/pipedrive-openapi-client/models/base_user_me.rb +466 -0
- data/lib/pipedrive-openapi-client/models/base_user_me_all_of.rb +256 -0
- data/lib/pipedrive-openapi-client/models/base_user_me_all_of_language.rb +218 -0
- data/lib/pipedrive-openapi-client/models/basic_deal.rb +341 -0
- data/lib/pipedrive-openapi-client/models/basic_deal_product.rb +271 -0
- data/lib/pipedrive-openapi-client/models/basic_goal.rb +291 -0
- data/lib/pipedrive-openapi-client/models/basic_organization.rb +227 -0
- data/lib/pipedrive-openapi-client/models/basic_person.rb +261 -0
- data/lib/pipedrive-openapi-client/models/basic_person_field.rb +222 -0
- data/lib/pipedrive-openapi-client/models/basic_product_field.rb +224 -0
- data/lib/pipedrive-openapi-client/models/common_mail_thread.rb +348 -0
- data/lib/pipedrive-openapi-client/models/create_remote_file_and_link_it_to_item.rb +216 -0
- data/lib/pipedrive-openapi-client/models/create_team.rb +247 -0
- data/lib/pipedrive-openapi-client/models/currencies.rb +219 -0
- data/lib/pipedrive-openapi-client/models/deal_non_strict_mode_fields.rb +243 -0
- data/lib/pipedrive-openapi-client/models/deal_non_strict_mode_fields_creator_user_id.rb +269 -0
- data/lib/pipedrive-openapi-client/models/deal_organization_data.rb +258 -0
- data/lib/pipedrive-openapi-client/models/deal_person_data.rb +242 -0
- data/lib/pipedrive-openapi-client/models/deal_person_data_email.rb +227 -0
- data/lib/pipedrive-openapi-client/models/deal_person_data_phone.rb +227 -0
- data/lib/pipedrive-openapi-client/models/deal_strict_mode_fields.rb +247 -0
- data/lib/pipedrive-openapi-client/models/deal_summary.rb +235 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_currency.rb +208 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_currency_full.rb +207 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_currency_full_currencyid.rb +218 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_stages.rb +207 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_stages_stageid.rb +207 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_stages_stageidcurrencyid.rb +248 -0
- data/lib/pipedrive-openapi-client/models/deal_user_data.rb +259 -0
- data/lib/pipedrive-openapi-client/models/delete_deal.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_follower.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_follower_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_participant.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_participant_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_product.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_product_data.rb +217 -0
- data/lib/pipedrive-openapi-client/models/delete_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_file_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_deals.rb +208 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_deals_all_of.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_deals_all_of_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_product_fields_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_product_fields_response_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/delete_note.rb +217 -0
- data/lib/pipedrive-openapi-client/models/delete_product_field_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_product_field_response_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_product_follower_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_product_follower_response_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_role.rb +224 -0
- data/lib/pipedrive-openapi-client/models/delete_role_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/delete_role_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/delete_role_assignment.rb +224 -0
- data/lib/pipedrive-openapi-client/models/delete_role_assignment_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/delete_role_assignment_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/edit_pipeline.rb +225 -0
- data/lib/pipedrive-openapi-client/models/edit_pipeline_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/fail_response.rb +217 -0
- data/lib/pipedrive-openapi-client/models/field_type.rb +246 -0
- data/lib/pipedrive-openapi-client/models/file_data.rb +458 -0
- data/lib/pipedrive-openapi-client/models/filter_type.rb +39 -0
- data/lib/pipedrive-openapi-client/models/find_products_by_name_response.rb +226 -0
- data/lib/pipedrive-openapi-client/models/find_products_by_name_response_data.rb +267 -0
- data/lib/pipedrive-openapi-client/models/full_role.rb +275 -0
- data/lib/pipedrive-openapi-client/models/full_role_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_add_product_attachement_details.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_add_update_stage.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_added_deal.rb +235 -0
- data/lib/pipedrive-openapi-client/models/get_added_deal_additional_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/get_added_deal_related_objects.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_all_files.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_all_pipelines.rb +227 -0
- data/lib/pipedrive-openapi-client/models/get_all_pipelines_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/get_all_product_fields_response.rb +229 -0
- data/lib/pipedrive-openapi-client/models/get_deal.rb +234 -0
- data/lib/pipedrive-openapi-client/models/get_deal_additional_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_deals.rb +237 -0
- data/lib/pipedrive-openapi-client/models/get_deals_by_name.rb +227 -0
- data/lib/pipedrive-openapi-client/models/get_deals_by_name_additional_data.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_deals_by_name_data.rb +328 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline_all_of_data.rb +230 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline_all_of_data_stage_conversions.rb +227 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data.rb +252 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days.rb +220 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days_by_stages.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_movements_between_stages.rb +208 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_new_deals.rb +238 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_new_deals_formatted_values.rb +208 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_new_deals_values.rb +208 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary_data.rb +266 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary_data_values_total.rb +248 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary_data_weighted_values_total.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_deals_timeline.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_deals_timeline_data.rb +238 -0
- data/lib/pipedrive-openapi-client/models/get_deals_timeline_data_totals.rb +278 -0
- data/lib/pipedrive-openapi-client/models/get_duplicated_deal.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_merged_deal.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_notes.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_one_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_one_pipeline.rb +225 -0
- data/lib/pipedrive-openapi-client/models/get_one_pipeline_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_one_stage.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_product_attachement_details.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_product_field_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_role.rb +233 -0
- data/lib/pipedrive-openapi-client/models/get_role_all_of.rb +215 -0
- data/lib/pipedrive-openapi-client/models/get_role_all_of_additional_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_role_assignments.rb +236 -0
- data/lib/pipedrive-openapi-client/models/get_role_assignments_all_of.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_role_settings.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_role_settings_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_role_subroles.rb +236 -0
- data/lib/pipedrive-openapi-client/models/get_role_subroles_all_of.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_roles.rb +236 -0
- data/lib/pipedrive-openapi-client/models/get_roles_all_of.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_stage_deals.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_stages.rb +219 -0
- data/lib/pipedrive-openapi-client/models/global_message_base_response.rb +207 -0
- data/lib/pipedrive-openapi-client/models/global_message_data.rb +257 -0
- data/lib/pipedrive-openapi-client/models/global_message_delete.rb +244 -0
- data/lib/pipedrive-openapi-client/models/global_message_delete_all_of.rb +226 -0
- data/lib/pipedrive-openapi-client/models/global_message_get.rb +247 -0
- data/lib/pipedrive-openapi-client/models/global_message_get_all_of.rb +229 -0
- data/lib/pipedrive-openapi-client/models/global_message_user_data.rb +228 -0
- data/lib/pipedrive-openapi-client/models/icon_key.rb +74 -0
- data/lib/pipedrive-openapi-client/models/inline_object.rb +236 -0
- data/lib/pipedrive-openapi-client/models/inline_object1.rb +236 -0
- data/lib/pipedrive-openapi-client/models/inline_object10.rb +303 -0
- data/lib/pipedrive-openapi-client/models/inline_object11.rb +217 -0
- data/lib/pipedrive-openapi-client/models/inline_object12.rb +242 -0
- data/lib/pipedrive-openapi-client/models/inline_object13.rb +222 -0
- data/lib/pipedrive-openapi-client/models/inline_object14.rb +283 -0
- data/lib/pipedrive-openapi-client/models/inline_object15.rb +293 -0
- data/lib/pipedrive-openapi-client/models/inline_object16.rb +261 -0
- data/lib/pipedrive-openapi-client/models/inline_object17.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_object18.rb +234 -0
- data/lib/pipedrive-openapi-client/models/inline_object19.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object2.rb +361 -0
- data/lib/pipedrive-openapi-client/models/inline_object20.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object21.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object22.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object23.rb +252 -0
- data/lib/pipedrive-openapi-client/models/inline_object24.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object25.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object26.rb +260 -0
- data/lib/pipedrive-openapi-client/models/inline_object27.rb +214 -0
- data/lib/pipedrive-openapi-client/models/inline_object28.rb +214 -0
- data/lib/pipedrive-openapi-client/models/inline_object29.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_object3.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object30.rb +214 -0
- data/lib/pipedrive-openapi-client/models/inline_object31.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object32.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object33.rb +318 -0
- data/lib/pipedrive-openapi-client/models/inline_object4.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object5.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object6.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object7.rb +222 -0
- data/lib/pipedrive-openapi-client/models/inline_object8.rb +262 -0
- data/lib/pipedrive-openapi-client/models/inline_object9.rb +330 -0
- data/lib/pipedrive-openapi-client/models/inline_response200.rb +226 -0
- data/lib/pipedrive-openapi-client/models/inline_response2001.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response20010.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_response20010_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/inline_response20011.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_response20011_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/inline_response2002.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response2003.rb +206 -0
- data/lib/pipedrive-openapi-client/models/inline_response2004.rb +226 -0
- data/lib/pipedrive-openapi-client/models/inline_response2005.rb +206 -0
- data/lib/pipedrive-openapi-client/models/inline_response2006.rb +217 -0
- data/lib/pipedrive-openapi-client/models/inline_response2007.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response2007_data.rb +246 -0
- data/lib/pipedrive-openapi-client/models/inline_response2008.rb +217 -0
- data/lib/pipedrive-openapi-client/models/inline_response2008_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/inline_response2009.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_response2009_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/inline_response200_additional_data.rb +227 -0
- data/lib/pipedrive-openapi-client/models/inline_response201.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response201_data.rb +362 -0
- data/lib/pipedrive-openapi-client/models/inline_response400.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response403.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response404.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response4041.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response409.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response410.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response500.rb +244 -0
- data/lib/pipedrive-openapi-client/models/leads_value.rb +226 -0
- data/lib/pipedrive-openapi-client/models/link_remote_file_to_item.rb +216 -0
- data/lib/pipedrive-openapi-client/models/mail_message.rb +254 -0
- data/lib/pipedrive-openapi-client/models/mail_message_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/mail_message_data.rb +530 -0
- data/lib/pipedrive-openapi-client/models/mail_participant.rb +257 -0
- data/lib/pipedrive-openapi-client/models/mail_service_base_response.rb +237 -0
- data/lib/pipedrive-openapi-client/models/mail_thread.rb +227 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_delete.rb +227 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_delete_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_messages.rb +227 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_messages_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_one.rb +225 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_one_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_participant.rb +289 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_put.rb +227 -0
- data/lib/pipedrive-openapi-client/models/new_deal.rb +364 -0
- data/lib/pipedrive-openapi-client/models/new_deal_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/new_deal_product.rb +304 -0
- data/lib/pipedrive-openapi-client/models/new_deal_product_all_of.rb +212 -0
- data/lib/pipedrive-openapi-client/models/new_follower_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/new_follower_response_data.rb +237 -0
- data/lib/pipedrive-openapi-client/models/new_goal.rb +230 -0
- data/lib/pipedrive-openapi-client/models/new_organization.rb +250 -0
- data/lib/pipedrive-openapi-client/models/new_organization_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/new_organization_field.rb +279 -0
- data/lib/pipedrive-openapi-client/models/new_person.rb +284 -0
- data/lib/pipedrive-openapi-client/models/new_person_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/new_person_field.rb +279 -0
- data/lib/pipedrive-openapi-client/models/new_product_field.rb +281 -0
- data/lib/pipedrive-openapi-client/models/new_product_field_all_of.rb +273 -0
- data/lib/pipedrive-openapi-client/models/note.rb +292 -0
- data/lib/pipedrive-openapi-client/models/note_creator_user.rb +238 -0
- data/lib/pipedrive-openapi-client/models/number_boolean.rb +36 -0
- data/lib/pipedrive-openapi-client/models/number_boolean_default0.rb +208 -0
- data/lib/pipedrive-openapi-client/models/number_boolean_default1.rb +208 -0
- data/lib/pipedrive-openapi-client/models/organization_relationship.rb +271 -0
- data/lib/pipedrive-openapi-client/models/permission_sets.rb +227 -0
- data/lib/pipedrive-openapi-client/models/permission_sets_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/permission_sets_item.rb +227 -0
- data/lib/pipedrive-openapi-client/models/pipeline.rb +235 -0
- data/lib/pipedrive-openapi-client/models/post_note.rb +216 -0
- data/lib/pipedrive-openapi-client/models/post_role_assignment.rb +224 -0
- data/lib/pipedrive-openapi-client/models/post_role_assignment_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/post_role_assignment_all_of_data.rb +218 -0
- data/lib/pipedrive-openapi-client/models/post_role_settings.rb +224 -0
- data/lib/pipedrive-openapi-client/models/post_role_settings_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/post_role_settings_all_of_data.rb +252 -0
- data/lib/pipedrive-openapi-client/models/post_roles.rb +224 -0
- data/lib/pipedrive-openapi-client/models/post_roles_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/post_roles_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/product.rb +281 -0
- data/lib/pipedrive-openapi-client/models/product_attachement_fields.rb +327 -0
- data/lib/pipedrive-openapi-client/models/product_field.rb +431 -0
- data/lib/pipedrive-openapi-client/models/product_field_all_of.rb +347 -0
- data/lib/pipedrive-openapi-client/models/put_role.rb +224 -0
- data/lib/pipedrive-openapi-client/models/put_role_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/put_role_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/role_assignment.rb +266 -0
- data/lib/pipedrive-openapi-client/models/role_assignment_all_of.rb +237 -0
- data/lib/pipedrive-openapi-client/models/role_settings.rb +278 -0
- data/lib/pipedrive-openapi-client/models/roles_additional_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/roles_additional_data_pagination.rb +228 -0
- data/lib/pipedrive-openapi-client/models/single_permission_sets_item.rb +247 -0
- data/lib/pipedrive-openapi-client/models/single_permission_sets_item_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/stage.rb +281 -0
- data/lib/pipedrive-openapi-client/models/sub_role.rb +266 -0
- data/lib/pipedrive-openapi-client/models/sub_role_all_of.rb +237 -0
- data/lib/pipedrive-openapi-client/models/teams.rb +226 -0
- data/lib/pipedrive-openapi-client/models/teams_all_of.rb +208 -0
- data/lib/pipedrive-openapi-client/models/unauthorized.rb +227 -0
- data/lib/pipedrive-openapi-client/models/update_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/update_team.rb +275 -0
- data/lib/pipedrive-openapi-client/models/update_team_all_of.rb +217 -0
- data/lib/pipedrive-openapi-client/models/user.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_assignment_to_permission_set.rb +237 -0
- data/lib/pipedrive-openapi-client/models/user_assignments_to_permission_set.rb +227 -0
- data/lib/pipedrive-openapi-client/models/user_assignments_to_permission_set_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/user_connections.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_connections_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_connections_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/user_i_ds.rb +227 -0
- data/lib/pipedrive-openapi-client/models/user_i_ds_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/user_me.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_me_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_settings.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_settings_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_settings_item.rb +297 -0
- data/lib/pipedrive-openapi-client/models/users.rb +226 -0
- data/lib/pipedrive-openapi-client/models/users_all_of.rb +208 -0
- data/lib/pipedrive-openapi-client/models/visible_to.rb +36 -0
- data/lib/pipedrive-openapi-client/version.rb +15 -0
- data/pipedrive-openapi-client.gemspec +39 -0
- data/spec/api/activities_api_spec.rb +115 -0
- data/spec/api/activity_fields_api_spec.rb +46 -0
- data/spec/api/activity_types_api_spec.rb +100 -0
- data/spec/api/call_logs_api_spec.rb +97 -0
- data/spec/api/currencies_api_spec.rb +47 -0
- data/spec/api/deal_fields_api_spec.rb +109 -0
- data/spec/api/deals_api_spec.rb +439 -0
- data/spec/api/files_api_spec.rb +148 -0
- data/spec/api/filters_api_spec.rb +117 -0
- data/spec/api/global_messages_api_spec.rb +59 -0
- data/spec/api/goals_api_spec.rb +114 -0
- data/spec/api/item_search_api_spec.rb +72 -0
- data/spec/api/leads_api_spec.rb +169 -0
- data/spec/api/mail_messages_api_spec.rb +48 -0
- data/spec/api/mail_threads_api_spec.rb +101 -0
- data/spec/api/note_fields_api_spec.rb +46 -0
- data/spec/api/notes_api_spec.rb +123 -0
- data/spec/api/organization_fields_api_spec.rb +107 -0
- data/spec/api/organization_relationships_api_spec.rb +99 -0
- data/spec/api/organizations_api_spec.rb +300 -0
- data/spec/api/permission_sets_api_spec.rb +70 -0
- data/spec/api/person_fields_api_spec.rb +107 -0
- data/spec/api/persons_api_spec.rb +331 -0
- data/spec/api/pipelines_api_spec.rb +152 -0
- data/spec/api/product_fields_api_spec.rb +107 -0
- data/spec/api/products_api_spec.rb +213 -0
- data/spec/api/recents_api_spec.rb +50 -0
- data/spec/api/roles_api_spec.rb +169 -0
- data/spec/api/search_results_api_spec.rb +70 -0
- data/spec/api/stages_api_spec.rb +123 -0
- data/spec/api/teams_api_spec.rb +140 -0
- data/spec/api/user_connections_api_spec.rb +46 -0
- data/spec/api/user_settings_api_spec.rb +46 -0
- data/spec/api/users_api_spec.rb +210 -0
- data/spec/api/webhooks_api_spec.rb +75 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/activity_spec.rb +135 -0
- data/spec/models/add_file_spec.rb +47 -0
- data/spec/models/add_new_pipeline_all_of_spec.rb +41 -0
- data/spec/models/add_new_pipeline_spec.rb +47 -0
- data/spec/models/added_deal_follower_data_spec.rb +59 -0
- data/spec/models/added_deal_follower_spec.rb +47 -0
- data/spec/models/additional_data_spec.rb +53 -0
- data/spec/models/additional_data_with_pagination_details_spec.rb +41 -0
- data/spec/models/base_currency_spec.rb +77 -0
- data/spec/models/base_deal_spec.rb +347 -0
- data/spec/models/base_mail_thread_all_of_parties_spec.rb +47 -0
- data/spec/models/base_mail_thread_all_of_spec.rb +167 -0
- data/spec/models/base_mail_thread_messages_all_of_spec.rb +113 -0
- data/spec/models/base_mail_thread_messages_spec.rb +203 -0
- data/spec/models/base_mail_thread_spec.rb +257 -0
- data/spec/models/base_note_deal_title_spec.rb +41 -0
- data/spec/models/base_note_organization_spec.rb +41 -0
- data/spec/models/base_note_person_spec.rb +41 -0
- data/spec/models/base_note_spec.rb +137 -0
- data/spec/models/base_response_spec.rb +41 -0
- data/spec/models/base_role_spec.rb +47 -0
- data/spec/models/base_stage_spec.rb +99 -0
- data/spec/models/base_team_all_of1_spec.rb +47 -0
- data/spec/models/base_team_all_of_spec.rb +41 -0
- data/spec/models/base_team_spec.rb +89 -0
- data/spec/models/base_user_me_all_of_language_spec.rb +47 -0
- data/spec/models/base_user_me_all_of_spec.rb +71 -0
- data/spec/models/base_user_me_spec.rb +191 -0
- data/spec/models/base_user_spec.rb +155 -0
- data/spec/models/basic_deal_product_spec.rb +77 -0
- data/spec/models/basic_deal_spec.rb +105 -0
- data/spec/models/basic_goal_spec.rb +75 -0
- data/spec/models/basic_organization_spec.rb +53 -0
- data/spec/models/basic_person_field_spec.rb +47 -0
- data/spec/models/basic_person_spec.rb +71 -0
- data/spec/models/basic_product_field_spec.rb +47 -0
- data/spec/models/common_mail_thread_spec.rb +125 -0
- data/spec/models/create_remote_file_and_link_it_to_item_spec.rb +47 -0
- data/spec/models/create_team_spec.rb +59 -0
- data/spec/models/currencies_spec.rb +47 -0
- data/spec/models/deal_non_strict_mode_fields_creator_user_id_spec.rb +77 -0
- data/spec/models/deal_non_strict_mode_fields_spec.rb +65 -0
- data/spec/models/deal_organization_data_spec.rb +71 -0
- data/spec/models/deal_person_data_email_spec.rb +53 -0
- data/spec/models/deal_person_data_phone_spec.rb +53 -0
- data/spec/models/deal_person_data_spec.rb +59 -0
- data/spec/models/deal_strict_mode_fields_spec.rb +65 -0
- data/spec/models/deal_summary_per_currency_full_currencyid_spec.rb +47 -0
- data/spec/models/deal_summary_per_currency_full_spec.rb +41 -0
- data/spec/models/deal_summary_per_currency_spec.rb +41 -0
- data/spec/models/deal_summary_per_stages_spec.rb +41 -0
- data/spec/models/deal_summary_per_stages_stageid_spec.rb +41 -0
- data/spec/models/deal_summary_per_stages_stageidcurrencyid_spec.rb +65 -0
- data/spec/models/deal_summary_spec.rb +59 -0
- data/spec/models/deal_user_data_spec.rb +71 -0
- data/spec/models/delete_deal_data_spec.rb +41 -0
- data/spec/models/delete_deal_follower_data_spec.rb +41 -0
- data/spec/models/delete_deal_follower_spec.rb +47 -0
- data/spec/models/delete_deal_participant_data_spec.rb +41 -0
- data/spec/models/delete_deal_participant_spec.rb +47 -0
- data/spec/models/delete_deal_product_data_spec.rb +47 -0
- data/spec/models/delete_deal_product_spec.rb +47 -0
- data/spec/models/delete_deal_spec.rb +47 -0
- data/spec/models/delete_file_data_spec.rb +41 -0
- data/spec/models/delete_file_spec.rb +47 -0
- data/spec/models/delete_multiple_deals_all_of_data_spec.rb +41 -0
- data/spec/models/delete_multiple_deals_all_of_spec.rb +47 -0
- data/spec/models/delete_multiple_deals_spec.rb +35 -0
- data/spec/models/delete_multiple_product_fields_response_data_spec.rb +41 -0
- data/spec/models/delete_multiple_product_fields_response_spec.rb +47 -0
- data/spec/models/delete_note_spec.rb +47 -0
- data/spec/models/delete_product_field_response_data_spec.rb +41 -0
- data/spec/models/delete_product_field_response_spec.rb +47 -0
- data/spec/models/delete_product_follower_response_data_spec.rb +41 -0
- data/spec/models/delete_product_follower_response_spec.rb +47 -0
- data/spec/models/delete_role_all_of_data_spec.rb +41 -0
- data/spec/models/delete_role_all_of_spec.rb +41 -0
- data/spec/models/delete_role_assignment_all_of_data_spec.rb +41 -0
- data/spec/models/delete_role_assignment_all_of_spec.rb +41 -0
- data/spec/models/delete_role_assignment_spec.rb +47 -0
- data/spec/models/delete_role_spec.rb +47 -0
- data/spec/models/edit_pipeline_all_of_spec.rb +41 -0
- data/spec/models/edit_pipeline_spec.rb +47 -0
- data/spec/models/fail_response_spec.rb +47 -0
- data/spec/models/field_type_spec.rb +45 -0
- data/spec/models/file_data_spec.rb +191 -0
- data/spec/models/filter_type_spec.rb +35 -0
- data/spec/models/find_products_by_name_response_data_spec.rb +77 -0
- data/spec/models/find_products_by_name_response_spec.rb +53 -0
- data/spec/models/full_role_all_of_spec.rb +41 -0
- data/spec/models/full_role_spec.rb +77 -0
- data/spec/models/get_add_product_attachement_details_spec.rb +47 -0
- data/spec/models/get_add_update_stage_spec.rb +47 -0
- data/spec/models/get_added_deal_additional_data_spec.rb +41 -0
- data/spec/models/get_added_deal_related_objects_spec.rb +53 -0
- data/spec/models/get_added_deal_spec.rb +59 -0
- data/spec/models/get_all_files_spec.rb +53 -0
- data/spec/models/get_all_pipelines_all_of_spec.rb +41 -0
- data/spec/models/get_all_pipelines_spec.rb +47 -0
- data/spec/models/get_all_product_fields_response_spec.rb +53 -0
- data/spec/models/get_deal_additional_data_spec.rb +41 -0
- data/spec/models/get_deal_spec.rb +59 -0
- data/spec/models/get_deals_by_name_additional_data_spec.rb +41 -0
- data/spec/models/get_deals_by_name_data_spec.rb +113 -0
- data/spec/models/get_deals_by_name_spec.rb +53 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_all_of_data_spec.rb +53 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_all_of_data_stage_conversions_spec.rb +53 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_all_of_spec.rb +41 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_spec.rb +47 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days_by_stages_spec.rb +47 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days_spec.rb +47 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_movements_between_stages_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_new_deals_formatted_values_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_new_deals_spec.rb +59 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_new_deals_values_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_spec.rb +71 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_spec.rb +47 -0
- data/spec/models/get_deals_spec.rb +59 -0
- data/spec/models/get_deals_summary_data_spec.rb +77 -0
- data/spec/models/get_deals_summary_data_values_total_spec.rb +65 -0
- data/spec/models/get_deals_summary_data_weighted_values_total_spec.rb +53 -0
- data/spec/models/get_deals_summary_spec.rb +47 -0
- data/spec/models/get_deals_timeline_data_spec.rb +59 -0
- data/spec/models/get_deals_timeline_data_totals_spec.rb +83 -0
- data/spec/models/get_deals_timeline_spec.rb +47 -0
- data/spec/models/get_duplicated_deal_spec.rb +47 -0
- data/spec/models/get_merged_deal_spec.rb +47 -0
- data/spec/models/get_notes_spec.rb +53 -0
- data/spec/models/get_one_file_spec.rb +47 -0
- data/spec/models/get_one_pipeline_all_of_spec.rb +41 -0
- data/spec/models/get_one_pipeline_spec.rb +47 -0
- data/spec/models/get_one_stage_spec.rb +47 -0
- data/spec/models/get_product_attachement_details_spec.rb +47 -0
- data/spec/models/get_product_field_response_spec.rb +47 -0
- data/spec/models/get_role_all_of_additional_data_spec.rb +41 -0
- data/spec/models/get_role_all_of_spec.rb +47 -0
- data/spec/models/get_role_assignments_all_of_spec.rb +47 -0
- data/spec/models/get_role_assignments_spec.rb +53 -0
- data/spec/models/get_role_settings_all_of_spec.rb +41 -0
- data/spec/models/get_role_settings_spec.rb +47 -0
- data/spec/models/get_role_spec.rb +53 -0
- data/spec/models/get_role_subroles_all_of_spec.rb +47 -0
- data/spec/models/get_role_subroles_spec.rb +53 -0
- data/spec/models/get_roles_all_of_spec.rb +47 -0
- data/spec/models/get_roles_spec.rb +53 -0
- data/spec/models/get_stage_deals_spec.rb +53 -0
- data/spec/models/get_stages_spec.rb +47 -0
- data/spec/models/global_message_base_response_spec.rb +41 -0
- data/spec/models/global_message_data_spec.rb +71 -0
- data/spec/models/global_message_delete_all_of_spec.rb +53 -0
- data/spec/models/global_message_delete_spec.rb +59 -0
- data/spec/models/global_message_get_all_of_spec.rb +53 -0
- data/spec/models/global_message_get_spec.rb +59 -0
- data/spec/models/global_message_user_data_spec.rb +53 -0
- data/spec/models/icon_key_spec.rb +35 -0
- data/spec/models/inline_object10_spec.rb +67 -0
- data/spec/models/inline_object11_spec.rb +47 -0
- data/spec/models/inline_object12_spec.rb +53 -0
- data/spec/models/inline_object13_spec.rb +47 -0
- data/spec/models/inline_object14_spec.rb +83 -0
- data/spec/models/inline_object15_spec.rb +89 -0
- data/spec/models/inline_object16_spec.rb +51 -0
- data/spec/models/inline_object17_spec.rb +47 -0
- data/spec/models/inline_object18_spec.rb +59 -0
- data/spec/models/inline_object19_spec.rb +41 -0
- data/spec/models/inline_object1_spec.rb +59 -0
- data/spec/models/inline_object20_spec.rb +41 -0
- data/spec/models/inline_object21_spec.rb +41 -0
- data/spec/models/inline_object22_spec.rb +41 -0
- data/spec/models/inline_object23_spec.rb +65 -0
- data/spec/models/inline_object24_spec.rb +41 -0
- data/spec/models/inline_object25_spec.rb +41 -0
- data/spec/models/inline_object26_spec.rb +51 -0
- data/spec/models/inline_object27_spec.rb +41 -0
- data/spec/models/inline_object28_spec.rb +41 -0
- data/spec/models/inline_object29_spec.rb +53 -0
- data/spec/models/inline_object2_spec.rb +105 -0
- data/spec/models/inline_object30_spec.rb +41 -0
- data/spec/models/inline_object31_spec.rb +41 -0
- data/spec/models/inline_object32_spec.rb +41 -0
- data/spec/models/inline_object33_spec.rb +79 -0
- data/spec/models/inline_object3_spec.rb +41 -0
- data/spec/models/inline_object4_spec.rb +41 -0
- data/spec/models/inline_object5_spec.rb +41 -0
- data/spec/models/inline_object6_spec.rb +41 -0
- data/spec/models/inline_object7_spec.rb +47 -0
- data/spec/models/inline_object8_spec.rb +71 -0
- data/spec/models/inline_object9_spec.rb +77 -0
- data/spec/models/inline_object_spec.rb +53 -0
- data/spec/models/inline_response20010_data_spec.rb +41 -0
- data/spec/models/inline_response20010_spec.rb +47 -0
- data/spec/models/inline_response20011_data_spec.rb +41 -0
- data/spec/models/inline_response20011_spec.rb +47 -0
- data/spec/models/inline_response2001_spec.rb +47 -0
- data/spec/models/inline_response2002_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +41 -0
- data/spec/models/inline_response2004_spec.rb +53 -0
- data/spec/models/inline_response2005_spec.rb +41 -0
- data/spec/models/inline_response2006_spec.rb +47 -0
- data/spec/models/inline_response2007_data_spec.rb +65 -0
- data/spec/models/inline_response2007_spec.rb +47 -0
- data/spec/models/inline_response2008_data_spec.rb +41 -0
- data/spec/models/inline_response2008_spec.rb +47 -0
- data/spec/models/inline_response2009_data_spec.rb +41 -0
- data/spec/models/inline_response2009_spec.rb +47 -0
- data/spec/models/inline_response200_additional_data_spec.rb +53 -0
- data/spec/models/inline_response200_spec.rb +53 -0
- data/spec/models/inline_response201_data_spec.rb +131 -0
- data/spec/models/inline_response201_spec.rb +47 -0
- data/spec/models/inline_response400_spec.rb +65 -0
- data/spec/models/inline_response403_spec.rb +65 -0
- data/spec/models/inline_response4041_spec.rb +65 -0
- data/spec/models/inline_response404_spec.rb +65 -0
- data/spec/models/inline_response409_spec.rb +65 -0
- data/spec/models/inline_response410_spec.rb +65 -0
- data/spec/models/inline_response500_spec.rb +65 -0
- data/spec/models/leads_value_spec.rb +47 -0
- data/spec/models/link_remote_file_to_item_spec.rb +47 -0
- data/spec/models/mail_message_all_of_spec.rb +41 -0
- data/spec/models/mail_message_data_spec.rb +213 -0
- data/spec/models/mail_message_spec.rb +65 -0
- data/spec/models/mail_participant_spec.rb +71 -0
- data/spec/models/mail_service_base_response_spec.rb +59 -0
- data/spec/models/mail_thread_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_delete_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_delete_spec.rb +47 -0
- data/spec/models/mail_thread_messages_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_messages_spec.rb +47 -0
- data/spec/models/mail_thread_one_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_one_spec.rb +47 -0
- data/spec/models/mail_thread_participant_spec.rb +89 -0
- data/spec/models/mail_thread_put_spec.rb +47 -0
- data/spec/models/mail_thread_spec.rb +47 -0
- data/spec/models/new_deal_all_of_spec.rb +41 -0
- data/spec/models/new_deal_product_all_of_spec.rb +41 -0
- data/spec/models/new_deal_product_spec.rb +83 -0
- data/spec/models/new_deal_spec.rb +111 -0
- data/spec/models/new_follower_response_data_spec.rb +59 -0
- data/spec/models/new_follower_response_spec.rb +47 -0
- data/spec/models/new_goal_spec.rb +35 -0
- data/spec/models/new_organization_all_of_spec.rb +41 -0
- data/spec/models/new_organization_field_spec.rb +57 -0
- data/spec/models/new_organization_spec.rb +59 -0
- data/spec/models/new_person_all_of_spec.rb +41 -0
- data/spec/models/new_person_field_spec.rb +57 -0
- data/spec/models/new_person_spec.rb +77 -0
- data/spec/models/new_product_field_all_of_spec.rb +57 -0
- data/spec/models/new_product_field_spec.rb +57 -0
- data/spec/models/note_creator_user_spec.rb +59 -0
- data/spec/models/note_spec.rb +89 -0
- data/spec/models/number_boolean_default0_spec.rb +35 -0
- data/spec/models/number_boolean_default1_spec.rb +35 -0
- data/spec/models/number_boolean_spec.rb +35 -0
- data/spec/models/organization_relationship_spec.rb +63 -0
- data/spec/models/permission_sets_all_of_spec.rb +41 -0
- data/spec/models/permission_sets_item_spec.rb +53 -0
- data/spec/models/permission_sets_spec.rb +47 -0
- data/spec/models/pipeline_spec.rb +59 -0
- data/spec/models/post_note_spec.rb +47 -0
- data/spec/models/post_role_assignment_all_of_data_spec.rb +47 -0
- data/spec/models/post_role_assignment_all_of_spec.rb +41 -0
- data/spec/models/post_role_assignment_spec.rb +47 -0
- data/spec/models/post_role_settings_all_of_data_spec.rb +51 -0
- data/spec/models/post_role_settings_all_of_spec.rb +41 -0
- data/spec/models/post_role_settings_spec.rb +47 -0
- data/spec/models/post_roles_all_of_data_spec.rb +41 -0
- data/spec/models/post_roles_all_of_spec.rb +41 -0
- data/spec/models/post_roles_spec.rb +47 -0
- data/spec/models/product_attachement_fields_spec.rb +113 -0
- data/spec/models/product_field_all_of_spec.rb +125 -0
- data/spec/models/product_field_spec.rb +147 -0
- data/spec/models/product_spec.rb +83 -0
- data/spec/models/put_role_all_of_data_spec.rb +41 -0
- data/spec/models/put_role_all_of_spec.rb +41 -0
- data/spec/models/put_role_spec.rb +47 -0
- data/spec/models/role_assignment_all_of_spec.rb +59 -0
- data/spec/models/role_assignment_spec.rb +71 -0
- data/spec/models/role_settings_spec.rb +83 -0
- data/spec/models/roles_additional_data_pagination_spec.rb +53 -0
- data/spec/models/roles_additional_data_spec.rb +41 -0
- data/spec/models/single_permission_sets_item_all_of_spec.rb +41 -0
- data/spec/models/single_permission_sets_item_spec.rb +59 -0
- data/spec/models/stage_spec.rb +69 -0
- data/spec/models/sub_role_all_of_spec.rb +59 -0
- data/spec/models/sub_role_spec.rb +71 -0
- data/spec/models/teams_all_of_spec.rb +41 -0
- data/spec/models/teams_spec.rb +47 -0
- data/spec/models/unauthorized_spec.rb +53 -0
- data/spec/models/update_file_spec.rb +47 -0
- data/spec/models/update_team_all_of_spec.rb +47 -0
- data/spec/models/update_team_spec.rb +71 -0
- data/spec/models/user_all_of_spec.rb +41 -0
- data/spec/models/user_assignment_to_permission_set_spec.rb +59 -0
- data/spec/models/user_assignments_to_permission_set_all_of_spec.rb +41 -0
- data/spec/models/user_assignments_to_permission_set_spec.rb +47 -0
- data/spec/models/user_connections_all_of_data_spec.rb +41 -0
- data/spec/models/user_connections_all_of_spec.rb +41 -0
- data/spec/models/user_connections_spec.rb +47 -0
- data/spec/models/user_i_ds_all_of_spec.rb +41 -0
- data/spec/models/user_i_ds_spec.rb +47 -0
- data/spec/models/user_me_all_of_spec.rb +41 -0
- data/spec/models/user_me_spec.rb +47 -0
- data/spec/models/user_settings_all_of_spec.rb +41 -0
- data/spec/models/user_settings_item_spec.rb +95 -0
- data/spec/models/user_settings_spec.rb +47 -0
- data/spec/models/user_spec.rb +47 -0
- data/spec/models/users_all_of_spec.rb +41 -0
- data/spec/models/users_spec.rb +47 -0
- data/spec/models/visible_to_spec.rb +35 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1495 -0
data/docs/PersonsApi.md
ADDED
|
@@ -0,0 +1,1311 @@
|
|
|
1
|
+
# Pipedrive::PersonsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.pipedrive.com/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**persons_delete**](PersonsApi.md#persons_delete) | **DELETE** /persons | Delete multiple persons in bulk
|
|
8
|
+
[**persons_find_get**](PersonsApi.md#persons_find_get) | **GET** /persons/find | Find persons by name
|
|
9
|
+
[**persons_get**](PersonsApi.md#persons_get) | **GET** /persons | Get all persons
|
|
10
|
+
[**persons_id_activities_get**](PersonsApi.md#persons_id_activities_get) | **GET** /persons/{id}/activities | List activities associated with a person
|
|
11
|
+
[**persons_id_deals_get**](PersonsApi.md#persons_id_deals_get) | **GET** /persons/{id}/deals | List deals associated with a person
|
|
12
|
+
[**persons_id_delete**](PersonsApi.md#persons_id_delete) | **DELETE** /persons/{id} | Delete a person
|
|
13
|
+
[**persons_id_files_get**](PersonsApi.md#persons_id_files_get) | **GET** /persons/{id}/files | List files attached to a person
|
|
14
|
+
[**persons_id_flow_get**](PersonsApi.md#persons_id_flow_get) | **GET** /persons/{id}/flow | List updates about a person
|
|
15
|
+
[**persons_id_followers_follower_id_delete**](PersonsApi.md#persons_id_followers_follower_id_delete) | **DELETE** /persons/{id}/followers/{follower_id} | Deletes a follower from a person.
|
|
16
|
+
[**persons_id_followers_get**](PersonsApi.md#persons_id_followers_get) | **GET** /persons/{id}/followers | List followers of a person
|
|
17
|
+
[**persons_id_followers_post**](PersonsApi.md#persons_id_followers_post) | **POST** /persons/{id}/followers | Add a follower to a person
|
|
18
|
+
[**persons_id_get**](PersonsApi.md#persons_id_get) | **GET** /persons/{id} | Get details of a person
|
|
19
|
+
[**persons_id_mail_messages_get**](PersonsApi.md#persons_id_mail_messages_get) | **GET** /persons/{id}/mailMessages | List mail messages associated with a person
|
|
20
|
+
[**persons_id_merge_put**](PersonsApi.md#persons_id_merge_put) | **PUT** /persons/{id}/merge | Merge two persons
|
|
21
|
+
[**persons_id_permitted_users_get**](PersonsApi.md#persons_id_permitted_users_get) | **GET** /persons/{id}/permittedUsers | List permitted users
|
|
22
|
+
[**persons_id_picture_delete**](PersonsApi.md#persons_id_picture_delete) | **DELETE** /persons/{id}/picture | Delete person picture
|
|
23
|
+
[**persons_id_picture_post**](PersonsApi.md#persons_id_picture_post) | **POST** /persons/{id}/picture | Add person picture
|
|
24
|
+
[**persons_id_products_get**](PersonsApi.md#persons_id_products_get) | **GET** /persons/{id}/products | List products associated with a person
|
|
25
|
+
[**persons_id_put**](PersonsApi.md#persons_id_put) | **PUT** /persons/{id} | Update a person
|
|
26
|
+
[**persons_post**](PersonsApi.md#persons_post) | **POST** /persons | Add a person
|
|
27
|
+
[**persons_search_get**](PersonsApi.md#persons_search_get) | **GET** /persons/search | Search persons
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## persons_delete
|
|
32
|
+
|
|
33
|
+
> persons_delete(opts)
|
|
34
|
+
|
|
35
|
+
Delete multiple persons in bulk
|
|
36
|
+
|
|
37
|
+
Marks multiple persons as deleted.
|
|
38
|
+
|
|
39
|
+
### Example
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
# load the gem
|
|
43
|
+
require 'pipedrive-openapi-client'
|
|
44
|
+
# setup authorization
|
|
45
|
+
Pipedrive.configure do |config|
|
|
46
|
+
# Configure API key authorization: api_key
|
|
47
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
48
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
49
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
50
|
+
|
|
51
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
52
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
56
|
+
opts = {
|
|
57
|
+
ids: 'ids_example' # String | Comma-separated IDs that will be deleted
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
begin
|
|
61
|
+
#Delete multiple persons in bulk
|
|
62
|
+
api_instance.persons_delete(opts)
|
|
63
|
+
rescue Pipedrive::ApiError => e
|
|
64
|
+
puts "Exception when calling PersonsApi->persons_delete: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
Name | Type | Description | Notes
|
|
72
|
+
------------- | ------------- | ------------- | -------------
|
|
73
|
+
**ids** | **String**| Comma-separated IDs that will be deleted | [optional]
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
nil (empty response body)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: Not defined
|
|
86
|
+
- **Accept**: Not defined
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## persons_find_get
|
|
90
|
+
|
|
91
|
+
> persons_find_get(term, opts)
|
|
92
|
+
|
|
93
|
+
Find persons by name
|
|
94
|
+
|
|
95
|
+
<strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_search\">/v1/persons/search</a> or <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Searches all persons by their name.
|
|
96
|
+
|
|
97
|
+
### Example
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
# load the gem
|
|
101
|
+
require 'pipedrive-openapi-client'
|
|
102
|
+
# setup authorization
|
|
103
|
+
Pipedrive.configure do |config|
|
|
104
|
+
# Configure API key authorization: api_key
|
|
105
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
106
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
107
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
108
|
+
|
|
109
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
110
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
114
|
+
term = 'term_example' # String | Search term to look for
|
|
115
|
+
opts = {
|
|
116
|
+
org_id: 56, # Integer | ID of the organization person is associated with.
|
|
117
|
+
start: 0, # Integer | Pagination start
|
|
118
|
+
limit: 56, # Integer | Items shown per page
|
|
119
|
+
search_by_email: Pipedrive::NumberBoolean.new # NumberBoolean | When enabled, term will only be matched against email addresses of people. Default: false
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
begin
|
|
123
|
+
#Find persons by name
|
|
124
|
+
api_instance.persons_find_get(term, opts)
|
|
125
|
+
rescue Pipedrive::ApiError => e
|
|
126
|
+
puts "Exception when calling PersonsApi->persons_find_get: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Parameters
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
Name | Type | Description | Notes
|
|
134
|
+
------------- | ------------- | ------------- | -------------
|
|
135
|
+
**term** | **String**| Search term to look for |
|
|
136
|
+
**org_id** | **Integer**| ID of the organization person is associated with. | [optional]
|
|
137
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
138
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
139
|
+
**search_by_email** | [**NumberBoolean**](.md)| When enabled, term will only be matched against email addresses of people. Default: false | [optional]
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
nil (empty response body)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: Not defined
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
## persons_get
|
|
156
|
+
|
|
157
|
+
> persons_get(opts)
|
|
158
|
+
|
|
159
|
+
Get all persons
|
|
160
|
+
|
|
161
|
+
Returns all persons
|
|
162
|
+
|
|
163
|
+
### Example
|
|
164
|
+
|
|
165
|
+
```ruby
|
|
166
|
+
# load the gem
|
|
167
|
+
require 'pipedrive-openapi-client'
|
|
168
|
+
# setup authorization
|
|
169
|
+
Pipedrive.configure do |config|
|
|
170
|
+
# Configure API key authorization: api_key
|
|
171
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
172
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
173
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
174
|
+
|
|
175
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
176
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
180
|
+
opts = {
|
|
181
|
+
user_id: 56, # Integer | If supplied, only persons owned by the given user will be returned.
|
|
182
|
+
filter_id: 56, # Integer | ID of the filter to use.
|
|
183
|
+
first_char: 'first_char_example', # String | If supplied, only persons whose name starts with the specified letter will be returned (case insensitive).
|
|
184
|
+
start: 0, # Integer | Pagination start
|
|
185
|
+
limit: 56, # Integer | Items shown per page
|
|
186
|
+
sort: 'sort_example' # String | Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
begin
|
|
190
|
+
#Get all persons
|
|
191
|
+
api_instance.persons_get(opts)
|
|
192
|
+
rescue Pipedrive::ApiError => e
|
|
193
|
+
puts "Exception when calling PersonsApi->persons_get: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
Name | Type | Description | Notes
|
|
201
|
+
------------- | ------------- | ------------- | -------------
|
|
202
|
+
**user_id** | **Integer**| If supplied, only persons owned by the given user will be returned. | [optional]
|
|
203
|
+
**filter_id** | **Integer**| ID of the filter to use. | [optional]
|
|
204
|
+
**first_char** | **String**| If supplied, only persons whose name starts with the specified letter will be returned (case insensitive). | [optional]
|
|
205
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
206
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
207
|
+
**sort** | **String**| Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). | [optional]
|
|
208
|
+
|
|
209
|
+
### Return type
|
|
210
|
+
|
|
211
|
+
nil (empty response body)
|
|
212
|
+
|
|
213
|
+
### Authorization
|
|
214
|
+
|
|
215
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
216
|
+
|
|
217
|
+
### HTTP request headers
|
|
218
|
+
|
|
219
|
+
- **Content-Type**: Not defined
|
|
220
|
+
- **Accept**: Not defined
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
## persons_id_activities_get
|
|
224
|
+
|
|
225
|
+
> persons_id_activities_get(id, opts)
|
|
226
|
+
|
|
227
|
+
List activities associated with a person
|
|
228
|
+
|
|
229
|
+
Lists activities associated with a person.
|
|
230
|
+
|
|
231
|
+
### Example
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
# load the gem
|
|
235
|
+
require 'pipedrive-openapi-client'
|
|
236
|
+
# setup authorization
|
|
237
|
+
Pipedrive.configure do |config|
|
|
238
|
+
# Configure API key authorization: api_key
|
|
239
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
240
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
241
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
242
|
+
|
|
243
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
244
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
248
|
+
id = 56 # Integer | ID of a person
|
|
249
|
+
opts = {
|
|
250
|
+
start: 0, # Integer | Pagination start
|
|
251
|
+
limit: 56, # Integer | Items shown per page
|
|
252
|
+
done: Pipedrive::NumberBoolean.new, # NumberBoolean | Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
|
|
253
|
+
exclude: 'exclude_example' # String | A comma-separated string of activity IDs to exclude from result
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
begin
|
|
257
|
+
#List activities associated with a person
|
|
258
|
+
api_instance.persons_id_activities_get(id, opts)
|
|
259
|
+
rescue Pipedrive::ApiError => e
|
|
260
|
+
puts "Exception when calling PersonsApi->persons_id_activities_get: #{e}"
|
|
261
|
+
end
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
Name | Type | Description | Notes
|
|
268
|
+
------------- | ------------- | ------------- | -------------
|
|
269
|
+
**id** | **Integer**| ID of a person |
|
|
270
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
271
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
272
|
+
**done** | [**NumberBoolean**](.md)| Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities. | [optional]
|
|
273
|
+
**exclude** | **String**| A comma-separated string of activity IDs to exclude from result | [optional]
|
|
274
|
+
|
|
275
|
+
### Return type
|
|
276
|
+
|
|
277
|
+
nil (empty response body)
|
|
278
|
+
|
|
279
|
+
### Authorization
|
|
280
|
+
|
|
281
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
282
|
+
|
|
283
|
+
### HTTP request headers
|
|
284
|
+
|
|
285
|
+
- **Content-Type**: Not defined
|
|
286
|
+
- **Accept**: Not defined
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
## persons_id_deals_get
|
|
290
|
+
|
|
291
|
+
> persons_id_deals_get(id, opts)
|
|
292
|
+
|
|
293
|
+
List deals associated with a person
|
|
294
|
+
|
|
295
|
+
Lists deals associated with a person.
|
|
296
|
+
|
|
297
|
+
### Example
|
|
298
|
+
|
|
299
|
+
```ruby
|
|
300
|
+
# load the gem
|
|
301
|
+
require 'pipedrive-openapi-client'
|
|
302
|
+
# setup authorization
|
|
303
|
+
Pipedrive.configure do |config|
|
|
304
|
+
# Configure API key authorization: api_key
|
|
305
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
306
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
307
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
308
|
+
|
|
309
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
310
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
314
|
+
id = 56 # Integer | ID of a person
|
|
315
|
+
opts = {
|
|
316
|
+
start: 0, # Integer | Pagination start
|
|
317
|
+
limit: 56, # Integer | Items shown per page
|
|
318
|
+
status: 'all_not_deleted', # String | Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
|
|
319
|
+
sort: 'sort_example' # String | Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
begin
|
|
323
|
+
#List deals associated with a person
|
|
324
|
+
api_instance.persons_id_deals_get(id, opts)
|
|
325
|
+
rescue Pipedrive::ApiError => e
|
|
326
|
+
puts "Exception when calling PersonsApi->persons_id_deals_get: #{e}"
|
|
327
|
+
end
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Parameters
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
Name | Type | Description | Notes
|
|
334
|
+
------------- | ------------- | ------------- | -------------
|
|
335
|
+
**id** | **Integer**| ID of a person |
|
|
336
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
337
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
338
|
+
**status** | **String**| Only fetch deals with specific status. If omitted, all not deleted deals are fetched. | [optional] [default to 'all_not_deleted']
|
|
339
|
+
**sort** | **String**| Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). | [optional]
|
|
340
|
+
|
|
341
|
+
### Return type
|
|
342
|
+
|
|
343
|
+
nil (empty response body)
|
|
344
|
+
|
|
345
|
+
### Authorization
|
|
346
|
+
|
|
347
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
348
|
+
|
|
349
|
+
### HTTP request headers
|
|
350
|
+
|
|
351
|
+
- **Content-Type**: Not defined
|
|
352
|
+
- **Accept**: Not defined
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
## persons_id_delete
|
|
356
|
+
|
|
357
|
+
> persons_id_delete(id)
|
|
358
|
+
|
|
359
|
+
Delete a person
|
|
360
|
+
|
|
361
|
+
Marks a person as deleted.
|
|
362
|
+
|
|
363
|
+
### Example
|
|
364
|
+
|
|
365
|
+
```ruby
|
|
366
|
+
# load the gem
|
|
367
|
+
require 'pipedrive-openapi-client'
|
|
368
|
+
# setup authorization
|
|
369
|
+
Pipedrive.configure do |config|
|
|
370
|
+
# Configure API key authorization: api_key
|
|
371
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
372
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
373
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
374
|
+
|
|
375
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
376
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
380
|
+
id = 56 # Integer | ID of a person
|
|
381
|
+
|
|
382
|
+
begin
|
|
383
|
+
#Delete a person
|
|
384
|
+
api_instance.persons_id_delete(id)
|
|
385
|
+
rescue Pipedrive::ApiError => e
|
|
386
|
+
puts "Exception when calling PersonsApi->persons_id_delete: #{e}"
|
|
387
|
+
end
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
### Parameters
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
Name | Type | Description | Notes
|
|
394
|
+
------------- | ------------- | ------------- | -------------
|
|
395
|
+
**id** | **Integer**| ID of a person |
|
|
396
|
+
|
|
397
|
+
### Return type
|
|
398
|
+
|
|
399
|
+
nil (empty response body)
|
|
400
|
+
|
|
401
|
+
### Authorization
|
|
402
|
+
|
|
403
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
404
|
+
|
|
405
|
+
### HTTP request headers
|
|
406
|
+
|
|
407
|
+
- **Content-Type**: Not defined
|
|
408
|
+
- **Accept**: Not defined
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
## persons_id_files_get
|
|
412
|
+
|
|
413
|
+
> persons_id_files_get(id, opts)
|
|
414
|
+
|
|
415
|
+
List files attached to a person
|
|
416
|
+
|
|
417
|
+
Lists files associated with a person.
|
|
418
|
+
|
|
419
|
+
### Example
|
|
420
|
+
|
|
421
|
+
```ruby
|
|
422
|
+
# load the gem
|
|
423
|
+
require 'pipedrive-openapi-client'
|
|
424
|
+
# setup authorization
|
|
425
|
+
Pipedrive.configure do |config|
|
|
426
|
+
# Configure API key authorization: api_key
|
|
427
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
428
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
429
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
430
|
+
|
|
431
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
432
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
433
|
+
end
|
|
434
|
+
|
|
435
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
436
|
+
id = 56 # Integer | ID of a person
|
|
437
|
+
opts = {
|
|
438
|
+
start: 0, # Integer | Pagination start
|
|
439
|
+
limit: 56, # Integer | Items shown per page
|
|
440
|
+
include_deleted_files: Pipedrive::NumberBoolean.new, # NumberBoolean | When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
|
441
|
+
sort: 'sort_example' # String | Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
begin
|
|
445
|
+
#List files attached to a person
|
|
446
|
+
api_instance.persons_id_files_get(id, opts)
|
|
447
|
+
rescue Pipedrive::ApiError => e
|
|
448
|
+
puts "Exception when calling PersonsApi->persons_id_files_get: #{e}"
|
|
449
|
+
end
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Parameters
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
Name | Type | Description | Notes
|
|
456
|
+
------------- | ------------- | ------------- | -------------
|
|
457
|
+
**id** | **Integer**| ID of a person |
|
|
458
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
459
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
460
|
+
**include_deleted_files** | [**NumberBoolean**](.md)| When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work. | [optional]
|
|
461
|
+
**sort** | **String**| Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment. | [optional]
|
|
462
|
+
|
|
463
|
+
### Return type
|
|
464
|
+
|
|
465
|
+
nil (empty response body)
|
|
466
|
+
|
|
467
|
+
### Authorization
|
|
468
|
+
|
|
469
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
470
|
+
|
|
471
|
+
### HTTP request headers
|
|
472
|
+
|
|
473
|
+
- **Content-Type**: Not defined
|
|
474
|
+
- **Accept**: Not defined
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
## persons_id_flow_get
|
|
478
|
+
|
|
479
|
+
> persons_id_flow_get(id, opts)
|
|
480
|
+
|
|
481
|
+
List updates about a person
|
|
482
|
+
|
|
483
|
+
Lists updates about a person.
|
|
484
|
+
|
|
485
|
+
### Example
|
|
486
|
+
|
|
487
|
+
```ruby
|
|
488
|
+
# load the gem
|
|
489
|
+
require 'pipedrive-openapi-client'
|
|
490
|
+
# setup authorization
|
|
491
|
+
Pipedrive.configure do |config|
|
|
492
|
+
# Configure API key authorization: api_key
|
|
493
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
494
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
495
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
496
|
+
|
|
497
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
498
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
502
|
+
id = 56 # Integer | ID of a person
|
|
503
|
+
opts = {
|
|
504
|
+
start: 0, # Integer | Pagination start
|
|
505
|
+
limit: 56, # Integer | Items shown per page
|
|
506
|
+
all_changes: 'all_changes_example', # String | Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
507
|
+
items: 'items_example' # String | A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
begin
|
|
511
|
+
#List updates about a person
|
|
512
|
+
api_instance.persons_id_flow_get(id, opts)
|
|
513
|
+
rescue Pipedrive::ApiError => e
|
|
514
|
+
puts "Exception when calling PersonsApi->persons_id_flow_get: #{e}"
|
|
515
|
+
end
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
### Parameters
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
Name | Type | Description | Notes
|
|
522
|
+
------------- | ------------- | ------------- | -------------
|
|
523
|
+
**id** | **Integer**| ID of a person |
|
|
524
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
525
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
526
|
+
**all_changes** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional]
|
|
527
|
+
**items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document) | [optional]
|
|
528
|
+
|
|
529
|
+
### Return type
|
|
530
|
+
|
|
531
|
+
nil (empty response body)
|
|
532
|
+
|
|
533
|
+
### Authorization
|
|
534
|
+
|
|
535
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
536
|
+
|
|
537
|
+
### HTTP request headers
|
|
538
|
+
|
|
539
|
+
- **Content-Type**: Not defined
|
|
540
|
+
- **Accept**: Not defined
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
## persons_id_followers_follower_id_delete
|
|
544
|
+
|
|
545
|
+
> persons_id_followers_follower_id_delete(id, follower_id)
|
|
546
|
+
|
|
547
|
+
Deletes a follower from a person.
|
|
548
|
+
|
|
549
|
+
Delete a follower from a person
|
|
550
|
+
|
|
551
|
+
### Example
|
|
552
|
+
|
|
553
|
+
```ruby
|
|
554
|
+
# load the gem
|
|
555
|
+
require 'pipedrive-openapi-client'
|
|
556
|
+
# setup authorization
|
|
557
|
+
Pipedrive.configure do |config|
|
|
558
|
+
# Configure API key authorization: api_key
|
|
559
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
560
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
561
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
562
|
+
end
|
|
563
|
+
|
|
564
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
565
|
+
id = 56 # Integer | ID of a person
|
|
566
|
+
follower_id = 56 # Integer | ID of the follower
|
|
567
|
+
|
|
568
|
+
begin
|
|
569
|
+
#Deletes a follower from a person.
|
|
570
|
+
api_instance.persons_id_followers_follower_id_delete(id, follower_id)
|
|
571
|
+
rescue Pipedrive::ApiError => e
|
|
572
|
+
puts "Exception when calling PersonsApi->persons_id_followers_follower_id_delete: #{e}"
|
|
573
|
+
end
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
### Parameters
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
Name | Type | Description | Notes
|
|
580
|
+
------------- | ------------- | ------------- | -------------
|
|
581
|
+
**id** | **Integer**| ID of a person |
|
|
582
|
+
**follower_id** | **Integer**| ID of the follower |
|
|
583
|
+
|
|
584
|
+
### Return type
|
|
585
|
+
|
|
586
|
+
nil (empty response body)
|
|
587
|
+
|
|
588
|
+
### Authorization
|
|
589
|
+
|
|
590
|
+
[api_key](../README.md#api_key)
|
|
591
|
+
|
|
592
|
+
### HTTP request headers
|
|
593
|
+
|
|
594
|
+
- **Content-Type**: Not defined
|
|
595
|
+
- **Accept**: Not defined
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
## persons_id_followers_get
|
|
599
|
+
|
|
600
|
+
> persons_id_followers_get(id)
|
|
601
|
+
|
|
602
|
+
List followers of a person
|
|
603
|
+
|
|
604
|
+
Lists the followers of a person.
|
|
605
|
+
|
|
606
|
+
### Example
|
|
607
|
+
|
|
608
|
+
```ruby
|
|
609
|
+
# load the gem
|
|
610
|
+
require 'pipedrive-openapi-client'
|
|
611
|
+
# setup authorization
|
|
612
|
+
Pipedrive.configure do |config|
|
|
613
|
+
# Configure API key authorization: api_key
|
|
614
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
615
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
616
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
617
|
+
|
|
618
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
619
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
620
|
+
end
|
|
621
|
+
|
|
622
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
623
|
+
id = 56 # Integer | ID of a person
|
|
624
|
+
|
|
625
|
+
begin
|
|
626
|
+
#List followers of a person
|
|
627
|
+
api_instance.persons_id_followers_get(id)
|
|
628
|
+
rescue Pipedrive::ApiError => e
|
|
629
|
+
puts "Exception when calling PersonsApi->persons_id_followers_get: #{e}"
|
|
630
|
+
end
|
|
631
|
+
```
|
|
632
|
+
|
|
633
|
+
### Parameters
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
Name | Type | Description | Notes
|
|
637
|
+
------------- | ------------- | ------------- | -------------
|
|
638
|
+
**id** | **Integer**| ID of a person |
|
|
639
|
+
|
|
640
|
+
### Return type
|
|
641
|
+
|
|
642
|
+
nil (empty response body)
|
|
643
|
+
|
|
644
|
+
### Authorization
|
|
645
|
+
|
|
646
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
647
|
+
|
|
648
|
+
### HTTP request headers
|
|
649
|
+
|
|
650
|
+
- **Content-Type**: Not defined
|
|
651
|
+
- **Accept**: Not defined
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
## persons_id_followers_post
|
|
655
|
+
|
|
656
|
+
> persons_id_followers_post(id, user_id)
|
|
657
|
+
|
|
658
|
+
Add a follower to a person
|
|
659
|
+
|
|
660
|
+
Adds a follower to a person.
|
|
661
|
+
|
|
662
|
+
### Example
|
|
663
|
+
|
|
664
|
+
```ruby
|
|
665
|
+
# load the gem
|
|
666
|
+
require 'pipedrive-openapi-client'
|
|
667
|
+
# setup authorization
|
|
668
|
+
Pipedrive.configure do |config|
|
|
669
|
+
# Configure API key authorization: api_key
|
|
670
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
671
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
672
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
673
|
+
|
|
674
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
675
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
676
|
+
end
|
|
677
|
+
|
|
678
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
679
|
+
id = 56 # Integer | ID of a person
|
|
680
|
+
user_id = 56 # Integer | ID of the user
|
|
681
|
+
|
|
682
|
+
begin
|
|
683
|
+
#Add a follower to a person
|
|
684
|
+
api_instance.persons_id_followers_post(id, user_id)
|
|
685
|
+
rescue Pipedrive::ApiError => e
|
|
686
|
+
puts "Exception when calling PersonsApi->persons_id_followers_post: #{e}"
|
|
687
|
+
end
|
|
688
|
+
```
|
|
689
|
+
|
|
690
|
+
### Parameters
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
Name | Type | Description | Notes
|
|
694
|
+
------------- | ------------- | ------------- | -------------
|
|
695
|
+
**id** | **Integer**| ID of a person |
|
|
696
|
+
**user_id** | **Integer**| ID of the user |
|
|
697
|
+
|
|
698
|
+
### Return type
|
|
699
|
+
|
|
700
|
+
nil (empty response body)
|
|
701
|
+
|
|
702
|
+
### Authorization
|
|
703
|
+
|
|
704
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
705
|
+
|
|
706
|
+
### HTTP request headers
|
|
707
|
+
|
|
708
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
709
|
+
- **Accept**: Not defined
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
## persons_id_get
|
|
713
|
+
|
|
714
|
+
> persons_id_get(id)
|
|
715
|
+
|
|
716
|
+
Get details of a person
|
|
717
|
+
|
|
718
|
+
Returns details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of personFields.
|
|
719
|
+
|
|
720
|
+
### Example
|
|
721
|
+
|
|
722
|
+
```ruby
|
|
723
|
+
# load the gem
|
|
724
|
+
require 'pipedrive-openapi-client'
|
|
725
|
+
# setup authorization
|
|
726
|
+
Pipedrive.configure do |config|
|
|
727
|
+
# Configure API key authorization: api_key
|
|
728
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
729
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
730
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
731
|
+
|
|
732
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
733
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
734
|
+
end
|
|
735
|
+
|
|
736
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
737
|
+
id = 56 # Integer | ID of a person
|
|
738
|
+
|
|
739
|
+
begin
|
|
740
|
+
#Get details of a person
|
|
741
|
+
api_instance.persons_id_get(id)
|
|
742
|
+
rescue Pipedrive::ApiError => e
|
|
743
|
+
puts "Exception when calling PersonsApi->persons_id_get: #{e}"
|
|
744
|
+
end
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
### Parameters
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
Name | Type | Description | Notes
|
|
751
|
+
------------- | ------------- | ------------- | -------------
|
|
752
|
+
**id** | **Integer**| ID of a person |
|
|
753
|
+
|
|
754
|
+
### Return type
|
|
755
|
+
|
|
756
|
+
nil (empty response body)
|
|
757
|
+
|
|
758
|
+
### Authorization
|
|
759
|
+
|
|
760
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
761
|
+
|
|
762
|
+
### HTTP request headers
|
|
763
|
+
|
|
764
|
+
- **Content-Type**: Not defined
|
|
765
|
+
- **Accept**: Not defined
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
## persons_id_mail_messages_get
|
|
769
|
+
|
|
770
|
+
> persons_id_mail_messages_get(id, opts)
|
|
771
|
+
|
|
772
|
+
List mail messages associated with a person
|
|
773
|
+
|
|
774
|
+
Lists mail messages associated with a person.
|
|
775
|
+
|
|
776
|
+
### Example
|
|
777
|
+
|
|
778
|
+
```ruby
|
|
779
|
+
# load the gem
|
|
780
|
+
require 'pipedrive-openapi-client'
|
|
781
|
+
# setup authorization
|
|
782
|
+
Pipedrive.configure do |config|
|
|
783
|
+
# Configure API key authorization: api_key
|
|
784
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
785
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
786
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
787
|
+
|
|
788
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
789
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
790
|
+
end
|
|
791
|
+
|
|
792
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
793
|
+
id = 56 # Integer | ID of a person
|
|
794
|
+
opts = {
|
|
795
|
+
start: 0, # Integer | Pagination start
|
|
796
|
+
limit: 56 # Integer | Items shown per page
|
|
797
|
+
}
|
|
798
|
+
|
|
799
|
+
begin
|
|
800
|
+
#List mail messages associated with a person
|
|
801
|
+
api_instance.persons_id_mail_messages_get(id, opts)
|
|
802
|
+
rescue Pipedrive::ApiError => e
|
|
803
|
+
puts "Exception when calling PersonsApi->persons_id_mail_messages_get: #{e}"
|
|
804
|
+
end
|
|
805
|
+
```
|
|
806
|
+
|
|
807
|
+
### Parameters
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
Name | Type | Description | Notes
|
|
811
|
+
------------- | ------------- | ------------- | -------------
|
|
812
|
+
**id** | **Integer**| ID of a person |
|
|
813
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
814
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
815
|
+
|
|
816
|
+
### Return type
|
|
817
|
+
|
|
818
|
+
nil (empty response body)
|
|
819
|
+
|
|
820
|
+
### Authorization
|
|
821
|
+
|
|
822
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
823
|
+
|
|
824
|
+
### HTTP request headers
|
|
825
|
+
|
|
826
|
+
- **Content-Type**: Not defined
|
|
827
|
+
- **Accept**: Not defined
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
## persons_id_merge_put
|
|
831
|
+
|
|
832
|
+
> persons_id_merge_put(id, merge_with_id)
|
|
833
|
+
|
|
834
|
+
Merge two persons
|
|
835
|
+
|
|
836
|
+
Merges a person with another person. For more information on how to merge two persons, see <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
837
|
+
|
|
838
|
+
### Example
|
|
839
|
+
|
|
840
|
+
```ruby
|
|
841
|
+
# load the gem
|
|
842
|
+
require 'pipedrive-openapi-client'
|
|
843
|
+
# setup authorization
|
|
844
|
+
Pipedrive.configure do |config|
|
|
845
|
+
# Configure API key authorization: api_key
|
|
846
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
847
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
848
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
849
|
+
|
|
850
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
851
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
852
|
+
end
|
|
853
|
+
|
|
854
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
855
|
+
id = 56 # Integer | ID of a person
|
|
856
|
+
merge_with_id = 56 # Integer | The ID of the Person that will not be overwritten. This Person’s data will be prioritized in case of conflict with the other Person.
|
|
857
|
+
|
|
858
|
+
begin
|
|
859
|
+
#Merge two persons
|
|
860
|
+
api_instance.persons_id_merge_put(id, merge_with_id)
|
|
861
|
+
rescue Pipedrive::ApiError => e
|
|
862
|
+
puts "Exception when calling PersonsApi->persons_id_merge_put: #{e}"
|
|
863
|
+
end
|
|
864
|
+
```
|
|
865
|
+
|
|
866
|
+
### Parameters
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
Name | Type | Description | Notes
|
|
870
|
+
------------- | ------------- | ------------- | -------------
|
|
871
|
+
**id** | **Integer**| ID of a person |
|
|
872
|
+
**merge_with_id** | **Integer**| The ID of the Person that will not be overwritten. This Person’s data will be prioritized in case of conflict with the other Person. |
|
|
873
|
+
|
|
874
|
+
### Return type
|
|
875
|
+
|
|
876
|
+
nil (empty response body)
|
|
877
|
+
|
|
878
|
+
### Authorization
|
|
879
|
+
|
|
880
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
881
|
+
|
|
882
|
+
### HTTP request headers
|
|
883
|
+
|
|
884
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
885
|
+
- **Accept**: Not defined
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
## persons_id_permitted_users_get
|
|
889
|
+
|
|
890
|
+
> persons_id_permitted_users_get(id)
|
|
891
|
+
|
|
892
|
+
List permitted users
|
|
893
|
+
|
|
894
|
+
List users permitted to access a person
|
|
895
|
+
|
|
896
|
+
### Example
|
|
897
|
+
|
|
898
|
+
```ruby
|
|
899
|
+
# load the gem
|
|
900
|
+
require 'pipedrive-openapi-client'
|
|
901
|
+
# setup authorization
|
|
902
|
+
Pipedrive.configure do |config|
|
|
903
|
+
# Configure API key authorization: api_key
|
|
904
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
905
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
906
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
907
|
+
end
|
|
908
|
+
|
|
909
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
910
|
+
id = 56 # Integer | ID of a person
|
|
911
|
+
|
|
912
|
+
begin
|
|
913
|
+
#List permitted users
|
|
914
|
+
api_instance.persons_id_permitted_users_get(id)
|
|
915
|
+
rescue Pipedrive::ApiError => e
|
|
916
|
+
puts "Exception when calling PersonsApi->persons_id_permitted_users_get: #{e}"
|
|
917
|
+
end
|
|
918
|
+
```
|
|
919
|
+
|
|
920
|
+
### Parameters
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
Name | Type | Description | Notes
|
|
924
|
+
------------- | ------------- | ------------- | -------------
|
|
925
|
+
**id** | **Integer**| ID of a person |
|
|
926
|
+
|
|
927
|
+
### Return type
|
|
928
|
+
|
|
929
|
+
nil (empty response body)
|
|
930
|
+
|
|
931
|
+
### Authorization
|
|
932
|
+
|
|
933
|
+
[api_key](../README.md#api_key)
|
|
934
|
+
|
|
935
|
+
### HTTP request headers
|
|
936
|
+
|
|
937
|
+
- **Content-Type**: Not defined
|
|
938
|
+
- **Accept**: Not defined
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
## persons_id_picture_delete
|
|
942
|
+
|
|
943
|
+
> persons_id_picture_delete(id)
|
|
944
|
+
|
|
945
|
+
Delete person picture
|
|
946
|
+
|
|
947
|
+
Delete person picture
|
|
948
|
+
|
|
949
|
+
### Example
|
|
950
|
+
|
|
951
|
+
```ruby
|
|
952
|
+
# load the gem
|
|
953
|
+
require 'pipedrive-openapi-client'
|
|
954
|
+
# setup authorization
|
|
955
|
+
Pipedrive.configure do |config|
|
|
956
|
+
# Configure API key authorization: api_key
|
|
957
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
958
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
959
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
960
|
+
|
|
961
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
962
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
963
|
+
end
|
|
964
|
+
|
|
965
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
966
|
+
id = 56 # Integer | ID of a person
|
|
967
|
+
|
|
968
|
+
begin
|
|
969
|
+
#Delete person picture
|
|
970
|
+
api_instance.persons_id_picture_delete(id)
|
|
971
|
+
rescue Pipedrive::ApiError => e
|
|
972
|
+
puts "Exception when calling PersonsApi->persons_id_picture_delete: #{e}"
|
|
973
|
+
end
|
|
974
|
+
```
|
|
975
|
+
|
|
976
|
+
### Parameters
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
Name | Type | Description | Notes
|
|
980
|
+
------------- | ------------- | ------------- | -------------
|
|
981
|
+
**id** | **Integer**| ID of a person |
|
|
982
|
+
|
|
983
|
+
### Return type
|
|
984
|
+
|
|
985
|
+
nil (empty response body)
|
|
986
|
+
|
|
987
|
+
### Authorization
|
|
988
|
+
|
|
989
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
990
|
+
|
|
991
|
+
### HTTP request headers
|
|
992
|
+
|
|
993
|
+
- **Content-Type**: Not defined
|
|
994
|
+
- **Accept**: Not defined
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
## persons_id_picture_post
|
|
998
|
+
|
|
999
|
+
> persons_id_picture_post(id, file, opts)
|
|
1000
|
+
|
|
1001
|
+
Add person picture
|
|
1002
|
+
|
|
1003
|
+
Add a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.
|
|
1004
|
+
|
|
1005
|
+
### Example
|
|
1006
|
+
|
|
1007
|
+
```ruby
|
|
1008
|
+
# load the gem
|
|
1009
|
+
require 'pipedrive-openapi-client'
|
|
1010
|
+
# setup authorization
|
|
1011
|
+
Pipedrive.configure do |config|
|
|
1012
|
+
# Configure API key authorization: api_key
|
|
1013
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1014
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1015
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1016
|
+
|
|
1017
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1018
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1019
|
+
end
|
|
1020
|
+
|
|
1021
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
1022
|
+
id = 56 # Integer | ID of a person
|
|
1023
|
+
file = File.new('/path/to/file') # File | One image supplied in the multipart/form-data encoding.
|
|
1024
|
+
opts = {
|
|
1025
|
+
crop_x: 56, # Integer | X coordinate to where start cropping form (in pixels)
|
|
1026
|
+
crop_y: 56, # Integer | Y coordinate to where start cropping form (in pixels)
|
|
1027
|
+
crop_width: 56, # Integer | Width of cropping area (in pixels)
|
|
1028
|
+
crop_height: 56 # Integer | Height of cropping area (in pixels)
|
|
1029
|
+
}
|
|
1030
|
+
|
|
1031
|
+
begin
|
|
1032
|
+
#Add person picture
|
|
1033
|
+
api_instance.persons_id_picture_post(id, file, opts)
|
|
1034
|
+
rescue Pipedrive::ApiError => e
|
|
1035
|
+
puts "Exception when calling PersonsApi->persons_id_picture_post: #{e}"
|
|
1036
|
+
end
|
|
1037
|
+
```
|
|
1038
|
+
|
|
1039
|
+
### Parameters
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
Name | Type | Description | Notes
|
|
1043
|
+
------------- | ------------- | ------------- | -------------
|
|
1044
|
+
**id** | **Integer**| ID of a person |
|
|
1045
|
+
**file** | **File**| One image supplied in the multipart/form-data encoding. |
|
|
1046
|
+
**crop_x** | **Integer**| X coordinate to where start cropping form (in pixels) | [optional]
|
|
1047
|
+
**crop_y** | **Integer**| Y coordinate to where start cropping form (in pixels) | [optional]
|
|
1048
|
+
**crop_width** | **Integer**| Width of cropping area (in pixels) | [optional]
|
|
1049
|
+
**crop_height** | **Integer**| Height of cropping area (in pixels) | [optional]
|
|
1050
|
+
|
|
1051
|
+
### Return type
|
|
1052
|
+
|
|
1053
|
+
nil (empty response body)
|
|
1054
|
+
|
|
1055
|
+
### Authorization
|
|
1056
|
+
|
|
1057
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1058
|
+
|
|
1059
|
+
### HTTP request headers
|
|
1060
|
+
|
|
1061
|
+
- **Content-Type**: multipart/form-data
|
|
1062
|
+
- **Accept**: Not defined
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
## persons_id_products_get
|
|
1066
|
+
|
|
1067
|
+
> persons_id_products_get(id, opts)
|
|
1068
|
+
|
|
1069
|
+
List products associated with a person
|
|
1070
|
+
|
|
1071
|
+
Lists products associated with a person.
|
|
1072
|
+
|
|
1073
|
+
### Example
|
|
1074
|
+
|
|
1075
|
+
```ruby
|
|
1076
|
+
# load the gem
|
|
1077
|
+
require 'pipedrive-openapi-client'
|
|
1078
|
+
# setup authorization
|
|
1079
|
+
Pipedrive.configure do |config|
|
|
1080
|
+
# Configure API key authorization: api_key
|
|
1081
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1082
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1083
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1084
|
+
end
|
|
1085
|
+
|
|
1086
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
1087
|
+
id = 56 # Integer | ID of a person
|
|
1088
|
+
opts = {
|
|
1089
|
+
start: 0, # Integer | Pagination start
|
|
1090
|
+
limit: 56 # Integer | Items shown per page
|
|
1091
|
+
}
|
|
1092
|
+
|
|
1093
|
+
begin
|
|
1094
|
+
#List products associated with a person
|
|
1095
|
+
api_instance.persons_id_products_get(id, opts)
|
|
1096
|
+
rescue Pipedrive::ApiError => e
|
|
1097
|
+
puts "Exception when calling PersonsApi->persons_id_products_get: #{e}"
|
|
1098
|
+
end
|
|
1099
|
+
```
|
|
1100
|
+
|
|
1101
|
+
### Parameters
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
Name | Type | Description | Notes
|
|
1105
|
+
------------- | ------------- | ------------- | -------------
|
|
1106
|
+
**id** | **Integer**| ID of a person |
|
|
1107
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
1108
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1109
|
+
|
|
1110
|
+
### Return type
|
|
1111
|
+
|
|
1112
|
+
nil (empty response body)
|
|
1113
|
+
|
|
1114
|
+
### Authorization
|
|
1115
|
+
|
|
1116
|
+
[api_key](../README.md#api_key)
|
|
1117
|
+
|
|
1118
|
+
### HTTP request headers
|
|
1119
|
+
|
|
1120
|
+
- **Content-Type**: Not defined
|
|
1121
|
+
- **Accept**: Not defined
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
## persons_id_put
|
|
1125
|
+
|
|
1126
|
+
> persons_id_put(id, opts)
|
|
1127
|
+
|
|
1128
|
+
Update a person
|
|
1129
|
+
|
|
1130
|
+
Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
1131
|
+
|
|
1132
|
+
### Example
|
|
1133
|
+
|
|
1134
|
+
```ruby
|
|
1135
|
+
# load the gem
|
|
1136
|
+
require 'pipedrive-openapi-client'
|
|
1137
|
+
# setup authorization
|
|
1138
|
+
Pipedrive.configure do |config|
|
|
1139
|
+
# Configure API key authorization: api_key
|
|
1140
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1141
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1142
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1143
|
+
|
|
1144
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1145
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1146
|
+
end
|
|
1147
|
+
|
|
1148
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
1149
|
+
id = 56 # Integer | ID of a person
|
|
1150
|
+
opts = {
|
|
1151
|
+
basic_person: Pipedrive::BasicPerson.new # BasicPerson |
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
begin
|
|
1155
|
+
#Update a person
|
|
1156
|
+
api_instance.persons_id_put(id, opts)
|
|
1157
|
+
rescue Pipedrive::ApiError => e
|
|
1158
|
+
puts "Exception when calling PersonsApi->persons_id_put: #{e}"
|
|
1159
|
+
end
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1162
|
+
### Parameters
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
Name | Type | Description | Notes
|
|
1166
|
+
------------- | ------------- | ------------- | -------------
|
|
1167
|
+
**id** | **Integer**| ID of a person |
|
|
1168
|
+
**basic_person** | [**BasicPerson**](BasicPerson.md)| | [optional]
|
|
1169
|
+
|
|
1170
|
+
### Return type
|
|
1171
|
+
|
|
1172
|
+
nil (empty response body)
|
|
1173
|
+
|
|
1174
|
+
### Authorization
|
|
1175
|
+
|
|
1176
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1177
|
+
|
|
1178
|
+
### HTTP request headers
|
|
1179
|
+
|
|
1180
|
+
- **Content-Type**: application/json
|
|
1181
|
+
- **Accept**: Not defined
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
## persons_post
|
|
1185
|
+
|
|
1186
|
+
> persons_post(opts)
|
|
1187
|
+
|
|
1188
|
+
Add a person
|
|
1189
|
+
|
|
1190
|
+
Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for 'key' values.
|
|
1191
|
+
|
|
1192
|
+
### Example
|
|
1193
|
+
|
|
1194
|
+
```ruby
|
|
1195
|
+
# load the gem
|
|
1196
|
+
require 'pipedrive-openapi-client'
|
|
1197
|
+
# setup authorization
|
|
1198
|
+
Pipedrive.configure do |config|
|
|
1199
|
+
# Configure API key authorization: api_key
|
|
1200
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1201
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1202
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1203
|
+
|
|
1204
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1205
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1206
|
+
end
|
|
1207
|
+
|
|
1208
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
1209
|
+
opts = {
|
|
1210
|
+
new_person: Pipedrive::NewPerson.new # NewPerson |
|
|
1211
|
+
}
|
|
1212
|
+
|
|
1213
|
+
begin
|
|
1214
|
+
#Add a person
|
|
1215
|
+
api_instance.persons_post(opts)
|
|
1216
|
+
rescue Pipedrive::ApiError => e
|
|
1217
|
+
puts "Exception when calling PersonsApi->persons_post: #{e}"
|
|
1218
|
+
end
|
|
1219
|
+
```
|
|
1220
|
+
|
|
1221
|
+
### Parameters
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
Name | Type | Description | Notes
|
|
1225
|
+
------------- | ------------- | ------------- | -------------
|
|
1226
|
+
**new_person** | [**NewPerson**](NewPerson.md)| | [optional]
|
|
1227
|
+
|
|
1228
|
+
### Return type
|
|
1229
|
+
|
|
1230
|
+
nil (empty response body)
|
|
1231
|
+
|
|
1232
|
+
### Authorization
|
|
1233
|
+
|
|
1234
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1235
|
+
|
|
1236
|
+
### HTTP request headers
|
|
1237
|
+
|
|
1238
|
+
- **Content-Type**: application/json
|
|
1239
|
+
- **Accept**: Not defined
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
## persons_search_get
|
|
1243
|
+
|
|
1244
|
+
> BaseResponse persons_search_get(term, opts)
|
|
1245
|
+
|
|
1246
|
+
Search persons
|
|
1247
|
+
|
|
1248
|
+
Searches all Persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> with a narrower OAuth scope. Found Persons can be filtered by Organization ID.
|
|
1249
|
+
|
|
1250
|
+
### Example
|
|
1251
|
+
|
|
1252
|
+
```ruby
|
|
1253
|
+
# load the gem
|
|
1254
|
+
require 'pipedrive-openapi-client'
|
|
1255
|
+
# setup authorization
|
|
1256
|
+
Pipedrive.configure do |config|
|
|
1257
|
+
# Configure API key authorization: api_key
|
|
1258
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1259
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1260
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1261
|
+
|
|
1262
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1263
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1264
|
+
end
|
|
1265
|
+
|
|
1266
|
+
api_instance = Pipedrive::PersonsApi.new
|
|
1267
|
+
term = 'term_example' # String | The search term to look for. Minimum 2 characters (or 1 if using exact_match).
|
|
1268
|
+
opts = {
|
|
1269
|
+
fields: 'fields_example', # String | A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
1270
|
+
exact_match: true, # Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1271
|
+
organization_id: 56, # Integer | Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.
|
|
1272
|
+
include_fields: 'include_fields_example', # String | Supports including optional fields in the results which are not provided by default.
|
|
1273
|
+
start: 0, # Integer | Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
|
|
1274
|
+
limit: 56 # Integer | Items shown per page
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
begin
|
|
1278
|
+
#Search persons
|
|
1279
|
+
result = api_instance.persons_search_get(term, opts)
|
|
1280
|
+
p result
|
|
1281
|
+
rescue Pipedrive::ApiError => e
|
|
1282
|
+
puts "Exception when calling PersonsApi->persons_search_get: #{e}"
|
|
1283
|
+
end
|
|
1284
|
+
```
|
|
1285
|
+
|
|
1286
|
+
### Parameters
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
Name | Type | Description | Notes
|
|
1290
|
+
------------- | ------------- | ------------- | -------------
|
|
1291
|
+
**term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using exact_match). |
|
|
1292
|
+
**fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. | [optional]
|
|
1293
|
+
**exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional]
|
|
1294
|
+
**organization_id** | **Integer**| Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000. | [optional]
|
|
1295
|
+
**include_fields** | **String**| Supports including optional fields in the results which are not provided by default. | [optional]
|
|
1296
|
+
**start** | **Integer**| Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter. | [optional] [default to 0]
|
|
1297
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1298
|
+
|
|
1299
|
+
### Return type
|
|
1300
|
+
|
|
1301
|
+
[**BaseResponse**](BaseResponse.md)
|
|
1302
|
+
|
|
1303
|
+
### Authorization
|
|
1304
|
+
|
|
1305
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1306
|
+
|
|
1307
|
+
### HTTP request headers
|
|
1308
|
+
|
|
1309
|
+
- **Content-Type**: Not defined
|
|
1310
|
+
- **Accept**: application/json
|
|
1311
|
+
|