apimatic-apollo-sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +28 -0
- data/README.md +179 -0
- data/bin/console +15 -0
- data/lib/apollo_rest_api/api_helper.rb +10 -0
- data/lib/apollo_rest_api/apis/accounts_api.rb +400 -0
- data/lib/apollo_rest_api/apis/analytics_api.rb +65 -0
- data/lib/apollo_rest_api/apis/api.rb +45 -0
- data/lib/apollo_rest_api/apis/base_api.rb +67 -0
- data/lib/apollo_rest_api/apis/calls_api.rb +354 -0
- data/lib/apollo_rest_api/apis/contacts_api.rb +478 -0
- data/lib/apollo_rest_api/apis/conversations_api.rb +157 -0
- data/lib/apollo_rest_api/apis/deals_api.rb +253 -0
- data/lib/apollo_rest_api/apis/emailer_messages_api.rb +160 -0
- data/lib/apollo_rest_api/apis/enrichment_api.rb +447 -0
- data/lib/apollo_rest_api/apis/miscellaneous_api.rb +610 -0
- data/lib/apollo_rest_api/apis/search_api.rb +675 -0
- data/lib/apollo_rest_api/apis/sequences_api.rb +774 -0
- data/lib/apollo_rest_api/apis/tasks_api.rb +397 -0
- data/lib/apollo_rest_api/client.rb +147 -0
- data/lib/apollo_rest_api/configuration.rb +170 -0
- data/lib/apollo_rest_api/exceptions/account_stages429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_bulk_create422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_bulk_create429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_bulk_create500_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_bulk_update422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_bulk_update429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_search403_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/accounts_update_owners429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/api_exception.rb +21 -0
- data/lib/apollo_rest_api/exceptions/contact_stages429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_bulk_create422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_bulk_create429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_bulk_create500_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_bulk_update422_error_exception.rb +51 -0
- data/lib/apollo_rest_api/exceptions/contacts_bulk_update429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_opportunities429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_search403_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_update_owners422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_update_owners429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_update_stages422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/contacts_update_stages429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/conversations404_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/conversations422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/conversations_export404_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/conversations_export422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/conversations_search403_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/email_accounts429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_abort422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_abort429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_add_contact_ids429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_approve422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_approve429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_archive429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_remove_or_stop_contact_ids429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_campaigns_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages_email_send_status404_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages_email_send_status422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages_email_send_status429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages_search422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_messages_send_now429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/emailer_schedules429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/fields429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/labels404_error_exception.rb +51 -0
- data/lib/apollo_rest_api/exceptions/labels422_error_exception.rb +53 -0
- data/lib/apollo_rest_api/exceptions/labels429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/labels_add_entity_ids_to_label_names422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/labels_add_entity_ids_to_label_names429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/labels_remove_entity_ids_from_label_names422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/labels_remove_entity_ids_from_label_names429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/mixed_companies_search403_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/mixed_companies_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/mixed_people_api_search422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/mixed_people_api_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/need_master_api_key_exception.rb +51 -0
- data/lib/apollo_rest_api/exceptions/notes400_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/opportunities404_error_exception.rb +51 -0
- data/lib/apollo_rest_api/exceptions/opportunities422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/opportunities429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/opportunities_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/opportunity_stages429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/organizations_bulk_enrich400_error_exception.rb +58 -0
- data/lib/apollo_rest_api/exceptions/organizations_bulk_enrich429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/organizations_enrich422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/organizations_enrich429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/organizations_job_postings422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/organizations_job_postings429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/people_bulk_match429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/people_match429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/reports_sync_report400_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/reports_sync_report429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/sequences404_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/sequences422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/sequences429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks401_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_bulk_create422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_bulk_create429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_complete422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_complete429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_skip422_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/tasks_skip429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/typed_custom_fields429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/users_search429_error_exception.rb +46 -0
- data/lib/apollo_rest_api/exceptions/webhook_result404_error_exception.rb +55 -0
- data/lib/apollo_rest_api/http/api_response.rb +19 -0
- data/lib/apollo_rest_api/http/auth/api_key.rb +52 -0
- data/lib/apollo_rest_api/http/auth/bearer_auth.rb +53 -0
- data/lib/apollo_rest_api/http/http_call_back.rb +10 -0
- data/lib/apollo_rest_api/http/http_method_enum.rb +10 -0
- data/lib/apollo_rest_api/http/http_request.rb +10 -0
- data/lib/apollo_rest_api/http/http_response.rb +10 -0
- data/lib/apollo_rest_api/http/proxy_settings.rb +22 -0
- data/lib/apollo_rest_api/logging/configuration/api_logging_configuration.rb +186 -0
- data/lib/apollo_rest_api/logging/sdk_logger.rb +17 -0
- data/lib/apollo_rest_api/models/account.rb +551 -0
- data/lib/apollo_rest_api/models/account1.rb +420 -0
- data/lib/apollo_rest_api/models/account10.rb +595 -0
- data/lib/apollo_rest_api/models/account12.rb +424 -0
- data/lib/apollo_rest_api/models/account14.rb +247 -0
- data/lib/apollo_rest_api/models/account2.rb +420 -0
- data/lib/apollo_rest_api/models/account22.rb +85 -0
- data/lib/apollo_rest_api/models/account3.rb +420 -0
- data/lib/apollo_rest_api/models/account4.rb +474 -0
- data/lib/apollo_rest_api/models/account5.rb +238 -0
- data/lib/apollo_rest_api/models/account6.rb +86 -0
- data/lib/apollo_rest_api/models/account7.rb +95 -0
- data/lib/apollo_rest_api/models/account8.rb +434 -0
- data/lib/apollo_rest_api/models/account9.rb +540 -0
- data/lib/apollo_rest_api/models/account_attribute.rb +116 -0
- data/lib/apollo_rest_api/models/account_rule_config_status.rb +138 -0
- data/lib/apollo_rest_api/models/account_stage.rb +151 -0
- data/lib/apollo_rest_api/models/account_stages_response.rb +85 -0
- data/lib/apollo_rest_api/models/accounts_bulk_create_request.rb +108 -0
- data/lib/apollo_rest_api/models/accounts_bulk_create_response.rb +105 -0
- data/lib/apollo_rest_api/models/accounts_bulk_update_request.rb +139 -0
- data/lib/apollo_rest_api/models/accounts_bulk_update_response.rb +84 -0
- data/lib/apollo_rest_api/models/accounts_request.rb +183 -0
- data/lib/apollo_rest_api/models/accounts_request1.rb +183 -0
- data/lib/apollo_rest_api/models/accounts_response.rb +75 -0
- data/lib/apollo_rest_api/models/accounts_response1.rb +85 -0
- data/lib/apollo_rest_api/models/accounts_search_request.rb +167 -0
- data/lib/apollo_rest_api/models/accounts_search_response.rb +168 -0
- data/lib/apollo_rest_api/models/accounts_update_owners_response.rb +84 -0
- data/lib/apollo_rest_api/models/active.rb +26 -0
- data/lib/apollo_rest_api/models/assistant_setting.rb +397 -0
- data/lib/apollo_rest_api/models/audio_recording.rb +74 -0
- data/lib/apollo_rest_api/models/base_model.rb +110 -0
- data/lib/apollo_rest_api/models/bounced.rb +26 -0
- data/lib/apollo_rest_api/models/breadcrumb.rb +107 -0
- data/lib/apollo_rest_api/models/check_apollo_pricing_plan.rb +75 -0
- data/lib/apollo_rest_api/models/check_the_account_id.rb +75 -0
- data/lib/apollo_rest_api/models/check_the_contact_stage_id.rb +75 -0
- data/lib/apollo_rest_api/models/contact.rb +809 -0
- data/lib/apollo_rest_api/models/contact1.rb +921 -0
- data/lib/apollo_rest_api/models/contact10.rb +465 -0
- data/lib/apollo_rest_api/models/contact11.rb +250 -0
- data/lib/apollo_rest_api/models/contact14.rb +248 -0
- data/lib/apollo_rest_api/models/contact15.rb +166 -0
- data/lib/apollo_rest_api/models/contact2.rb +884 -0
- data/lib/apollo_rest_api/models/contact3.rb +239 -0
- data/lib/apollo_rest_api/models/contact4.rb +105 -0
- data/lib/apollo_rest_api/models/contact5.rb +893 -0
- data/lib/apollo_rest_api/models/contact6.rb +839 -0
- data/lib/apollo_rest_api/models/contact7.rb +95 -0
- data/lib/apollo_rest_api/models/contact8.rb +375 -0
- data/lib/apollo_rest_api/models/contact9.rb +198 -0
- data/lib/apollo_rest_api/models/contact_attribute.rb +179 -0
- data/lib/apollo_rest_api/models/contact_campaign_status.rb +336 -0
- data/lib/apollo_rest_api/models/contact_campaign_status2.rb +163 -0
- data/lib/apollo_rest_api/models/contact_email.rb +167 -0
- data/lib/apollo_rest_api/models/contact_email1.rb +85 -0
- data/lib/apollo_rest_api/models/contact_email2.rb +148 -0
- data/lib/apollo_rest_api/models/contact_statuses.rb +132 -0
- data/lib/apollo_rest_api/models/contacts_bulk_create_request.rb +121 -0
- data/lib/apollo_rest_api/models/contacts_bulk_create_response.rb +106 -0
- data/lib/apollo_rest_api/models/contacts_bulk_update_request.rb +224 -0
- data/lib/apollo_rest_api/models/contacts_bulk_update_response.rb +94 -0
- data/lib/apollo_rest_api/models/contacts_bulk_update_response1.rb +87 -0
- data/lib/apollo_rest_api/models/contacts_opportunities_response.rb +85 -0
- data/lib/apollo_rest_api/models/contacts_request.rb +269 -0
- data/lib/apollo_rest_api/models/contacts_request1.rb +253 -0
- data/lib/apollo_rest_api/models/contacts_response.rb +94 -0
- data/lib/apollo_rest_api/models/contacts_response1.rb +94 -0
- data/lib/apollo_rest_api/models/contacts_response2.rb +75 -0
- data/lib/apollo_rest_api/models/contacts_search_request.rb +166 -0
- data/lib/apollo_rest_api/models/contacts_search_response.rb +168 -0
- data/lib/apollo_rest_api/models/contacts_update_owners_response.rb +84 -0
- data/lib/apollo_rest_api/models/contacts_update_stages_response.rb +84 -0
- data/lib/apollo_rest_api/models/conversation.rb +284 -0
- data/lib/apollo_rest_api/models/conversation_type.rb +36 -0
- data/lib/apollo_rest_api/models/conversation_type2.rb +36 -0
- data/lib/apollo_rest_api/models/conversations_export_request.rb +94 -0
- data/lib/apollo_rest_api/models/conversations_export_response.rb +86 -0
- data/lib/apollo_rest_api/models/conversations_export_response1.rb +76 -0
- data/lib/apollo_rest_api/models/conversations_response.rb +333 -0
- data/lib/apollo_rest_api/models/conversations_search_request.rb +207 -0
- data/lib/apollo_rest_api/models/conversations_search_response.rb +130 -0
- data/lib/apollo_rest_api/models/counts.rb +115 -0
- data/lib/apollo_rest_api/models/created_account.rb +174 -0
- data/lib/apollo_rest_api/models/created_contact.rb +195 -0
- data/lib/apollo_rest_api/models/creation_type.rb +41 -0
- data/lib/apollo_rest_api/models/currency.rb +95 -0
- data/lib/apollo_rest_api/models/current_technology.rb +95 -0
- data/lib/apollo_rest_api/models/date_range.rb +84 -0
- data/lib/apollo_rest_api/models/date_range1.rb +87 -0
- data/lib/apollo_rest_api/models/deal.rb +107 -0
- data/lib/apollo_rest_api/models/deliverability_score.rb +460 -0
- data/lib/apollo_rest_api/models/departmental_head_count.rb +260 -0
- data/lib/apollo_rest_api/models/detail.rb +173 -0
- data/lib/apollo_rest_api/models/detail1.rb +109 -0
- data/lib/apollo_rest_api/models/email_account.rb +616 -0
- data/lib/apollo_rest_api/models/email_accounts_response.rb +85 -0
- data/lib/apollo_rest_api/models/emailer_campaign.rb +722 -0
- data/lib/apollo_rest_api/models/emailer_campaign1.rb +359 -0
- data/lib/apollo_rest_api/models/emailer_campaign2.rb +158 -0
- data/lib/apollo_rest_api/models/emailer_campaign3.rb +95 -0
- data/lib/apollo_rest_api/models/emailer_campaign4.rb +96 -0
- data/lib/apollo_rest_api/models/emailer_campaign6.rb +105 -0
- data/lib/apollo_rest_api/models/emailer_campaigns_abort_response.rb +96 -0
- data/lib/apollo_rest_api/models/emailer_campaigns_add_contact_ids_response.rb +164 -0
- data/lib/apollo_rest_api/models/emailer_campaigns_approve_response.rb +96 -0
- data/lib/apollo_rest_api/models/emailer_campaigns_archive_response.rb +77 -0
- data/lib/apollo_rest_api/models/emailer_campaigns_remove_or_stop_contact_ids_response.rb +77 -0
- data/lib/apollo_rest_api/models/emailer_campaigns_search_response.rb +125 -0
- data/lib/apollo_rest_api/models/emailer_message.rb +676 -0
- data/lib/apollo_rest_api/models/emailer_message1.rb +410 -0
- data/lib/apollo_rest_api/models/emailer_messages_email_send_status_request.rb +74 -0
- data/lib/apollo_rest_api/models/emailer_messages_email_send_status_response.rb +166 -0
- data/lib/apollo_rest_api/models/emailer_messages_request.rb +197 -0
- data/lib/apollo_rest_api/models/emailer_messages_response.rb +77 -0
- data/lib/apollo_rest_api/models/emailer_messages_send_now_request.rb +76 -0
- data/lib/apollo_rest_api/models/emailer_messages_send_now_response.rb +77 -0
- data/lib/apollo_rest_api/models/emailer_schedule.rb +154 -0
- data/lib/apollo_rest_api/models/emailer_schedules_response.rb +85 -0
- data/lib/apollo_rest_api/models/emailer_step.rb +206 -0
- data/lib/apollo_rest_api/models/emailer_step1.rb +189 -0
- data/lib/apollo_rest_api/models/emailer_step2.rb +126 -0
- data/lib/apollo_rest_api/models/emailer_step3.rb +148 -0
- data/lib/apollo_rest_api/models/emailer_step4.rb +85 -0
- data/lib/apollo_rest_api/models/emailer_step5.rb +128 -0
- data/lib/apollo_rest_api/models/emailer_template.rb +100 -0
- data/lib/apollo_rest_api/models/emailer_template1.rb +95 -0
- data/lib/apollo_rest_api/models/emailer_template2.rb +85 -0
- data/lib/apollo_rest_api/models/emailer_touch.rb +254 -0
- data/lib/apollo_rest_api/models/emailer_touch1.rb +128 -0
- data/lib/apollo_rest_api/models/emailer_touch2.rb +117 -0
- data/lib/apollo_rest_api/models/emailer_touch3.rb +139 -0
- data/lib/apollo_rest_api/models/emailer_touch4.rb +85 -0
- data/lib/apollo_rest_api/models/employment_history.rb +238 -0
- data/lib/apollo_rest_api/models/entity_progress_job.rb +153 -0
- data/lib/apollo_rest_api/models/entity_progress_job1.rb +135 -0
- data/lib/apollo_rest_api/models/entity_progress_job2.rb +141 -0
- data/lib/apollo_rest_api/models/error_details.rb +95 -0
- data/lib/apollo_rest_api/models/existing_account.rb +152 -0
- data/lib/apollo_rest_api/models/existing_contact.rb +171 -0
- data/lib/apollo_rest_api/models/faceting.rb +523 -0
- data/lib/apollo_rest_api/models/failure_reason.rb +44 -0
- data/lib/apollo_rest_api/models/field.rb +181 -0
- data/lib/apollo_rest_api/models/fields_request.rb +105 -0
- data/lib/apollo_rest_api/models/fields_response.rb +84 -0
- data/lib/apollo_rest_api/models/fields_response1.rb +85 -0
- data/lib/apollo_rest_api/models/filters.rb +165 -0
- data/lib/apollo_rest_api/models/finished.rb +26 -0
- data/lib/apollo_rest_api/models/funding_event.rb +134 -0
- data/lib/apollo_rest_api/models/generation_option.rb +107 -0
- data/lib/apollo_rest_api/models/generation_tone.rb +86 -0
- data/lib/apollo_rest_api/models/group_by.rb +84 -0
- data/lib/apollo_rest_api/models/industry_tag_hash.rb +83 -0
- data/lib/apollo_rest_api/models/label.rb +135 -0
- data/lib/apollo_rest_api/models/label2.rb +147 -0
- data/lib/apollo_rest_api/models/labels_add_entity_ids_to_label_names_request.rb +113 -0
- data/lib/apollo_rest_api/models/labels_add_entity_ids_to_label_names_response.rb +107 -0
- data/lib/apollo_rest_api/models/labels_remove_entity_ids_from_label_names_request.rb +113 -0
- data/lib/apollo_rest_api/models/labels_remove_entity_ids_from_label_names_response.rb +107 -0
- data/lib/apollo_rest_api/models/labels_request.rb +97 -0
- data/lib/apollo_rest_api/models/labels_request1.rb +87 -0
- data/lib/apollo_rest_api/models/labels_response.rb +201 -0
- data/lib/apollo_rest_api/models/labels_response1.rb +75 -0
- data/lib/apollo_rest_api/models/match.rb +393 -0
- data/lib/apollo_rest_api/models/meta.rb +76 -0
- data/lib/apollo_rest_api/models/metric.rb +117 -0
- data/lib/apollo_rest_api/models/metric1.rb +100 -0
- data/lib/apollo_rest_api/models/mixed_companies_search_response.rb +199 -0
- data/lib/apollo_rest_api/models/mixed_people_api_search_response.rb +95 -0
- data/lib/apollo_rest_api/models/modality.rb +37 -0
- data/lib/apollo_rest_api/models/modality1.rb +37 -0
- data/lib/apollo_rest_api/models/modality3.rb +40 -0
- data/lib/apollo_rest_api/models/note.rb +260 -0
- data/lib/apollo_rest_api/models/notes_response.rb +84 -0
- data/lib/apollo_rest_api/models/opportunities_request.rb +175 -0
- data/lib/apollo_rest_api/models/opportunities_request1.rb +164 -0
- data/lib/apollo_rest_api/models/opportunities_response.rb +76 -0
- data/lib/apollo_rest_api/models/opportunities_response1.rb +76 -0
- data/lib/apollo_rest_api/models/opportunities_response2.rb +76 -0
- data/lib/apollo_rest_api/models/opportunities_search_response.rb +170 -0
- data/lib/apollo_rest_api/models/opportunity.rb +602 -0
- data/lib/apollo_rest_api/models/opportunity1.rb +574 -0
- data/lib/apollo_rest_api/models/opportunity11.rb +217 -0
- data/lib/apollo_rest_api/models/opportunity2.rb +583 -0
- data/lib/apollo_rest_api/models/opportunity3.rb +594 -0
- data/lib/apollo_rest_api/models/opportunity4.rb +574 -0
- data/lib/apollo_rest_api/models/opportunity5.rb +591 -0
- data/lib/apollo_rest_api/models/opportunity_contact_role.rb +95 -0
- data/lib/apollo_rest_api/models/opportunity_contact_role1.rb +135 -0
- data/lib/apollo_rest_api/models/opportunity_stage.rb +210 -0
- data/lib/apollo_rest_api/models/opportunity_stages_response.rb +85 -0
- data/lib/apollo_rest_api/models/organization.rb +659 -0
- data/lib/apollo_rest_api/models/organization1.rb +422 -0
- data/lib/apollo_rest_api/models/organization2.rb +752 -0
- data/lib/apollo_rest_api/models/organization3.rb +600 -0
- data/lib/apollo_rest_api/models/organization4.rb +162 -0
- data/lib/apollo_rest_api/models/organization5.rb +336 -0
- data/lib/apollo_rest_api/models/organization6.rb +264 -0
- data/lib/apollo_rest_api/models/organization7.rb +88 -0
- data/lib/apollo_rest_api/models/organization_job_posting.rb +144 -0
- data/lib/apollo_rest_api/models/organizations_bulk_enrich_request.rb +89 -0
- data/lib/apollo_rest_api/models/organizations_bulk_enrich_response.rb +194 -0
- data/lib/apollo_rest_api/models/organizations_enrich_response.rb +76 -0
- data/lib/apollo_rest_api/models/organizations_job_postings_response.rb +88 -0
- data/lib/apollo_rest_api/models/pagination.rb +105 -0
- data/lib/apollo_rest_api/models/pagination6.rb +105 -0
- data/lib/apollo_rest_api/models/params.rb +116 -0
- data/lib/apollo_rest_api/models/participants.rb +85 -0
- data/lib/apollo_rest_api/models/paused.rb +26 -0
- data/lib/apollo_rest_api/models/people_bulk_match_request.rb +83 -0
- data/lib/apollo_rest_api/models/people_bulk_match_response.rb +180 -0
- data/lib/apollo_rest_api/models/people_match_response.rb +87 -0
- data/lib/apollo_rest_api/models/person.rb +393 -0
- data/lib/apollo_rest_api/models/person1.rb +196 -0
- data/lib/apollo_rest_api/models/phone_call.rb +131 -0
- data/lib/apollo_rest_api/models/phone_number.rb +149 -0
- data/lib/apollo_rest_api/models/phone_number1.rb +149 -0
- data/lib/apollo_rest_api/models/phone_number3.rb +97 -0
- data/lib/apollo_rest_api/models/phone_number4.rb +85 -0
- data/lib/apollo_rest_api/models/phone_number5.rb +127 -0
- data/lib/apollo_rest_api/models/pivot_group_by.rb +85 -0
- data/lib/apollo_rest_api/models/primary_phone.rb +96 -0
- data/lib/apollo_rest_api/models/priority.rb +40 -0
- data/lib/apollo_rest_api/models/recipient.rb +100 -0
- data/lib/apollo_rest_api/models/recipient1.rb +116 -0
- data/lib/apollo_rest_api/models/reports_sync_report_request.rb +253 -0
- data/lib/apollo_rest_api/models/reports_sync_report_response.rb +102 -0
- data/lib/apollo_rest_api/models/request_type.rb +40 -0
- data/lib/apollo_rest_api/models/response.rb +118 -0
- data/lib/apollo_rest_api/models/role.rb +112 -0
- data/lib/apollo_rest_api/models/send_from.rb +116 -0
- data/lib/apollo_rest_api/models/sequences_request.rb +391 -0
- data/lib/apollo_rest_api/models/sequences_request1.rb +206 -0
- data/lib/apollo_rest_api/models/sequences_response.rb +148 -0
- data/lib/apollo_rest_api/models/sequences_response1.rb +203 -0
- data/lib/apollo_rest_api/models/sharing_access.rb +148 -0
- data/lib/apollo_rest_api/models/sharing_permission.rb +154 -0
- data/lib/apollo_rest_api/models/skipped_contact_ids.rb +77 -0
- data/lib/apollo_rest_api/models/smart_datetime_range.rb +86 -0
- data/lib/apollo_rest_api/models/sort.rb +85 -0
- data/lib/apollo_rest_api/models/sort_by_field.rb +43 -0
- data/lib/apollo_rest_api/models/sort_by_field1.rb +36 -0
- data/lib/apollo_rest_api/models/sort_direction.rb +36 -0
- data/lib/apollo_rest_api/models/source.rb +40 -0
- data/lib/apollo_rest_api/models/status.rb +44 -0
- data/lib/apollo_rest_api/models/status2.rb +36 -0
- data/lib/apollo_rest_api/models/status3.rb +40 -0
- data/lib/apollo_rest_api/models/status4.rb +37 -0
- data/lib/apollo_rest_api/models/step.rb +127 -0
- data/lib/apollo_rest_api/models/task.rb +394 -0
- data/lib/apollo_rest_api/models/task2.rb +536 -0
- data/lib/apollo_rest_api/models/task4.rb +524 -0
- data/lib/apollo_rest_api/models/task5.rb +104 -0
- data/lib/apollo_rest_api/models/task_type.rb +95 -0
- data/lib/apollo_rest_api/models/tasks_bulk_create_request.rb +173 -0
- data/lib/apollo_rest_api/models/tasks_bulk_create_response.rb +94 -0
- data/lib/apollo_rest_api/models/tasks_complete_request.rb +75 -0
- data/lib/apollo_rest_api/models/tasks_complete_response.rb +86 -0
- data/lib/apollo_rest_api/models/tasks_request.rb +183 -0
- data/lib/apollo_rest_api/models/tasks_request1.rb +227 -0
- data/lib/apollo_rest_api/models/tasks_response.rb +74 -0
- data/lib/apollo_rest_api/models/tasks_response1.rb +74 -0
- data/lib/apollo_rest_api/models/tasks_search_response.rb +136 -0
- data/lib/apollo_rest_api/models/tasks_skip_request.rb +88 -0
- data/lib/apollo_rest_api/models/tasks_skip_response.rb +74 -0
- data/lib/apollo_rest_api/models/team.rb +87 -0
- data/lib/apollo_rest_api/models/total_facet.rb +95 -0
- data/lib/apollo_rest_api/models/true_warmup_thresholds.rb +106 -0
- data/lib/apollo_rest_api/models/type.rb +44 -0
- data/lib/apollo_rest_api/models/type1.rb +36 -0
- data/lib/apollo_rest_api/models/type2.rb +52 -0
- data/lib/apollo_rest_api/models/typed_custom_fields.rb +111 -0
- data/lib/apollo_rest_api/models/typed_custom_fields6.rb +106 -0
- data/lib/apollo_rest_api/models/typed_custom_fields7.rb +243 -0
- data/lib/apollo_rest_api/models/typed_custom_fields_response.rb +85 -0
- data/lib/apollo_rest_api/models/unique_completed.rb +26 -0
- data/lib/apollo_rest_api/models/unique_scheduled.rb +26 -0
- data/lib/apollo_rest_api/models/unique_skipped.rb +26 -0
- data/lib/apollo_rest_api/models/user.rb +1294 -0
- data/lib/apollo_rest_api/models/users_api_profile_response.rb +309 -0
- data/lib/apollo_rest_api/models/users_search_response.rb +106 -0
- data/lib/apollo_rest_api/models/video_recording.rb +95 -0
- data/lib/apollo_rest_api/models/wait_mode.rb +40 -0
- data/lib/apollo_rest_api/models/webhook_result_response.rb +140 -0
- data/lib/apollo_rest_api/models/webhook_status.rb +40 -0
- data/lib/apollo_rest_api/utilities/date_time_helper.rb +11 -0
- data/lib/apollo_rest_api/utilities/file_wrapper.rb +28 -0
- data/lib/apollo_rest_api/utilities/union_type_lookup.rb +128 -0
- data/lib/apollo_rest_api.rb +503 -0
- metadata +499 -0
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# apollo_rest_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module ApolloRestApi
|
|
7
|
+
# AnalyticsApi
|
|
8
|
+
class AnalyticsApi < BaseApi
|
|
9
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
10
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
11
|
+
# Use the Query Analytics Report endpoint to programmatically query <a
|
|
12
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/33574373762317-Analyti
|
|
13
|
+
# cs-Overview" target="_blank">Apollo analytics</a> and retrieve aggregated
|
|
14
|
+
# sales activity data for your team.<br><br>This endpoint accepts a flexible
|
|
15
|
+
# payload specifying which metrics to measure, how to group and filter
|
|
16
|
+
# results, and which date range to apply — returning the same data that
|
|
17
|
+
# powers Apollo's built-in Analytics dashboards. <br><br>Three query modes
|
|
18
|
+
# are supported: flat totals (no <code>group_by</code>), grouped by one
|
|
19
|
+
# dimension such as user or sequence, and pivot cross-tab (one
|
|
20
|
+
# <code>group_by</code> dimension as rows + one <code>pivot_group_by</code>
|
|
21
|
+
# dimension as columns). Each array supports a maximum of one entry.<br><br>
|
|
22
|
+
# <strong>Authentication:</strong> Requires an Apollo API key with access to
|
|
23
|
+
# the <code>api/v1/reports/sync_report</code> API. When creating or editing
|
|
24
|
+
# an API key in Apollo Settings, open the <strong>APIs</strong> tab and
|
|
25
|
+
# select <code>api/v1/reports/sync_report</code> from the list. Check out <a
|
|
26
|
+
# href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a>
|
|
27
|
+
# for detailed instructions.<br><br><strong>Tip:</strong> The easiest way to
|
|
28
|
+
# discover valid metric and group_by combinations is to build a report
|
|
29
|
+
# interactively at <a href="https://app.apollo.io/#/analytics/reports/new"
|
|
30
|
+
# target="_blank">Apollo Analytics → Start from scratch</a>, then replicate
|
|
31
|
+
# that configuration in your API request.
|
|
32
|
+
# @param [ReportsSyncReportRequest] body Required parameter: TODO: type
|
|
33
|
+
# description here
|
|
34
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
35
|
+
def sync_report(body)
|
|
36
|
+
@api_call
|
|
37
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
38
|
+
'/reports/sync_report',
|
|
39
|
+
Server::DEFAULT)
|
|
40
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
41
|
+
.body_param(new_parameter(body)
|
|
42
|
+
.is_required(true))
|
|
43
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
44
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
45
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
46
|
+
.response(new_response_handler
|
|
47
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
48
|
+
.deserialize_into(ReportsSyncReportResponse.method(:from_hash))
|
|
49
|
+
.is_api_response(true)
|
|
50
|
+
.local_error('400',
|
|
51
|
+
'400',
|
|
52
|
+
ReportsSyncReport400ErrorException)
|
|
53
|
+
.local_error('401',
|
|
54
|
+
'401',
|
|
55
|
+
APIException)
|
|
56
|
+
.local_error('422',
|
|
57
|
+
'422',
|
|
58
|
+
NeedMasterApiKeyException)
|
|
59
|
+
.local_error('429',
|
|
60
|
+
'429',
|
|
61
|
+
ReportsSyncReport429ErrorException))
|
|
62
|
+
.execute
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# apollo_rest_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module ApolloRestApi
|
|
7
|
+
# Api
|
|
8
|
+
class Api < BaseApi
|
|
9
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
10
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
11
|
+
# <a
|
|
12
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Mana
|
|
13
|
+
# ge-and-Deactivate-Users" target="_blank">Users</a> are the people who use
|
|
14
|
+
# your Apollo workspace.<br><br>Use the Get Current User Profile endpoint to
|
|
15
|
+
# retrieve the authenticated profile of the person who owns the API key
|
|
16
|
+
# being used.<br><br>By default, the endpoint returns the user's identity
|
|
17
|
+
# fields. Set the `include_credit_usage` query parameter to `true` to also
|
|
18
|
+
# return the user's and team's credit usage and remaining credit
|
|
19
|
+
# balances.<br><br>If you call this endpoint without valid access
|
|
20
|
+
# credentials, you receive a `401` response.
|
|
21
|
+
# @param [TrueClass | FalseClass] include_credit_usage Optional parameter:
|
|
22
|
+
# Set to `true` to include credit usage and remaining credit details (lead,
|
|
23
|
+
# direct dial, export, AI, and power-up credits) in the response. Accepts
|
|
24
|
+
# boolean (`true`/`false`) or string (`"true"`/`"false"`) values. Defaults
|
|
25
|
+
# to `false`. <br><br>Example: `true`
|
|
26
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
27
|
+
def get_current_user_profile(include_credit_usage: false)
|
|
28
|
+
@api_call
|
|
29
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
30
|
+
'/users/api_profile',
|
|
31
|
+
Server::DEFAULT)
|
|
32
|
+
.query_param(new_parameter(include_credit_usage, key: 'include_credit_usage'))
|
|
33
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
34
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
35
|
+
.response(new_response_handler
|
|
36
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
37
|
+
.deserialize_into(UsersApiProfileResponse.method(:from_hash))
|
|
38
|
+
.is_api_response(true)
|
|
39
|
+
.local_error('401',
|
|
40
|
+
'401',
|
|
41
|
+
APIException))
|
|
42
|
+
.execute
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# apollo_rest_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module ApolloRestApi
|
|
7
|
+
# BaseApi.
|
|
8
|
+
class BaseApi
|
|
9
|
+
include CoreLibrary
|
|
10
|
+
attr_accessor :config, :http_call_back
|
|
11
|
+
|
|
12
|
+
def self.user_agent
|
|
13
|
+
'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def self.user_agent_parameters
|
|
17
|
+
{
|
|
18
|
+
'{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
|
|
19
|
+
'{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
|
|
20
|
+
'{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
|
|
21
|
+
}
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
GLOBAL_ERRORS = {
|
|
25
|
+
'default' => ErrorCase.new
|
|
26
|
+
.error_message('HTTP response not OK.')
|
|
27
|
+
.exception_type(APIException)
|
|
28
|
+
}.freeze
|
|
29
|
+
|
|
30
|
+
# Initialization constructor.
|
|
31
|
+
# @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
|
|
32
|
+
def initialize(global_configuration)
|
|
33
|
+
@global_configuration = global_configuration
|
|
34
|
+
@config = @global_configuration.client_configuration
|
|
35
|
+
@http_call_back = @config.http_callback
|
|
36
|
+
@api_call = ApiCall.new(@global_configuration)
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Creates a new instance of the request builder.
|
|
40
|
+
# @param [String] http_method The HTTP method to use in the request.
|
|
41
|
+
# @param [String] path The endpoint path to use in the request.
|
|
42
|
+
# @param [String] server The server to extract the base uri for the request.
|
|
43
|
+
# @return [RequestBuilder] The instance of RequestBuilder.
|
|
44
|
+
def new_request_builder(http_method, path, server)
|
|
45
|
+
RequestBuilder.new
|
|
46
|
+
.http_method(http_method)
|
|
47
|
+
.path(path)
|
|
48
|
+
.server(server)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Creates a new instance of the response handler.
|
|
52
|
+
# @return [ResponseHandler] The instance of ResponseHandler.
|
|
53
|
+
def new_response_handler
|
|
54
|
+
ResponseHandler.new
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Creates a new instance of the parameter.
|
|
58
|
+
# @param [String|optional] key The key of the parameter.
|
|
59
|
+
# @param [Object] value The value of the parameter.
|
|
60
|
+
# @return [Parameter] The instance of Parameter.
|
|
61
|
+
def new_parameter(value, key: nil)
|
|
62
|
+
Parameter.new
|
|
63
|
+
.key(key)
|
|
64
|
+
.value(value)
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
@@ -0,0 +1,354 @@
|
|
|
1
|
+
# apollo_rest_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module ApolloRestApi
|
|
7
|
+
# CallsApi
|
|
8
|
+
class CallsApi < BaseApi
|
|
9
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
10
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
11
|
+
# Use the Search for Calls endpoint to find calls that your team has made or
|
|
12
|
+
# received using <a
|
|
13
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/4409140527757-Dialer-O
|
|
14
|
+
# verview" target="_blank">the dialer</a> on Apollo.<br><br>This endpoint
|
|
15
|
+
# requires a master API key. If you call the endpoint without a master key,
|
|
16
|
+
# you receive a `403` response. Check out <a
|
|
17
|
+
# href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
|
|
18
|
+
# learn how to create a master API key.
|
|
19
|
+
# @param [Date] date_range_max Optional parameter: Set the upper bound of
|
|
20
|
+
# the date range you want to search. <br><br>Use this parameter in
|
|
21
|
+
# combination with the `date_range[min]` parameter. This date should fall
|
|
22
|
+
# after the `date_range[min]` date. <br><br>The date should be formatted as
|
|
23
|
+
# `YYYY-MM-DD`. <br><br>Example: `2025-06-12`
|
|
24
|
+
# @param [Date] date_range_min Optional parameter: Set the lower bound of
|
|
25
|
+
# the date range you want to search. <br><br>Use this parameter in
|
|
26
|
+
# combination with the `date_range[max]` parameter. This date should fall
|
|
27
|
+
# before the `date_range[max]` date. <br><br>The date should be formatted as
|
|
28
|
+
# `YYYY-MM-DD`. <br><br>Example: `2025-04-01`
|
|
29
|
+
# @param [Integer] duration_max Optional parameter: Set the upper bound for
|
|
30
|
+
# the call duration you want to search. The duration should be seconds, not
|
|
31
|
+
# minutes or hours. <br><br>Use this parameter in combination with the
|
|
32
|
+
# `duration[min]` parameter. This number should be larger than
|
|
33
|
+
# `duration[min]`. <br><br>Example: `180`
|
|
34
|
+
# @param [Integer] duration_min Optional parameter: Set the lower bound for
|
|
35
|
+
# the call duration you want to search. The duration should be seconds, not
|
|
36
|
+
# minutes or hours. <br><br>Use this parameter in combination with the
|
|
37
|
+
# `duration[max]` parameter. This number should be smallerr than
|
|
38
|
+
# `duration[min]`. <br><br>Example: `30`
|
|
39
|
+
# @param [String] inbound Optional parameter: Search for calls based on
|
|
40
|
+
# whether they were `incoming` (the prospect called your team) or `outgoing`
|
|
41
|
+
# (your team called the prospect).
|
|
42
|
+
# @param [Array[String]] user_ids Optional parameter: Find calls that
|
|
43
|
+
# included specific users in your team's Apollo account. You can add
|
|
44
|
+
# multiple users. <br><br>Use the <a
|
|
45
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-users"
|
|
46
|
+
# target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
|
|
47
|
+
# of the users within your Apollo account. <br><br>Example:
|
|
48
|
+
# `67e33d527de088000daa60c4`
|
|
49
|
+
# @param [Array[String]] contact_label_ids Optional parameter: Find calls
|
|
50
|
+
# that included specific contacts. You can add multiple contacts. <br><br>In
|
|
51
|
+
# Apollo terminology, a contact is a person that your team has explicitly
|
|
52
|
+
# added to your database. <br><br>Use the <a
|
|
53
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-users"
|
|
54
|
+
# target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
|
|
55
|
+
# of the users within your Apollo account. <br><br>Example:
|
|
56
|
+
# `67e33d527de088000daa60c4` 6708415f59d9c70001b2f852
|
|
57
|
+
# @param [Array[String]] phone_call_purpose_ids Optional parameter: Filter
|
|
58
|
+
# calls based on their purpose. <br><br>Call purposes are unique to your
|
|
59
|
+
# team's Apollo account. When you use the <b>Purpose</b> search filter for
|
|
60
|
+
# calls in the Apollo product, you can find the corresponding call purpose
|
|
61
|
+
# ID in the URL. <br><br>Example: `6095a710bd01d100a506d4cf`
|
|
62
|
+
# @param [Array[String]] phone_call_outcome_ids Optional parameter: Filter
|
|
63
|
+
# calls based on their outcome. <br><br>Call outcomes are unique to your
|
|
64
|
+
# team's Apollo account. When you use the <b>Disposition</b> search filter
|
|
65
|
+
# for calls in the Apollo product, you can find the corresponding call
|
|
66
|
+
# outcome ID in the URL. <br><br>Example: `6095a710bd01d100a506d4c5`
|
|
67
|
+
# @param [String] q_keywords Optional parameter: Add keywords to narrow the
|
|
68
|
+
# search of the calls in your team's Apollo account. <br><br>Example:
|
|
69
|
+
# `marketing conference attendees`
|
|
70
|
+
# @param [String] page Optional parameter: The page number of the Apollo
|
|
71
|
+
# data that you want to retrieve. <br><br>Use this parameter in combination
|
|
72
|
+
# with the `per_page` parameter to make search results for navigable and
|
|
73
|
+
# improve the performance of the endpoint. <br><br>Example: `4`
|
|
74
|
+
# @param [String] per_page Optional parameter: The number of search results
|
|
75
|
+
# that should be returned for each page. Limiting the number of results per
|
|
76
|
+
# page improves the endpoint's performance. <br><br>Use the page parameter
|
|
77
|
+
# to search the different pages of data. <br><br>Example: `10`
|
|
78
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
79
|
+
def get_phone_callssearch(date_range_max: nil,
|
|
80
|
+
date_range_min: nil,
|
|
81
|
+
duration_max: nil,
|
|
82
|
+
duration_min: nil,
|
|
83
|
+
inbound: nil,
|
|
84
|
+
user_ids: nil,
|
|
85
|
+
contact_label_ids: nil,
|
|
86
|
+
phone_call_purpose_ids: nil,
|
|
87
|
+
phone_call_outcome_ids: nil,
|
|
88
|
+
q_keywords: nil,
|
|
89
|
+
page: nil,
|
|
90
|
+
per_page: nil)
|
|
91
|
+
@api_call
|
|
92
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
93
|
+
'/phone_calls/search',
|
|
94
|
+
Server::DEFAULT)
|
|
95
|
+
.query_param(new_parameter(date_range_max, key: 'date_range[max]'))
|
|
96
|
+
.query_param(new_parameter(date_range_min, key: 'date_range[min]'))
|
|
97
|
+
.query_param(new_parameter(duration_max, key: 'duration[max]'))
|
|
98
|
+
.query_param(new_parameter(duration_min, key: 'duration[min]'))
|
|
99
|
+
.query_param(new_parameter(inbound, key: 'inbound'))
|
|
100
|
+
.query_param(new_parameter(user_ids, key: 'user_ids[]'))
|
|
101
|
+
.query_param(new_parameter(contact_label_ids, key: 'contact_label_ids[]'))
|
|
102
|
+
.query_param(new_parameter(phone_call_purpose_ids, key: 'phone_call_purpose_ids[]'))
|
|
103
|
+
.query_param(new_parameter(phone_call_outcome_ids, key: 'phone_call_outcome_ids[]'))
|
|
104
|
+
.query_param(new_parameter(q_keywords, key: 'q_keywords'))
|
|
105
|
+
.query_param(new_parameter(page, key: 'page'))
|
|
106
|
+
.query_param(new_parameter(per_page, key: 'per_page'))
|
|
107
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
108
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
109
|
+
.response(new_response_handler
|
|
110
|
+
.deserializer(APIHelper.method(:dynamic_deserializer))
|
|
111
|
+
.is_api_response(true)
|
|
112
|
+
.local_error('401',
|
|
113
|
+
'401',
|
|
114
|
+
APIException)
|
|
115
|
+
.local_error('403',
|
|
116
|
+
'Forbidden',
|
|
117
|
+
APIException))
|
|
118
|
+
.execute
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
122
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
123
|
+
# Use the Create Call Records endpoint to log calls in Apollo that were made
|
|
124
|
+
# using outside systems such as Orum or Nooks. This endpoint can only be
|
|
125
|
+
# used create call records, not to dial prospects.<br><br>This endpoint
|
|
126
|
+
# requires a master API key. If you call the endpoint without a master key,
|
|
127
|
+
# you receive a `403` response. Check out <a
|
|
128
|
+
# href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
|
|
129
|
+
# learn how to create a master key.
|
|
130
|
+
# @param [TrueClass | FalseClass] logged Optional parameter: Set to `true`
|
|
131
|
+
# if you want to create an individual record for the phone call in Apollo.
|
|
132
|
+
# @param [Array[String]] user_id Optional parameter: Designate the caller in
|
|
133
|
+
# your team's Apollo account. <br><br>Use the <a
|
|
134
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-users"
|
|
135
|
+
# target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
|
|
136
|
+
# of the users within your Apollo account. <br><br>Example:
|
|
137
|
+
# `67e33d527de088000daa60c4`
|
|
138
|
+
# @param [String] contact_id Optional parameter: Designate the contact that
|
|
139
|
+
# was called. <br><br>Use the <a
|
|
140
|
+
# href="https://docs.apollo.io/reference/search-for-contacts#/"
|
|
141
|
+
# target="_blank">Search for Contacts endpoint</a> to retrieve IDs for all
|
|
142
|
+
# of the contacts within your Apollo account. <br><br>Example:
|
|
143
|
+
# `66e34b81740c50074e3d1bd4`
|
|
144
|
+
# @param [String] account_id Optional parameter: Associate the call with an
|
|
145
|
+
# account. <br><br>Use the <a
|
|
146
|
+
# href="https://docs.apollo.io/reference/search-for-accounts#/"
|
|
147
|
+
# target="_blank">Search for Accounts endpoint</a> to retrieve IDs for all
|
|
148
|
+
# of the accounts within your Apollo account. <br><br>Example:
|
|
149
|
+
# `66e9abf95ac32901b20d1a0d`
|
|
150
|
+
# @param [String] to_number Optional parameter: The phone number that you
|
|
151
|
+
# dialed. <br><br>Example: `5555550164`
|
|
152
|
+
# @param [String] from_number Optional parameter: The phone number that
|
|
153
|
+
# dialed you. <br><br>Example: `5555550164`
|
|
154
|
+
# @param [String] status Optional parameter: The status of the phone call.
|
|
155
|
+
# Possible values include: <ul> <li>`queued`</li> <li>`ringing`</li>
|
|
156
|
+
# <li>`in-progress`</li> <li>`completed`</li> <li>`no_answer`</li>
|
|
157
|
+
# <li>`failed`</li> <li>`busy`</li></ul>
|
|
158
|
+
# @param [DateTime] start_time Optional parameter: The time when the call
|
|
159
|
+
# started. <br><br>Your entry should adhere to the ISO 8601 date-time
|
|
160
|
+
# format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not
|
|
161
|
+
# account for time zone differences, you could add a start time that falls
|
|
162
|
+
# on a different day than you intended. <br><br>The value you enter can
|
|
163
|
+
# either adhere to GMT, or you can adjust the time manually by specifiying
|
|
164
|
+
# in hours and minutes how much you want to offset GMT. <br><br>Example:
|
|
165
|
+
# `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00Z`
|
|
166
|
+
# @param [DateTime] end_time Optional parameter: The time when the call
|
|
167
|
+
# ended. <br><br>Your entry should adhere to the ISO 8601 date-time format.
|
|
168
|
+
# Apollo uses Greenwich Mean Time (GMT) by default. If you do not account
|
|
169
|
+
# for time zone differences, you could add a end time that falls on a
|
|
170
|
+
# different day than you intended. <br><br>The value you enter can either
|
|
171
|
+
# adhere to GMT, or you can adjust the time manually by specifiying in hours
|
|
172
|
+
# and minutes how much you want to offset GMT. <br><br>Example:
|
|
173
|
+
# `2025-05-15T08:10:30Z`; `2025-05-25T10:15:30+05:00Z`
|
|
174
|
+
# @param [Integer] duration Optional parameter: The duration of the call in
|
|
175
|
+
# seconds. Do not enter minutes. <br><br>Examples: `120`; `205`
|
|
176
|
+
# @param [String] phone_call_purpose_id Optional parameter: Assign a call
|
|
177
|
+
# purpose to the record. <br><br>Call purposes are unique to your team's
|
|
178
|
+
# Apollo account. When you use the <b>Purpose</b> search filter for calls in
|
|
179
|
+
# the Apollo product, you can find the corresponding call purpose ID in the
|
|
180
|
+
# URL. <br><br>Examples: `6095a710bd01d100a506d4cd`
|
|
181
|
+
# @param [String] phone_call_outcome_id Optional parameter: Assign a call
|
|
182
|
+
# outcome to the record. <br><br>Call outcomes are unique to your team's
|
|
183
|
+
# Apollo account. When you use the <b>Disposition</b> search filter for
|
|
184
|
+
# calls in the Apollo product, you can find the corresponding call outcome
|
|
185
|
+
# ID in the URL. <br><br>Examples: `6095a710bd01d100a506d4c5`
|
|
186
|
+
# @param [String] note Optional parameter: Add a note to the call record.
|
|
187
|
+
# <br><br>Example: `This lead is interested in learning more about our new
|
|
188
|
+
# product line.`
|
|
189
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
190
|
+
def phonecalls_create(logged: nil,
|
|
191
|
+
user_id: nil,
|
|
192
|
+
contact_id: nil,
|
|
193
|
+
account_id: nil,
|
|
194
|
+
to_number: nil,
|
|
195
|
+
from_number: nil,
|
|
196
|
+
status: nil,
|
|
197
|
+
start_time: nil,
|
|
198
|
+
end_time: nil,
|
|
199
|
+
duration: nil,
|
|
200
|
+
phone_call_purpose_id: nil,
|
|
201
|
+
phone_call_outcome_id: nil,
|
|
202
|
+
note: nil)
|
|
203
|
+
@api_call
|
|
204
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
205
|
+
'/phone_calls',
|
|
206
|
+
Server::DEFAULT)
|
|
207
|
+
.query_param(new_parameter(logged, key: 'logged'))
|
|
208
|
+
.query_param(new_parameter(user_id, key: 'user_id[]'))
|
|
209
|
+
.query_param(new_parameter(contact_id, key: 'contact_id'))
|
|
210
|
+
.query_param(new_parameter(account_id, key: 'account_id'))
|
|
211
|
+
.query_param(new_parameter(to_number, key: 'to_number'))
|
|
212
|
+
.query_param(new_parameter(from_number, key: 'from_number'))
|
|
213
|
+
.query_param(new_parameter(status, key: 'status'))
|
|
214
|
+
.query_param(new_parameter(start_time, key: 'start_time'))
|
|
215
|
+
.query_param(new_parameter(end_time, key: 'end_time'))
|
|
216
|
+
.query_param(new_parameter(duration, key: 'duration'))
|
|
217
|
+
.query_param(new_parameter(phone_call_purpose_id, key: 'phone_call_purpose_id'))
|
|
218
|
+
.query_param(new_parameter(phone_call_outcome_id, key: 'phone_call_outcome_id'))
|
|
219
|
+
.query_param(new_parameter(note, key: 'note'))
|
|
220
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
221
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
222
|
+
.response(new_response_handler
|
|
223
|
+
.deserializer(APIHelper.method(:dynamic_deserializer))
|
|
224
|
+
.is_api_response(true)
|
|
225
|
+
.local_error('401',
|
|
226
|
+
'Unauthorized',
|
|
227
|
+
APIException)
|
|
228
|
+
.local_error('403',
|
|
229
|
+
'Forbidden',
|
|
230
|
+
APIException))
|
|
231
|
+
.execute
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
235
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
236
|
+
# Use the Update Call Records endpoint to update your team's call records in
|
|
237
|
+
# Apollo.<br><br>This endpoint requires a master API key. If you call the
|
|
238
|
+
# endpoint without a master key, you receive a `403` response. Check out <a
|
|
239
|
+
# href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
|
|
240
|
+
# learn how to create a master key.
|
|
241
|
+
# @param [String] id Required parameter: The Apollo ID for the call record
|
|
242
|
+
# that you want to update. <br><br>To find call record IDs, call the <a
|
|
243
|
+
# href="https://docs.apollo.io/reference/search-for-calls#/"
|
|
244
|
+
# target="_blank">Search for Calls endpoint</a> and identify the `id` value
|
|
245
|
+
# for the call record. <br><br>Example: `6859b0dd828b270021e69648`
|
|
246
|
+
# @param [TrueClass | FalseClass] logged Optional parameter: Set to `true`
|
|
247
|
+
# if you want to create an individual record for the phone call in Apollo.
|
|
248
|
+
# @param [Array[String]] user_id Optional parameter: Designate the caller in
|
|
249
|
+
# your team's Apollo account. <br><br>Use the <a
|
|
250
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-users"
|
|
251
|
+
# target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
|
|
252
|
+
# of the users within your Apollo account. <br><br>Example:
|
|
253
|
+
# `67e33d527de088000daa60c4`
|
|
254
|
+
# @param [String] contact_id Optional parameter: Designate the contact that
|
|
255
|
+
# was called. <br><br>Use the <a
|
|
256
|
+
# href="https://docs.apollo.io/reference/search-for-contacts#/"
|
|
257
|
+
# target="_blank">Search for Contacts endpoint</a> to retrieve IDs for all
|
|
258
|
+
# of the contacts within your Apollo account. <br><br>Example:
|
|
259
|
+
# `66e34b81740c50074e3d1bd4`
|
|
260
|
+
# @param [String] account_id Optional parameter: Associate the call with an
|
|
261
|
+
# account. <br><br>Use the <a
|
|
262
|
+
# href="https://docs.apollo.io/reference/search-for-accounts#/"
|
|
263
|
+
# target="_blank">Search for Accounts endpoint</a> to retrieve IDs for all
|
|
264
|
+
# of the accounts within your Apollo account. <br><br>Example:
|
|
265
|
+
# `66e9abf95ac32901b20d1a0d`
|
|
266
|
+
# @param [String] to_number Optional parameter: The phone number that you
|
|
267
|
+
# dialed. <br><br>Example: `5555550164`
|
|
268
|
+
# @param [String] from_number Optional parameter: The phone number that
|
|
269
|
+
# dialed you. <br><br>Example: `5555550164`
|
|
270
|
+
# @param [String] status Optional parameter: The status of the phone call.
|
|
271
|
+
# Possible values include: <ul> <li>`queued`</li> <li>`ringing`</li>
|
|
272
|
+
# <li>`in-progress`</li> <li>`completed`</li> <li>`no_answer`</li>
|
|
273
|
+
# <li>`failed`</li> <li>`busy`</li></ul>
|
|
274
|
+
# @param [DateTime] start_time Optional parameter: The time when the call
|
|
275
|
+
# started. <br><br>Your entry should adhere to the ISO 8601 date-time
|
|
276
|
+
# format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not
|
|
277
|
+
# account for time zone differences, you could add a start time that falls
|
|
278
|
+
# on a different day than you intended. <br><br>The value you enter can
|
|
279
|
+
# either adhere to GMT, or you can adjust the time manually by specifiying
|
|
280
|
+
# in hours and minutes how much you want to offset GMT. <br><br>Example:
|
|
281
|
+
# `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00Z`
|
|
282
|
+
# @param [DateTime] end_time Optional parameter: The time when the call
|
|
283
|
+
# ended. <br><br>Your entry should adhere to the ISO 8601 date-time format.
|
|
284
|
+
# Apollo uses Greenwich Mean Time (GMT) by default. If you do not account
|
|
285
|
+
# for time zone differences, you could add a end time that falls on a
|
|
286
|
+
# different day than you intended. <br><br>The value you enter can either
|
|
287
|
+
# adhere to GMT, or you can adjust the time manually by specifiying in hours
|
|
288
|
+
# and minutes how much you want to offset GMT. <br><br>Example:
|
|
289
|
+
# `2025-05-15T08:10:30Z`; `2025-05-25T10:15:30+05:00Z`
|
|
290
|
+
# @param [Integer] duration Optional parameter: The duration of the call in
|
|
291
|
+
# seconds. Do not enter minutes. <br><br>Examples: `120`; `205`
|
|
292
|
+
# @param [String] phone_call_purpose_id Optional parameter: Assign a call
|
|
293
|
+
# purpose to the record. <br><br>Call purposes are unique to your team's
|
|
294
|
+
# Apollo account. When you use the <b>Purpose</b> search filter for calls in
|
|
295
|
+
# the Apollo product, you can find the corresponding call purpose ID in the
|
|
296
|
+
# URL. <br><br>Examples: `6095a710bd01d100a506d4cd`
|
|
297
|
+
# @param [String] phone_call_outcome_id Optional parameter: Assign a call
|
|
298
|
+
# outcome to the record. <br><br>Call outcomes are unique to your team's
|
|
299
|
+
# Apollo account. When you use the <b>Disposition</b> search filter for
|
|
300
|
+
# calls in the Apollo product, you can find the corresponding call outcome
|
|
301
|
+
# ID in the URL. <br><br>Examples: `6095a710bd01d100a506d4c5`
|
|
302
|
+
# @param [String] note Optional parameter: Add a note to the call record.
|
|
303
|
+
# <br><br>Example: `This lead is interested in learning more about our new
|
|
304
|
+
# product line.`
|
|
305
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
306
|
+
def put_phone_callsupdate(id,
|
|
307
|
+
logged: nil,
|
|
308
|
+
user_id: nil,
|
|
309
|
+
contact_id: nil,
|
|
310
|
+
account_id: nil,
|
|
311
|
+
to_number: nil,
|
|
312
|
+
from_number: nil,
|
|
313
|
+
status: nil,
|
|
314
|
+
start_time: nil,
|
|
315
|
+
end_time: nil,
|
|
316
|
+
duration: nil,
|
|
317
|
+
phone_call_purpose_id: nil,
|
|
318
|
+
phone_call_outcome_id: nil,
|
|
319
|
+
note: nil)
|
|
320
|
+
@api_call
|
|
321
|
+
.request(new_request_builder(HttpMethodEnum::PUT,
|
|
322
|
+
'/phone_calls/{id}',
|
|
323
|
+
Server::DEFAULT)
|
|
324
|
+
.template_param(new_parameter(id, key: 'id')
|
|
325
|
+
.is_required(true)
|
|
326
|
+
.should_encode(true))
|
|
327
|
+
.query_param(new_parameter(logged, key: 'logged'))
|
|
328
|
+
.query_param(new_parameter(user_id, key: 'user_id[]'))
|
|
329
|
+
.query_param(new_parameter(contact_id, key: 'contact_id'))
|
|
330
|
+
.query_param(new_parameter(account_id, key: 'account_id'))
|
|
331
|
+
.query_param(new_parameter(to_number, key: 'to_number'))
|
|
332
|
+
.query_param(new_parameter(from_number, key: 'from_number'))
|
|
333
|
+
.query_param(new_parameter(status, key: 'status'))
|
|
334
|
+
.query_param(new_parameter(start_time, key: 'start_time'))
|
|
335
|
+
.query_param(new_parameter(end_time, key: 'end_time'))
|
|
336
|
+
.query_param(new_parameter(duration, key: 'duration'))
|
|
337
|
+
.query_param(new_parameter(phone_call_purpose_id, key: 'phone_call_purpose_id'))
|
|
338
|
+
.query_param(new_parameter(phone_call_outcome_id, key: 'phone_call_outcome_id'))
|
|
339
|
+
.query_param(new_parameter(note, key: 'note'))
|
|
340
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
341
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
342
|
+
.response(new_response_handler
|
|
343
|
+
.deserializer(APIHelper.method(:dynamic_deserializer))
|
|
344
|
+
.is_api_response(true)
|
|
345
|
+
.local_error('401',
|
|
346
|
+
'Unauthorized',
|
|
347
|
+
APIException)
|
|
348
|
+
.local_error('403',
|
|
349
|
+
'Forbidden',
|
|
350
|
+
APIException))
|
|
351
|
+
.execute
|
|
352
|
+
end
|
|
353
|
+
end
|
|
354
|
+
end
|