pipedrive-openapi-client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +68 -0
- data/LICENSE +201 -0
- data/README.md +669 -0
- data/Rakefile +10 -0
- data/docs/ActivitiesApi.md +372 -0
- data/docs/Activity.md +47 -0
- data/docs/ActivityFieldsApi.md +61 -0
- data/docs/ActivityTypesApi.md +305 -0
- data/docs/AddFile.md +19 -0
- data/docs/AddNewPipeline.md +19 -0
- data/docs/AddNewPipelineAllOf.md +17 -0
- data/docs/AddedDealFollower.md +19 -0
- data/docs/AddedDealFollowerData.md +23 -0
- data/docs/AdditionalData.md +21 -0
- data/docs/AdditionalDataWithPaginationDetails.md +17 -0
- data/docs/BaseCurrency.md +29 -0
- data/docs/BaseDeal.md +119 -0
- data/docs/BaseMailThread.md +89 -0
- data/docs/BaseMailThreadAllOf.md +59 -0
- data/docs/BaseMailThreadAllOfParties.md +19 -0
- data/docs/BaseMailThreadMessages.md +71 -0
- data/docs/BaseMailThreadMessagesAllOf.md +41 -0
- data/docs/BaseNote.md +49 -0
- data/docs/BaseNoteDealTitle.md +17 -0
- data/docs/BaseNoteOrganization.md +17 -0
- data/docs/BaseNotePerson.md +17 -0
- data/docs/BaseResponse.md +17 -0
- data/docs/BaseRole.md +19 -0
- data/docs/BaseStage.md +35 -0
- data/docs/BaseTeam.md +33 -0
- data/docs/BaseTeamAllOf.md +17 -0
- data/docs/BaseTeamAllOf1.md +19 -0
- data/docs/BaseUser.md +55 -0
- data/docs/BaseUserMe.md +67 -0
- data/docs/BaseUserMeAllOf.md +27 -0
- data/docs/BaseUserMeAllOfLanguage.md +19 -0
- data/docs/BasicDeal.md +37 -0
- data/docs/BasicDealProduct.md +29 -0
- data/docs/BasicGoal.md +27 -0
- data/docs/BasicOrganization.md +21 -0
- data/docs/BasicPerson.md +27 -0
- data/docs/BasicPersonField.md +19 -0
- data/docs/BasicProductField.md +19 -0
- data/docs/CallLogsApi.md +296 -0
- data/docs/CommonMailThread.md +45 -0
- data/docs/CreateRemoteFileAndLinkItToItem.md +19 -0
- data/docs/CreateTeam.md +23 -0
- data/docs/Currencies.md +19 -0
- data/docs/CurrenciesApi.md +68 -0
- data/docs/DealFieldsApi.md +356 -0
- data/docs/DealNonStrictModeFields.md +25 -0
- data/docs/DealNonStrictModeFieldsCreatorUserId.md +29 -0
- data/docs/DealOrganizationData.md +27 -0
- data/docs/DealPersonData.md +23 -0
- data/docs/DealPersonDataEmail.md +21 -0
- data/docs/DealPersonDataPhone.md +21 -0
- data/docs/DealStrictModeFields.md +25 -0
- data/docs/DealSummary.md +23 -0
- data/docs/DealSummaryPerCurrency.md +17 -0
- data/docs/DealSummaryPerCurrencyFull.md +17 -0
- data/docs/DealSummaryPerCurrencyFullCURRENCYID.md +19 -0
- data/docs/DealSummaryPerStages.md +17 -0
- data/docs/DealSummaryPerStagesSTAGEID.md +17 -0
- data/docs/DealSummaryPerStagesSTAGEIDCURRENCYID.md +25 -0
- data/docs/DealUserData.md +27 -0
- data/docs/DealsApi.md +1777 -0
- data/docs/DeleteDeal.md +19 -0
- data/docs/DeleteDealData.md +17 -0
- data/docs/DeleteDealFollower.md +19 -0
- data/docs/DeleteDealFollowerData.md +17 -0
- data/docs/DeleteDealParticipant.md +19 -0
- data/docs/DeleteDealParticipantData.md +17 -0
- data/docs/DeleteDealProduct.md +19 -0
- data/docs/DeleteDealProductData.md +19 -0
- data/docs/DeleteFile.md +19 -0
- data/docs/DeleteFileData.md +17 -0
- data/docs/DeleteMultipleDeals.md +16 -0
- data/docs/DeleteMultipleDealsAllOf.md +19 -0
- data/docs/DeleteMultipleDealsAllOfData.md +17 -0
- data/docs/DeleteMultipleProductFieldsResponse.md +19 -0
- data/docs/DeleteMultipleProductFieldsResponseData.md +17 -0
- data/docs/DeleteNote.md +19 -0
- data/docs/DeleteProductFieldResponse.md +19 -0
- data/docs/DeleteProductFieldResponseData.md +17 -0
- data/docs/DeleteProductFollowerResponse.md +19 -0
- data/docs/DeleteProductFollowerResponseData.md +17 -0
- data/docs/DeleteRole.md +19 -0
- data/docs/DeleteRoleAllOf.md +17 -0
- data/docs/DeleteRoleAllOfData.md +17 -0
- data/docs/DeleteRoleAssignment.md +19 -0
- data/docs/DeleteRoleAssignmentAllOf.md +17 -0
- data/docs/DeleteRoleAssignmentAllOfData.md +17 -0
- data/docs/EditPipeline.md +19 -0
- data/docs/EditPipelineAllOf.md +17 -0
- data/docs/FailResponse.md +19 -0
- data/docs/FieldType.md +17 -0
- data/docs/FileData.md +67 -0
- data/docs/FilesApi.md +509 -0
- data/docs/FilterType.md +16 -0
- data/docs/FiltersApi.md +408 -0
- data/docs/FindProductsByNameResponse.md +21 -0
- data/docs/FindProductsByNameResponseData.md +29 -0
- data/docs/FullRole.md +29 -0
- data/docs/FullRoleAllOf.md +17 -0
- data/docs/GetAddProductAttachementDetails.md +19 -0
- data/docs/GetAddUpdateStage.md +19 -0
- data/docs/GetAddedDeal.md +23 -0
- data/docs/GetAddedDealAdditionalData.md +17 -0
- data/docs/GetAddedDealRelatedObjects.md +21 -0
- data/docs/GetAllFiles.md +21 -0
- data/docs/GetAllPipelines.md +19 -0
- data/docs/GetAllPipelinesAllOf.md +17 -0
- data/docs/GetAllProductFieldsResponse.md +21 -0
- data/docs/GetDeal.md +23 -0
- data/docs/GetDealAdditionalData.md +17 -0
- data/docs/GetDeals.md +23 -0
- data/docs/GetDealsByName.md +21 -0
- data/docs/GetDealsByNameAdditionalData.md +17 -0
- data/docs/GetDealsByNameData.md +41 -0
- data/docs/GetDealsConversionRatesInPipeline.md +19 -0
- data/docs/GetDealsConversionRatesInPipelineAllOf.md +17 -0
- data/docs/GetDealsConversionRatesInPipelineAllOfData.md +21 -0
- data/docs/GetDealsConversionRatesInPipelineAllOfDataStageConversions.md +21 -0
- data/docs/GetDealsMovementsInPipeline.md +19 -0
- data/docs/GetDealsMovementsInPipelineAllOf.md +17 -0
- data/docs/GetDealsMovementsInPipelineAllOfData.md +27 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md +19 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md +19 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.md +17 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataNewDeals.md +23 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataNewDealsFormattedValues.md +17 -0
- data/docs/GetDealsMovementsInPipelineAllOfDataNewDealsValues.md +17 -0
- data/docs/GetDealsSummary.md +19 -0
- data/docs/GetDealsSummaryData.md +29 -0
- data/docs/GetDealsSummaryDataValuesTotal.md +25 -0
- data/docs/GetDealsSummaryDataWeightedValuesTotal.md +21 -0
- data/docs/GetDealsTimeline.md +19 -0
- data/docs/GetDealsTimelineData.md +23 -0
- data/docs/GetDealsTimelineDataTotals.md +31 -0
- data/docs/GetDuplicatedDeal.md +19 -0
- data/docs/GetMergedDeal.md +19 -0
- data/docs/GetNotes.md +21 -0
- data/docs/GetOneFile.md +19 -0
- data/docs/GetOnePipeline.md +19 -0
- data/docs/GetOnePipelineAllOf.md +17 -0
- data/docs/GetOneStage.md +19 -0
- data/docs/GetProductAttachementDetails.md +19 -0
- data/docs/GetProductFieldResponse.md +19 -0
- data/docs/GetRole.md +21 -0
- data/docs/GetRoleAllOf.md +19 -0
- data/docs/GetRoleAllOfAdditionalData.md +17 -0
- data/docs/GetRoleAssignments.md +21 -0
- data/docs/GetRoleAssignmentsAllOf.md +19 -0
- data/docs/GetRoleSettings.md +19 -0
- data/docs/GetRoleSettingsAllOf.md +17 -0
- data/docs/GetRoleSubroles.md +21 -0
- data/docs/GetRoleSubrolesAllOf.md +19 -0
- data/docs/GetRoles.md +21 -0
- data/docs/GetRolesAllOf.md +19 -0
- data/docs/GetStageDeals.md +21 -0
- data/docs/GetStages.md +19 -0
- data/docs/GlobalMessageBaseResponse.md +17 -0
- data/docs/GlobalMessageData.md +27 -0
- data/docs/GlobalMessageDelete.md +23 -0
- data/docs/GlobalMessageDeleteAllOf.md +21 -0
- data/docs/GlobalMessageGet.md +23 -0
- data/docs/GlobalMessageGetAllOf.md +21 -0
- data/docs/GlobalMessageUserData.md +21 -0
- data/docs/GlobalMessagesApi.md +120 -0
- data/docs/GoalsApi.md +318 -0
- data/docs/IconKey.md +16 -0
- data/docs/InlineObject.md +21 -0
- data/docs/InlineObject1.md +23 -0
- data/docs/InlineObject10.md +23 -0
- data/docs/InlineObject11.md +19 -0
- data/docs/InlineObject12.md +21 -0
- data/docs/InlineObject13.md +19 -0
- data/docs/InlineObject14.md +31 -0
- data/docs/InlineObject15.md +33 -0
- data/docs/InlineObject16.md +19 -0
- data/docs/InlineObject17.md +19 -0
- data/docs/InlineObject18.md +23 -0
- data/docs/InlineObject19.md +17 -0
- data/docs/InlineObject2.md +37 -0
- data/docs/InlineObject20.md +17 -0
- data/docs/InlineObject21.md +17 -0
- data/docs/InlineObject22.md +17 -0
- data/docs/InlineObject23.md +25 -0
- data/docs/InlineObject24.md +17 -0
- data/docs/InlineObject25.md +17 -0
- data/docs/InlineObject26.md +19 -0
- data/docs/InlineObject27.md +17 -0
- data/docs/InlineObject28.md +17 -0
- data/docs/InlineObject29.md +21 -0
- data/docs/InlineObject3.md +17 -0
- data/docs/InlineObject30.md +17 -0
- data/docs/InlineObject31.md +17 -0
- data/docs/InlineObject32.md +17 -0
- data/docs/InlineObject33.md +27 -0
- data/docs/InlineObject4.md +17 -0
- data/docs/InlineObject5.md +17 -0
- data/docs/InlineObject6.md +17 -0
- data/docs/InlineObject7.md +19 -0
- data/docs/InlineObject8.md +27 -0
- data/docs/InlineObject9.md +25 -0
- data/docs/InlineResponse200.md +21 -0
- data/docs/InlineResponse2001.md +19 -0
- data/docs/InlineResponse20010.md +19 -0
- data/docs/InlineResponse20010Data.md +17 -0
- data/docs/InlineResponse20011.md +19 -0
- data/docs/InlineResponse20011Data.md +17 -0
- data/docs/InlineResponse2002.md +19 -0
- data/docs/InlineResponse2003.md +17 -0
- data/docs/InlineResponse2004.md +21 -0
- data/docs/InlineResponse2005.md +17 -0
- data/docs/InlineResponse2006.md +19 -0
- data/docs/InlineResponse2007.md +19 -0
- data/docs/InlineResponse2007Data.md +25 -0
- data/docs/InlineResponse2008.md +19 -0
- data/docs/InlineResponse2008Data.md +17 -0
- data/docs/InlineResponse2009.md +19 -0
- data/docs/InlineResponse2009Data.md +17 -0
- data/docs/InlineResponse200AdditionalData.md +21 -0
- data/docs/InlineResponse201.md +19 -0
- data/docs/InlineResponse201Data.md +47 -0
- data/docs/InlineResponse400.md +25 -0
- data/docs/InlineResponse403.md +25 -0
- data/docs/InlineResponse404.md +25 -0
- data/docs/InlineResponse4041.md +25 -0
- data/docs/InlineResponse409.md +25 -0
- data/docs/InlineResponse410.md +25 -0
- data/docs/InlineResponse500.md +25 -0
- data/docs/ItemSearchApi.md +154 -0
- data/docs/LeadsApi.md +651 -0
- data/docs/LeadsValue.md +19 -0
- data/docs/LinkRemoteFileToItem.md +19 -0
- data/docs/MailMessage.md +25 -0
- data/docs/MailMessageAllOf.md +17 -0
- data/docs/MailMessageData.md +73 -0
- data/docs/MailMessagesApi.md +70 -0
- data/docs/MailParticipant.md +27 -0
- data/docs/MailServiceBaseResponse.md +23 -0
- data/docs/MailThread.md +19 -0
- data/docs/MailThreadAllOf.md +17 -0
- data/docs/MailThreadDelete.md +19 -0
- data/docs/MailThreadDeleteAllOf.md +17 -0
- data/docs/MailThreadMessages.md +19 -0
- data/docs/MailThreadMessagesAllOf.md +17 -0
- data/docs/MailThreadOne.md +19 -0
- data/docs/MailThreadOneAllOf.md +17 -0
- data/docs/MailThreadParticipant.md +33 -0
- data/docs/MailThreadPut.md +19 -0
- data/docs/MailThreadsApi.md +314 -0
- data/docs/NewDeal.md +39 -0
- data/docs/NewDealAllOf.md +17 -0
- data/docs/NewDealProduct.md +31 -0
- data/docs/NewDealProductAllOf.md +17 -0
- data/docs/NewFollowerResponse.md +19 -0
- data/docs/NewFollowerResponseData.md +23 -0
- data/docs/NewGoal.md +16 -0
- data/docs/NewOrganization.md +23 -0
- data/docs/NewOrganizationAllOf.md +17 -0
- data/docs/NewOrganizationField.md +21 -0
- data/docs/NewPerson.md +29 -0
- data/docs/NewPersonAllOf.md +17 -0
- data/docs/NewPersonField.md +21 -0
- data/docs/NewProductField.md +21 -0
- data/docs/NewProductFieldAllOf.md +21 -0
- data/docs/Note.md +33 -0
- data/docs/NoteCreatorUser.md +23 -0
- data/docs/NoteFieldsApi.md +61 -0
- data/docs/NotesApi.md +360 -0
- data/docs/NumberBoolean.md +16 -0
- data/docs/NumberBooleanDefault0.md +16 -0
- data/docs/NumberBooleanDefault1.md +16 -0
- data/docs/OrganizationFieldsApi.md +348 -0
- data/docs/OrganizationRelationship.md +23 -0
- data/docs/OrganizationRelationshipsApi.md +303 -0
- data/docs/OrganizationsApi.md +1178 -0
- data/docs/PermissionSets.md +19 -0
- data/docs/PermissionSetsAllOf.md +17 -0
- data/docs/PermissionSetsApi.md +171 -0
- data/docs/PermissionSetsItem.md +21 -0
- data/docs/PersonFieldsApi.md +348 -0
- data/docs/PersonsApi.md +1311 -0
- data/docs/Pipeline.md +23 -0
- data/docs/PipelinesApi.md +524 -0
- data/docs/PostNote.md +19 -0
- data/docs/PostRoleAssignment.md +19 -0
- data/docs/PostRoleAssignmentAllOf.md +17 -0
- data/docs/PostRoleAssignmentAllOfData.md +19 -0
- data/docs/PostRoleSettings.md +19 -0
- data/docs/PostRoleSettingsAllOf.md +17 -0
- data/docs/PostRoleSettingsAllOfData.md +19 -0
- data/docs/PostRoles.md +19 -0
- data/docs/PostRolesAllOf.md +17 -0
- data/docs/PostRolesAllOfData.md +17 -0
- data/docs/Product.md +31 -0
- data/docs/ProductAttachementFields.md +41 -0
- data/docs/ProductField.md +51 -0
- data/docs/ProductFieldAllOf.md +45 -0
- data/docs/ProductFieldsApi.md +358 -0
- data/docs/ProductsApi.md +809 -0
- data/docs/PutRole.md +19 -0
- data/docs/PutRoleAllOf.md +17 -0
- data/docs/PutRoleAllOfData.md +17 -0
- data/docs/RecentsApi.md +73 -0
- data/docs/RoleAssignment.md +27 -0
- data/docs/RoleAssignmentAllOf.md +23 -0
- data/docs/RoleSettings.md +31 -0
- data/docs/RolesAdditionalData.md +17 -0
- data/docs/RolesAdditionalDataPagination.md +21 -0
- data/docs/RolesApi.md +623 -0
- data/docs/SearchResultsApi.md +148 -0
- data/docs/SinglePermissionSetsItem.md +23 -0
- data/docs/SinglePermissionSetsItemAllOf.md +17 -0
- data/docs/Stage.md +25 -0
- data/docs/StagesApi.md +424 -0
- data/docs/SubRole.md +27 -0
- data/docs/SubRoleAllOf.md +23 -0
- data/docs/Teams.md +19 -0
- data/docs/TeamsAllOf.md +17 -0
- data/docs/TeamsApi.md +498 -0
- data/docs/Unauthorized.md +21 -0
- data/docs/UpdateFile.md +19 -0
- data/docs/UpdateTeam.md +27 -0
- data/docs/UpdateTeamAllOf.md +19 -0
- data/docs/User.md +19 -0
- data/docs/UserAllOf.md +17 -0
- data/docs/UserAssignmentToPermissionSet.md +23 -0
- data/docs/UserAssignmentsToPermissionSet.md +19 -0
- data/docs/UserAssignmentsToPermissionSetAllOf.md +17 -0
- data/docs/UserConnections.md +19 -0
- data/docs/UserConnectionsAllOf.md +17 -0
- data/docs/UserConnectionsAllOfData.md +17 -0
- data/docs/UserConnectionsApi.md +62 -0
- data/docs/UserIDs.md +19 -0
- data/docs/UserIDsAllOf.md +17 -0
- data/docs/UserMe.md +19 -0
- data/docs/UserMeAllOf.md +17 -0
- data/docs/UserSettings.md +19 -0
- data/docs/UserSettingsAllOf.md +17 -0
- data/docs/UserSettingsApi.md +62 -0
- data/docs/UserSettingsItem.md +35 -0
- data/docs/Users.md +19 -0
- data/docs/UsersAllOf.md +17 -0
- data/docs/UsersApi.md +818 -0
- data/docs/VisibleTo.md +16 -0
- data/docs/WebhooksApi.md +190 -0
- data/git_push.sh +58 -0
- data/lib/pipedrive-openapi-client.rb +384 -0
- data/lib/pipedrive-openapi-client/api/activities_api.rb +403 -0
- data/lib/pipedrive-openapi-client/api/activity_fields_api.rb +76 -0
- data/lib/pipedrive-openapi-client/api/activity_types_api.rb +344 -0
- data/lib/pipedrive-openapi-client/api/call_logs_api.rb +339 -0
- data/lib/pipedrive-openapi-client/api/currencies_api.rb +81 -0
- data/lib/pipedrive-openapi-client/api/deal_fields_api.rb +391 -0
- data/lib/pipedrive-openapi-client/api/deals_api.rb +2018 -0
- data/lib/pipedrive-openapi-client/api/files_api.rb +630 -0
- data/lib/pipedrive-openapi-client/api/filters_api.rb +436 -0
- data/lib/pipedrive-openapi-client/api/global_messages_api.rb +143 -0
- data/lib/pipedrive-openapi-client/api/goals_api.rb +405 -0
- data/lib/pipedrive-openapi-client/api/item_search_api.rb +228 -0
- data/lib/pipedrive-openapi-client/api/leads_api.rb +697 -0
- data/lib/pipedrive-openapi-client/api/mail_messages_api.rb +87 -0
- data/lib/pipedrive-openapi-client/api/mail_threads_api.rb +358 -0
- data/lib/pipedrive-openapi-client/api/note_fields_api.rb +76 -0
- data/lib/pipedrive-openapi-client/api/notes_api.rb +422 -0
- data/lib/pipedrive-openapi-client/api/organization_fields_api.rb +385 -0
- data/lib/pipedrive-openapi-client/api/organization_relationships_api.rb +340 -0
- data/lib/pipedrive-openapi-client/api/organizations_api.rb +1303 -0
- data/lib/pipedrive-openapi-client/api/permission_sets_api.rb +204 -0
- data/lib/pipedrive-openapi-client/api/person_fields_api.rb +385 -0
- data/lib/pipedrive-openapi-client/api/persons_api.rb +1448 -0
- data/lib/pipedrive-openapi-client/api/pipelines_api.rb +595 -0
- data/lib/pipedrive-openapi-client/api/product_fields_api.rb +391 -0
- data/lib/pipedrive-openapi-client/api/products_api.rb +904 -0
- data/lib/pipedrive-openapi-client/api/recents_api.rb +96 -0
- data/lib/pipedrive-openapi-client/api/roles_api.rb +741 -0
- data/lib/pipedrive-openapi-client/api/search_results_api.rb +194 -0
- data/lib/pipedrive-openapi-client/api/stages_api.rb +467 -0
- data/lib/pipedrive-openapi-client/api/teams_api.rb +571 -0
- data/lib/pipedrive-openapi-client/api/user_connections_api.rb +78 -0
- data/lib/pipedrive-openapi-client/api/user_settings_api.rb +78 -0
- data/lib/pipedrive-openapi-client/api/users_api.rb +925 -0
- data/lib/pipedrive-openapi-client/api/webhooks_api.rb +238 -0
- data/lib/pipedrive-openapi-client/api_client.rb +404 -0
- data/lib/pipedrive-openapi-client/api_error.rb +57 -0
- data/lib/pipedrive-openapi-client/configuration.rb +250 -0
- data/lib/pipedrive-openapi-client/models/activity.rb +404 -0
- data/lib/pipedrive-openapi-client/models/add_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/add_new_pipeline.rb +224 -0
- data/lib/pipedrive-openapi-client/models/add_new_pipeline_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/added_deal_follower.rb +216 -0
- data/lib/pipedrive-openapi-client/models/added_deal_follower_data.rb +237 -0
- data/lib/pipedrive-openapi-client/models/additional_data.rb +228 -0
- data/lib/pipedrive-openapi-client/models/additional_data_with_pagination_details.rb +207 -0
- data/lib/pipedrive-openapi-client/models/base_currency.rb +267 -0
- data/lib/pipedrive-openapi-client/models/base_deal.rb +724 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread.rb +582 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_all_of.rb +423 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_all_of_parties.rb +222 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_messages.rb +495 -0
- data/lib/pipedrive-openapi-client/models/base_mail_thread_messages_all_of.rb +336 -0
- data/lib/pipedrive-openapi-client/models/base_note.rb +363 -0
- data/lib/pipedrive-openapi-client/models/base_note_deal_title.rb +208 -0
- data/lib/pipedrive-openapi-client/models/base_note_organization.rb +208 -0
- data/lib/pipedrive-openapi-client/models/base_note_person.rb +208 -0
- data/lib/pipedrive-openapi-client/models/base_response.rb +207 -0
- data/lib/pipedrive-openapi-client/models/base_role.rb +218 -0
- data/lib/pipedrive-openapi-client/models/base_stage.rb +331 -0
- data/lib/pipedrive-openapi-client/models/base_team.rb +306 -0
- data/lib/pipedrive-openapi-client/models/base_team_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/base_team_all_of1.rb +217 -0
- data/lib/pipedrive-openapi-client/models/base_user.rb +399 -0
- data/lib/pipedrive-openapi-client/models/base_user_me.rb +466 -0
- data/lib/pipedrive-openapi-client/models/base_user_me_all_of.rb +256 -0
- data/lib/pipedrive-openapi-client/models/base_user_me_all_of_language.rb +218 -0
- data/lib/pipedrive-openapi-client/models/basic_deal.rb +341 -0
- data/lib/pipedrive-openapi-client/models/basic_deal_product.rb +271 -0
- data/lib/pipedrive-openapi-client/models/basic_goal.rb +291 -0
- data/lib/pipedrive-openapi-client/models/basic_organization.rb +227 -0
- data/lib/pipedrive-openapi-client/models/basic_person.rb +261 -0
- data/lib/pipedrive-openapi-client/models/basic_person_field.rb +222 -0
- data/lib/pipedrive-openapi-client/models/basic_product_field.rb +224 -0
- data/lib/pipedrive-openapi-client/models/common_mail_thread.rb +348 -0
- data/lib/pipedrive-openapi-client/models/create_remote_file_and_link_it_to_item.rb +216 -0
- data/lib/pipedrive-openapi-client/models/create_team.rb +247 -0
- data/lib/pipedrive-openapi-client/models/currencies.rb +219 -0
- data/lib/pipedrive-openapi-client/models/deal_non_strict_mode_fields.rb +243 -0
- data/lib/pipedrive-openapi-client/models/deal_non_strict_mode_fields_creator_user_id.rb +269 -0
- data/lib/pipedrive-openapi-client/models/deal_organization_data.rb +258 -0
- data/lib/pipedrive-openapi-client/models/deal_person_data.rb +242 -0
- data/lib/pipedrive-openapi-client/models/deal_person_data_email.rb +227 -0
- data/lib/pipedrive-openapi-client/models/deal_person_data_phone.rb +227 -0
- data/lib/pipedrive-openapi-client/models/deal_strict_mode_fields.rb +247 -0
- data/lib/pipedrive-openapi-client/models/deal_summary.rb +235 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_currency.rb +208 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_currency_full.rb +207 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_currency_full_currencyid.rb +218 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_stages.rb +207 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_stages_stageid.rb +207 -0
- data/lib/pipedrive-openapi-client/models/deal_summary_per_stages_stageidcurrencyid.rb +248 -0
- data/lib/pipedrive-openapi-client/models/deal_user_data.rb +259 -0
- data/lib/pipedrive-openapi-client/models/delete_deal.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_follower.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_follower_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_participant.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_participant_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_product.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_deal_product_data.rb +217 -0
- data/lib/pipedrive-openapi-client/models/delete_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_file_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_deals.rb +208 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_deals_all_of.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_deals_all_of_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_product_fields_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_multiple_product_fields_response_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/delete_note.rb +217 -0
- data/lib/pipedrive-openapi-client/models/delete_product_field_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_product_field_response_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_product_follower_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/delete_product_follower_response_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/delete_role.rb +224 -0
- data/lib/pipedrive-openapi-client/models/delete_role_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/delete_role_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/delete_role_assignment.rb +224 -0
- data/lib/pipedrive-openapi-client/models/delete_role_assignment_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/delete_role_assignment_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/edit_pipeline.rb +225 -0
- data/lib/pipedrive-openapi-client/models/edit_pipeline_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/fail_response.rb +217 -0
- data/lib/pipedrive-openapi-client/models/field_type.rb +246 -0
- data/lib/pipedrive-openapi-client/models/file_data.rb +458 -0
- data/lib/pipedrive-openapi-client/models/filter_type.rb +39 -0
- data/lib/pipedrive-openapi-client/models/find_products_by_name_response.rb +226 -0
- data/lib/pipedrive-openapi-client/models/find_products_by_name_response_data.rb +267 -0
- data/lib/pipedrive-openapi-client/models/full_role.rb +275 -0
- data/lib/pipedrive-openapi-client/models/full_role_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_add_product_attachement_details.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_add_update_stage.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_added_deal.rb +235 -0
- data/lib/pipedrive-openapi-client/models/get_added_deal_additional_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/get_added_deal_related_objects.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_all_files.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_all_pipelines.rb +227 -0
- data/lib/pipedrive-openapi-client/models/get_all_pipelines_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/get_all_product_fields_response.rb +229 -0
- data/lib/pipedrive-openapi-client/models/get_deal.rb +234 -0
- data/lib/pipedrive-openapi-client/models/get_deal_additional_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_deals.rb +237 -0
- data/lib/pipedrive-openapi-client/models/get_deals_by_name.rb +227 -0
- data/lib/pipedrive-openapi-client/models/get_deals_by_name_additional_data.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_deals_by_name_data.rb +328 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline_all_of_data.rb +230 -0
- data/lib/pipedrive-openapi-client/models/get_deals_conversion_rates_in_pipeline_all_of_data_stage_conversions.rb +227 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data.rb +252 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days.rb +220 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days_by_stages.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_movements_between_stages.rb +208 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_new_deals.rb +238 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_new_deals_formatted_values.rb +208 -0
- data/lib/pipedrive-openapi-client/models/get_deals_movements_in_pipeline_all_of_data_new_deals_values.rb +208 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary_data.rb +266 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary_data_values_total.rb +248 -0
- data/lib/pipedrive-openapi-client/models/get_deals_summary_data_weighted_values_total.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_deals_timeline.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_deals_timeline_data.rb +238 -0
- data/lib/pipedrive-openapi-client/models/get_deals_timeline_data_totals.rb +278 -0
- data/lib/pipedrive-openapi-client/models/get_duplicated_deal.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_merged_deal.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_notes.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_one_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_one_pipeline.rb +225 -0
- data/lib/pipedrive-openapi-client/models/get_one_pipeline_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_one_stage.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_product_attachement_details.rb +217 -0
- data/lib/pipedrive-openapi-client/models/get_product_field_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/get_role.rb +233 -0
- data/lib/pipedrive-openapi-client/models/get_role_all_of.rb +215 -0
- data/lib/pipedrive-openapi-client/models/get_role_all_of_additional_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/get_role_assignments.rb +236 -0
- data/lib/pipedrive-openapi-client/models/get_role_assignments_all_of.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_role_settings.rb +224 -0
- data/lib/pipedrive-openapi-client/models/get_role_settings_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/get_role_subroles.rb +236 -0
- data/lib/pipedrive-openapi-client/models/get_role_subroles_all_of.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_roles.rb +236 -0
- data/lib/pipedrive-openapi-client/models/get_roles_all_of.rb +218 -0
- data/lib/pipedrive-openapi-client/models/get_stage_deals.rb +228 -0
- data/lib/pipedrive-openapi-client/models/get_stages.rb +219 -0
- data/lib/pipedrive-openapi-client/models/global_message_base_response.rb +207 -0
- data/lib/pipedrive-openapi-client/models/global_message_data.rb +257 -0
- data/lib/pipedrive-openapi-client/models/global_message_delete.rb +244 -0
- data/lib/pipedrive-openapi-client/models/global_message_delete_all_of.rb +226 -0
- data/lib/pipedrive-openapi-client/models/global_message_get.rb +247 -0
- data/lib/pipedrive-openapi-client/models/global_message_get_all_of.rb +229 -0
- data/lib/pipedrive-openapi-client/models/global_message_user_data.rb +228 -0
- data/lib/pipedrive-openapi-client/models/icon_key.rb +74 -0
- data/lib/pipedrive-openapi-client/models/inline_object.rb +236 -0
- data/lib/pipedrive-openapi-client/models/inline_object1.rb +236 -0
- data/lib/pipedrive-openapi-client/models/inline_object10.rb +303 -0
- data/lib/pipedrive-openapi-client/models/inline_object11.rb +217 -0
- data/lib/pipedrive-openapi-client/models/inline_object12.rb +242 -0
- data/lib/pipedrive-openapi-client/models/inline_object13.rb +222 -0
- data/lib/pipedrive-openapi-client/models/inline_object14.rb +283 -0
- data/lib/pipedrive-openapi-client/models/inline_object15.rb +293 -0
- data/lib/pipedrive-openapi-client/models/inline_object16.rb +261 -0
- data/lib/pipedrive-openapi-client/models/inline_object17.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_object18.rb +234 -0
- data/lib/pipedrive-openapi-client/models/inline_object19.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object2.rb +361 -0
- data/lib/pipedrive-openapi-client/models/inline_object20.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object21.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object22.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object23.rb +252 -0
- data/lib/pipedrive-openapi-client/models/inline_object24.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object25.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object26.rb +260 -0
- data/lib/pipedrive-openapi-client/models/inline_object27.rb +214 -0
- data/lib/pipedrive-openapi-client/models/inline_object28.rb +214 -0
- data/lib/pipedrive-openapi-client/models/inline_object29.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_object3.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object30.rb +214 -0
- data/lib/pipedrive-openapi-client/models/inline_object31.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object32.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object33.rb +318 -0
- data/lib/pipedrive-openapi-client/models/inline_object4.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object5.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object6.rb +212 -0
- data/lib/pipedrive-openapi-client/models/inline_object7.rb +222 -0
- data/lib/pipedrive-openapi-client/models/inline_object8.rb +262 -0
- data/lib/pipedrive-openapi-client/models/inline_object9.rb +330 -0
- data/lib/pipedrive-openapi-client/models/inline_response200.rb +226 -0
- data/lib/pipedrive-openapi-client/models/inline_response2001.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response20010.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_response20010_data.rb +209 -0
- data/lib/pipedrive-openapi-client/models/inline_response20011.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_response20011_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/inline_response2002.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response2003.rb +206 -0
- data/lib/pipedrive-openapi-client/models/inline_response2004.rb +226 -0
- data/lib/pipedrive-openapi-client/models/inline_response2005.rb +206 -0
- data/lib/pipedrive-openapi-client/models/inline_response2006.rb +217 -0
- data/lib/pipedrive-openapi-client/models/inline_response2007.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response2007_data.rb +246 -0
- data/lib/pipedrive-openapi-client/models/inline_response2008.rb +217 -0
- data/lib/pipedrive-openapi-client/models/inline_response2008_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/inline_response2009.rb +216 -0
- data/lib/pipedrive-openapi-client/models/inline_response2009_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/inline_response200_additional_data.rb +227 -0
- data/lib/pipedrive-openapi-client/models/inline_response201.rb +215 -0
- data/lib/pipedrive-openapi-client/models/inline_response201_data.rb +362 -0
- data/lib/pipedrive-openapi-client/models/inline_response400.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response403.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response404.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response4041.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response409.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response410.rb +244 -0
- data/lib/pipedrive-openapi-client/models/inline_response500.rb +244 -0
- data/lib/pipedrive-openapi-client/models/leads_value.rb +226 -0
- data/lib/pipedrive-openapi-client/models/link_remote_file_to_item.rb +216 -0
- data/lib/pipedrive-openapi-client/models/mail_message.rb +254 -0
- data/lib/pipedrive-openapi-client/models/mail_message_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/mail_message_data.rb +530 -0
- data/lib/pipedrive-openapi-client/models/mail_participant.rb +257 -0
- data/lib/pipedrive-openapi-client/models/mail_service_base_response.rb +237 -0
- data/lib/pipedrive-openapi-client/models/mail_thread.rb +227 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_delete.rb +227 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_delete_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_messages.rb +227 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_messages_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_one.rb +225 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_one_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_participant.rb +289 -0
- data/lib/pipedrive-openapi-client/models/mail_thread_put.rb +227 -0
- data/lib/pipedrive-openapi-client/models/new_deal.rb +364 -0
- data/lib/pipedrive-openapi-client/models/new_deal_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/new_deal_product.rb +304 -0
- data/lib/pipedrive-openapi-client/models/new_deal_product_all_of.rb +212 -0
- data/lib/pipedrive-openapi-client/models/new_follower_response.rb +216 -0
- data/lib/pipedrive-openapi-client/models/new_follower_response_data.rb +237 -0
- data/lib/pipedrive-openapi-client/models/new_goal.rb +230 -0
- data/lib/pipedrive-openapi-client/models/new_organization.rb +250 -0
- data/lib/pipedrive-openapi-client/models/new_organization_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/new_organization_field.rb +279 -0
- data/lib/pipedrive-openapi-client/models/new_person.rb +284 -0
- data/lib/pipedrive-openapi-client/models/new_person_all_of.rb +207 -0
- data/lib/pipedrive-openapi-client/models/new_person_field.rb +279 -0
- data/lib/pipedrive-openapi-client/models/new_product_field.rb +281 -0
- data/lib/pipedrive-openapi-client/models/new_product_field_all_of.rb +273 -0
- data/lib/pipedrive-openapi-client/models/note.rb +292 -0
- data/lib/pipedrive-openapi-client/models/note_creator_user.rb +238 -0
- data/lib/pipedrive-openapi-client/models/number_boolean.rb +36 -0
- data/lib/pipedrive-openapi-client/models/number_boolean_default0.rb +208 -0
- data/lib/pipedrive-openapi-client/models/number_boolean_default1.rb +208 -0
- data/lib/pipedrive-openapi-client/models/organization_relationship.rb +271 -0
- data/lib/pipedrive-openapi-client/models/permission_sets.rb +227 -0
- data/lib/pipedrive-openapi-client/models/permission_sets_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/permission_sets_item.rb +227 -0
- data/lib/pipedrive-openapi-client/models/pipeline.rb +235 -0
- data/lib/pipedrive-openapi-client/models/post_note.rb +216 -0
- data/lib/pipedrive-openapi-client/models/post_role_assignment.rb +224 -0
- data/lib/pipedrive-openapi-client/models/post_role_assignment_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/post_role_assignment_all_of_data.rb +218 -0
- data/lib/pipedrive-openapi-client/models/post_role_settings.rb +224 -0
- data/lib/pipedrive-openapi-client/models/post_role_settings_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/post_role_settings_all_of_data.rb +252 -0
- data/lib/pipedrive-openapi-client/models/post_roles.rb +224 -0
- data/lib/pipedrive-openapi-client/models/post_roles_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/post_roles_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/product.rb +281 -0
- data/lib/pipedrive-openapi-client/models/product_attachement_fields.rb +327 -0
- data/lib/pipedrive-openapi-client/models/product_field.rb +431 -0
- data/lib/pipedrive-openapi-client/models/product_field_all_of.rb +347 -0
- data/lib/pipedrive-openapi-client/models/put_role.rb +224 -0
- data/lib/pipedrive-openapi-client/models/put_role_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/put_role_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/role_assignment.rb +266 -0
- data/lib/pipedrive-openapi-client/models/role_assignment_all_of.rb +237 -0
- data/lib/pipedrive-openapi-client/models/role_settings.rb +278 -0
- data/lib/pipedrive-openapi-client/models/roles_additional_data.rb +207 -0
- data/lib/pipedrive-openapi-client/models/roles_additional_data_pagination.rb +228 -0
- data/lib/pipedrive-openapi-client/models/single_permission_sets_item.rb +247 -0
- data/lib/pipedrive-openapi-client/models/single_permission_sets_item_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/stage.rb +281 -0
- data/lib/pipedrive-openapi-client/models/sub_role.rb +266 -0
- data/lib/pipedrive-openapi-client/models/sub_role_all_of.rb +237 -0
- data/lib/pipedrive-openapi-client/models/teams.rb +226 -0
- data/lib/pipedrive-openapi-client/models/teams_all_of.rb +208 -0
- data/lib/pipedrive-openapi-client/models/unauthorized.rb +227 -0
- data/lib/pipedrive-openapi-client/models/update_file.rb +216 -0
- data/lib/pipedrive-openapi-client/models/update_team.rb +275 -0
- data/lib/pipedrive-openapi-client/models/update_team_all_of.rb +217 -0
- data/lib/pipedrive-openapi-client/models/user.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_assignment_to_permission_set.rb +237 -0
- data/lib/pipedrive-openapi-client/models/user_assignments_to_permission_set.rb +227 -0
- data/lib/pipedrive-openapi-client/models/user_assignments_to_permission_set_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/user_connections.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_connections_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_connections_all_of_data.rb +208 -0
- data/lib/pipedrive-openapi-client/models/user_i_ds.rb +227 -0
- data/lib/pipedrive-openapi-client/models/user_i_ds_all_of.rb +209 -0
- data/lib/pipedrive-openapi-client/models/user_me.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_me_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_settings.rb +224 -0
- data/lib/pipedrive-openapi-client/models/user_settings_all_of.rb +206 -0
- data/lib/pipedrive-openapi-client/models/user_settings_item.rb +297 -0
- data/lib/pipedrive-openapi-client/models/users.rb +226 -0
- data/lib/pipedrive-openapi-client/models/users_all_of.rb +208 -0
- data/lib/pipedrive-openapi-client/models/visible_to.rb +36 -0
- data/lib/pipedrive-openapi-client/version.rb +15 -0
- data/pipedrive-openapi-client.gemspec +39 -0
- data/spec/api/activities_api_spec.rb +115 -0
- data/spec/api/activity_fields_api_spec.rb +46 -0
- data/spec/api/activity_types_api_spec.rb +100 -0
- data/spec/api/call_logs_api_spec.rb +97 -0
- data/spec/api/currencies_api_spec.rb +47 -0
- data/spec/api/deal_fields_api_spec.rb +109 -0
- data/spec/api/deals_api_spec.rb +439 -0
- data/spec/api/files_api_spec.rb +148 -0
- data/spec/api/filters_api_spec.rb +117 -0
- data/spec/api/global_messages_api_spec.rb +59 -0
- data/spec/api/goals_api_spec.rb +114 -0
- data/spec/api/item_search_api_spec.rb +72 -0
- data/spec/api/leads_api_spec.rb +169 -0
- data/spec/api/mail_messages_api_spec.rb +48 -0
- data/spec/api/mail_threads_api_spec.rb +101 -0
- data/spec/api/note_fields_api_spec.rb +46 -0
- data/spec/api/notes_api_spec.rb +123 -0
- data/spec/api/organization_fields_api_spec.rb +107 -0
- data/spec/api/organization_relationships_api_spec.rb +99 -0
- data/spec/api/organizations_api_spec.rb +300 -0
- data/spec/api/permission_sets_api_spec.rb +70 -0
- data/spec/api/person_fields_api_spec.rb +107 -0
- data/spec/api/persons_api_spec.rb +331 -0
- data/spec/api/pipelines_api_spec.rb +152 -0
- data/spec/api/product_fields_api_spec.rb +107 -0
- data/spec/api/products_api_spec.rb +213 -0
- data/spec/api/recents_api_spec.rb +50 -0
- data/spec/api/roles_api_spec.rb +169 -0
- data/spec/api/search_results_api_spec.rb +70 -0
- data/spec/api/stages_api_spec.rb +123 -0
- data/spec/api/teams_api_spec.rb +140 -0
- data/spec/api/user_connections_api_spec.rb +46 -0
- data/spec/api/user_settings_api_spec.rb +46 -0
- data/spec/api/users_api_spec.rb +210 -0
- data/spec/api/webhooks_api_spec.rb +75 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/activity_spec.rb +135 -0
- data/spec/models/add_file_spec.rb +47 -0
- data/spec/models/add_new_pipeline_all_of_spec.rb +41 -0
- data/spec/models/add_new_pipeline_spec.rb +47 -0
- data/spec/models/added_deal_follower_data_spec.rb +59 -0
- data/spec/models/added_deal_follower_spec.rb +47 -0
- data/spec/models/additional_data_spec.rb +53 -0
- data/spec/models/additional_data_with_pagination_details_spec.rb +41 -0
- data/spec/models/base_currency_spec.rb +77 -0
- data/spec/models/base_deal_spec.rb +347 -0
- data/spec/models/base_mail_thread_all_of_parties_spec.rb +47 -0
- data/spec/models/base_mail_thread_all_of_spec.rb +167 -0
- data/spec/models/base_mail_thread_messages_all_of_spec.rb +113 -0
- data/spec/models/base_mail_thread_messages_spec.rb +203 -0
- data/spec/models/base_mail_thread_spec.rb +257 -0
- data/spec/models/base_note_deal_title_spec.rb +41 -0
- data/spec/models/base_note_organization_spec.rb +41 -0
- data/spec/models/base_note_person_spec.rb +41 -0
- data/spec/models/base_note_spec.rb +137 -0
- data/spec/models/base_response_spec.rb +41 -0
- data/spec/models/base_role_spec.rb +47 -0
- data/spec/models/base_stage_spec.rb +99 -0
- data/spec/models/base_team_all_of1_spec.rb +47 -0
- data/spec/models/base_team_all_of_spec.rb +41 -0
- data/spec/models/base_team_spec.rb +89 -0
- data/spec/models/base_user_me_all_of_language_spec.rb +47 -0
- data/spec/models/base_user_me_all_of_spec.rb +71 -0
- data/spec/models/base_user_me_spec.rb +191 -0
- data/spec/models/base_user_spec.rb +155 -0
- data/spec/models/basic_deal_product_spec.rb +77 -0
- data/spec/models/basic_deal_spec.rb +105 -0
- data/spec/models/basic_goal_spec.rb +75 -0
- data/spec/models/basic_organization_spec.rb +53 -0
- data/spec/models/basic_person_field_spec.rb +47 -0
- data/spec/models/basic_person_spec.rb +71 -0
- data/spec/models/basic_product_field_spec.rb +47 -0
- data/spec/models/common_mail_thread_spec.rb +125 -0
- data/spec/models/create_remote_file_and_link_it_to_item_spec.rb +47 -0
- data/spec/models/create_team_spec.rb +59 -0
- data/spec/models/currencies_spec.rb +47 -0
- data/spec/models/deal_non_strict_mode_fields_creator_user_id_spec.rb +77 -0
- data/spec/models/deal_non_strict_mode_fields_spec.rb +65 -0
- data/spec/models/deal_organization_data_spec.rb +71 -0
- data/spec/models/deal_person_data_email_spec.rb +53 -0
- data/spec/models/deal_person_data_phone_spec.rb +53 -0
- data/spec/models/deal_person_data_spec.rb +59 -0
- data/spec/models/deal_strict_mode_fields_spec.rb +65 -0
- data/spec/models/deal_summary_per_currency_full_currencyid_spec.rb +47 -0
- data/spec/models/deal_summary_per_currency_full_spec.rb +41 -0
- data/spec/models/deal_summary_per_currency_spec.rb +41 -0
- data/spec/models/deal_summary_per_stages_spec.rb +41 -0
- data/spec/models/deal_summary_per_stages_stageid_spec.rb +41 -0
- data/spec/models/deal_summary_per_stages_stageidcurrencyid_spec.rb +65 -0
- data/spec/models/deal_summary_spec.rb +59 -0
- data/spec/models/deal_user_data_spec.rb +71 -0
- data/spec/models/delete_deal_data_spec.rb +41 -0
- data/spec/models/delete_deal_follower_data_spec.rb +41 -0
- data/spec/models/delete_deal_follower_spec.rb +47 -0
- data/spec/models/delete_deal_participant_data_spec.rb +41 -0
- data/spec/models/delete_deal_participant_spec.rb +47 -0
- data/spec/models/delete_deal_product_data_spec.rb +47 -0
- data/spec/models/delete_deal_product_spec.rb +47 -0
- data/spec/models/delete_deal_spec.rb +47 -0
- data/spec/models/delete_file_data_spec.rb +41 -0
- data/spec/models/delete_file_spec.rb +47 -0
- data/spec/models/delete_multiple_deals_all_of_data_spec.rb +41 -0
- data/spec/models/delete_multiple_deals_all_of_spec.rb +47 -0
- data/spec/models/delete_multiple_deals_spec.rb +35 -0
- data/spec/models/delete_multiple_product_fields_response_data_spec.rb +41 -0
- data/spec/models/delete_multiple_product_fields_response_spec.rb +47 -0
- data/spec/models/delete_note_spec.rb +47 -0
- data/spec/models/delete_product_field_response_data_spec.rb +41 -0
- data/spec/models/delete_product_field_response_spec.rb +47 -0
- data/spec/models/delete_product_follower_response_data_spec.rb +41 -0
- data/spec/models/delete_product_follower_response_spec.rb +47 -0
- data/spec/models/delete_role_all_of_data_spec.rb +41 -0
- data/spec/models/delete_role_all_of_spec.rb +41 -0
- data/spec/models/delete_role_assignment_all_of_data_spec.rb +41 -0
- data/spec/models/delete_role_assignment_all_of_spec.rb +41 -0
- data/spec/models/delete_role_assignment_spec.rb +47 -0
- data/spec/models/delete_role_spec.rb +47 -0
- data/spec/models/edit_pipeline_all_of_spec.rb +41 -0
- data/spec/models/edit_pipeline_spec.rb +47 -0
- data/spec/models/fail_response_spec.rb +47 -0
- data/spec/models/field_type_spec.rb +45 -0
- data/spec/models/file_data_spec.rb +191 -0
- data/spec/models/filter_type_spec.rb +35 -0
- data/spec/models/find_products_by_name_response_data_spec.rb +77 -0
- data/spec/models/find_products_by_name_response_spec.rb +53 -0
- data/spec/models/full_role_all_of_spec.rb +41 -0
- data/spec/models/full_role_spec.rb +77 -0
- data/spec/models/get_add_product_attachement_details_spec.rb +47 -0
- data/spec/models/get_add_update_stage_spec.rb +47 -0
- data/spec/models/get_added_deal_additional_data_spec.rb +41 -0
- data/spec/models/get_added_deal_related_objects_spec.rb +53 -0
- data/spec/models/get_added_deal_spec.rb +59 -0
- data/spec/models/get_all_files_spec.rb +53 -0
- data/spec/models/get_all_pipelines_all_of_spec.rb +41 -0
- data/spec/models/get_all_pipelines_spec.rb +47 -0
- data/spec/models/get_all_product_fields_response_spec.rb +53 -0
- data/spec/models/get_deal_additional_data_spec.rb +41 -0
- data/spec/models/get_deal_spec.rb +59 -0
- data/spec/models/get_deals_by_name_additional_data_spec.rb +41 -0
- data/spec/models/get_deals_by_name_data_spec.rb +113 -0
- data/spec/models/get_deals_by_name_spec.rb +53 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_all_of_data_spec.rb +53 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_all_of_data_stage_conversions_spec.rb +53 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_all_of_spec.rb +41 -0
- data/spec/models/get_deals_conversion_rates_in_pipeline_spec.rb +47 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days_by_stages_spec.rb +47 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_average_age_in_days_spec.rb +47 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_movements_between_stages_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_new_deals_formatted_values_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_new_deals_spec.rb +59 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_new_deals_values_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_data_spec.rb +71 -0
- data/spec/models/get_deals_movements_in_pipeline_all_of_spec.rb +41 -0
- data/spec/models/get_deals_movements_in_pipeline_spec.rb +47 -0
- data/spec/models/get_deals_spec.rb +59 -0
- data/spec/models/get_deals_summary_data_spec.rb +77 -0
- data/spec/models/get_deals_summary_data_values_total_spec.rb +65 -0
- data/spec/models/get_deals_summary_data_weighted_values_total_spec.rb +53 -0
- data/spec/models/get_deals_summary_spec.rb +47 -0
- data/spec/models/get_deals_timeline_data_spec.rb +59 -0
- data/spec/models/get_deals_timeline_data_totals_spec.rb +83 -0
- data/spec/models/get_deals_timeline_spec.rb +47 -0
- data/spec/models/get_duplicated_deal_spec.rb +47 -0
- data/spec/models/get_merged_deal_spec.rb +47 -0
- data/spec/models/get_notes_spec.rb +53 -0
- data/spec/models/get_one_file_spec.rb +47 -0
- data/spec/models/get_one_pipeline_all_of_spec.rb +41 -0
- data/spec/models/get_one_pipeline_spec.rb +47 -0
- data/spec/models/get_one_stage_spec.rb +47 -0
- data/spec/models/get_product_attachement_details_spec.rb +47 -0
- data/spec/models/get_product_field_response_spec.rb +47 -0
- data/spec/models/get_role_all_of_additional_data_spec.rb +41 -0
- data/spec/models/get_role_all_of_spec.rb +47 -0
- data/spec/models/get_role_assignments_all_of_spec.rb +47 -0
- data/spec/models/get_role_assignments_spec.rb +53 -0
- data/spec/models/get_role_settings_all_of_spec.rb +41 -0
- data/spec/models/get_role_settings_spec.rb +47 -0
- data/spec/models/get_role_spec.rb +53 -0
- data/spec/models/get_role_subroles_all_of_spec.rb +47 -0
- data/spec/models/get_role_subroles_spec.rb +53 -0
- data/spec/models/get_roles_all_of_spec.rb +47 -0
- data/spec/models/get_roles_spec.rb +53 -0
- data/spec/models/get_stage_deals_spec.rb +53 -0
- data/spec/models/get_stages_spec.rb +47 -0
- data/spec/models/global_message_base_response_spec.rb +41 -0
- data/spec/models/global_message_data_spec.rb +71 -0
- data/spec/models/global_message_delete_all_of_spec.rb +53 -0
- data/spec/models/global_message_delete_spec.rb +59 -0
- data/spec/models/global_message_get_all_of_spec.rb +53 -0
- data/spec/models/global_message_get_spec.rb +59 -0
- data/spec/models/global_message_user_data_spec.rb +53 -0
- data/spec/models/icon_key_spec.rb +35 -0
- data/spec/models/inline_object10_spec.rb +67 -0
- data/spec/models/inline_object11_spec.rb +47 -0
- data/spec/models/inline_object12_spec.rb +53 -0
- data/spec/models/inline_object13_spec.rb +47 -0
- data/spec/models/inline_object14_spec.rb +83 -0
- data/spec/models/inline_object15_spec.rb +89 -0
- data/spec/models/inline_object16_spec.rb +51 -0
- data/spec/models/inline_object17_spec.rb +47 -0
- data/spec/models/inline_object18_spec.rb +59 -0
- data/spec/models/inline_object19_spec.rb +41 -0
- data/spec/models/inline_object1_spec.rb +59 -0
- data/spec/models/inline_object20_spec.rb +41 -0
- data/spec/models/inline_object21_spec.rb +41 -0
- data/spec/models/inline_object22_spec.rb +41 -0
- data/spec/models/inline_object23_spec.rb +65 -0
- data/spec/models/inline_object24_spec.rb +41 -0
- data/spec/models/inline_object25_spec.rb +41 -0
- data/spec/models/inline_object26_spec.rb +51 -0
- data/spec/models/inline_object27_spec.rb +41 -0
- data/spec/models/inline_object28_spec.rb +41 -0
- data/spec/models/inline_object29_spec.rb +53 -0
- data/spec/models/inline_object2_spec.rb +105 -0
- data/spec/models/inline_object30_spec.rb +41 -0
- data/spec/models/inline_object31_spec.rb +41 -0
- data/spec/models/inline_object32_spec.rb +41 -0
- data/spec/models/inline_object33_spec.rb +79 -0
- data/spec/models/inline_object3_spec.rb +41 -0
- data/spec/models/inline_object4_spec.rb +41 -0
- data/spec/models/inline_object5_spec.rb +41 -0
- data/spec/models/inline_object6_spec.rb +41 -0
- data/spec/models/inline_object7_spec.rb +47 -0
- data/spec/models/inline_object8_spec.rb +71 -0
- data/spec/models/inline_object9_spec.rb +77 -0
- data/spec/models/inline_object_spec.rb +53 -0
- data/spec/models/inline_response20010_data_spec.rb +41 -0
- data/spec/models/inline_response20010_spec.rb +47 -0
- data/spec/models/inline_response20011_data_spec.rb +41 -0
- data/spec/models/inline_response20011_spec.rb +47 -0
- data/spec/models/inline_response2001_spec.rb +47 -0
- data/spec/models/inline_response2002_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +41 -0
- data/spec/models/inline_response2004_spec.rb +53 -0
- data/spec/models/inline_response2005_spec.rb +41 -0
- data/spec/models/inline_response2006_spec.rb +47 -0
- data/spec/models/inline_response2007_data_spec.rb +65 -0
- data/spec/models/inline_response2007_spec.rb +47 -0
- data/spec/models/inline_response2008_data_spec.rb +41 -0
- data/spec/models/inline_response2008_spec.rb +47 -0
- data/spec/models/inline_response2009_data_spec.rb +41 -0
- data/spec/models/inline_response2009_spec.rb +47 -0
- data/spec/models/inline_response200_additional_data_spec.rb +53 -0
- data/spec/models/inline_response200_spec.rb +53 -0
- data/spec/models/inline_response201_data_spec.rb +131 -0
- data/spec/models/inline_response201_spec.rb +47 -0
- data/spec/models/inline_response400_spec.rb +65 -0
- data/spec/models/inline_response403_spec.rb +65 -0
- data/spec/models/inline_response4041_spec.rb +65 -0
- data/spec/models/inline_response404_spec.rb +65 -0
- data/spec/models/inline_response409_spec.rb +65 -0
- data/spec/models/inline_response410_spec.rb +65 -0
- data/spec/models/inline_response500_spec.rb +65 -0
- data/spec/models/leads_value_spec.rb +47 -0
- data/spec/models/link_remote_file_to_item_spec.rb +47 -0
- data/spec/models/mail_message_all_of_spec.rb +41 -0
- data/spec/models/mail_message_data_spec.rb +213 -0
- data/spec/models/mail_message_spec.rb +65 -0
- data/spec/models/mail_participant_spec.rb +71 -0
- data/spec/models/mail_service_base_response_spec.rb +59 -0
- data/spec/models/mail_thread_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_delete_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_delete_spec.rb +47 -0
- data/spec/models/mail_thread_messages_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_messages_spec.rb +47 -0
- data/spec/models/mail_thread_one_all_of_spec.rb +41 -0
- data/spec/models/mail_thread_one_spec.rb +47 -0
- data/spec/models/mail_thread_participant_spec.rb +89 -0
- data/spec/models/mail_thread_put_spec.rb +47 -0
- data/spec/models/mail_thread_spec.rb +47 -0
- data/spec/models/new_deal_all_of_spec.rb +41 -0
- data/spec/models/new_deal_product_all_of_spec.rb +41 -0
- data/spec/models/new_deal_product_spec.rb +83 -0
- data/spec/models/new_deal_spec.rb +111 -0
- data/spec/models/new_follower_response_data_spec.rb +59 -0
- data/spec/models/new_follower_response_spec.rb +47 -0
- data/spec/models/new_goal_spec.rb +35 -0
- data/spec/models/new_organization_all_of_spec.rb +41 -0
- data/spec/models/new_organization_field_spec.rb +57 -0
- data/spec/models/new_organization_spec.rb +59 -0
- data/spec/models/new_person_all_of_spec.rb +41 -0
- data/spec/models/new_person_field_spec.rb +57 -0
- data/spec/models/new_person_spec.rb +77 -0
- data/spec/models/new_product_field_all_of_spec.rb +57 -0
- data/spec/models/new_product_field_spec.rb +57 -0
- data/spec/models/note_creator_user_spec.rb +59 -0
- data/spec/models/note_spec.rb +89 -0
- data/spec/models/number_boolean_default0_spec.rb +35 -0
- data/spec/models/number_boolean_default1_spec.rb +35 -0
- data/spec/models/number_boolean_spec.rb +35 -0
- data/spec/models/organization_relationship_spec.rb +63 -0
- data/spec/models/permission_sets_all_of_spec.rb +41 -0
- data/spec/models/permission_sets_item_spec.rb +53 -0
- data/spec/models/permission_sets_spec.rb +47 -0
- data/spec/models/pipeline_spec.rb +59 -0
- data/spec/models/post_note_spec.rb +47 -0
- data/spec/models/post_role_assignment_all_of_data_spec.rb +47 -0
- data/spec/models/post_role_assignment_all_of_spec.rb +41 -0
- data/spec/models/post_role_assignment_spec.rb +47 -0
- data/spec/models/post_role_settings_all_of_data_spec.rb +51 -0
- data/spec/models/post_role_settings_all_of_spec.rb +41 -0
- data/spec/models/post_role_settings_spec.rb +47 -0
- data/spec/models/post_roles_all_of_data_spec.rb +41 -0
- data/spec/models/post_roles_all_of_spec.rb +41 -0
- data/spec/models/post_roles_spec.rb +47 -0
- data/spec/models/product_attachement_fields_spec.rb +113 -0
- data/spec/models/product_field_all_of_spec.rb +125 -0
- data/spec/models/product_field_spec.rb +147 -0
- data/spec/models/product_spec.rb +83 -0
- data/spec/models/put_role_all_of_data_spec.rb +41 -0
- data/spec/models/put_role_all_of_spec.rb +41 -0
- data/spec/models/put_role_spec.rb +47 -0
- data/spec/models/role_assignment_all_of_spec.rb +59 -0
- data/spec/models/role_assignment_spec.rb +71 -0
- data/spec/models/role_settings_spec.rb +83 -0
- data/spec/models/roles_additional_data_pagination_spec.rb +53 -0
- data/spec/models/roles_additional_data_spec.rb +41 -0
- data/spec/models/single_permission_sets_item_all_of_spec.rb +41 -0
- data/spec/models/single_permission_sets_item_spec.rb +59 -0
- data/spec/models/stage_spec.rb +69 -0
- data/spec/models/sub_role_all_of_spec.rb +59 -0
- data/spec/models/sub_role_spec.rb +71 -0
- data/spec/models/teams_all_of_spec.rb +41 -0
- data/spec/models/teams_spec.rb +47 -0
- data/spec/models/unauthorized_spec.rb +53 -0
- data/spec/models/update_file_spec.rb +47 -0
- data/spec/models/update_team_all_of_spec.rb +47 -0
- data/spec/models/update_team_spec.rb +71 -0
- data/spec/models/user_all_of_spec.rb +41 -0
- data/spec/models/user_assignment_to_permission_set_spec.rb +59 -0
- data/spec/models/user_assignments_to_permission_set_all_of_spec.rb +41 -0
- data/spec/models/user_assignments_to_permission_set_spec.rb +47 -0
- data/spec/models/user_connections_all_of_data_spec.rb +41 -0
- data/spec/models/user_connections_all_of_spec.rb +41 -0
- data/spec/models/user_connections_spec.rb +47 -0
- data/spec/models/user_i_ds_all_of_spec.rb +41 -0
- data/spec/models/user_i_ds_spec.rb +47 -0
- data/spec/models/user_me_all_of_spec.rb +41 -0
- data/spec/models/user_me_spec.rb +47 -0
- data/spec/models/user_settings_all_of_spec.rb +41 -0
- data/spec/models/user_settings_item_spec.rb +95 -0
- data/spec/models/user_settings_spec.rb +47 -0
- data/spec/models/user_spec.rb +47 -0
- data/spec/models/users_all_of_spec.rb +41 -0
- data/spec/models/users_spec.rb +47 -0
- data/spec/models/visible_to_spec.rb +35 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1495 -0
data/docs/ProductsApi.md
ADDED
|
@@ -0,0 +1,809 @@
|
|
|
1
|
+
# Pipedrive::ProductsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.pipedrive.com/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**products_find_get**](ProductsApi.md#products_find_get) | **GET** /products/find | Find products by name
|
|
8
|
+
[**products_get**](ProductsApi.md#products_get) | **GET** /products | Get all products
|
|
9
|
+
[**products_id_deals_get**](ProductsApi.md#products_id_deals_get) | **GET** /products/{id}/deals | Get deals where a product is attached to
|
|
10
|
+
[**products_id_delete**](ProductsApi.md#products_id_delete) | **DELETE** /products/{id} | Delete a product
|
|
11
|
+
[**products_id_files_get**](ProductsApi.md#products_id_files_get) | **GET** /products/{id}/files | List files attached to a product
|
|
12
|
+
[**products_id_followers_follower_id_delete**](ProductsApi.md#products_id_followers_follower_id_delete) | **DELETE** /products/{id}/followers/{follower_id} | Delete a follower from a product
|
|
13
|
+
[**products_id_followers_get**](ProductsApi.md#products_id_followers_get) | **GET** /products/{id}/followers | List followers of a product
|
|
14
|
+
[**products_id_followers_post**](ProductsApi.md#products_id_followers_post) | **POST** /products/{id}/followers | Add a follower to a product
|
|
15
|
+
[**products_id_get**](ProductsApi.md#products_id_get) | **GET** /products/{id} | Get one product
|
|
16
|
+
[**products_id_permitted_users_get**](ProductsApi.md#products_id_permitted_users_get) | **GET** /products/{id}/permittedUsers | List permitted users
|
|
17
|
+
[**products_id_put**](ProductsApi.md#products_id_put) | **PUT** /products/{id} | Update a product
|
|
18
|
+
[**products_post**](ProductsApi.md#products_post) | **POST** /products | Add a product
|
|
19
|
+
[**products_search_get**](ProductsApi.md#products_search_get) | **GET** /products/search | Search products
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## products_find_get
|
|
24
|
+
|
|
25
|
+
> FindProductsByNameResponse products_find_get(term, opts)
|
|
26
|
+
|
|
27
|
+
Find products by name
|
|
28
|
+
|
|
29
|
+
<strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_search\">/v1/products/search</a> or <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Returns data about the products that were found. If currency was set in request, prices in that currency are served back.
|
|
30
|
+
|
|
31
|
+
### Example
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
# load the gem
|
|
35
|
+
require 'pipedrive-openapi-client'
|
|
36
|
+
# setup authorization
|
|
37
|
+
Pipedrive.configure do |config|
|
|
38
|
+
# Configure API key authorization: api_key
|
|
39
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
40
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
41
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
42
|
+
|
|
43
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
44
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
48
|
+
term = 'term_example' # String | Search term to look for, minimum 3 characters.
|
|
49
|
+
opts = {
|
|
50
|
+
currency: 'currency_example', # String | Currency code in which prices should be returned in. If omitted, prices in user's default currency will be returned.
|
|
51
|
+
start: 0, # Integer | Pagination start
|
|
52
|
+
limit: 56 # Integer | Items shown per page
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
begin
|
|
56
|
+
#Find products by name
|
|
57
|
+
result = api_instance.products_find_get(term, opts)
|
|
58
|
+
p result
|
|
59
|
+
rescue Pipedrive::ApiError => e
|
|
60
|
+
puts "Exception when calling ProductsApi->products_find_get: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
Name | Type | Description | Notes
|
|
68
|
+
------------- | ------------- | ------------- | -------------
|
|
69
|
+
**term** | **String**| Search term to look for, minimum 3 characters. |
|
|
70
|
+
**currency** | **String**| Currency code in which prices should be returned in. If omitted, prices in user's default currency will be returned. | [optional]
|
|
71
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
72
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
[**FindProductsByNameResponse**](FindProductsByNameResponse.md)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: Not defined
|
|
85
|
+
- **Accept**: application/json
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
## products_get
|
|
89
|
+
|
|
90
|
+
> Product products_get(opts)
|
|
91
|
+
|
|
92
|
+
Get all products
|
|
93
|
+
|
|
94
|
+
Returns data about all products.
|
|
95
|
+
|
|
96
|
+
### Example
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
# load the gem
|
|
100
|
+
require 'pipedrive-openapi-client'
|
|
101
|
+
# setup authorization
|
|
102
|
+
Pipedrive.configure do |config|
|
|
103
|
+
# Configure API key authorization: api_key
|
|
104
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
106
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
107
|
+
|
|
108
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
109
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
113
|
+
opts = {
|
|
114
|
+
user_id: 56, # Integer | If supplied, only products owned by the given user will be returned.
|
|
115
|
+
filter_id: 56, # Integer | ID of the filter to use
|
|
116
|
+
first_char: 'first_char_example', # String | If supplied, only products whose name starts with the specified letter will be returned (case insensitive).
|
|
117
|
+
start: 0, # Integer | Pagination start
|
|
118
|
+
limit: 56 # Integer | Items shown per page
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
#Get all products
|
|
123
|
+
result = api_instance.products_get(opts)
|
|
124
|
+
p result
|
|
125
|
+
rescue Pipedrive::ApiError => e
|
|
126
|
+
puts "Exception when calling ProductsApi->products_get: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Parameters
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
Name | Type | Description | Notes
|
|
134
|
+
------------- | ------------- | ------------- | -------------
|
|
135
|
+
**user_id** | **Integer**| If supplied, only products owned by the given user will be returned. | [optional]
|
|
136
|
+
**filter_id** | **Integer**| ID of the filter to use | [optional]
|
|
137
|
+
**first_char** | **String**| If supplied, only products whose name starts with the specified letter will be returned (case insensitive). | [optional]
|
|
138
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
139
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
[**Product**](Product.md)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: application/json
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
## products_id_deals_get
|
|
156
|
+
|
|
157
|
+
> BasicDeal products_id_deals_get(id, opts)
|
|
158
|
+
|
|
159
|
+
Get deals where a product is attached to
|
|
160
|
+
|
|
161
|
+
Returns data about deals that have a product attached to.
|
|
162
|
+
|
|
163
|
+
### Example
|
|
164
|
+
|
|
165
|
+
```ruby
|
|
166
|
+
# load the gem
|
|
167
|
+
require 'pipedrive-openapi-client'
|
|
168
|
+
# setup authorization
|
|
169
|
+
Pipedrive.configure do |config|
|
|
170
|
+
# Configure API key authorization: api_key
|
|
171
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
172
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
173
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
174
|
+
|
|
175
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
176
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
180
|
+
id = 56 # Integer | ID of the product
|
|
181
|
+
opts = {
|
|
182
|
+
start: 0, # Integer | Pagination start
|
|
183
|
+
limit: 56, # Integer | Items shown per page
|
|
184
|
+
status: 'all_not_deleted' # String | Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
#Get deals where a product is attached to
|
|
189
|
+
result = api_instance.products_id_deals_get(id, opts)
|
|
190
|
+
p result
|
|
191
|
+
rescue Pipedrive::ApiError => e
|
|
192
|
+
puts "Exception when calling ProductsApi->products_id_deals_get: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
Name | Type | Description | Notes
|
|
200
|
+
------------- | ------------- | ------------- | -------------
|
|
201
|
+
**id** | **Integer**| ID of the product |
|
|
202
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
203
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
204
|
+
**status** | **String**| Only fetch deals with specific status. If omitted, all not deleted deals are fetched. | [optional] [default to 'all_not_deleted']
|
|
205
|
+
|
|
206
|
+
### Return type
|
|
207
|
+
|
|
208
|
+
[**BasicDeal**](BasicDeal.md)
|
|
209
|
+
|
|
210
|
+
### Authorization
|
|
211
|
+
|
|
212
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
213
|
+
|
|
214
|
+
### HTTP request headers
|
|
215
|
+
|
|
216
|
+
- **Content-Type**: Not defined
|
|
217
|
+
- **Accept**: application/json
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
## products_id_delete
|
|
221
|
+
|
|
222
|
+
> products_id_delete(id)
|
|
223
|
+
|
|
224
|
+
Delete a product
|
|
225
|
+
|
|
226
|
+
Marks a product as deleted.
|
|
227
|
+
|
|
228
|
+
### Example
|
|
229
|
+
|
|
230
|
+
```ruby
|
|
231
|
+
# load the gem
|
|
232
|
+
require 'pipedrive-openapi-client'
|
|
233
|
+
# setup authorization
|
|
234
|
+
Pipedrive.configure do |config|
|
|
235
|
+
# Configure API key authorization: api_key
|
|
236
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
237
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
238
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
239
|
+
|
|
240
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
241
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
245
|
+
id = 56 # Integer | ID of the product
|
|
246
|
+
|
|
247
|
+
begin
|
|
248
|
+
#Delete a product
|
|
249
|
+
api_instance.products_id_delete(id)
|
|
250
|
+
rescue Pipedrive::ApiError => e
|
|
251
|
+
puts "Exception when calling ProductsApi->products_id_delete: #{e}"
|
|
252
|
+
end
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### Parameters
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
Name | Type | Description | Notes
|
|
259
|
+
------------- | ------------- | ------------- | -------------
|
|
260
|
+
**id** | **Integer**| ID of the product |
|
|
261
|
+
|
|
262
|
+
### Return type
|
|
263
|
+
|
|
264
|
+
nil (empty response body)
|
|
265
|
+
|
|
266
|
+
### Authorization
|
|
267
|
+
|
|
268
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
269
|
+
|
|
270
|
+
### HTTP request headers
|
|
271
|
+
|
|
272
|
+
- **Content-Type**: Not defined
|
|
273
|
+
- **Accept**: Not defined
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
## products_id_files_get
|
|
277
|
+
|
|
278
|
+
> products_id_files_get(id, opts)
|
|
279
|
+
|
|
280
|
+
List files attached to a product
|
|
281
|
+
|
|
282
|
+
Lists files associated with a product.
|
|
283
|
+
|
|
284
|
+
### Example
|
|
285
|
+
|
|
286
|
+
```ruby
|
|
287
|
+
# load the gem
|
|
288
|
+
require 'pipedrive-openapi-client'
|
|
289
|
+
# setup authorization
|
|
290
|
+
Pipedrive.configure do |config|
|
|
291
|
+
# Configure API key authorization: api_key
|
|
292
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
293
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
294
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
295
|
+
|
|
296
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
297
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
301
|
+
id = 56 # Integer | ID of the product
|
|
302
|
+
opts = {
|
|
303
|
+
start: 0, # Integer | Pagination start
|
|
304
|
+
limit: 56, # Integer | Items shown per page
|
|
305
|
+
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.
|
|
306
|
+
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.
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
begin
|
|
310
|
+
#List files attached to a product
|
|
311
|
+
api_instance.products_id_files_get(id, opts)
|
|
312
|
+
rescue Pipedrive::ApiError => e
|
|
313
|
+
puts "Exception when calling ProductsApi->products_id_files_get: #{e}"
|
|
314
|
+
end
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
### Parameters
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
Name | Type | Description | Notes
|
|
321
|
+
------------- | ------------- | ------------- | -------------
|
|
322
|
+
**id** | **Integer**| ID of the product |
|
|
323
|
+
**start** | **Integer**| Pagination start | [optional] [default to 0]
|
|
324
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
325
|
+
**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]
|
|
326
|
+
**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]
|
|
327
|
+
|
|
328
|
+
### Return type
|
|
329
|
+
|
|
330
|
+
nil (empty response body)
|
|
331
|
+
|
|
332
|
+
### Authorization
|
|
333
|
+
|
|
334
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
335
|
+
|
|
336
|
+
### HTTP request headers
|
|
337
|
+
|
|
338
|
+
- **Content-Type**: Not defined
|
|
339
|
+
- **Accept**: Not defined
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
## products_id_followers_follower_id_delete
|
|
343
|
+
|
|
344
|
+
> DeleteProductFollowerResponse products_id_followers_follower_id_delete(id, follower_id)
|
|
345
|
+
|
|
346
|
+
Delete a follower from a product
|
|
347
|
+
|
|
348
|
+
Deletes a follower from a product.
|
|
349
|
+
|
|
350
|
+
### Example
|
|
351
|
+
|
|
352
|
+
```ruby
|
|
353
|
+
# load the gem
|
|
354
|
+
require 'pipedrive-openapi-client'
|
|
355
|
+
# setup authorization
|
|
356
|
+
Pipedrive.configure do |config|
|
|
357
|
+
# Configure API key authorization: api_key
|
|
358
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
359
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
360
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
364
|
+
id = 56 # Integer | ID of the product
|
|
365
|
+
follower_id = 56 # Integer | ID of the follower
|
|
366
|
+
|
|
367
|
+
begin
|
|
368
|
+
#Delete a follower from a product
|
|
369
|
+
result = api_instance.products_id_followers_follower_id_delete(id, follower_id)
|
|
370
|
+
p result
|
|
371
|
+
rescue Pipedrive::ApiError => e
|
|
372
|
+
puts "Exception when calling ProductsApi->products_id_followers_follower_id_delete: #{e}"
|
|
373
|
+
end
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
Name | Type | Description | Notes
|
|
380
|
+
------------- | ------------- | ------------- | -------------
|
|
381
|
+
**id** | **Integer**| ID of the product |
|
|
382
|
+
**follower_id** | **Integer**| ID of the follower |
|
|
383
|
+
|
|
384
|
+
### Return type
|
|
385
|
+
|
|
386
|
+
[**DeleteProductFollowerResponse**](DeleteProductFollowerResponse.md)
|
|
387
|
+
|
|
388
|
+
### Authorization
|
|
389
|
+
|
|
390
|
+
[api_key](../README.md#api_key)
|
|
391
|
+
|
|
392
|
+
### HTTP request headers
|
|
393
|
+
|
|
394
|
+
- **Content-Type**: Not defined
|
|
395
|
+
- **Accept**: application/json
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
## products_id_followers_get
|
|
399
|
+
|
|
400
|
+
> UserIDs products_id_followers_get(id)
|
|
401
|
+
|
|
402
|
+
List followers of a product
|
|
403
|
+
|
|
404
|
+
Lists the followers of a Product
|
|
405
|
+
|
|
406
|
+
### Example
|
|
407
|
+
|
|
408
|
+
```ruby
|
|
409
|
+
# load the gem
|
|
410
|
+
require 'pipedrive-openapi-client'
|
|
411
|
+
# setup authorization
|
|
412
|
+
Pipedrive.configure do |config|
|
|
413
|
+
# Configure API key authorization: api_key
|
|
414
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
415
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
416
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
417
|
+
|
|
418
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
419
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
423
|
+
id = 56 # Integer | ID of the product
|
|
424
|
+
|
|
425
|
+
begin
|
|
426
|
+
#List followers of a product
|
|
427
|
+
result = api_instance.products_id_followers_get(id)
|
|
428
|
+
p result
|
|
429
|
+
rescue Pipedrive::ApiError => e
|
|
430
|
+
puts "Exception when calling ProductsApi->products_id_followers_get: #{e}"
|
|
431
|
+
end
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
### Parameters
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
Name | Type | Description | Notes
|
|
438
|
+
------------- | ------------- | ------------- | -------------
|
|
439
|
+
**id** | **Integer**| ID of the product |
|
|
440
|
+
|
|
441
|
+
### Return type
|
|
442
|
+
|
|
443
|
+
[**UserIDs**](UserIDs.md)
|
|
444
|
+
|
|
445
|
+
### Authorization
|
|
446
|
+
|
|
447
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
448
|
+
|
|
449
|
+
### HTTP request headers
|
|
450
|
+
|
|
451
|
+
- **Content-Type**: Not defined
|
|
452
|
+
- **Accept**: application/json
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
## products_id_followers_post
|
|
456
|
+
|
|
457
|
+
> NewFollowerResponse products_id_followers_post(id, opts)
|
|
458
|
+
|
|
459
|
+
Add a follower to a product
|
|
460
|
+
|
|
461
|
+
Adds a follower to a product.
|
|
462
|
+
|
|
463
|
+
### Example
|
|
464
|
+
|
|
465
|
+
```ruby
|
|
466
|
+
# load the gem
|
|
467
|
+
require 'pipedrive-openapi-client'
|
|
468
|
+
# setup authorization
|
|
469
|
+
Pipedrive.configure do |config|
|
|
470
|
+
# Configure API key authorization: api_key
|
|
471
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
472
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
473
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
477
|
+
id = 56 # Integer | ID of the product
|
|
478
|
+
opts = {
|
|
479
|
+
inline_object24: Pipedrive::InlineObject24.new # InlineObject24 |
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
begin
|
|
483
|
+
#Add a follower to a product
|
|
484
|
+
result = api_instance.products_id_followers_post(id, opts)
|
|
485
|
+
p result
|
|
486
|
+
rescue Pipedrive::ApiError => e
|
|
487
|
+
puts "Exception when calling ProductsApi->products_id_followers_post: #{e}"
|
|
488
|
+
end
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
### Parameters
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
Name | Type | Description | Notes
|
|
495
|
+
------------- | ------------- | ------------- | -------------
|
|
496
|
+
**id** | **Integer**| ID of the product |
|
|
497
|
+
**inline_object24** | [**InlineObject24**](InlineObject24.md)| | [optional]
|
|
498
|
+
|
|
499
|
+
### Return type
|
|
500
|
+
|
|
501
|
+
[**NewFollowerResponse**](NewFollowerResponse.md)
|
|
502
|
+
|
|
503
|
+
### Authorization
|
|
504
|
+
|
|
505
|
+
[api_key](../README.md#api_key)
|
|
506
|
+
|
|
507
|
+
### HTTP request headers
|
|
508
|
+
|
|
509
|
+
- **Content-Type**: application/json
|
|
510
|
+
- **Accept**: application/json
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
## products_id_get
|
|
514
|
+
|
|
515
|
+
> products_id_get(id)
|
|
516
|
+
|
|
517
|
+
Get one product
|
|
518
|
+
|
|
519
|
+
Returns data about a specific product.
|
|
520
|
+
|
|
521
|
+
### Example
|
|
522
|
+
|
|
523
|
+
```ruby
|
|
524
|
+
# load the gem
|
|
525
|
+
require 'pipedrive-openapi-client'
|
|
526
|
+
# setup authorization
|
|
527
|
+
Pipedrive.configure do |config|
|
|
528
|
+
# Configure API key authorization: api_key
|
|
529
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
530
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
531
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
532
|
+
|
|
533
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
534
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
535
|
+
end
|
|
536
|
+
|
|
537
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
538
|
+
id = 56 # Integer | ID of the product
|
|
539
|
+
|
|
540
|
+
begin
|
|
541
|
+
#Get one product
|
|
542
|
+
api_instance.products_id_get(id)
|
|
543
|
+
rescue Pipedrive::ApiError => e
|
|
544
|
+
puts "Exception when calling ProductsApi->products_id_get: #{e}"
|
|
545
|
+
end
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
### Parameters
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
Name | Type | Description | Notes
|
|
552
|
+
------------- | ------------- | ------------- | -------------
|
|
553
|
+
**id** | **Integer**| ID of the product |
|
|
554
|
+
|
|
555
|
+
### Return type
|
|
556
|
+
|
|
557
|
+
nil (empty response body)
|
|
558
|
+
|
|
559
|
+
### Authorization
|
|
560
|
+
|
|
561
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
562
|
+
|
|
563
|
+
### HTTP request headers
|
|
564
|
+
|
|
565
|
+
- **Content-Type**: Not defined
|
|
566
|
+
- **Accept**: Not defined
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
## products_id_permitted_users_get
|
|
570
|
+
|
|
571
|
+
> UserIDs products_id_permitted_users_get(id)
|
|
572
|
+
|
|
573
|
+
List permitted users
|
|
574
|
+
|
|
575
|
+
Lists users permitted to access a product.
|
|
576
|
+
|
|
577
|
+
### Example
|
|
578
|
+
|
|
579
|
+
```ruby
|
|
580
|
+
# load the gem
|
|
581
|
+
require 'pipedrive-openapi-client'
|
|
582
|
+
# setup authorization
|
|
583
|
+
Pipedrive.configure do |config|
|
|
584
|
+
# Configure API key authorization: api_key
|
|
585
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
586
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
587
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
588
|
+
end
|
|
589
|
+
|
|
590
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
591
|
+
id = 56 # Integer | ID of the product
|
|
592
|
+
|
|
593
|
+
begin
|
|
594
|
+
#List permitted users
|
|
595
|
+
result = api_instance.products_id_permitted_users_get(id)
|
|
596
|
+
p result
|
|
597
|
+
rescue Pipedrive::ApiError => e
|
|
598
|
+
puts "Exception when calling ProductsApi->products_id_permitted_users_get: #{e}"
|
|
599
|
+
end
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
### Parameters
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
Name | Type | Description | Notes
|
|
606
|
+
------------- | ------------- | ------------- | -------------
|
|
607
|
+
**id** | **Integer**| ID of the product |
|
|
608
|
+
|
|
609
|
+
### Return type
|
|
610
|
+
|
|
611
|
+
[**UserIDs**](UserIDs.md)
|
|
612
|
+
|
|
613
|
+
### Authorization
|
|
614
|
+
|
|
615
|
+
[api_key](../README.md#api_key)
|
|
616
|
+
|
|
617
|
+
### HTTP request headers
|
|
618
|
+
|
|
619
|
+
- **Content-Type**: Not defined
|
|
620
|
+
- **Accept**: application/json
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
## products_id_put
|
|
624
|
+
|
|
625
|
+
> Product products_id_put(id, opts)
|
|
626
|
+
|
|
627
|
+
Update a product
|
|
628
|
+
|
|
629
|
+
Updates product data.
|
|
630
|
+
|
|
631
|
+
### Example
|
|
632
|
+
|
|
633
|
+
```ruby
|
|
634
|
+
# load the gem
|
|
635
|
+
require 'pipedrive-openapi-client'
|
|
636
|
+
# setup authorization
|
|
637
|
+
Pipedrive.configure do |config|
|
|
638
|
+
# Configure API key authorization: api_key
|
|
639
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
640
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
641
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
642
|
+
|
|
643
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
644
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
645
|
+
end
|
|
646
|
+
|
|
647
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
648
|
+
id = 56 # Integer | ID of the product
|
|
649
|
+
opts = {
|
|
650
|
+
product: Pipedrive::Product.new # Product |
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
begin
|
|
654
|
+
#Update a product
|
|
655
|
+
result = api_instance.products_id_put(id, opts)
|
|
656
|
+
p result
|
|
657
|
+
rescue Pipedrive::ApiError => e
|
|
658
|
+
puts "Exception when calling ProductsApi->products_id_put: #{e}"
|
|
659
|
+
end
|
|
660
|
+
```
|
|
661
|
+
|
|
662
|
+
### Parameters
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
Name | Type | Description | Notes
|
|
666
|
+
------------- | ------------- | ------------- | -------------
|
|
667
|
+
**id** | **Integer**| ID of the product |
|
|
668
|
+
**product** | [**Product**](Product.md)| | [optional]
|
|
669
|
+
|
|
670
|
+
### Return type
|
|
671
|
+
|
|
672
|
+
[**Product**](Product.md)
|
|
673
|
+
|
|
674
|
+
### Authorization
|
|
675
|
+
|
|
676
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
677
|
+
|
|
678
|
+
### HTTP request headers
|
|
679
|
+
|
|
680
|
+
- **Content-Type**: application/json
|
|
681
|
+
- **Accept**: application/json
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
## products_post
|
|
685
|
+
|
|
686
|
+
> products_post(opts)
|
|
687
|
+
|
|
688
|
+
Add a product
|
|
689
|
+
|
|
690
|
+
Adds a new product to the products inventory. For more information on how to add a product, see <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
691
|
+
|
|
692
|
+
### Example
|
|
693
|
+
|
|
694
|
+
```ruby
|
|
695
|
+
# load the gem
|
|
696
|
+
require 'pipedrive-openapi-client'
|
|
697
|
+
# setup authorization
|
|
698
|
+
Pipedrive.configure do |config|
|
|
699
|
+
# Configure API key authorization: api_key
|
|
700
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
701
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
702
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
703
|
+
|
|
704
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
705
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
709
|
+
opts = {
|
|
710
|
+
unknown_base_type: Pipedrive::UNKNOWN_BASE_TYPE.new # UNKNOWN_BASE_TYPE |
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
begin
|
|
714
|
+
#Add a product
|
|
715
|
+
api_instance.products_post(opts)
|
|
716
|
+
rescue Pipedrive::ApiError => e
|
|
717
|
+
puts "Exception when calling ProductsApi->products_post: #{e}"
|
|
718
|
+
end
|
|
719
|
+
```
|
|
720
|
+
|
|
721
|
+
### Parameters
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
Name | Type | Description | Notes
|
|
725
|
+
------------- | ------------- | ------------- | -------------
|
|
726
|
+
**unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)| | [optional]
|
|
727
|
+
|
|
728
|
+
### Return type
|
|
729
|
+
|
|
730
|
+
nil (empty response body)
|
|
731
|
+
|
|
732
|
+
### Authorization
|
|
733
|
+
|
|
734
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
735
|
+
|
|
736
|
+
### HTTP request headers
|
|
737
|
+
|
|
738
|
+
- **Content-Type**: application/json
|
|
739
|
+
- **Accept**: Not defined
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
## products_search_get
|
|
743
|
+
|
|
744
|
+
> BaseResponse products_search_get(term, opts)
|
|
745
|
+
|
|
746
|
+
Search products
|
|
747
|
+
|
|
748
|
+
Searches all Products by name, code 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.
|
|
749
|
+
|
|
750
|
+
### Example
|
|
751
|
+
|
|
752
|
+
```ruby
|
|
753
|
+
# load the gem
|
|
754
|
+
require 'pipedrive-openapi-client'
|
|
755
|
+
# setup authorization
|
|
756
|
+
Pipedrive.configure do |config|
|
|
757
|
+
# Configure API key authorization: api_key
|
|
758
|
+
config.api_key['api_token'] = 'YOUR API KEY'
|
|
759
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
760
|
+
#config.api_key_prefix['api_token'] = 'Bearer'
|
|
761
|
+
|
|
762
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
763
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
764
|
+
end
|
|
765
|
+
|
|
766
|
+
api_instance = Pipedrive::ProductsApi.new
|
|
767
|
+
term = 'term_example' # String | The search term to look for. Minimum 2 characters (or 1 if using exact_match).
|
|
768
|
+
opts = {
|
|
769
|
+
fields: 'fields_example', # String | A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
770
|
+
exact_match: true, # Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
771
|
+
include_fields: 'include_fields_example', # String | Supports including optional fields in the results which are not provided by default.
|
|
772
|
+
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.
|
|
773
|
+
limit: 56 # Integer | Items shown per page
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
begin
|
|
777
|
+
#Search products
|
|
778
|
+
result = api_instance.products_search_get(term, opts)
|
|
779
|
+
p result
|
|
780
|
+
rescue Pipedrive::ApiError => e
|
|
781
|
+
puts "Exception when calling ProductsApi->products_search_get: #{e}"
|
|
782
|
+
end
|
|
783
|
+
```
|
|
784
|
+
|
|
785
|
+
### Parameters
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
Name | Type | Description | Notes
|
|
789
|
+
------------- | ------------- | ------------- | -------------
|
|
790
|
+
**term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using exact_match). |
|
|
791
|
+
**fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. | [optional]
|
|
792
|
+
**exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional]
|
|
793
|
+
**include_fields** | **String**| Supports including optional fields in the results which are not provided by default. | [optional]
|
|
794
|
+
**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]
|
|
795
|
+
**limit** | **Integer**| Items shown per page | [optional]
|
|
796
|
+
|
|
797
|
+
### Return type
|
|
798
|
+
|
|
799
|
+
[**BaseResponse**](BaseResponse.md)
|
|
800
|
+
|
|
801
|
+
### Authorization
|
|
802
|
+
|
|
803
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
|
804
|
+
|
|
805
|
+
### HTTP request headers
|
|
806
|
+
|
|
807
|
+
- **Content-Type**: Not defined
|
|
808
|
+
- **Accept**: application/json
|
|
809
|
+
|