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,1178 @@
|
|
|
1
|
+
# Pipedrive::OrganizationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.pipedrive.com/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**organizations_delete**](OrganizationsApi.md#organizations_delete) | **DELETE** /organizations | Delete multiple organizations in bulk
|
|
8
|
+
[**organizations_find_get**](OrganizationsApi.md#organizations_find_get) | **GET** /organizations/find | Find organizations by name
|
|
9
|
+
[**organizations_get**](OrganizationsApi.md#organizations_get) | **GET** /organizations | Get all organizations
|
|
10
|
+
[**organizations_id_activities_get**](OrganizationsApi.md#organizations_id_activities_get) | **GET** /organizations/{id}/activities | List activities associated with an organization
|
|
11
|
+
[**organizations_id_deals_get**](OrganizationsApi.md#organizations_id_deals_get) | **GET** /organizations/{id}/deals | List deals associated with an organization
|
|
12
|
+
[**organizations_id_delete**](OrganizationsApi.md#organizations_id_delete) | **DELETE** /organizations/{id} | Delete an organization
|
|
13
|
+
[**organizations_id_files_get**](OrganizationsApi.md#organizations_id_files_get) | **GET** /organizations/{id}/files | List files attached to an organization
|
|
14
|
+
[**organizations_id_flow_get**](OrganizationsApi.md#organizations_id_flow_get) | **GET** /organizations/{id}/flow | List updates about an organization
|
|
15
|
+
[**organizations_id_followers_follower_id_delete**](OrganizationsApi.md#organizations_id_followers_follower_id_delete) | **DELETE** /organizations/{id}/followers/{follower_id} | Delete a follower from an organization
|
|
16
|
+
[**organizations_id_followers_get**](OrganizationsApi.md#organizations_id_followers_get) | **GET** /organizations/{id}/followers | List followers of an organization
|
|
17
|
+
[**organizations_id_followers_post**](OrganizationsApi.md#organizations_id_followers_post) | **POST** /organizations/{id}/followers | Add a follower to an organization
|
|
18
|
+
[**organizations_id_get**](OrganizationsApi.md#organizations_id_get) | **GET** /organizations/{id} | Get details of an organization
|
|
19
|
+
[**organizations_id_mail_messages_get**](OrganizationsApi.md#organizations_id_mail_messages_get) | **GET** /organizations/{id}/mailMessages | List mail messages associated with an organization
|
|
20
|
+
[**organizations_id_merge_put**](OrganizationsApi.md#organizations_id_merge_put) | **PUT** /organizations/{id}/merge | Merge two organizations
|
|
21
|
+
[**organizations_id_permitted_users_get**](OrganizationsApi.md#organizations_id_permitted_users_get) | **GET** /organizations/{id}/permittedUsers | List permitted users
|
|
22
|
+
[**organizations_id_persons_get**](OrganizationsApi.md#organizations_id_persons_get) | **GET** /organizations/{id}/persons | List persons of an organization
|
|
23
|
+
[**organizations_id_put**](OrganizationsApi.md#organizations_id_put) | **PUT** /organizations/{id} | Update an organization
|
|
24
|
+
[**organizations_post**](OrganizationsApi.md#organizations_post) | **POST** /organizations | Add an organization
|
|
25
|
+
[**organizations_search_get**](OrganizationsApi.md#organizations_search_get) | **GET** /organizations/search | Search organizations
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## organizations_delete
|
|
30
|
+
|
|
31
|
+
> organizations_delete(ids)
|
|
32
|
+
|
|
33
|
+
Delete multiple organizations in bulk
|
|
34
|
+
|
|
35
|
+
Marks multiple organizations as deleted.
|
|
36
|
+
|
|
37
|
+
### Example
|
|
38
|
+
|
|
39
|
+
```ruby
|
|
40
|
+
# load the gem
|
|
41
|
+
require 'pipedrive-openapi-client'
|
|
42
|
+
# setup authorization
|
|
43
|
+
Pipedrive.configure do |config|
|
|
44
|
+
# Configure API key authorization: api_key
|
|
45
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
46
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
47
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
48
|
+
|
|
49
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
50
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
54
|
+
ids = 'ids_example' # String | Comma-separated IDs that will be deleted
|
|
55
|
+
|
|
56
|
+
begin
|
|
57
|
+
#Delete multiple organizations in bulk
|
|
58
|
+
api_instance.organizations_delete(ids)
|
|
59
|
+
rescue Pipedrive::ApiError => e
|
|
60
|
+
puts "Exception when calling OrganizationsApi->organizations_delete: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
Name | Type | Description | Notes
|
|
68
|
+
------------- | ------------- | ------------- | -------------
|
|
69
|
+
**ids** | **String**| Comma-separated IDs that will be deleted |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
nil (empty response body)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: Not defined
|
|
82
|
+
- **Accept**: Not defined
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## organizations_find_get
|
|
86
|
+
|
|
87
|
+
> organizations_find_get(term, opts)
|
|
88
|
+
|
|
89
|
+
Find organizations by name
|
|
90
|
+
|
|
91
|
+
<strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_search\">/v1/organizations/search</a> or <<a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Searches all organizations by their name.
|
|
92
|
+
|
|
93
|
+
### Example
|
|
94
|
+
|
|
95
|
+
```ruby
|
|
96
|
+
# load the gem
|
|
97
|
+
require 'pipedrive-openapi-client'
|
|
98
|
+
# setup authorization
|
|
99
|
+
Pipedrive.configure do |config|
|
|
100
|
+
# Configure API key authorization: api_key
|
|
101
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
104
|
+
|
|
105
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
106
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
110
|
+
term = 'term_example' # String | Search term to look for
|
|
111
|
+
opts = {
|
|
112
|
+
start: 0, # Integer | Pagination start
|
|
113
|
+
limit: 56 # Integer | Items shown per page
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
#Find organizations by name
|
|
118
|
+
api_instance.organizations_find_get(term, opts)
|
|
119
|
+
rescue Pipedrive::ApiError => e
|
|
120
|
+
puts "Exception when calling OrganizationsApi->organizations_find_get: #{e}"
|
|
121
|
+
end
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Parameters
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
Name | Type | Description | Notes
|
|
128
|
+
------------- | ------------- | ------------- | -------------
|
|
129
|
+
**term** | **String**| Search term to look for |
|
|
130
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
131
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
132
|
+
|
|
133
|
+
### Return type
|
|
134
|
+
|
|
135
|
+
nil (empty response body)
|
|
136
|
+
|
|
137
|
+
### Authorization
|
|
138
|
+
|
|
139
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: Not defined
|
|
144
|
+
- **Accept**: Not defined
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
## organizations_get
|
|
148
|
+
|
|
149
|
+
> organizations_get(opts)
|
|
150
|
+
|
|
151
|
+
Get all organizations
|
|
152
|
+
|
|
153
|
+
Returns all organizations
|
|
154
|
+
|
|
155
|
+
### Example
|
|
156
|
+
|
|
157
|
+
```ruby
|
|
158
|
+
# load the gem
|
|
159
|
+
require 'pipedrive-openapi-client'
|
|
160
|
+
# setup authorization
|
|
161
|
+
Pipedrive.configure do |config|
|
|
162
|
+
# Configure API key authorization: api_key
|
|
163
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
164
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
165
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
166
|
+
|
|
167
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
168
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
172
|
+
opts = {
|
|
173
|
+
user_id: 56, # Integer | If supplied, only organizations owned by the given user will be returned.
|
|
174
|
+
filter_id: 56, # Integer | ID of the filter to use
|
|
175
|
+
first_char: 'first_char_example', # String | If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive).
|
|
176
|
+
start: 0, # Integer | Pagination start
|
|
177
|
+
limit: 56, # Integer | Items shown per page
|
|
178
|
+
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).
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
begin
|
|
182
|
+
#Get all organizations
|
|
183
|
+
api_instance.organizations_get(opts)
|
|
184
|
+
rescue Pipedrive::ApiError => e
|
|
185
|
+
puts "Exception when calling OrganizationsApi->organizations_get: #{e}"
|
|
186
|
+
end
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Parameters
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
Name | Type | Description | Notes
|
|
193
|
+
------------- | ------------- | ------------- | -------------
|
|
194
|
+
**user_id** | **Integer**| If supplied, only organizations owned by the given user will be returned. | [optional]
|
|
195
|
+
**filter_id** | **Integer**| ID of the filter to use | [optional]
|
|
196
|
+
**first_char** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive). | [optional]
|
|
197
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
198
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
199
|
+
**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]
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
nil (empty response body)
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: Not defined
|
|
212
|
+
- **Accept**: Not defined
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
## organizations_id_activities_get
|
|
216
|
+
|
|
217
|
+
> organizations_id_activities_get(id, opts)
|
|
218
|
+
|
|
219
|
+
List activities associated with an organization
|
|
220
|
+
|
|
221
|
+
Lists activities associated with an organization.
|
|
222
|
+
|
|
223
|
+
### Example
|
|
224
|
+
|
|
225
|
+
```ruby
|
|
226
|
+
# load the gem
|
|
227
|
+
require 'pipedrive-openapi-client'
|
|
228
|
+
# setup authorization
|
|
229
|
+
Pipedrive.configure do |config|
|
|
230
|
+
# Configure API key authorization: api_key
|
|
231
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
232
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
233
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
234
|
+
|
|
235
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
236
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
240
|
+
id = 56 # Integer | ID of the organization
|
|
241
|
+
opts = {
|
|
242
|
+
start: 0, # Integer | Pagination start
|
|
243
|
+
limit: 56, # Integer | Items shown per page
|
|
244
|
+
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.
|
|
245
|
+
exclude: 'exclude_example' # String | A comma-separated string of activity IDs to exclude from result
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
begin
|
|
249
|
+
#List activities associated with an organization
|
|
250
|
+
api_instance.organizations_id_activities_get(id, opts)
|
|
251
|
+
rescue Pipedrive::ApiError => e
|
|
252
|
+
puts "Exception when calling OrganizationsApi->organizations_id_activities_get: #{e}"
|
|
253
|
+
end
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Parameters
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
Name | Type | Description | Notes
|
|
260
|
+
------------- | ------------- | ------------- | -------------
|
|
261
|
+
**id** | **Integer**| ID of the organization |
|
|
262
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
263
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
264
|
+
**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]
|
|
265
|
+
**exclude** | **String**| A comma-separated string of activity IDs to exclude from result | [optional]
|
|
266
|
+
|
|
267
|
+
### Return type
|
|
268
|
+
|
|
269
|
+
nil (empty response body)
|
|
270
|
+
|
|
271
|
+
### Authorization
|
|
272
|
+
|
|
273
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
274
|
+
|
|
275
|
+
### HTTP request headers
|
|
276
|
+
|
|
277
|
+
- **Content-Type**: Not defined
|
|
278
|
+
- **Accept**: Not defined
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
## organizations_id_deals_get
|
|
282
|
+
|
|
283
|
+
> organizations_id_deals_get(id, opts)
|
|
284
|
+
|
|
285
|
+
List deals associated with an organization
|
|
286
|
+
|
|
287
|
+
Lists deals associated with an organization.
|
|
288
|
+
|
|
289
|
+
### Example
|
|
290
|
+
|
|
291
|
+
```ruby
|
|
292
|
+
# load the gem
|
|
293
|
+
require 'pipedrive-openapi-client'
|
|
294
|
+
# setup authorization
|
|
295
|
+
Pipedrive.configure do |config|
|
|
296
|
+
# Configure API key authorization: api_key
|
|
297
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
298
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
299
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
300
|
+
|
|
301
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
302
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
306
|
+
id = 56 # Integer | ID of the organization
|
|
307
|
+
opts = {
|
|
308
|
+
start: 0, # Integer | Pagination start
|
|
309
|
+
limit: 56, # Integer | Items shown per page
|
|
310
|
+
status: 'all_not_deleted', # String | Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
|
|
311
|
+
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).
|
|
312
|
+
only_primary_association: Pipedrive::NumberBoolean.new # NumberBoolean | If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
begin
|
|
316
|
+
#List deals associated with an organization
|
|
317
|
+
api_instance.organizations_id_deals_get(id, opts)
|
|
318
|
+
rescue Pipedrive::ApiError => e
|
|
319
|
+
puts "Exception when calling OrganizationsApi->organizations_id_deals_get: #{e}"
|
|
320
|
+
end
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Parameters
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
Name | Type | Description | Notes
|
|
327
|
+
------------- | ------------- | ------------- | -------------
|
|
328
|
+
**id** | **Integer**| ID of the organization |
|
|
329
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
330
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
331
|
+
**status** | **String**| Only fetch deals with specific status. If omitted, all not deleted deals are fetched. | [optional] [default to 'all_not_deleted']
|
|
332
|
+
**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]
|
|
333
|
+
**only_primary_association** | [**NumberBoolean**](.md)| If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. | [optional]
|
|
334
|
+
|
|
335
|
+
### Return type
|
|
336
|
+
|
|
337
|
+
nil (empty response body)
|
|
338
|
+
|
|
339
|
+
### Authorization
|
|
340
|
+
|
|
341
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
342
|
+
|
|
343
|
+
### HTTP request headers
|
|
344
|
+
|
|
345
|
+
- **Content-Type**: Not defined
|
|
346
|
+
- **Accept**: Not defined
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
## organizations_id_delete
|
|
350
|
+
|
|
351
|
+
> organizations_id_delete(id)
|
|
352
|
+
|
|
353
|
+
Delete an organization
|
|
354
|
+
|
|
355
|
+
Marks an organization as deleted.
|
|
356
|
+
|
|
357
|
+
### Example
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
# load the gem
|
|
361
|
+
require 'pipedrive-openapi-client'
|
|
362
|
+
# setup authorization
|
|
363
|
+
Pipedrive.configure do |config|
|
|
364
|
+
# Configure API key authorization: api_key
|
|
365
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
366
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
367
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
368
|
+
|
|
369
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
370
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
374
|
+
id = 56 # Integer | ID of the organization
|
|
375
|
+
|
|
376
|
+
begin
|
|
377
|
+
#Delete an organization
|
|
378
|
+
api_instance.organizations_id_delete(id)
|
|
379
|
+
rescue Pipedrive::ApiError => e
|
|
380
|
+
puts "Exception when calling OrganizationsApi->organizations_id_delete: #{e}"
|
|
381
|
+
end
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
### Parameters
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
Name | Type | Description | Notes
|
|
388
|
+
------------- | ------------- | ------------- | -------------
|
|
389
|
+
**id** | **Integer**| ID of the organization |
|
|
390
|
+
|
|
391
|
+
### Return type
|
|
392
|
+
|
|
393
|
+
nil (empty response body)
|
|
394
|
+
|
|
395
|
+
### Authorization
|
|
396
|
+
|
|
397
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
398
|
+
|
|
399
|
+
### HTTP request headers
|
|
400
|
+
|
|
401
|
+
- **Content-Type**: Not defined
|
|
402
|
+
- **Accept**: Not defined
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
## organizations_id_files_get
|
|
406
|
+
|
|
407
|
+
> organizations_id_files_get(id, opts)
|
|
408
|
+
|
|
409
|
+
List files attached to an organization
|
|
410
|
+
|
|
411
|
+
Lists files associated with an organization.
|
|
412
|
+
|
|
413
|
+
### Example
|
|
414
|
+
|
|
415
|
+
```ruby
|
|
416
|
+
# load the gem
|
|
417
|
+
require 'pipedrive-openapi-client'
|
|
418
|
+
# setup authorization
|
|
419
|
+
Pipedrive.configure do |config|
|
|
420
|
+
# Configure API key authorization: api_key
|
|
421
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
422
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
423
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
424
|
+
|
|
425
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
426
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
427
|
+
end
|
|
428
|
+
|
|
429
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
430
|
+
id = 56 # Integer | ID of the organization
|
|
431
|
+
opts = {
|
|
432
|
+
start: 0, # Integer | Pagination start
|
|
433
|
+
limit: 56, # Integer | Items shown per page
|
|
434
|
+
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.
|
|
435
|
+
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.
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
begin
|
|
439
|
+
#List files attached to an organization
|
|
440
|
+
api_instance.organizations_id_files_get(id, opts)
|
|
441
|
+
rescue Pipedrive::ApiError => e
|
|
442
|
+
puts "Exception when calling OrganizationsApi->organizations_id_files_get: #{e}"
|
|
443
|
+
end
|
|
444
|
+
```
|
|
445
|
+
|
|
446
|
+
### Parameters
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
Name | Type | Description | Notes
|
|
450
|
+
------------- | ------------- | ------------- | -------------
|
|
451
|
+
**id** | **Integer**| ID of the organization |
|
|
452
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
453
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
454
|
+
**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]
|
|
455
|
+
**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]
|
|
456
|
+
|
|
457
|
+
### Return type
|
|
458
|
+
|
|
459
|
+
nil (empty response body)
|
|
460
|
+
|
|
461
|
+
### Authorization
|
|
462
|
+
|
|
463
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
464
|
+
|
|
465
|
+
### HTTP request headers
|
|
466
|
+
|
|
467
|
+
- **Content-Type**: Not defined
|
|
468
|
+
- **Accept**: Not defined
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
## organizations_id_flow_get
|
|
472
|
+
|
|
473
|
+
> organizations_id_flow_get(id, opts)
|
|
474
|
+
|
|
475
|
+
List updates about an organization
|
|
476
|
+
|
|
477
|
+
Lists updates about an organization.
|
|
478
|
+
|
|
479
|
+
### Example
|
|
480
|
+
|
|
481
|
+
```ruby
|
|
482
|
+
# load the gem
|
|
483
|
+
require 'pipedrive-openapi-client'
|
|
484
|
+
# setup authorization
|
|
485
|
+
Pipedrive.configure do |config|
|
|
486
|
+
# Configure API key authorization: api_key
|
|
487
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
488
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
489
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
490
|
+
|
|
491
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
492
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
496
|
+
id = 56 # Integer | ID of the organization
|
|
497
|
+
opts = {
|
|
498
|
+
start: 0, # Integer | Pagination start
|
|
499
|
+
limit: 56, # Integer | Items shown per page
|
|
500
|
+
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.
|
|
501
|
+
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)
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
begin
|
|
505
|
+
#List updates about an organization
|
|
506
|
+
api_instance.organizations_id_flow_get(id, opts)
|
|
507
|
+
rescue Pipedrive::ApiError => e
|
|
508
|
+
puts "Exception when calling OrganizationsApi->organizations_id_flow_get: #{e}"
|
|
509
|
+
end
|
|
510
|
+
```
|
|
511
|
+
|
|
512
|
+
### Parameters
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
Name | Type | Description | Notes
|
|
516
|
+
------------- | ------------- | ------------- | -------------
|
|
517
|
+
**id** | **Integer**| ID of the organization |
|
|
518
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
519
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
520
|
+
**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]
|
|
521
|
+
**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]
|
|
522
|
+
|
|
523
|
+
### Return type
|
|
524
|
+
|
|
525
|
+
nil (empty response body)
|
|
526
|
+
|
|
527
|
+
### Authorization
|
|
528
|
+
|
|
529
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
530
|
+
|
|
531
|
+
### HTTP request headers
|
|
532
|
+
|
|
533
|
+
- **Content-Type**: Not defined
|
|
534
|
+
- **Accept**: Not defined
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
## organizations_id_followers_follower_id_delete
|
|
538
|
+
|
|
539
|
+
> organizations_id_followers_follower_id_delete(id, follower_id)
|
|
540
|
+
|
|
541
|
+
Delete a follower from an organization
|
|
542
|
+
|
|
543
|
+
Deletes a follower from an organization. You can retrieve the follower_id from the <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_followers\">List followers of an organization</a> endpoint.
|
|
544
|
+
|
|
545
|
+
### Example
|
|
546
|
+
|
|
547
|
+
```ruby
|
|
548
|
+
# load the gem
|
|
549
|
+
require 'pipedrive-openapi-client'
|
|
550
|
+
# setup authorization
|
|
551
|
+
Pipedrive.configure do |config|
|
|
552
|
+
# Configure API key authorization: api_key
|
|
553
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
554
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
555
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
556
|
+
end
|
|
557
|
+
|
|
558
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
559
|
+
id = 56 # Integer | ID of the organization
|
|
560
|
+
follower_id = 56 # Integer | ID of the follower
|
|
561
|
+
|
|
562
|
+
begin
|
|
563
|
+
#Delete a follower from an organization
|
|
564
|
+
api_instance.organizations_id_followers_follower_id_delete(id, follower_id)
|
|
565
|
+
rescue Pipedrive::ApiError => e
|
|
566
|
+
puts "Exception when calling OrganizationsApi->organizations_id_followers_follower_id_delete: #{e}"
|
|
567
|
+
end
|
|
568
|
+
```
|
|
569
|
+
|
|
570
|
+
### Parameters
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
Name | Type | Description | Notes
|
|
574
|
+
------------- | ------------- | ------------- | -------------
|
|
575
|
+
**id** | **Integer**| ID of the organization |
|
|
576
|
+
**follower_id** | **Integer**| ID of the follower |
|
|
577
|
+
|
|
578
|
+
### Return type
|
|
579
|
+
|
|
580
|
+
nil (empty response body)
|
|
581
|
+
|
|
582
|
+
### Authorization
|
|
583
|
+
|
|
584
|
+
[api_key](../README.md#api_key)
|
|
585
|
+
|
|
586
|
+
### HTTP request headers
|
|
587
|
+
|
|
588
|
+
- **Content-Type**: Not defined
|
|
589
|
+
- **Accept**: Not defined
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
## organizations_id_followers_get
|
|
593
|
+
|
|
594
|
+
> organizations_id_followers_get(id)
|
|
595
|
+
|
|
596
|
+
List followers of an organization
|
|
597
|
+
|
|
598
|
+
Lists the followers of an organization.
|
|
599
|
+
|
|
600
|
+
### Example
|
|
601
|
+
|
|
602
|
+
```ruby
|
|
603
|
+
# load the gem
|
|
604
|
+
require 'pipedrive-openapi-client'
|
|
605
|
+
# setup authorization
|
|
606
|
+
Pipedrive.configure do |config|
|
|
607
|
+
# Configure API key authorization: api_key
|
|
608
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
609
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
610
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
611
|
+
|
|
612
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
613
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
614
|
+
end
|
|
615
|
+
|
|
616
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
617
|
+
id = 56 # Integer | ID of the organization
|
|
618
|
+
|
|
619
|
+
begin
|
|
620
|
+
#List followers of an organization
|
|
621
|
+
api_instance.organizations_id_followers_get(id)
|
|
622
|
+
rescue Pipedrive::ApiError => e
|
|
623
|
+
puts "Exception when calling OrganizationsApi->organizations_id_followers_get: #{e}"
|
|
624
|
+
end
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
### Parameters
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
Name | Type | Description | Notes
|
|
631
|
+
------------- | ------------- | ------------- | -------------
|
|
632
|
+
**id** | **Integer**| ID of the organization |
|
|
633
|
+
|
|
634
|
+
### Return type
|
|
635
|
+
|
|
636
|
+
nil (empty response body)
|
|
637
|
+
|
|
638
|
+
### Authorization
|
|
639
|
+
|
|
640
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
641
|
+
|
|
642
|
+
### HTTP request headers
|
|
643
|
+
|
|
644
|
+
- **Content-Type**: Not defined
|
|
645
|
+
- **Accept**: Not defined
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
## organizations_id_followers_post
|
|
649
|
+
|
|
650
|
+
> organizations_id_followers_post(id, user_id)
|
|
651
|
+
|
|
652
|
+
Add a follower to an organization
|
|
653
|
+
|
|
654
|
+
Adds a follower to an organization.
|
|
655
|
+
|
|
656
|
+
### Example
|
|
657
|
+
|
|
658
|
+
```ruby
|
|
659
|
+
# load the gem
|
|
660
|
+
require 'pipedrive-openapi-client'
|
|
661
|
+
# setup authorization
|
|
662
|
+
Pipedrive.configure do |config|
|
|
663
|
+
# Configure API key authorization: api_key
|
|
664
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
665
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
666
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
667
|
+
|
|
668
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
669
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
670
|
+
end
|
|
671
|
+
|
|
672
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
673
|
+
id = 56 # Integer | ID of the organization
|
|
674
|
+
user_id = 56 # Integer | ID of the user
|
|
675
|
+
|
|
676
|
+
begin
|
|
677
|
+
#Add a follower to an organization
|
|
678
|
+
api_instance.organizations_id_followers_post(id, user_id)
|
|
679
|
+
rescue Pipedrive::ApiError => e
|
|
680
|
+
puts "Exception when calling OrganizationsApi->organizations_id_followers_post: #{e}"
|
|
681
|
+
end
|
|
682
|
+
```
|
|
683
|
+
|
|
684
|
+
### Parameters
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
Name | Type | Description | Notes
|
|
688
|
+
------------- | ------------- | ------------- | -------------
|
|
689
|
+
**id** | **Integer**| ID of the organization |
|
|
690
|
+
**user_id** | **Integer**| ID of the user |
|
|
691
|
+
|
|
692
|
+
### Return type
|
|
693
|
+
|
|
694
|
+
nil (empty response body)
|
|
695
|
+
|
|
696
|
+
### Authorization
|
|
697
|
+
|
|
698
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
699
|
+
|
|
700
|
+
### HTTP request headers
|
|
701
|
+
|
|
702
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
703
|
+
- **Accept**: Not defined
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
## organizations_id_get
|
|
707
|
+
|
|
708
|
+
> organizations_id_get(id)
|
|
709
|
+
|
|
710
|
+
Get details of an organization
|
|
711
|
+
|
|
712
|
+
Returns details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of organizationFields.
|
|
713
|
+
|
|
714
|
+
### Example
|
|
715
|
+
|
|
716
|
+
```ruby
|
|
717
|
+
# load the gem
|
|
718
|
+
require 'pipedrive-openapi-client'
|
|
719
|
+
# setup authorization
|
|
720
|
+
Pipedrive.configure do |config|
|
|
721
|
+
# Configure API key authorization: api_key
|
|
722
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
723
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
724
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
725
|
+
|
|
726
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
727
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
728
|
+
end
|
|
729
|
+
|
|
730
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
731
|
+
id = 56 # Integer | ID of the organization
|
|
732
|
+
|
|
733
|
+
begin
|
|
734
|
+
#Get details of an organization
|
|
735
|
+
api_instance.organizations_id_get(id)
|
|
736
|
+
rescue Pipedrive::ApiError => e
|
|
737
|
+
puts "Exception when calling OrganizationsApi->organizations_id_get: #{e}"
|
|
738
|
+
end
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### Parameters
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
Name | Type | Description | Notes
|
|
745
|
+
------------- | ------------- | ------------- | -------------
|
|
746
|
+
**id** | **Integer**| ID of the organization |
|
|
747
|
+
|
|
748
|
+
### Return type
|
|
749
|
+
|
|
750
|
+
nil (empty response body)
|
|
751
|
+
|
|
752
|
+
### Authorization
|
|
753
|
+
|
|
754
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
755
|
+
|
|
756
|
+
### HTTP request headers
|
|
757
|
+
|
|
758
|
+
- **Content-Type**: Not defined
|
|
759
|
+
- **Accept**: Not defined
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
## organizations_id_mail_messages_get
|
|
763
|
+
|
|
764
|
+
> organizations_id_mail_messages_get(id, opts)
|
|
765
|
+
|
|
766
|
+
List mail messages associated with an organization
|
|
767
|
+
|
|
768
|
+
Lists mail messages associated with an organization.
|
|
769
|
+
|
|
770
|
+
### Example
|
|
771
|
+
|
|
772
|
+
```ruby
|
|
773
|
+
# load the gem
|
|
774
|
+
require 'pipedrive-openapi-client'
|
|
775
|
+
# setup authorization
|
|
776
|
+
Pipedrive.configure do |config|
|
|
777
|
+
# Configure API key authorization: api_key
|
|
778
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
779
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
780
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
781
|
+
|
|
782
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
783
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
784
|
+
end
|
|
785
|
+
|
|
786
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
787
|
+
id = 56 # Integer | ID of the organization
|
|
788
|
+
opts = {
|
|
789
|
+
start: 0, # Integer | Pagination start
|
|
790
|
+
limit: 56 # Integer | Items shown per page
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
begin
|
|
794
|
+
#List mail messages associated with an organization
|
|
795
|
+
api_instance.organizations_id_mail_messages_get(id, opts)
|
|
796
|
+
rescue Pipedrive::ApiError => e
|
|
797
|
+
puts "Exception when calling OrganizationsApi->organizations_id_mail_messages_get: #{e}"
|
|
798
|
+
end
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
### Parameters
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
Name | Type | Description | Notes
|
|
805
|
+
------------- | ------------- | ------------- | -------------
|
|
806
|
+
**id** | **Integer**| ID of the organization |
|
|
807
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
808
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
809
|
+
|
|
810
|
+
### Return type
|
|
811
|
+
|
|
812
|
+
nil (empty response body)
|
|
813
|
+
|
|
814
|
+
### Authorization
|
|
815
|
+
|
|
816
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
817
|
+
|
|
818
|
+
### HTTP request headers
|
|
819
|
+
|
|
820
|
+
- **Content-Type**: Not defined
|
|
821
|
+
- **Accept**: Not defined
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
## organizations_id_merge_put
|
|
825
|
+
|
|
826
|
+
> organizations_id_merge_put(id, merge_with_id)
|
|
827
|
+
|
|
828
|
+
Merge two organizations
|
|
829
|
+
|
|
830
|
+
Merges an organization with another organization. For more information on how to merge two organizations, see <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
831
|
+
|
|
832
|
+
### Example
|
|
833
|
+
|
|
834
|
+
```ruby
|
|
835
|
+
# load the gem
|
|
836
|
+
require 'pipedrive-openapi-client'
|
|
837
|
+
# setup authorization
|
|
838
|
+
Pipedrive.configure do |config|
|
|
839
|
+
# Configure API key authorization: api_key
|
|
840
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
841
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
842
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
843
|
+
|
|
844
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
845
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
846
|
+
end
|
|
847
|
+
|
|
848
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
849
|
+
id = 56 # Integer | ID of the organization
|
|
850
|
+
merge_with_id = 56 # Integer | ID of the organization that the organization will be merged with
|
|
851
|
+
|
|
852
|
+
begin
|
|
853
|
+
#Merge two organizations
|
|
854
|
+
api_instance.organizations_id_merge_put(id, merge_with_id)
|
|
855
|
+
rescue Pipedrive::ApiError => e
|
|
856
|
+
puts "Exception when calling OrganizationsApi->organizations_id_merge_put: #{e}"
|
|
857
|
+
end
|
|
858
|
+
```
|
|
859
|
+
|
|
860
|
+
### Parameters
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
Name | Type | Description | Notes
|
|
864
|
+
------------- | ------------- | ------------- | -------------
|
|
865
|
+
**id** | **Integer**| ID of the organization |
|
|
866
|
+
**merge_with_id** | **Integer**| ID of the organization that the organization will be merged with |
|
|
867
|
+
|
|
868
|
+
### Return type
|
|
869
|
+
|
|
870
|
+
nil (empty response body)
|
|
871
|
+
|
|
872
|
+
### Authorization
|
|
873
|
+
|
|
874
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
875
|
+
|
|
876
|
+
### HTTP request headers
|
|
877
|
+
|
|
878
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
879
|
+
- **Accept**: Not defined
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
## organizations_id_permitted_users_get
|
|
883
|
+
|
|
884
|
+
> organizations_id_permitted_users_get(id)
|
|
885
|
+
|
|
886
|
+
List permitted users
|
|
887
|
+
|
|
888
|
+
List users permitted to access an organization
|
|
889
|
+
|
|
890
|
+
### Example
|
|
891
|
+
|
|
892
|
+
```ruby
|
|
893
|
+
# load the gem
|
|
894
|
+
require 'pipedrive-openapi-client'
|
|
895
|
+
# setup authorization
|
|
896
|
+
Pipedrive.configure do |config|
|
|
897
|
+
# Configure API key authorization: api_key
|
|
898
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
899
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
900
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
901
|
+
end
|
|
902
|
+
|
|
903
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
904
|
+
id = 56 # Integer | ID of the organization
|
|
905
|
+
|
|
906
|
+
begin
|
|
907
|
+
#List permitted users
|
|
908
|
+
api_instance.organizations_id_permitted_users_get(id)
|
|
909
|
+
rescue Pipedrive::ApiError => e
|
|
910
|
+
puts "Exception when calling OrganizationsApi->organizations_id_permitted_users_get: #{e}"
|
|
911
|
+
end
|
|
912
|
+
```
|
|
913
|
+
|
|
914
|
+
### Parameters
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
Name | Type | Description | Notes
|
|
918
|
+
------------- | ------------- | ------------- | -------------
|
|
919
|
+
**id** | **Integer**| ID of the organization |
|
|
920
|
+
|
|
921
|
+
### Return type
|
|
922
|
+
|
|
923
|
+
nil (empty response body)
|
|
924
|
+
|
|
925
|
+
### Authorization
|
|
926
|
+
|
|
927
|
+
[api_key](../README.md#api_key)
|
|
928
|
+
|
|
929
|
+
### HTTP request headers
|
|
930
|
+
|
|
931
|
+
- **Content-Type**: Not defined
|
|
932
|
+
- **Accept**: Not defined
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
## organizations_id_persons_get
|
|
936
|
+
|
|
937
|
+
> organizations_id_persons_get(id, opts)
|
|
938
|
+
|
|
939
|
+
List persons of an organization
|
|
940
|
+
|
|
941
|
+
Lists persons associated with an organization.
|
|
942
|
+
|
|
943
|
+
### Example
|
|
944
|
+
|
|
945
|
+
```ruby
|
|
946
|
+
# load the gem
|
|
947
|
+
require 'pipedrive-openapi-client'
|
|
948
|
+
# setup authorization
|
|
949
|
+
Pipedrive.configure do |config|
|
|
950
|
+
# Configure API key authorization: api_key
|
|
951
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
952
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
953
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
954
|
+
|
|
955
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
956
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
957
|
+
end
|
|
958
|
+
|
|
959
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
960
|
+
id = 56 # Integer | ID of the organization
|
|
961
|
+
opts = {
|
|
962
|
+
start: 0, # Integer | Pagination start
|
|
963
|
+
limit: 56 # Integer | Items shown per page
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
begin
|
|
967
|
+
#List persons of an organization
|
|
968
|
+
api_instance.organizations_id_persons_get(id, opts)
|
|
969
|
+
rescue Pipedrive::ApiError => e
|
|
970
|
+
puts "Exception when calling OrganizationsApi->organizations_id_persons_get: #{e}"
|
|
971
|
+
end
|
|
972
|
+
```
|
|
973
|
+
|
|
974
|
+
### Parameters
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
Name | Type | Description | Notes
|
|
978
|
+
------------- | ------------- | ------------- | -------------
|
|
979
|
+
**id** | **Integer**| ID of the organization |
|
|
980
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
981
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
982
|
+
|
|
983
|
+
### Return type
|
|
984
|
+
|
|
985
|
+
nil (empty response body)
|
|
986
|
+
|
|
987
|
+
### Authorization
|
|
988
|
+
|
|
989
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
990
|
+
|
|
991
|
+
### HTTP request headers
|
|
992
|
+
|
|
993
|
+
- **Content-Type**: Not defined
|
|
994
|
+
- **Accept**: Not defined
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
## organizations_id_put
|
|
998
|
+
|
|
999
|
+
> organizations_id_put(id, opts)
|
|
1000
|
+
|
|
1001
|
+
Update an organization
|
|
1002
|
+
|
|
1003
|
+
Updates the properties of an organization.
|
|
1004
|
+
|
|
1005
|
+
### Example
|
|
1006
|
+
|
|
1007
|
+
```ruby
|
|
1008
|
+
# load the gem
|
|
1009
|
+
require 'pipedrive-openapi-client'
|
|
1010
|
+
# setup authorization
|
|
1011
|
+
Pipedrive.configure do |config|
|
|
1012
|
+
# Configure API key authorization: api_key
|
|
1013
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1014
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1015
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1016
|
+
|
|
1017
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1018
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1019
|
+
end
|
|
1020
|
+
|
|
1021
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
1022
|
+
id = 56 # Integer | ID of the organization
|
|
1023
|
+
opts = {
|
|
1024
|
+
name: 'name_example', # String | Organization name
|
|
1025
|
+
owner_id: 56, # Integer | ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used.
|
|
1026
|
+
visible_to: Pipedrive::VisibleTo.new # VisibleTo | Visibility of the organization. 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>
|
|
1027
|
+
}
|
|
1028
|
+
|
|
1029
|
+
begin
|
|
1030
|
+
#Update an organization
|
|
1031
|
+
api_instance.organizations_id_put(id, opts)
|
|
1032
|
+
rescue Pipedrive::ApiError => e
|
|
1033
|
+
puts "Exception when calling OrganizationsApi->organizations_id_put: #{e}"
|
|
1034
|
+
end
|
|
1035
|
+
```
|
|
1036
|
+
|
|
1037
|
+
### Parameters
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
Name | Type | Description | Notes
|
|
1041
|
+
------------- | ------------- | ------------- | -------------
|
|
1042
|
+
**id** | **Integer**| ID of the organization |
|
|
1043
|
+
**name** | **String**| Organization name | [optional]
|
|
1044
|
+
**owner_id** | **Integer**| ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional]
|
|
1045
|
+
**visible_to** | [**VisibleTo**](VisibleTo.md)| Visibility of the organization. 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]
|
|
1046
|
+
|
|
1047
|
+
### Return type
|
|
1048
|
+
|
|
1049
|
+
nil (empty response body)
|
|
1050
|
+
|
|
1051
|
+
### Authorization
|
|
1052
|
+
|
|
1053
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1054
|
+
|
|
1055
|
+
### HTTP request headers
|
|
1056
|
+
|
|
1057
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
1058
|
+
- **Accept**: Not defined
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
## organizations_post
|
|
1062
|
+
|
|
1063
|
+
> organizations_post
|
|
1064
|
+
|
|
1065
|
+
Add an organization
|
|
1066
|
+
|
|
1067
|
+
Adds a new organization. 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 organizationFields and look for 'key' values. For more information on how to add an organization, see <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
1068
|
+
|
|
1069
|
+
### Example
|
|
1070
|
+
|
|
1071
|
+
```ruby
|
|
1072
|
+
# load the gem
|
|
1073
|
+
require 'pipedrive-openapi-client'
|
|
1074
|
+
# setup authorization
|
|
1075
|
+
Pipedrive.configure do |config|
|
|
1076
|
+
# Configure API key authorization: api_key
|
|
1077
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1078
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1079
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1080
|
+
|
|
1081
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1082
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1083
|
+
end
|
|
1084
|
+
|
|
1085
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
1086
|
+
|
|
1087
|
+
begin
|
|
1088
|
+
#Add an organization
|
|
1089
|
+
api_instance.organizations_post
|
|
1090
|
+
rescue Pipedrive::ApiError => e
|
|
1091
|
+
puts "Exception when calling OrganizationsApi->organizations_post: #{e}"
|
|
1092
|
+
end
|
|
1093
|
+
```
|
|
1094
|
+
|
|
1095
|
+
### Parameters
|
|
1096
|
+
|
|
1097
|
+
This endpoint does not need any parameter.
|
|
1098
|
+
|
|
1099
|
+
### Return type
|
|
1100
|
+
|
|
1101
|
+
nil (empty response body)
|
|
1102
|
+
|
|
1103
|
+
### Authorization
|
|
1104
|
+
|
|
1105
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1106
|
+
|
|
1107
|
+
### HTTP request headers
|
|
1108
|
+
|
|
1109
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
1110
|
+
- **Accept**: Not defined
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
## organizations_search_get
|
|
1114
|
+
|
|
1115
|
+
> BaseResponse organizations_search_get(term, opts)
|
|
1116
|
+
|
|
1117
|
+
Search organizations
|
|
1118
|
+
|
|
1119
|
+
Searches all Organizations by name, address, 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.
|
|
1120
|
+
|
|
1121
|
+
### Example
|
|
1122
|
+
|
|
1123
|
+
```ruby
|
|
1124
|
+
# load the gem
|
|
1125
|
+
require 'pipedrive-openapi-client'
|
|
1126
|
+
# setup authorization
|
|
1127
|
+
Pipedrive.configure do |config|
|
|
1128
|
+
# Configure API key authorization: api_key
|
|
1129
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
1130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1131
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
1132
|
+
|
|
1133
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
1134
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1135
|
+
end
|
|
1136
|
+
|
|
1137
|
+
api_instance = Pipedrive::OrganizationsApi.new
|
|
1138
|
+
term = 'term_example' # String | The search term to look for. Minimum 2 characters (or 1 if using exact_match).
|
|
1139
|
+
opts = {
|
|
1140
|
+
fields: 'fields_example', # String | A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
1141
|
+
exact_match: true, # Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1142
|
+
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.
|
|
1143
|
+
limit: 56 # Integer | Items shown per page
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
begin
|
|
1147
|
+
#Search organizations
|
|
1148
|
+
result = api_instance.organizations_search_get(term, opts)
|
|
1149
|
+
p result
|
|
1150
|
+
rescue Pipedrive::ApiError => e
|
|
1151
|
+
puts "Exception when calling OrganizationsApi->organizations_search_get: #{e}"
|
|
1152
|
+
end
|
|
1153
|
+
```
|
|
1154
|
+
|
|
1155
|
+
### Parameters
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
Name | Type | Description | Notes
|
|
1159
|
+
------------- | ------------- | ------------- | -------------
|
|
1160
|
+
**term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using exact_match). |
|
|
1161
|
+
**fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. | [optional]
|
|
1162
|
+
**exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional]
|
|
1163
|
+
**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]
|
|
1164
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
1165
|
+
|
|
1166
|
+
### Return type
|
|
1167
|
+
|
|
1168
|
+
[**BaseResponse**](BaseResponse.md)
|
|
1169
|
+
|
|
1170
|
+
### Authorization
|
|
1171
|
+
|
|
1172
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
1173
|
+
|
|
1174
|
+
### HTTP request headers
|
|
1175
|
+
|
|
1176
|
+
- **Content-Type**: Not defined
|
|
1177
|
+
- **Accept**: application/json
|
|
1178
|
+
|