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
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Pipedrive::DealNonStrictModeFields
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the Deal | [optional]
|
|
8
|
+
**creator_user_id** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional]
|
|
9
|
+
**user_id** | [**DealUserData**](DealUserData.md) | | [optional]
|
|
10
|
+
**person_id** | [**DealPersonData**](DealPersonData.md) | | [optional]
|
|
11
|
+
**org_id** | [**DealOrganizationData**](DealOrganizationData.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'Pipedrive'
|
|
17
|
+
|
|
18
|
+
instance = Pipedrive::DealNonStrictModeFields.new(id: null,
|
|
19
|
+
creator_user_id: null,
|
|
20
|
+
user_id: null,
|
|
21
|
+
person_id: null,
|
|
22
|
+
org_id: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Pipedrive::DealNonStrictModeFieldsCreatorUserId
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the Deal creator | [optional]
|
|
8
|
+
**name** | **String** | The name of the Deal creator | [optional]
|
|
9
|
+
**email** | **String** | The email of the Deal creator | [optional]
|
|
10
|
+
**has_pic** | **Boolean** | If the creator has a picture or not | [optional]
|
|
11
|
+
**pic_hash** | **String** | The creator picture hash | [optional]
|
|
12
|
+
**active_flag** | **Boolean** | If the creator is activated or not | [optional]
|
|
13
|
+
**value** | **Integer** | The ID of the Deal creator | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'Pipedrive'
|
|
19
|
+
|
|
20
|
+
instance = Pipedrive::DealNonStrictModeFieldsCreatorUserId.new(id: null,
|
|
21
|
+
name: null,
|
|
22
|
+
email: null,
|
|
23
|
+
has_pic: null,
|
|
24
|
+
pic_hash: null,
|
|
25
|
+
active_flag: null,
|
|
26
|
+
value: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Pipedrive::DealOrganizationData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The name of the Organization associated with the Deal | [optional]
|
|
8
|
+
**people_count** | **Integer** | The number of people connected with the Organization that is associated with the Deal | [optional]
|
|
9
|
+
**owner_id** | **Integer** | The ID of the owner of the Organization that is associated with the Deal | [optional]
|
|
10
|
+
**address** | **String** | The address of the Organization that is associated with the Deal | [optional]
|
|
11
|
+
**active_flag** | **Boolean** | If the associated Organization is activated or not | [optional]
|
|
12
|
+
**cc_email** | **String** | The Cc email of the Organization associated with the Deal | [optional]
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'Pipedrive'
|
|
18
|
+
|
|
19
|
+
instance = Pipedrive::DealOrganizationData.new(name: null,
|
|
20
|
+
people_count: null,
|
|
21
|
+
owner_id: null,
|
|
22
|
+
address: null,
|
|
23
|
+
active_flag: null,
|
|
24
|
+
cc_email: null)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Pipedrive::DealPersonData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**active_flag** | **Boolean** | If the associated Person is activated or not | [optional]
|
|
8
|
+
**name** | **String** | The name of the Person associated with the Deal | [optional]
|
|
9
|
+
**email** | [**Array<DealPersonDataEmail>**](DealPersonDataEmail.md) | The emails of the Person associated with the Deal | [optional]
|
|
10
|
+
**phone** | [**Array<DealPersonDataPhone>**](DealPersonDataPhone.md) | The phone numbers of the Person associated with the Deal | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'Pipedrive'
|
|
16
|
+
|
|
17
|
+
instance = Pipedrive::DealPersonData.new(active_flag: null,
|
|
18
|
+
name: null,
|
|
19
|
+
email: null,
|
|
20
|
+
phone: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Pipedrive::DealPersonDataEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**label** | **String** | The type of the email | [optional]
|
|
8
|
+
**value** | **String** | The email of the associated Person | [optional]
|
|
9
|
+
**primary** | **Boolean** | If this is the primary email or not | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'Pipedrive'
|
|
15
|
+
|
|
16
|
+
instance = Pipedrive::DealPersonDataEmail.new(label: null,
|
|
17
|
+
value: null,
|
|
18
|
+
primary: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Pipedrive::DealPersonDataPhone
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**label** | **String** | The type of the phone number | [optional]
|
|
8
|
+
**value** | **String** | The phone number of the Person associated with the Deal | [optional]
|
|
9
|
+
**primary** | **Boolean** | If this is the primary phone number or not | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'Pipedrive'
|
|
15
|
+
|
|
16
|
+
instance = Pipedrive::DealPersonDataPhone.new(label: null,
|
|
17
|
+
value: null,
|
|
18
|
+
primary: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Pipedrive::DealStrictModeFields
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the Deal | [optional]
|
|
8
|
+
**creator_user_id** | **Integer** | The ID of the Deal creator | [optional]
|
|
9
|
+
**user_id** | **Integer** | The ID of the User | [optional]
|
|
10
|
+
**person_id** | **Integer** | The ID of the Person associated with the Deal | [optional]
|
|
11
|
+
**org_id** | **Integer** | The ID of the Organization associated with the Deal | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'Pipedrive'
|
|
17
|
+
|
|
18
|
+
instance = Pipedrive::DealStrictModeFields.new(id: null,
|
|
19
|
+
creator_user_id: null,
|
|
20
|
+
user_id: null,
|
|
21
|
+
person_id: null,
|
|
22
|
+
org_id: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
data/docs/DealSummary.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Pipedrive::DealSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**per_stages** | [**DealSummaryPerStages**](DealSummaryPerStages.md) | | [optional]
|
|
8
|
+
**per_currency** | [**DealSummaryPerCurrency**](DealSummaryPerCurrency.md) | | [optional]
|
|
9
|
+
**total_count** | **Integer** | Deals count | [optional]
|
|
10
|
+
**per_currency_full** | [**DealSummaryPerCurrencyFull**](DealSummaryPerCurrencyFull.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'Pipedrive'
|
|
16
|
+
|
|
17
|
+
instance = Pipedrive::DealSummary.new(per_stages: null,
|
|
18
|
+
per_currency: null,
|
|
19
|
+
total_count: null,
|
|
20
|
+
per_currency_full: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Pipedrive::DealSummaryPerCurrency
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**currency_id** | **Integer** | Deals count per currency. This parameter is dynamic and changes according to currency_id value. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Pipedrive'
|
|
13
|
+
|
|
14
|
+
instance = Pipedrive::DealSummaryPerCurrency.new(currency_id: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Pipedrive::DealSummaryPerCurrencyFull
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**currency_id** | [**DealSummaryPerCurrencyFullCURRENCYID**](DealSummaryPerCurrencyFullCURRENCYID.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Pipedrive'
|
|
13
|
+
|
|
14
|
+
instance = Pipedrive::DealSummaryPerCurrencyFull.new(currency_id: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Pipedrive::DealSummaryPerCurrencyFullCURRENCYID
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**count** | **Integer** | Deals count per currency | [optional]
|
|
8
|
+
**value** | **Integer** | Deals value per currency | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Pipedrive'
|
|
14
|
+
|
|
15
|
+
instance = Pipedrive::DealSummaryPerCurrencyFullCURRENCYID.new(count: null,
|
|
16
|
+
value: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Pipedrive::DealSummaryPerStages
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**stage_id** | [**DealSummaryPerStagesSTAGEID**](DealSummaryPerStagesSTAGEID.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Pipedrive'
|
|
13
|
+
|
|
14
|
+
instance = Pipedrive::DealSummaryPerStages.new(stage_id: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Pipedrive::DealSummaryPerStagesSTAGEID
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**currency_id** | [**DealSummaryPerStagesSTAGEIDCURRENCYID**](DealSummaryPerStagesSTAGEIDCURRENCYID.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Pipedrive'
|
|
13
|
+
|
|
14
|
+
instance = Pipedrive::DealSummaryPerStagesSTAGEID.new(currency_id: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Pipedrive::DealSummaryPerStagesSTAGEIDCURRENCYID
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**count** | **Integer** | Deals count per currency | [optional]
|
|
8
|
+
**value** | **Integer** | Deals value per currency | [optional]
|
|
9
|
+
**value_formatted** | **String** | Deals value formatted per currency | [optional]
|
|
10
|
+
**weighted_value** | **Integer** | Deals weighted value per currency | [optional]
|
|
11
|
+
**weighted_value_formatted** | **String** | Deals weighted value formatted per currency | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'Pipedrive'
|
|
17
|
+
|
|
18
|
+
instance = Pipedrive::DealSummaryPerStagesSTAGEIDCURRENCYID.new(count: null,
|
|
19
|
+
value: null,
|
|
20
|
+
value_formatted: null,
|
|
21
|
+
weighted_value: null,
|
|
22
|
+
weighted_value_formatted: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Pipedrive::DealUserData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the User | [optional]
|
|
8
|
+
**name** | **String** | The Name of the User | [optional]
|
|
9
|
+
**email** | **String** | The email of the User | [optional]
|
|
10
|
+
**has_pic** | **Boolean** | If the User has a picture or not | [optional]
|
|
11
|
+
**pic_hash** | **String** | The User picture hash | [optional]
|
|
12
|
+
**active_flag** | **Boolean** | If the User is activated or not | [optional]
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'Pipedrive'
|
|
18
|
+
|
|
19
|
+
instance = Pipedrive::DealUserData.new(id: null,
|
|
20
|
+
name: null,
|
|
21
|
+
email: null,
|
|
22
|
+
has_pic: null,
|
|
23
|
+
pic_hash: null,
|
|
24
|
+
active_flag: null)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
data/docs/DealsApi.md
ADDED
|
@@ -0,0 +1,1777 @@
|
|
|
1
|
+
# Pipedrive::DealsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.pipedrive.com/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**deals_delete**](DealsApi.md#deals_delete) | **DELETE** /deals | Delete multiple deals in bulk
|
|
8
|
+
[**deals_find_get**](DealsApi.md#deals_find_get) | **GET** /deals/find | Find deals by name
|
|
9
|
+
[**deals_get**](DealsApi.md#deals_get) | **GET** /deals | Get all deals
|
|
10
|
+
[**deals_id_activities_get**](DealsApi.md#deals_id_activities_get) | **GET** /deals/{id}/activities | List activities associated with a deal
|
|
11
|
+
[**deals_id_delete**](DealsApi.md#deals_id_delete) | **DELETE** /deals/{id} | Delete a deal
|
|
12
|
+
[**deals_id_duplicate_post**](DealsApi.md#deals_id_duplicate_post) | **POST** /deals/{id}/duplicate | Duplicate deal
|
|
13
|
+
[**deals_id_files_get**](DealsApi.md#deals_id_files_get) | **GET** /deals/{id}/files | List files attached to a deal
|
|
14
|
+
[**deals_id_flow_get**](DealsApi.md#deals_id_flow_get) | **GET** /deals/{id}/flow | List updates about a deal
|
|
15
|
+
[**deals_id_followers_follower_id_delete**](DealsApi.md#deals_id_followers_follower_id_delete) | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal
|
|
16
|
+
[**deals_id_followers_get**](DealsApi.md#deals_id_followers_get) | **GET** /deals/{id}/followers | List followers of a deal
|
|
17
|
+
[**deals_id_followers_post**](DealsApi.md#deals_id_followers_post) | **POST** /deals/{id}/followers | Add a follower to a deal
|
|
18
|
+
[**deals_id_get**](DealsApi.md#deals_id_get) | **GET** /deals/{id} | Get details of a deal
|
|
19
|
+
[**deals_id_mail_messages_get**](DealsApi.md#deals_id_mail_messages_get) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
|
|
20
|
+
[**deals_id_merge_put**](DealsApi.md#deals_id_merge_put) | **PUT** /deals/{id}/merge | Merge two deals
|
|
21
|
+
[**deals_id_participants_deal_participant_id_delete**](DealsApi.md#deals_id_participants_deal_participant_id_delete) | **DELETE** /deals/{id}/participants/{deal_participant_id} | Delete a participant from a deal
|
|
22
|
+
[**deals_id_participants_get**](DealsApi.md#deals_id_participants_get) | **GET** /deals/{id}/participants | List participants of a deal
|
|
23
|
+
[**deals_id_participants_post**](DealsApi.md#deals_id_participants_post) | **POST** /deals/{id}/participants | Add a participant to a deal
|
|
24
|
+
[**deals_id_permitted_users_get**](DealsApi.md#deals_id_permitted_users_get) | **GET** /deals/{id}/permittedUsers | List permitted users
|
|
25
|
+
[**deals_id_persons_get**](DealsApi.md#deals_id_persons_get) | **GET** /deals/{id}/persons | List all persons associated with a deal
|
|
26
|
+
[**deals_id_products_get**](DealsApi.md#deals_id_products_get) | **GET** /deals/{id}/products | List products attached to a deal
|
|
27
|
+
[**deals_id_products_post**](DealsApi.md#deals_id_products_post) | **POST** /deals/{id}/products | Add a product to the deal, eventually creating a new item called a deal-product
|
|
28
|
+
[**deals_id_products_product_attachment_id_delete**](DealsApi.md#deals_id_products_product_attachment_id_delete) | **DELETE** /deals/{id}/products/{product_attachment_id} | Delete an attached product from a deal
|
|
29
|
+
[**deals_id_products_product_attachment_id_put**](DealsApi.md#deals_id_products_product_attachment_id_put) | **PUT** /deals/{id}/products/{product_attachment_id} | Update product attachment details of the deal-product (a product already attached to a deal)
|
|
30
|
+
[**deals_id_put**](DealsApi.md#deals_id_put) | **PUT** /deals/{id} | Update a deal
|
|
31
|
+
[**deals_post**](DealsApi.md#deals_post) | **POST** /deals | Add a deal
|
|
32
|
+
[**deals_search_get**](DealsApi.md#deals_search_get) | **GET** /deals/search | Search deals
|
|
33
|
+
[**deals_summary_get**](DealsApi.md#deals_summary_get) | **GET** /deals/summary | Get deals summary
|
|
34
|
+
[**deals_timeline_get**](DealsApi.md#deals_timeline_get) | **GET** /deals/timeline | Get deals timeline
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## deals_delete
|
|
39
|
+
|
|
40
|
+
> DeleteMultipleDeals deals_delete(ids)
|
|
41
|
+
|
|
42
|
+
Delete multiple deals in bulk
|
|
43
|
+
|
|
44
|
+
Marks multiple deals as deleted.
|
|
45
|
+
|
|
46
|
+
### Example
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
# load the gem
|
|
50
|
+
require 'pipedrive-openapi-client'
|
|
51
|
+
# setup authorization
|
|
52
|
+
Pipedrive.configure do |config|
|
|
53
|
+
# Configure API key authorization: api_key
|
|
54
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
55
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
56
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
57
|
+
|
|
58
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
59
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
api_instance = Pipedrive::DealsApi.new
|
|
63
|
+
ids = 'ids_example' # String | Comma-separated IDs that will be deleted
|
|
64
|
+
|
|
65
|
+
begin
|
|
66
|
+
#Delete multiple deals in bulk
|
|
67
|
+
result = api_instance.deals_delete(ids)
|
|
68
|
+
p result
|
|
69
|
+
rescue Pipedrive::ApiError => e
|
|
70
|
+
puts "Exception when calling DealsApi->deals_delete: #{e}"
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
Name | Type | Description | Notes
|
|
78
|
+
------------- | ------------- | ------------- | -------------
|
|
79
|
+
**ids** | **String**| Comma-separated IDs that will be deleted |
|
|
80
|
+
|
|
81
|
+
### Return type
|
|
82
|
+
|
|
83
|
+
[**DeleteMultipleDeals**](DeleteMultipleDeals.md)
|
|
84
|
+
|
|
85
|
+
### Authorization
|
|
86
|
+
|
|
87
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
88
|
+
|
|
89
|
+
### HTTP request headers
|
|
90
|
+
|
|
91
|
+
- **Content-Type**: Not defined
|
|
92
|
+
- **Accept**: application/json
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
## deals_find_get
|
|
96
|
+
|
|
97
|
+
> GetDealsByName deals_find_get(term, opts)
|
|
98
|
+
|
|
99
|
+
Find deals by name
|
|
100
|
+
|
|
101
|
+
<strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_search\">/v1/deals/search</a> or <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Searches all deals by their title.
|
|
102
|
+
|
|
103
|
+
### Example
|
|
104
|
+
|
|
105
|
+
```ruby
|
|
106
|
+
# load the gem
|
|
107
|
+
require 'pipedrive-openapi-client'
|
|
108
|
+
# setup authorization
|
|
109
|
+
Pipedrive.configure do |config|
|
|
110
|
+
# Configure API key authorization: api_key
|
|
111
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
112
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
113
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
114
|
+
|
|
115
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
116
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
api_instance = Pipedrive::DealsApi.new
|
|
120
|
+
term = 'term_example' # String | Search term to look for
|
|
121
|
+
opts = {
|
|
122
|
+
person_id: 56, # Integer | ID of the person the Deal is associated with.
|
|
123
|
+
org_id: 56 # Integer | ID of the organization the Deal is associated with.
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
begin
|
|
127
|
+
#Find deals by name
|
|
128
|
+
result = api_instance.deals_find_get(term, opts)
|
|
129
|
+
p result
|
|
130
|
+
rescue Pipedrive::ApiError => e
|
|
131
|
+
puts "Exception when calling DealsApi->deals_find_get: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
Name | Type | Description | Notes
|
|
139
|
+
------------- | ------------- | ------------- | -------------
|
|
140
|
+
**term** | **String**| Search term to look for |
|
|
141
|
+
**person_id** | **Integer**| ID of the person the Deal is associated with. | [optional]
|
|
142
|
+
**org_id** | **Integer**| ID of the organization the Deal is associated with. | [optional]
|
|
143
|
+
|
|
144
|
+
### Return type
|
|
145
|
+
|
|
146
|
+
[**GetDealsByName**](GetDealsByName.md)
|
|
147
|
+
|
|
148
|
+
### Authorization
|
|
149
|
+
|
|
150
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
151
|
+
|
|
152
|
+
### HTTP request headers
|
|
153
|
+
|
|
154
|
+
- **Content-Type**: Not defined
|
|
155
|
+
- **Accept**: application/json
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
## deals_get
|
|
159
|
+
|
|
160
|
+
> GetDeals deals_get(opts)
|
|
161
|
+
|
|
162
|
+
Get all deals
|
|
163
|
+
|
|
164
|
+
Returns all deals. For more information on how to get all deals, see <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
165
|
+
|
|
166
|
+
### Example
|
|
167
|
+
|
|
168
|
+
```ruby
|
|
169
|
+
# load the gem
|
|
170
|
+
require 'pipedrive-openapi-client'
|
|
171
|
+
# setup authorization
|
|
172
|
+
Pipedrive.configure do |config|
|
|
173
|
+
# Configure API key authorization: api_key
|
|
174
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
175
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
176
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
177
|
+
|
|
178
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
179
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
api_instance = Pipedrive::DealsApi.new
|
|
183
|
+
opts = {
|
|
184
|
+
user_id: 56, # Integer | If supplied, only deals matching the given user will be returned.
|
|
185
|
+
filter_id: 56, # Integer | ID of the filter to use
|
|
186
|
+
stage_id: 56, # Integer | If supplied, only deals within the given stage will be returned.
|
|
187
|
+
status: 'all_not_deleted', # String | Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
|
|
188
|
+
start: 0, # Integer | Pagination start
|
|
189
|
+
limit: 56, # Integer | Items shown per page
|
|
190
|
+
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).
|
|
191
|
+
owned_by_you: Pipedrive::NumberBoolean.new # NumberBoolean | When supplied, only deals owned by you are returned. However filter_id takes precedence over owned_by_you when both are supplied.
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
begin
|
|
195
|
+
#Get all deals
|
|
196
|
+
result = api_instance.deals_get(opts)
|
|
197
|
+
p result
|
|
198
|
+
rescue Pipedrive::ApiError => e
|
|
199
|
+
puts "Exception when calling DealsApi->deals_get: #{e}"
|
|
200
|
+
end
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
Name | Type | Description | Notes
|
|
207
|
+
------------- | ------------- | ------------- | -------------
|
|
208
|
+
**user_id** | **Integer**| If supplied, only deals matching the given user will be returned. | [optional]
|
|
209
|
+
**filter_id** | **Integer**| ID of the filter to use | [optional]
|
|
210
|
+
**stage_id** | **Integer**| If supplied, only deals within the given stage will be returned. | [optional]
|
|
211
|
+
**status** | **String**| Only fetch deals with specific status. If omitted, all not deleted deals are fetched. | [optional] [default to 'all_not_deleted']
|
|
212
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
213
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
214
|
+
**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]
|
|
215
|
+
**owned_by_you** | [**NumberBoolean**](.md)| When supplied, only deals owned by you are returned. However filter_id takes precedence over owned_by_you when both are supplied. | [optional]
|
|
216
|
+
|
|
217
|
+
### Return type
|
|
218
|
+
|
|
219
|
+
[**GetDeals**](GetDeals.md)
|
|
220
|
+
|
|
221
|
+
### Authorization
|
|
222
|
+
|
|
223
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
224
|
+
|
|
225
|
+
### HTTP request headers
|
|
226
|
+
|
|
227
|
+
- **Content-Type**: Not defined
|
|
228
|
+
- **Accept**: application/json
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
## deals_id_activities_get
|
|
232
|
+
|
|
233
|
+
> deals_id_activities_get(id, opts)
|
|
234
|
+
|
|
235
|
+
List activities associated with a deal
|
|
236
|
+
|
|
237
|
+
Lists activities associated with a deal.
|
|
238
|
+
|
|
239
|
+
### Example
|
|
240
|
+
|
|
241
|
+
```ruby
|
|
242
|
+
# load the gem
|
|
243
|
+
require 'pipedrive-openapi-client'
|
|
244
|
+
# setup authorization
|
|
245
|
+
Pipedrive.configure do |config|
|
|
246
|
+
# Configure API key authorization: api_key
|
|
247
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
248
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
249
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
250
|
+
|
|
251
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
252
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
api_instance = Pipedrive::DealsApi.new
|
|
256
|
+
id = 56 # Integer | ID of the deal
|
|
257
|
+
opts = {
|
|
258
|
+
start: 0, # Integer | Pagination start
|
|
259
|
+
limit: 56, # Integer | Items shown per page
|
|
260
|
+
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.
|
|
261
|
+
exclude: 'exclude_example' # String | A comma-separated string of activity IDs to exclude from result
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
begin
|
|
265
|
+
#List activities associated with a deal
|
|
266
|
+
api_instance.deals_id_activities_get(id, opts)
|
|
267
|
+
rescue Pipedrive::ApiError => e
|
|
268
|
+
puts "Exception when calling DealsApi->deals_id_activities_get: #{e}"
|
|
269
|
+
end
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### Parameters
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
Name | Type | Description | Notes
|
|
276
|
+
------------- | ------------- | ------------- | -------------
|
|
277
|
+
**id** | **Integer**| ID of the deal |
|
|
278
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
279
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
280
|
+
**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]
|
|
281
|
+
**exclude** | **String**| A comma-separated string of activity IDs to exclude from result | [optional]
|
|
282
|
+
|
|
283
|
+
### Return type
|
|
284
|
+
|
|
285
|
+
nil (empty response body)
|
|
286
|
+
|
|
287
|
+
### Authorization
|
|
288
|
+
|
|
289
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
290
|
+
|
|
291
|
+
### HTTP request headers
|
|
292
|
+
|
|
293
|
+
- **Content-Type**: Not defined
|
|
294
|
+
- **Accept**: Not defined
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
## deals_id_delete
|
|
298
|
+
|
|
299
|
+
> DeleteDeal deals_id_delete(id)
|
|
300
|
+
|
|
301
|
+
Delete a deal
|
|
302
|
+
|
|
303
|
+
Marks a deal as deleted.
|
|
304
|
+
|
|
305
|
+
### Example
|
|
306
|
+
|
|
307
|
+
```ruby
|
|
308
|
+
# load the gem
|
|
309
|
+
require 'pipedrive-openapi-client'
|
|
310
|
+
# setup authorization
|
|
311
|
+
Pipedrive.configure do |config|
|
|
312
|
+
# Configure API key authorization: api_key
|
|
313
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
314
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
315
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
316
|
+
|
|
317
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
318
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
api_instance = Pipedrive::DealsApi.new
|
|
322
|
+
id = 56 # Integer | ID of the deal
|
|
323
|
+
|
|
324
|
+
begin
|
|
325
|
+
#Delete a deal
|
|
326
|
+
result = api_instance.deals_id_delete(id)
|
|
327
|
+
p result
|
|
328
|
+
rescue Pipedrive::ApiError => e
|
|
329
|
+
puts "Exception when calling DealsApi->deals_id_delete: #{e}"
|
|
330
|
+
end
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
### Parameters
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
Name | Type | Description | Notes
|
|
337
|
+
------------- | ------------- | ------------- | -------------
|
|
338
|
+
**id** | **Integer**| ID of the deal |
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
[**DeleteDeal**](DeleteDeal.md)
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: Not defined
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
## deals_id_duplicate_post
|
|
355
|
+
|
|
356
|
+
> GetDuplicatedDeal deals_id_duplicate_post(id)
|
|
357
|
+
|
|
358
|
+
Duplicate deal
|
|
359
|
+
|
|
360
|
+
Duplicate a deal
|
|
361
|
+
|
|
362
|
+
### Example
|
|
363
|
+
|
|
364
|
+
```ruby
|
|
365
|
+
# load the gem
|
|
366
|
+
require 'pipedrive-openapi-client'
|
|
367
|
+
# setup authorization
|
|
368
|
+
Pipedrive.configure do |config|
|
|
369
|
+
# Configure API key authorization: api_key
|
|
370
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
371
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
372
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
373
|
+
|
|
374
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
375
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
376
|
+
end
|
|
377
|
+
|
|
378
|
+
api_instance = Pipedrive::DealsApi.new
|
|
379
|
+
id = 56 # Integer | ID of the deal
|
|
380
|
+
|
|
381
|
+
begin
|
|
382
|
+
#Duplicate deal
|
|
383
|
+
result = api_instance.deals_id_duplicate_post(id)
|
|
384
|
+
p result
|
|
385
|
+
rescue Pipedrive::ApiError => e
|
|
386
|
+
puts "Exception when calling DealsApi->deals_id_duplicate_post: #{e}"
|
|
387
|
+
end
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
### Parameters
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
Name | Type | Description | Notes
|
|
394
|
+
------------- | ------------- | ------------- | -------------
|
|
395
|
+
**id** | **Integer**| ID of the deal |
|
|
396
|
+
|
|
397
|
+
### Return type
|
|
398
|
+
|
|
399
|
+
[**GetDuplicatedDeal**](GetDuplicatedDeal.md)
|
|
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**: application/json
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
## deals_id_files_get
|
|
412
|
+
|
|
413
|
+
> deals_id_files_get(id, opts)
|
|
414
|
+
|
|
415
|
+
List files attached to a deal
|
|
416
|
+
|
|
417
|
+
Lists files associated with a deal.
|
|
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::DealsApi.new
|
|
436
|
+
id = 56 # Integer | ID of the deal
|
|
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 deal
|
|
446
|
+
api_instance.deals_id_files_get(id, opts)
|
|
447
|
+
rescue Pipedrive::ApiError => e
|
|
448
|
+
puts "Exception when calling DealsApi->deals_id_files_get: #{e}"
|
|
449
|
+
end
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Parameters
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
Name | Type | Description | Notes
|
|
456
|
+
------------- | ------------- | ------------- | -------------
|
|
457
|
+
**id** | **Integer**| ID of the deal |
|
|
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
|
+
## deals_id_flow_get
|
|
478
|
+
|
|
479
|
+
> deals_id_flow_get(id, opts)
|
|
480
|
+
|
|
481
|
+
List updates about a deal
|
|
482
|
+
|
|
483
|
+
Lists updates about a deal.
|
|
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::DealsApi.new
|
|
502
|
+
id = 56 # Integer | ID of the deal
|
|
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 deal
|
|
512
|
+
api_instance.deals_id_flow_get(id, opts)
|
|
513
|
+
rescue Pipedrive::ApiError => e
|
|
514
|
+
puts "Exception when calling DealsApi->deals_id_flow_get: #{e}"
|
|
515
|
+
end
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
### Parameters
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
Name | Type | Description | Notes
|
|
522
|
+
------------- | ------------- | ------------- | -------------
|
|
523
|
+
**id** | **Integer**| ID of the deal |
|
|
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
|
+
## deals_id_followers_follower_id_delete
|
|
544
|
+
|
|
545
|
+
> DeleteDealFollower deals_id_followers_follower_id_delete(id, follower_id)
|
|
546
|
+
|
|
547
|
+
Delete a follower from a deal
|
|
548
|
+
|
|
549
|
+
Deletes a follower from a deal.
|
|
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
|
+
|
|
563
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
564
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
api_instance = Pipedrive::DealsApi.new
|
|
568
|
+
id = 56 # Integer | ID of the deal
|
|
569
|
+
follower_id = 56 # Integer | ID of the follower
|
|
570
|
+
|
|
571
|
+
begin
|
|
572
|
+
#Delete a follower from a deal
|
|
573
|
+
result = api_instance.deals_id_followers_follower_id_delete(id, follower_id)
|
|
574
|
+
p result
|
|
575
|
+
rescue Pipedrive::ApiError => e
|
|
576
|
+
puts "Exception when calling DealsApi->deals_id_followers_follower_id_delete: #{e}"
|
|
577
|
+
end
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### Parameters
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
Name | Type | Description | Notes
|
|
584
|
+
------------- | ------------- | ------------- | -------------
|
|
585
|
+
**id** | **Integer**| ID of the deal |
|
|
586
|
+
**follower_id** | **Integer**| ID of the follower |
|
|
587
|
+
|
|
588
|
+
### Return type
|
|
589
|
+
|
|
590
|
+
[**DeleteDealFollower**](DeleteDealFollower.md)
|
|
591
|
+
|
|
592
|
+
### Authorization
|
|
593
|
+
|
|
594
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
595
|
+
|
|
596
|
+
### HTTP request headers
|
|
597
|
+
|
|
598
|
+
- **Content-Type**: Not defined
|
|
599
|
+
- **Accept**: application/json
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
## deals_id_followers_get
|
|
603
|
+
|
|
604
|
+
> deals_id_followers_get(id)
|
|
605
|
+
|
|
606
|
+
List followers of a deal
|
|
607
|
+
|
|
608
|
+
Lists the followers of a deal.
|
|
609
|
+
|
|
610
|
+
### Example
|
|
611
|
+
|
|
612
|
+
```ruby
|
|
613
|
+
# load the gem
|
|
614
|
+
require 'pipedrive-openapi-client'
|
|
615
|
+
# setup authorization
|
|
616
|
+
Pipedrive.configure do |config|
|
|
617
|
+
# Configure API key authorization: api_key
|
|
618
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
619
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
620
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
621
|
+
|
|
622
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
623
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
624
|
+
end
|
|
625
|
+
|
|
626
|
+
api_instance = Pipedrive::DealsApi.new
|
|
627
|
+
id = 56 # Integer | ID of the deal
|
|
628
|
+
|
|
629
|
+
begin
|
|
630
|
+
#List followers of a deal
|
|
631
|
+
api_instance.deals_id_followers_get(id)
|
|
632
|
+
rescue Pipedrive::ApiError => e
|
|
633
|
+
puts "Exception when calling DealsApi->deals_id_followers_get: #{e}"
|
|
634
|
+
end
|
|
635
|
+
```
|
|
636
|
+
|
|
637
|
+
### Parameters
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
Name | Type | Description | Notes
|
|
641
|
+
------------- | ------------- | ------------- | -------------
|
|
642
|
+
**id** | **Integer**| ID of the deal |
|
|
643
|
+
|
|
644
|
+
### Return type
|
|
645
|
+
|
|
646
|
+
nil (empty response body)
|
|
647
|
+
|
|
648
|
+
### Authorization
|
|
649
|
+
|
|
650
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
651
|
+
|
|
652
|
+
### HTTP request headers
|
|
653
|
+
|
|
654
|
+
- **Content-Type**: Not defined
|
|
655
|
+
- **Accept**: Not defined
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
## deals_id_followers_post
|
|
659
|
+
|
|
660
|
+
> AddedDealFollower deals_id_followers_post(id, user_id)
|
|
661
|
+
|
|
662
|
+
Add a follower to a deal
|
|
663
|
+
|
|
664
|
+
Adds a follower to a deal.
|
|
665
|
+
|
|
666
|
+
### Example
|
|
667
|
+
|
|
668
|
+
```ruby
|
|
669
|
+
# load the gem
|
|
670
|
+
require 'pipedrive-openapi-client'
|
|
671
|
+
# setup authorization
|
|
672
|
+
Pipedrive.configure do |config|
|
|
673
|
+
# Configure API key authorization: api_key
|
|
674
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
675
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
676
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
677
|
+
|
|
678
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
679
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
680
|
+
end
|
|
681
|
+
|
|
682
|
+
api_instance = Pipedrive::DealsApi.new
|
|
683
|
+
id = 56 # Integer | ID of the deal
|
|
684
|
+
user_id = 56 # Integer | ID of the user
|
|
685
|
+
|
|
686
|
+
begin
|
|
687
|
+
#Add a follower to a deal
|
|
688
|
+
result = api_instance.deals_id_followers_post(id, user_id)
|
|
689
|
+
p result
|
|
690
|
+
rescue Pipedrive::ApiError => e
|
|
691
|
+
puts "Exception when calling DealsApi->deals_id_followers_post: #{e}"
|
|
692
|
+
end
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
### Parameters
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
Name | Type | Description | Notes
|
|
699
|
+
------------- | ------------- | ------------- | -------------
|
|
700
|
+
**id** | **Integer**| ID of the deal |
|
|
701
|
+
**user_id** | **Integer**| ID of the user |
|
|
702
|
+
|
|
703
|
+
### Return type
|
|
704
|
+
|
|
705
|
+
[**AddedDealFollower**](AddedDealFollower.md)
|
|
706
|
+
|
|
707
|
+
### Authorization
|
|
708
|
+
|
|
709
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
710
|
+
|
|
711
|
+
### HTTP request headers
|
|
712
|
+
|
|
713
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
714
|
+
- **Accept**: application/json
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
## deals_id_get
|
|
718
|
+
|
|
719
|
+
> GetDeal deals_id_get(id)
|
|
720
|
+
|
|
721
|
+
Get details of a deal
|
|
722
|
+
|
|
723
|
+
Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of dealFields. For more information on how to get all details of a deal, see <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
724
|
+
|
|
725
|
+
### Example
|
|
726
|
+
|
|
727
|
+
```ruby
|
|
728
|
+
# load the gem
|
|
729
|
+
require 'pipedrive-openapi-client'
|
|
730
|
+
# setup authorization
|
|
731
|
+
Pipedrive.configure do |config|
|
|
732
|
+
# Configure API key authorization: api_key
|
|
733
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
734
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
735
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
736
|
+
|
|
737
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
738
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
739
|
+
end
|
|
740
|
+
|
|
741
|
+
api_instance = Pipedrive::DealsApi.new
|
|
742
|
+
id = 56 # Integer | ID of the deal
|
|
743
|
+
|
|
744
|
+
begin
|
|
745
|
+
#Get details of a deal
|
|
746
|
+
result = api_instance.deals_id_get(id)
|
|
747
|
+
p result
|
|
748
|
+
rescue Pipedrive::ApiError => e
|
|
749
|
+
puts "Exception when calling DealsApi->deals_id_get: #{e}"
|
|
750
|
+
end
|
|
751
|
+
```
|
|
752
|
+
|
|
753
|
+
### Parameters
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
Name | Type | Description | Notes
|
|
757
|
+
------------- | ------------- | ------------- | -------------
|
|
758
|
+
**id** | **Integer**| ID of the deal |
|
|
759
|
+
|
|
760
|
+
### Return type
|
|
761
|
+
|
|
762
|
+
[**GetDeal**](GetDeal.md)
|
|
763
|
+
|
|
764
|
+
### Authorization
|
|
765
|
+
|
|
766
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
767
|
+
|
|
768
|
+
### HTTP request headers
|
|
769
|
+
|
|
770
|
+
- **Content-Type**: Not defined
|
|
771
|
+
- **Accept**: application/json
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
## deals_id_mail_messages_get
|
|
775
|
+
|
|
776
|
+
> deals_id_mail_messages_get(id, opts)
|
|
777
|
+
|
|
778
|
+
List mail messages associated with a deal
|
|
779
|
+
|
|
780
|
+
Lists mail messages associated with a deal.
|
|
781
|
+
|
|
782
|
+
### Example
|
|
783
|
+
|
|
784
|
+
```ruby
|
|
785
|
+
# load the gem
|
|
786
|
+
require 'pipedrive-openapi-client'
|
|
787
|
+
# setup authorization
|
|
788
|
+
Pipedrive.configure do |config|
|
|
789
|
+
# Configure API key authorization: api_key
|
|
790
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
791
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
792
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
793
|
+
|
|
794
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
795
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
796
|
+
end
|
|
797
|
+
|
|
798
|
+
api_instance = Pipedrive::DealsApi.new
|
|
799
|
+
id = 56 # Integer | ID of the deal
|
|
800
|
+
opts = {
|
|
801
|
+
start: 0, # Integer | Pagination start
|
|
802
|
+
limit: 56 # Integer | Items shown per page
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
begin
|
|
806
|
+
#List mail messages associated with a deal
|
|
807
|
+
api_instance.deals_id_mail_messages_get(id, opts)
|
|
808
|
+
rescue Pipedrive::ApiError => e
|
|
809
|
+
puts "Exception when calling DealsApi->deals_id_mail_messages_get: #{e}"
|
|
810
|
+
end
|
|
811
|
+
```
|
|
812
|
+
|
|
813
|
+
### Parameters
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
Name | Type | Description | Notes
|
|
817
|
+
------------- | ------------- | ------------- | -------------
|
|
818
|
+
**id** | **Integer**| ID of the deal |
|
|
819
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
820
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
821
|
+
|
|
822
|
+
### Return type
|
|
823
|
+
|
|
824
|
+
nil (empty response body)
|
|
825
|
+
|
|
826
|
+
### Authorization
|
|
827
|
+
|
|
828
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
829
|
+
|
|
830
|
+
### HTTP request headers
|
|
831
|
+
|
|
832
|
+
- **Content-Type**: Not defined
|
|
833
|
+
- **Accept**: Not defined
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
## deals_id_merge_put
|
|
837
|
+
|
|
838
|
+
> GetMergedDeal deals_id_merge_put(id, merge_with_id)
|
|
839
|
+
|
|
840
|
+
Merge two deals
|
|
841
|
+
|
|
842
|
+
Merges a deal with another deal. For more information on how to merge two deals, see <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
843
|
+
|
|
844
|
+
### Example
|
|
845
|
+
|
|
846
|
+
```ruby
|
|
847
|
+
# load the gem
|
|
848
|
+
require 'pipedrive-openapi-client'
|
|
849
|
+
# setup authorization
|
|
850
|
+
Pipedrive.configure do |config|
|
|
851
|
+
# Configure API key authorization: api_key
|
|
852
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
853
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
854
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
855
|
+
|
|
856
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
857
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
858
|
+
end
|
|
859
|
+
|
|
860
|
+
api_instance = Pipedrive::DealsApi.new
|
|
861
|
+
id = 56 # Integer | ID of the deal
|
|
862
|
+
merge_with_id = 56 # Integer | ID of the deal that the deal will be merged with
|
|
863
|
+
|
|
864
|
+
begin
|
|
865
|
+
#Merge two deals
|
|
866
|
+
result = api_instance.deals_id_merge_put(id, merge_with_id)
|
|
867
|
+
p result
|
|
868
|
+
rescue Pipedrive::ApiError => e
|
|
869
|
+
puts "Exception when calling DealsApi->deals_id_merge_put: #{e}"
|
|
870
|
+
end
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
### Parameters
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
Name | Type | Description | Notes
|
|
877
|
+
------------- | ------------- | ------------- | -------------
|
|
878
|
+
**id** | **Integer**| ID of the deal |
|
|
879
|
+
**merge_with_id** | **Integer**| ID of the deal that the deal will be merged with |
|
|
880
|
+
|
|
881
|
+
### Return type
|
|
882
|
+
|
|
883
|
+
[**GetMergedDeal**](GetMergedDeal.md)
|
|
884
|
+
|
|
885
|
+
### Authorization
|
|
886
|
+
|
|
887
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
888
|
+
|
|
889
|
+
### HTTP request headers
|
|
890
|
+
|
|
891
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
892
|
+
- **Accept**: application/json
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
## deals_id_participants_deal_participant_id_delete
|
|
896
|
+
|
|
897
|
+
> DeleteDealParticipant deals_id_participants_deal_participant_id_delete(id, deal_participant_id)
|
|
898
|
+
|
|
899
|
+
Delete a participant from a deal
|
|
900
|
+
|
|
901
|
+
Deletes a participant from a deal.
|
|
902
|
+
|
|
903
|
+
### Example
|
|
904
|
+
|
|
905
|
+
```ruby
|
|
906
|
+
# load the gem
|
|
907
|
+
require 'pipedrive-openapi-client'
|
|
908
|
+
# setup authorization
|
|
909
|
+
Pipedrive.configure do |config|
|
|
910
|
+
# Configure API key authorization: api_key
|
|
911
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
912
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
913
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
914
|
+
|
|
915
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
916
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
917
|
+
end
|
|
918
|
+
|
|
919
|
+
api_instance = Pipedrive::DealsApi.new
|
|
920
|
+
id = 56 # Integer | ID of the deal
|
|
921
|
+
deal_participant_id = 56 # Integer | ID of the deal participant
|
|
922
|
+
|
|
923
|
+
begin
|
|
924
|
+
#Delete a participant from a deal
|
|
925
|
+
result = api_instance.deals_id_participants_deal_participant_id_delete(id, deal_participant_id)
|
|
926
|
+
p result
|
|
927
|
+
rescue Pipedrive::ApiError => e
|
|
928
|
+
puts "Exception when calling DealsApi->deals_id_participants_deal_participant_id_delete: #{e}"
|
|
929
|
+
end
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
### Parameters
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
Name | Type | Description | Notes
|
|
936
|
+
------------- | ------------- | ------------- | -------------
|
|
937
|
+
**id** | **Integer**| ID of the deal |
|
|
938
|
+
**deal_participant_id** | **Integer**| ID of the deal participant |
|
|
939
|
+
|
|
940
|
+
### Return type
|
|
941
|
+
|
|
942
|
+
[**DeleteDealParticipant**](DeleteDealParticipant.md)
|
|
943
|
+
|
|
944
|
+
### Authorization
|
|
945
|
+
|
|
946
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
947
|
+
|
|
948
|
+
### HTTP request headers
|
|
949
|
+
|
|
950
|
+
- **Content-Type**: Not defined
|
|
951
|
+
- **Accept**: application/json
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
## deals_id_participants_get
|
|
955
|
+
|
|
956
|
+
> deals_id_participants_get(id, opts)
|
|
957
|
+
|
|
958
|
+
List participants of a deal
|
|
959
|
+
|
|
960
|
+
Lists participants associated with a deal.
|
|
961
|
+
|
|
962
|
+
### Example
|
|
963
|
+
|
|
964
|
+
```ruby
|
|
965
|
+
# load the gem
|
|
966
|
+
require 'pipedrive-openapi-client'
|
|
967
|
+
# setup authorization
|
|
968
|
+
Pipedrive.configure do |config|
|
|
969
|
+
# Configure API key authorization: api_key
|
|
970
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
971
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
972
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
973
|
+
|
|
974
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
975
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
976
|
+
end
|
|
977
|
+
|
|
978
|
+
api_instance = Pipedrive::DealsApi.new
|
|
979
|
+
id = 56 # Integer | ID of the deal
|
|
980
|
+
opts = {
|
|
981
|
+
start: 0, # Integer | Pagination start
|
|
982
|
+
limit: 56 # Integer | Items shown per page
|
|
983
|
+
}
|
|
984
|
+
|
|
985
|
+
begin
|
|
986
|
+
#List participants of a deal
|
|
987
|
+
api_instance.deals_id_participants_get(id, opts)
|
|
988
|
+
rescue Pipedrive::ApiError => e
|
|
989
|
+
puts "Exception when calling DealsApi->deals_id_participants_get: #{e}"
|
|
990
|
+
end
|
|
991
|
+
```
|
|
992
|
+
|
|
993
|
+
### Parameters
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
Name | Type | Description | Notes
|
|
997
|
+
------------- | ------------- | ------------- | -------------
|
|
998
|
+
**id** | **Integer**| ID of the deal |
|
|
999
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
1000
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1001
|
+
|
|
1002
|
+
### Return type
|
|
1003
|
+
|
|
1004
|
+
nil (empty response body)
|
|
1005
|
+
|
|
1006
|
+
### Authorization
|
|
1007
|
+
|
|
1008
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1009
|
+
|
|
1010
|
+
### HTTP request headers
|
|
1011
|
+
|
|
1012
|
+
- **Content-Type**: Not defined
|
|
1013
|
+
- **Accept**: Not defined
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
## deals_id_participants_post
|
|
1017
|
+
|
|
1018
|
+
> deals_id_participants_post(id, person_id)
|
|
1019
|
+
|
|
1020
|
+
Add a participant to a deal
|
|
1021
|
+
|
|
1022
|
+
Adds a participant to a deal.
|
|
1023
|
+
|
|
1024
|
+
### Example
|
|
1025
|
+
|
|
1026
|
+
```ruby
|
|
1027
|
+
# load the gem
|
|
1028
|
+
require 'pipedrive-openapi-client'
|
|
1029
|
+
# setup authorization
|
|
1030
|
+
Pipedrive.configure do |config|
|
|
1031
|
+
# Configure API key authorization: api_key
|
|
1032
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1033
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1034
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1035
|
+
|
|
1036
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1037
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1038
|
+
end
|
|
1039
|
+
|
|
1040
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1041
|
+
id = 56 # Integer | ID of the deal
|
|
1042
|
+
person_id = 56 # Integer | ID of the person
|
|
1043
|
+
|
|
1044
|
+
begin
|
|
1045
|
+
#Add a participant to a deal
|
|
1046
|
+
api_instance.deals_id_participants_post(id, person_id)
|
|
1047
|
+
rescue Pipedrive::ApiError => e
|
|
1048
|
+
puts "Exception when calling DealsApi->deals_id_participants_post: #{e}"
|
|
1049
|
+
end
|
|
1050
|
+
```
|
|
1051
|
+
|
|
1052
|
+
### Parameters
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
Name | Type | Description | Notes
|
|
1056
|
+
------------- | ------------- | ------------- | -------------
|
|
1057
|
+
**id** | **Integer**| ID of the deal |
|
|
1058
|
+
**person_id** | **Integer**| ID of the person |
|
|
1059
|
+
|
|
1060
|
+
### Return type
|
|
1061
|
+
|
|
1062
|
+
nil (empty response body)
|
|
1063
|
+
|
|
1064
|
+
### Authorization
|
|
1065
|
+
|
|
1066
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1067
|
+
|
|
1068
|
+
### HTTP request headers
|
|
1069
|
+
|
|
1070
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
1071
|
+
- **Accept**: Not defined
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
## deals_id_permitted_users_get
|
|
1075
|
+
|
|
1076
|
+
> deals_id_permitted_users_get(id)
|
|
1077
|
+
|
|
1078
|
+
List permitted users
|
|
1079
|
+
|
|
1080
|
+
List users permitted to access a deal
|
|
1081
|
+
|
|
1082
|
+
### Example
|
|
1083
|
+
|
|
1084
|
+
```ruby
|
|
1085
|
+
# load the gem
|
|
1086
|
+
require 'pipedrive-openapi-client'
|
|
1087
|
+
# setup authorization
|
|
1088
|
+
Pipedrive.configure do |config|
|
|
1089
|
+
# Configure API key authorization: api_key
|
|
1090
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1091
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1092
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1093
|
+
end
|
|
1094
|
+
|
|
1095
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1096
|
+
id = 56 # Integer | ID of the deal
|
|
1097
|
+
|
|
1098
|
+
begin
|
|
1099
|
+
#List permitted users
|
|
1100
|
+
api_instance.deals_id_permitted_users_get(id)
|
|
1101
|
+
rescue Pipedrive::ApiError => e
|
|
1102
|
+
puts "Exception when calling DealsApi->deals_id_permitted_users_get: #{e}"
|
|
1103
|
+
end
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
### Parameters
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
Name | Type | Description | Notes
|
|
1110
|
+
------------- | ------------- | ------------- | -------------
|
|
1111
|
+
**id** | **Integer**| ID of the deal |
|
|
1112
|
+
|
|
1113
|
+
### Return type
|
|
1114
|
+
|
|
1115
|
+
nil (empty response body)
|
|
1116
|
+
|
|
1117
|
+
### Authorization
|
|
1118
|
+
|
|
1119
|
+
[api_key](../README.md#api_key)
|
|
1120
|
+
|
|
1121
|
+
### HTTP request headers
|
|
1122
|
+
|
|
1123
|
+
- **Content-Type**: Not defined
|
|
1124
|
+
- **Accept**: Not defined
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
## deals_id_persons_get
|
|
1128
|
+
|
|
1129
|
+
> deals_id_persons_get(id, opts)
|
|
1130
|
+
|
|
1131
|
+
List all persons associated with a deal
|
|
1132
|
+
|
|
1133
|
+
Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
|
|
1134
|
+
|
|
1135
|
+
### Example
|
|
1136
|
+
|
|
1137
|
+
```ruby
|
|
1138
|
+
# load the gem
|
|
1139
|
+
require 'pipedrive-openapi-client'
|
|
1140
|
+
# setup authorization
|
|
1141
|
+
Pipedrive.configure do |config|
|
|
1142
|
+
# Configure API key authorization: api_key
|
|
1143
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1144
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1145
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1146
|
+
|
|
1147
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1148
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1149
|
+
end
|
|
1150
|
+
|
|
1151
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1152
|
+
id = 56 # Integer | ID of the deal
|
|
1153
|
+
opts = {
|
|
1154
|
+
start: 0, # Integer | Pagination start
|
|
1155
|
+
limit: 56 # Integer | Items shown per page
|
|
1156
|
+
}
|
|
1157
|
+
|
|
1158
|
+
begin
|
|
1159
|
+
#List all persons associated with a deal
|
|
1160
|
+
api_instance.deals_id_persons_get(id, opts)
|
|
1161
|
+
rescue Pipedrive::ApiError => e
|
|
1162
|
+
puts "Exception when calling DealsApi->deals_id_persons_get: #{e}"
|
|
1163
|
+
end
|
|
1164
|
+
```
|
|
1165
|
+
|
|
1166
|
+
### Parameters
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
Name | Type | Description | Notes
|
|
1170
|
+
------------- | ------------- | ------------- | -------------
|
|
1171
|
+
**id** | **Integer**| ID of the deal |
|
|
1172
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
1173
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1174
|
+
|
|
1175
|
+
### Return type
|
|
1176
|
+
|
|
1177
|
+
nil (empty response body)
|
|
1178
|
+
|
|
1179
|
+
### Authorization
|
|
1180
|
+
|
|
1181
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1182
|
+
|
|
1183
|
+
### HTTP request headers
|
|
1184
|
+
|
|
1185
|
+
- **Content-Type**: Not defined
|
|
1186
|
+
- **Accept**: Not defined
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
## deals_id_products_get
|
|
1190
|
+
|
|
1191
|
+
> deals_id_products_get(id, opts)
|
|
1192
|
+
|
|
1193
|
+
List products attached to a deal
|
|
1194
|
+
|
|
1195
|
+
Lists products attached to a deal.
|
|
1196
|
+
|
|
1197
|
+
### Example
|
|
1198
|
+
|
|
1199
|
+
```ruby
|
|
1200
|
+
# load the gem
|
|
1201
|
+
require 'pipedrive-openapi-client'
|
|
1202
|
+
# setup authorization
|
|
1203
|
+
Pipedrive.configure do |config|
|
|
1204
|
+
# Configure API key authorization: api_key
|
|
1205
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1206
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1207
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1208
|
+
|
|
1209
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1210
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1211
|
+
end
|
|
1212
|
+
|
|
1213
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1214
|
+
id = 56 # Integer | ID of the deal
|
|
1215
|
+
opts = {
|
|
1216
|
+
start: 0, # Integer | Pagination start
|
|
1217
|
+
limit: 56, # Integer | Items shown per page
|
|
1218
|
+
include_product_data: Pipedrive::NumberBoolean.new # NumberBoolean | Whether to fetch product data along with each attached product (1) or not (0, default).
|
|
1219
|
+
}
|
|
1220
|
+
|
|
1221
|
+
begin
|
|
1222
|
+
#List products attached to a deal
|
|
1223
|
+
api_instance.deals_id_products_get(id, opts)
|
|
1224
|
+
rescue Pipedrive::ApiError => e
|
|
1225
|
+
puts "Exception when calling DealsApi->deals_id_products_get: #{e}"
|
|
1226
|
+
end
|
|
1227
|
+
```
|
|
1228
|
+
|
|
1229
|
+
### Parameters
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
Name | Type | Description | Notes
|
|
1233
|
+
------------- | ------------- | ------------- | -------------
|
|
1234
|
+
**id** | **Integer**| ID of the deal |
|
|
1235
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
1236
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1237
|
+
**include_product_data** | [**NumberBoolean**](.md)| Whether to fetch product data along with each attached product (1) or not (0, default). | [optional]
|
|
1238
|
+
|
|
1239
|
+
### Return type
|
|
1240
|
+
|
|
1241
|
+
nil (empty response body)
|
|
1242
|
+
|
|
1243
|
+
### Authorization
|
|
1244
|
+
|
|
1245
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1246
|
+
|
|
1247
|
+
### HTTP request headers
|
|
1248
|
+
|
|
1249
|
+
- **Content-Type**: Not defined
|
|
1250
|
+
- **Accept**: Not defined
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
## deals_id_products_post
|
|
1254
|
+
|
|
1255
|
+
> GetAddProductAttachementDetails deals_id_products_post(id, opts)
|
|
1256
|
+
|
|
1257
|
+
Add a product to the deal, eventually creating a new item called a deal-product
|
|
1258
|
+
|
|
1259
|
+
Adds a product to the deal.
|
|
1260
|
+
|
|
1261
|
+
### Example
|
|
1262
|
+
|
|
1263
|
+
```ruby
|
|
1264
|
+
# load the gem
|
|
1265
|
+
require 'pipedrive-openapi-client'
|
|
1266
|
+
# setup authorization
|
|
1267
|
+
Pipedrive.configure do |config|
|
|
1268
|
+
# Configure API key authorization: api_key
|
|
1269
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1270
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1271
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1272
|
+
|
|
1273
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1274
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1275
|
+
end
|
|
1276
|
+
|
|
1277
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1278
|
+
id = 56 # Integer | ID of the deal
|
|
1279
|
+
opts = {
|
|
1280
|
+
new_deal_product: Pipedrive::NewDealProduct.new # NewDealProduct |
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
begin
|
|
1284
|
+
#Add a product to the deal, eventually creating a new item called a deal-product
|
|
1285
|
+
result = api_instance.deals_id_products_post(id, opts)
|
|
1286
|
+
p result
|
|
1287
|
+
rescue Pipedrive::ApiError => e
|
|
1288
|
+
puts "Exception when calling DealsApi->deals_id_products_post: #{e}"
|
|
1289
|
+
end
|
|
1290
|
+
```
|
|
1291
|
+
|
|
1292
|
+
### Parameters
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
Name | Type | Description | Notes
|
|
1296
|
+
------------- | ------------- | ------------- | -------------
|
|
1297
|
+
**id** | **Integer**| ID of the deal |
|
|
1298
|
+
**new_deal_product** | [**NewDealProduct**](NewDealProduct.md)| | [optional]
|
|
1299
|
+
|
|
1300
|
+
### Return type
|
|
1301
|
+
|
|
1302
|
+
[**GetAddProductAttachementDetails**](GetAddProductAttachementDetails.md)
|
|
1303
|
+
|
|
1304
|
+
### Authorization
|
|
1305
|
+
|
|
1306
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1307
|
+
|
|
1308
|
+
### HTTP request headers
|
|
1309
|
+
|
|
1310
|
+
- **Content-Type**: application/json
|
|
1311
|
+
- **Accept**: application/json
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
## deals_id_products_product_attachment_id_delete
|
|
1315
|
+
|
|
1316
|
+
> DeleteDealProduct deals_id_products_product_attachment_id_delete(id, product_attachment_id)
|
|
1317
|
+
|
|
1318
|
+
Delete an attached product from a deal
|
|
1319
|
+
|
|
1320
|
+
Deletes a product attachment from a deal, using the product_attachment_id.
|
|
1321
|
+
|
|
1322
|
+
### Example
|
|
1323
|
+
|
|
1324
|
+
```ruby
|
|
1325
|
+
# load the gem
|
|
1326
|
+
require 'pipedrive-openapi-client'
|
|
1327
|
+
# setup authorization
|
|
1328
|
+
Pipedrive.configure do |config|
|
|
1329
|
+
# Configure API key authorization: api_key
|
|
1330
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1331
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1332
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1333
|
+
end
|
|
1334
|
+
|
|
1335
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1336
|
+
id = 56 # Integer | ID of the deal
|
|
1337
|
+
product_attachment_id = 56 # Integer | Product attachment ID. This is returned as product_attachment_id after attaching a product to a deal or as id when listing the products attached to a deal.
|
|
1338
|
+
|
|
1339
|
+
begin
|
|
1340
|
+
#Delete an attached product from a deal
|
|
1341
|
+
result = api_instance.deals_id_products_product_attachment_id_delete(id, product_attachment_id)
|
|
1342
|
+
p result
|
|
1343
|
+
rescue Pipedrive::ApiError => e
|
|
1344
|
+
puts "Exception when calling DealsApi->deals_id_products_product_attachment_id_delete: #{e}"
|
|
1345
|
+
end
|
|
1346
|
+
```
|
|
1347
|
+
|
|
1348
|
+
### Parameters
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
Name | Type | Description | Notes
|
|
1352
|
+
------------- | ------------- | ------------- | -------------
|
|
1353
|
+
**id** | **Integer**| ID of the deal |
|
|
1354
|
+
**product_attachment_id** | **Integer**| Product attachment ID. This is returned as product_attachment_id after attaching a product to a deal or as id when listing the products attached to a deal. |
|
|
1355
|
+
|
|
1356
|
+
### Return type
|
|
1357
|
+
|
|
1358
|
+
[**DeleteDealProduct**](DeleteDealProduct.md)
|
|
1359
|
+
|
|
1360
|
+
### Authorization
|
|
1361
|
+
|
|
1362
|
+
[api_key](../README.md#api_key)
|
|
1363
|
+
|
|
1364
|
+
### HTTP request headers
|
|
1365
|
+
|
|
1366
|
+
- **Content-Type**: Not defined
|
|
1367
|
+
- **Accept**: application/json
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
## deals_id_products_product_attachment_id_put
|
|
1371
|
+
|
|
1372
|
+
> GetProductAttachementDetails deals_id_products_product_attachment_id_put(id, product_attachment_id, opts)
|
|
1373
|
+
|
|
1374
|
+
Update product attachment details of the deal-product (a product already attached to a deal)
|
|
1375
|
+
|
|
1376
|
+
Updates product attachment details.
|
|
1377
|
+
|
|
1378
|
+
### Example
|
|
1379
|
+
|
|
1380
|
+
```ruby
|
|
1381
|
+
# load the gem
|
|
1382
|
+
require 'pipedrive-openapi-client'
|
|
1383
|
+
# setup authorization
|
|
1384
|
+
Pipedrive.configure do |config|
|
|
1385
|
+
# Configure API key authorization: api_key
|
|
1386
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1387
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1388
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1389
|
+
end
|
|
1390
|
+
|
|
1391
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1392
|
+
id = 56 # Integer | ID of the deal
|
|
1393
|
+
product_attachment_id = 56 # Integer | ID of the deal-product (the ID of the product attached to the deal)
|
|
1394
|
+
opts = {
|
|
1395
|
+
basic_deal_product: Pipedrive::BasicDealProduct.new # BasicDealProduct |
|
|
1396
|
+
}
|
|
1397
|
+
|
|
1398
|
+
begin
|
|
1399
|
+
#Update product attachment details of the deal-product (a product already attached to a deal)
|
|
1400
|
+
result = api_instance.deals_id_products_product_attachment_id_put(id, product_attachment_id, opts)
|
|
1401
|
+
p result
|
|
1402
|
+
rescue Pipedrive::ApiError => e
|
|
1403
|
+
puts "Exception when calling DealsApi->deals_id_products_product_attachment_id_put: #{e}"
|
|
1404
|
+
end
|
|
1405
|
+
```
|
|
1406
|
+
|
|
1407
|
+
### Parameters
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
Name | Type | Description | Notes
|
|
1411
|
+
------------- | ------------- | ------------- | -------------
|
|
1412
|
+
**id** | **Integer**| ID of the deal |
|
|
1413
|
+
**product_attachment_id** | **Integer**| ID of the deal-product (the ID of the product attached to the deal) |
|
|
1414
|
+
**basic_deal_product** | [**BasicDealProduct**](BasicDealProduct.md)| | [optional]
|
|
1415
|
+
|
|
1416
|
+
### Return type
|
|
1417
|
+
|
|
1418
|
+
[**GetProductAttachementDetails**](GetProductAttachementDetails.md)
|
|
1419
|
+
|
|
1420
|
+
### Authorization
|
|
1421
|
+
|
|
1422
|
+
[api_key](../README.md#api_key)
|
|
1423
|
+
|
|
1424
|
+
### HTTP request headers
|
|
1425
|
+
|
|
1426
|
+
- **Content-Type**: application/json
|
|
1427
|
+
- **Accept**: application/json
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
## deals_id_put
|
|
1431
|
+
|
|
1432
|
+
> GetAddedDeal deals_id_put(id, opts)
|
|
1433
|
+
|
|
1434
|
+
Update a deal
|
|
1435
|
+
|
|
1436
|
+
Updates the properties of a deal. For more information on how to update a deal, see <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
1437
|
+
|
|
1438
|
+
### Example
|
|
1439
|
+
|
|
1440
|
+
```ruby
|
|
1441
|
+
# load the gem
|
|
1442
|
+
require 'pipedrive-openapi-client'
|
|
1443
|
+
# setup authorization
|
|
1444
|
+
Pipedrive.configure do |config|
|
|
1445
|
+
# Configure API key authorization: api_key
|
|
1446
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1447
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1448
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1449
|
+
|
|
1450
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1451
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1452
|
+
end
|
|
1453
|
+
|
|
1454
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1455
|
+
id = 56 # Integer | ID of the deal
|
|
1456
|
+
opts = {
|
|
1457
|
+
title: 'title_example', # String | Deal title
|
|
1458
|
+
value: 'value_example', # String | Value of the deal. If omitted, value will be set to 0.
|
|
1459
|
+
currency: 'currency_example', # String | Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
|
|
1460
|
+
user_id: 56, # Integer | ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.
|
|
1461
|
+
person_id: 56, # Integer | ID of the person this deal will be associated with
|
|
1462
|
+
org_id: 56, # Integer | ID of the organization this deal will be associated with
|
|
1463
|
+
stage_id: 56, # Integer | ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline.
|
|
1464
|
+
status: 'status_example', # String | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.
|
|
1465
|
+
probability: 3.4, # Float | Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.
|
|
1466
|
+
lost_reason: 'lost_reason_example', # String | Optional message about why the deal was lost (to be used when status=lost)
|
|
1467
|
+
visible_to: Pipedrive::VisibleTo.new # VisibleTo | Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<dl class=\\\"fields-list\\\"><dt>1</dt><dd>Owner & followers (private)</dd><dt>3</dt><dd>Entire company (shared)</dd></dl>
|
|
1468
|
+
}
|
|
1469
|
+
|
|
1470
|
+
begin
|
|
1471
|
+
#Update a deal
|
|
1472
|
+
result = api_instance.deals_id_put(id, opts)
|
|
1473
|
+
p result
|
|
1474
|
+
rescue Pipedrive::ApiError => e
|
|
1475
|
+
puts "Exception when calling DealsApi->deals_id_put: #{e}"
|
|
1476
|
+
end
|
|
1477
|
+
```
|
|
1478
|
+
|
|
1479
|
+
### Parameters
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
Name | Type | Description | Notes
|
|
1483
|
+
------------- | ------------- | ------------- | -------------
|
|
1484
|
+
**id** | **Integer**| ID of the deal |
|
|
1485
|
+
**title** | **String**| Deal title | [optional]
|
|
1486
|
+
**value** | **String**| Value of the deal. If omitted, value will be set to 0. | [optional]
|
|
1487
|
+
**currency** | **String**| Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user. | [optional]
|
|
1488
|
+
**user_id** | **Integer**| ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used. | [optional]
|
|
1489
|
+
**person_id** | **Integer**| ID of the person this deal will be associated with | [optional]
|
|
1490
|
+
**org_id** | **Integer**| ID of the organization this deal will be associated with | [optional]
|
|
1491
|
+
**stage_id** | **Integer**| ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline. | [optional]
|
|
1492
|
+
**status** | **String**| open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional]
|
|
1493
|
+
**probability** | **Float**| Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled. | [optional]
|
|
1494
|
+
**lost_reason** | **String**| Optional message about why the deal was lost (to be used when status=lost) | [optional]
|
|
1495
|
+
**visible_to** | [**VisibleTo**](VisibleTo.md)| Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<dl class=\\\"fields-list\\\"><dt>1</dt><dd>Owner &amp; followers (private)</dd><dt>3</dt><dd>Entire company (shared)</dd></dl> | [optional]
|
|
1496
|
+
|
|
1497
|
+
### Return type
|
|
1498
|
+
|
|
1499
|
+
[**GetAddedDeal**](GetAddedDeal.md)
|
|
1500
|
+
|
|
1501
|
+
### Authorization
|
|
1502
|
+
|
|
1503
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1504
|
+
|
|
1505
|
+
### HTTP request headers
|
|
1506
|
+
|
|
1507
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
1508
|
+
- **Accept**: application/json
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
## deals_post
|
|
1512
|
+
|
|
1513
|
+
> GetAddedDeal deals_post
|
|
1514
|
+
|
|
1515
|
+
Add a deal
|
|
1516
|
+
|
|
1517
|
+
Adds a new deal. 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 dealFields and look for 'key' values. For more information on how to add a deal, see <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
1518
|
+
|
|
1519
|
+
### Example
|
|
1520
|
+
|
|
1521
|
+
```ruby
|
|
1522
|
+
# load the gem
|
|
1523
|
+
require 'pipedrive-openapi-client'
|
|
1524
|
+
# setup authorization
|
|
1525
|
+
Pipedrive.configure do |config|
|
|
1526
|
+
# Configure API key authorization: api_key
|
|
1527
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1528
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1529
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1530
|
+
|
|
1531
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1532
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1533
|
+
end
|
|
1534
|
+
|
|
1535
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1536
|
+
|
|
1537
|
+
begin
|
|
1538
|
+
#Add a deal
|
|
1539
|
+
result = api_instance.deals_post
|
|
1540
|
+
p result
|
|
1541
|
+
rescue Pipedrive::ApiError => e
|
|
1542
|
+
puts "Exception when calling DealsApi->deals_post: #{e}"
|
|
1543
|
+
end
|
|
1544
|
+
```
|
|
1545
|
+
|
|
1546
|
+
### Parameters
|
|
1547
|
+
|
|
1548
|
+
This endpoint does not need any parameter.
|
|
1549
|
+
|
|
1550
|
+
### Return type
|
|
1551
|
+
|
|
1552
|
+
[**GetAddedDeal**](GetAddedDeal.md)
|
|
1553
|
+
|
|
1554
|
+
### Authorization
|
|
1555
|
+
|
|
1556
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1557
|
+
|
|
1558
|
+
### HTTP request headers
|
|
1559
|
+
|
|
1560
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
1561
|
+
- **Accept**: application/json
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
## deals_search_get
|
|
1565
|
+
|
|
1566
|
+
> BaseResponse deals_search_get(term, opts)
|
|
1567
|
+
|
|
1568
|
+
Search deals
|
|
1569
|
+
|
|
1570
|
+
Searches all Deals by title, 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 Deals can be filtered by Person ID and Organization ID.
|
|
1571
|
+
|
|
1572
|
+
### Example
|
|
1573
|
+
|
|
1574
|
+
```ruby
|
|
1575
|
+
# load the gem
|
|
1576
|
+
require 'pipedrive-openapi-client'
|
|
1577
|
+
# setup authorization
|
|
1578
|
+
Pipedrive.configure do |config|
|
|
1579
|
+
# Configure API key authorization: api_key
|
|
1580
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1581
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1582
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1583
|
+
|
|
1584
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1585
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1586
|
+
end
|
|
1587
|
+
|
|
1588
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1589
|
+
term = 'term_example' # String | The search term to look for. Minimum 2 characters (or 1 if using exact_match).
|
|
1590
|
+
opts = {
|
|
1591
|
+
fields: 'fields_example', # String | A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
1592
|
+
exact_match: true, # Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1593
|
+
person_id: 56, # Integer | Will filter Deals by the provided Person ID. The upper limit of found Deals associated with the Person is 2000.
|
|
1594
|
+
organization_id: 56, # Integer | Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.
|
|
1595
|
+
status: 'status_example', # String | Will filter Deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found Deals associated with the status is 2000.
|
|
1596
|
+
include_fields: 'include_fields_example', # String | Supports including optional fields in the results which are not provided by default.
|
|
1597
|
+
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.
|
|
1598
|
+
limit: 56 # Integer | Items shown per page
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1601
|
+
begin
|
|
1602
|
+
#Search deals
|
|
1603
|
+
result = api_instance.deals_search_get(term, opts)
|
|
1604
|
+
p result
|
|
1605
|
+
rescue Pipedrive::ApiError => e
|
|
1606
|
+
puts "Exception when calling DealsApi->deals_search_get: #{e}"
|
|
1607
|
+
end
|
|
1608
|
+
```
|
|
1609
|
+
|
|
1610
|
+
### Parameters
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
Name | Type | Description | Notes
|
|
1614
|
+
------------- | ------------- | ------------- | -------------
|
|
1615
|
+
**term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using exact_match). |
|
|
1616
|
+
**fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. | [optional]
|
|
1617
|
+
**exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional]
|
|
1618
|
+
**person_id** | **Integer**| Will filter Deals by the provided Person ID. The upper limit of found Deals associated with the Person is 2000. | [optional]
|
|
1619
|
+
**organization_id** | **Integer**| Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000. | [optional]
|
|
1620
|
+
**status** | **String**| Will filter Deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found Deals associated with the status is 2000. | [optional]
|
|
1621
|
+
**include_fields** | **String**| Supports including optional fields in the results which are not provided by default. | [optional]
|
|
1622
|
+
**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]
|
|
1623
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1624
|
+
|
|
1625
|
+
### Return type
|
|
1626
|
+
|
|
1627
|
+
[**BaseResponse**](BaseResponse.md)
|
|
1628
|
+
|
|
1629
|
+
### Authorization
|
|
1630
|
+
|
|
1631
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1632
|
+
|
|
1633
|
+
### HTTP request headers
|
|
1634
|
+
|
|
1635
|
+
- **Content-Type**: Not defined
|
|
1636
|
+
- **Accept**: application/json
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
## deals_summary_get
|
|
1640
|
+
|
|
1641
|
+
> GetDealsSummary deals_summary_get(opts)
|
|
1642
|
+
|
|
1643
|
+
Get deals summary
|
|
1644
|
+
|
|
1645
|
+
Returns summary of all the deals.
|
|
1646
|
+
|
|
1647
|
+
### Example
|
|
1648
|
+
|
|
1649
|
+
```ruby
|
|
1650
|
+
# load the gem
|
|
1651
|
+
require 'pipedrive-openapi-client'
|
|
1652
|
+
# setup authorization
|
|
1653
|
+
Pipedrive.configure do |config|
|
|
1654
|
+
# Configure API key authorization: api_key
|
|
1655
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1656
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1657
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1658
|
+
|
|
1659
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1660
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1661
|
+
end
|
|
1662
|
+
|
|
1663
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1664
|
+
opts = {
|
|
1665
|
+
status: 'status_example', # String | Only fetch deals with specific status. open = Open, won = Won, lost = Lost
|
|
1666
|
+
filter_id: 56, # Integer | user_id will not be considered. Only deals matching the given filter will be returned.
|
|
1667
|
+
user_id: 56, # Integer | Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.
|
|
1668
|
+
stage_id: 56 # Integer | Only deals within the given stage will be returned.
|
|
1669
|
+
}
|
|
1670
|
+
|
|
1671
|
+
begin
|
|
1672
|
+
#Get deals summary
|
|
1673
|
+
result = api_instance.deals_summary_get(opts)
|
|
1674
|
+
p result
|
|
1675
|
+
rescue Pipedrive::ApiError => e
|
|
1676
|
+
puts "Exception when calling DealsApi->deals_summary_get: #{e}"
|
|
1677
|
+
end
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
### Parameters
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
Name | Type | Description | Notes
|
|
1684
|
+
------------- | ------------- | ------------- | -------------
|
|
1685
|
+
**status** | **String**| Only fetch deals with specific status. open = Open, won = Won, lost = Lost | [optional]
|
|
1686
|
+
**filter_id** | **Integer**| user_id will not be considered. Only deals matching the given filter will be returned. | [optional]
|
|
1687
|
+
**user_id** | **Integer**| Only deals matching the given user will be returned. user_id will not be considered if you use filter_id. | [optional]
|
|
1688
|
+
**stage_id** | **Integer**| Only deals within the given stage will be returned. | [optional]
|
|
1689
|
+
|
|
1690
|
+
### Return type
|
|
1691
|
+
|
|
1692
|
+
[**GetDealsSummary**](GetDealsSummary.md)
|
|
1693
|
+
|
|
1694
|
+
### Authorization
|
|
1695
|
+
|
|
1696
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1697
|
+
|
|
1698
|
+
### HTTP request headers
|
|
1699
|
+
|
|
1700
|
+
- **Content-Type**: Not defined
|
|
1701
|
+
- **Accept**: application/json
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
## deals_timeline_get
|
|
1705
|
+
|
|
1706
|
+
> GetDealsTimeline deals_timeline_get(start_date, interval, amount, field_key, opts)
|
|
1707
|
+
|
|
1708
|
+
Get deals timeline
|
|
1709
|
+
|
|
1710
|
+
Returns open and won deals, grouped by defined interval of time set in a date-type dealField (field_key) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given field_key.
|
|
1711
|
+
|
|
1712
|
+
### Example
|
|
1713
|
+
|
|
1714
|
+
```ruby
|
|
1715
|
+
# load the gem
|
|
1716
|
+
require 'pipedrive-openapi-client'
|
|
1717
|
+
# setup authorization
|
|
1718
|
+
Pipedrive.configure do |config|
|
|
1719
|
+
# Configure API key authorization: api_key
|
|
1720
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1721
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1722
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1723
|
+
|
|
1724
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1725
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1726
|
+
end
|
|
1727
|
+
|
|
1728
|
+
api_instance = Pipedrive::DealsApi.new
|
|
1729
|
+
start_date = Date.parse('2013-10-20') # Date | Date where the first interval starts. Format: YYYY-MM-DD
|
|
1730
|
+
interval = 'interval_example' # String | The type of interval<dl class=\"fields-list\"><dt>day</dt><dd>Day</dd><dt>week</dt><dd>A full week (7 days) starting from start_date</dd><dt>month</dt><dd>A full month (depending on the number of days in given month) starting from start_date</dd><dt>quarter</dt><dd>A full quarter (3 months) starting from start_date</dd></dl>
|
|
1731
|
+
amount = 56 # Integer | The number of given intervals, starting from start_date, to fetch. E.g. 3 (months).
|
|
1732
|
+
field_key = 'field_key_example' # String | The date field key which deals will be retrieved from
|
|
1733
|
+
opts = {
|
|
1734
|
+
user_id: 56, # Integer | If supplied, only deals matching the given user will be returned.
|
|
1735
|
+
pipeline_id: 56, # Integer | If supplied, only deals matching the given pipeline will be returned
|
|
1736
|
+
filter_id: 56, # Integer | If supplied, only deals matching the given filter will be returned
|
|
1737
|
+
exclude_deals: Pipedrive::NumberBoolean.new, # NumberBoolean | Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
|
1738
|
+
totals_convert_currency: 'totals_convert_currency_example' # String | 3-letter currency code of any of the supported currencies. When supplied, totals_converted is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to 'default_currency' in which case users default currency is used.
|
|
1739
|
+
}
|
|
1740
|
+
|
|
1741
|
+
begin
|
|
1742
|
+
#Get deals timeline
|
|
1743
|
+
result = api_instance.deals_timeline_get(start_date, interval, amount, field_key, opts)
|
|
1744
|
+
p result
|
|
1745
|
+
rescue Pipedrive::ApiError => e
|
|
1746
|
+
puts "Exception when calling DealsApi->deals_timeline_get: #{e}"
|
|
1747
|
+
end
|
|
1748
|
+
```
|
|
1749
|
+
|
|
1750
|
+
### Parameters
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
Name | Type | Description | Notes
|
|
1754
|
+
------------- | ------------- | ------------- | -------------
|
|
1755
|
+
**start_date** | **Date**| Date where the first interval starts. Format: YYYY-MM-DD |
|
|
1756
|
+
**interval** | **String**| The type of interval<dl class=\"fields-list\"><dt>day</dt><dd>Day</dd><dt>week</dt><dd>A full week (7 days) starting from start_date</dd><dt>month</dt><dd>A full month (depending on the number of days in given month) starting from start_date</dd><dt>quarter</dt><dd>A full quarter (3 months) starting from start_date</dd></dl> |
|
|
1757
|
+
**amount** | **Integer**| The number of given intervals, starting from start_date, to fetch. E.g. 3 (months). |
|
|
1758
|
+
**field_key** | **String**| The date field key which deals will be retrieved from |
|
|
1759
|
+
**user_id** | **Integer**| If supplied, only deals matching the given user will be returned. | [optional]
|
|
1760
|
+
**pipeline_id** | **Integer**| If supplied, only deals matching the given pipeline will be returned | [optional]
|
|
1761
|
+
**filter_id** | **Integer**| If supplied, only deals matching the given filter will be returned | [optional]
|
|
1762
|
+
**exclude_deals** | [**NumberBoolean**](.md)| Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. | [optional]
|
|
1763
|
+
**totals_convert_currency** | **String**| 3-letter currency code of any of the supported currencies. When supplied, totals_converted is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to 'default_currency' in which case users default currency is used. | [optional]
|
|
1764
|
+
|
|
1765
|
+
### Return type
|
|
1766
|
+
|
|
1767
|
+
[**GetDealsTimeline**](GetDealsTimeline.md)
|
|
1768
|
+
|
|
1769
|
+
### Authorization
|
|
1770
|
+
|
|
1771
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1772
|
+
|
|
1773
|
+
### HTTP request headers
|
|
1774
|
+
|
|
1775
|
+
- **Content-Type**: Not defined
|
|
1776
|
+
- **Accept**: application/json
|
|
1777
|
+
|