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
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: f3156d9b0fa0f368c55ef98c8a8d6f313c43023d63bd374dc3884102ce626336
|
|
4
|
+
data.tar.gz: 461ad0ec8f4817be052ebd31f207750fdbcdb19b8066d3876d265f4e96cfb568
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: b64fd127bdde984b4da4e718fd2034e85b3b8831b93a7b02f6faf5b1e6a32f46e4556082dd56b86f6eb8fa9efb6d3a827e6b47c2ed3f8ef3cd958d4f7d1b455f
|
|
7
|
+
data.tar.gz: 695f55d41c41d9582df535f88b845677a9d4ad6b434565a29bb37da03ef2ec76887ee4d1616f9a2a156d7348538efb7eb5091297920cee527d3fc9e4c2bab7bc
|
data/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
License:
|
|
2
|
+
========
|
|
3
|
+
The MIT License (MIT)
|
|
4
|
+
http://opensource.org/licenses/MIT
|
|
5
|
+
|
|
6
|
+
Copyright (c) 2014 - 2026 APIMATIC Limited
|
|
7
|
+
|
|
8
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
9
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
10
|
+
in the Software without restriction, including without limitation the rights
|
|
11
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
12
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
13
|
+
furnished to do so, subject to the following conditions:
|
|
14
|
+
|
|
15
|
+
The above copyright notice and this permission notice shall be included in
|
|
16
|
+
all copies or substantial portions of the Software.
|
|
17
|
+
|
|
18
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
19
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
20
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
21
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
22
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
23
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
24
|
+
THE SOFTWARE.
|
|
25
|
+
|
|
26
|
+
Trade Mark:
|
|
27
|
+
==========
|
|
28
|
+
APIMATIC is a trade mark for APIMATIC Limited
|
data/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
|
|
2
|
+
# Getting Started with apollo-rest-api
|
|
3
|
+
|
|
4
|
+
## Introduction
|
|
5
|
+
|
|
6
|
+
The Apollo API provides programmatic access to [Apollo](https://www.apollo.io/), the all-in-one sales intelligence and engagement platform. Use it to enrich people and company data (individually or in bulk), search Apollo's database of over 240 million contacts and 30 million companies, and manage accounts, contacts, deals, sequences, tasks, calls, and conversations in your go-to-market workflows.
|
|
7
|
+
|
|
8
|
+
### Base URL
|
|
9
|
+
|
|
10
|
+
All API requests are made to `https://api.apollo.io/api/v1`.
|
|
11
|
+
|
|
12
|
+
### Authentication
|
|
13
|
+
|
|
14
|
+
- **Apollo users** authenticate with an API key passed in the `x-api-key` request header. See [Create API Keys](https://docs.apollo.io/docs/create-api-key).
|
|
15
|
+
- **Apollo partners** building integrations on behalf of mutual users authenticate with the [OAuth 2.0 authorization flow](https://docs.apollo.io/docs/use-oauth-20-authorization-flow-to-access-apollo-user-information-partners).
|
|
16
|
+
|
|
17
|
+
### Rate limits & credits
|
|
18
|
+
|
|
19
|
+
Rate limits and credit consumption depend on your [Apollo pricing plan](https://docs.apollo.io/docs/api-pricing). Check your current limits and usage with the [View API Usage Stats and Rate Limits](https://docs.apollo.io/reference/view-api-usage-stats) endpoint. For more details, see [Rate Limits](https://docs.apollo.io/reference/rate-limits) and the [API FAQs](https://docs.apollo.io/docs/apollo-api-faqs).
|
|
20
|
+
|
|
21
|
+
New to the API? Start with the [Apollo API overview](https://docs.apollo.io/reference/apollo-api).
|
|
22
|
+
|
|
23
|
+
## Install the Package
|
|
24
|
+
|
|
25
|
+
Install the gem from the command line:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
gem install apimatic-apollo-sdk -v 0.0.1
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Or add the gem to your Gemfile and run `bundle`:
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
gem 'apimatic-apollo-sdk', '0.0.1'
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
For additional gem details, see the [RubyGems page for the apimatic-apollo-sdk gem](https://rubygems.org/gems/apimatic-apollo-sdk/versions/0.0.1).
|
|
38
|
+
|
|
39
|
+
## IRB Console Usage
|
|
40
|
+
|
|
41
|
+
You can explore the SDK interactively using IRB in two ways
|
|
42
|
+
|
|
43
|
+
### 1. Use IRB with Installed Gem
|
|
44
|
+
|
|
45
|
+
Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
irb
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Now you can load the SDK in the IRB
|
|
52
|
+
|
|
53
|
+
```ruby
|
|
54
|
+
require 'apollo_rest_api'
|
|
55
|
+
include ApolloRestApi
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### 2. Use IRB within SDK
|
|
59
|
+
|
|
60
|
+
Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
cd path/to/apollo_rest_api
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Now you can start the preconfigured irb console by running the following command
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
ruby bin/console
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**_Note:_** This automatically loads the SDK from lib/
|
|
73
|
+
|
|
74
|
+
## Initialize the API Client
|
|
75
|
+
|
|
76
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/client.md)
|
|
77
|
+
|
|
78
|
+
The following parameters are configurable for the API Client:
|
|
79
|
+
|
|
80
|
+
| Parameter | Type | Description |
|
|
81
|
+
| --- | --- | --- |
|
|
82
|
+
| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
|
|
83
|
+
| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
|
|
84
|
+
| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
|
|
85
|
+
| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
|
|
86
|
+
| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
|
|
87
|
+
| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
|
|
88
|
+
| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
|
89
|
+
| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
|
90
|
+
| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
|
91
|
+
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
|
|
92
|
+
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
|
|
93
|
+
| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
|
|
94
|
+
| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
|
|
95
|
+
|
|
96
|
+
The API client can be initialized as follows:
|
|
97
|
+
|
|
98
|
+
### Code-Based Client Initialization
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
require 'apollo_rest_api'
|
|
102
|
+
include ApolloRestApi
|
|
103
|
+
|
|
104
|
+
client = Client.new(
|
|
105
|
+
api_key_credentials: ApiKeyCredentials.new(
|
|
106
|
+
x_api_key: 'x-api-key'
|
|
107
|
+
),
|
|
108
|
+
bearer_auth_credentials: BearerAuthCredentials.new(
|
|
109
|
+
access_token: 'AccessToken'
|
|
110
|
+
),
|
|
111
|
+
logging_configuration: LoggingConfiguration.new(
|
|
112
|
+
log_level: Logger::INFO,
|
|
113
|
+
request_logging_config: RequestLoggingConfiguration.new(
|
|
114
|
+
log_body: true
|
|
115
|
+
),
|
|
116
|
+
response_logging_config: ResponseLoggingConfiguration.new(
|
|
117
|
+
log_headers: true
|
|
118
|
+
)
|
|
119
|
+
)
|
|
120
|
+
)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Environment-Based Client Initialization
|
|
124
|
+
|
|
125
|
+
```ruby
|
|
126
|
+
require 'apollo_rest_api'
|
|
127
|
+
include ApolloRestApi
|
|
128
|
+
|
|
129
|
+
# Create client from environment
|
|
130
|
+
client = Client.from_env
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
|
|
134
|
+
|
|
135
|
+
## Authorization
|
|
136
|
+
|
|
137
|
+
This API uses the following authentication schemes.
|
|
138
|
+
|
|
139
|
+
* [`apiKey (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md)
|
|
140
|
+
* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
|
|
141
|
+
|
|
142
|
+
## List of APIs
|
|
143
|
+
|
|
144
|
+
* [Emailer Messages](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/emailer-messages.md)
|
|
145
|
+
* [API](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/api.md)
|
|
146
|
+
* [Enrichment](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/enrichment.md)
|
|
147
|
+
* [Search](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/search.md)
|
|
148
|
+
* [Accounts](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/accounts.md)
|
|
149
|
+
* [Contacts](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/contacts.md)
|
|
150
|
+
* [Deals](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/deals.md)
|
|
151
|
+
* [Sequences](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/sequences.md)
|
|
152
|
+
* [Tasks](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/tasks.md)
|
|
153
|
+
* [Calls](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/calls.md)
|
|
154
|
+
* [Conversations](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/conversations.md)
|
|
155
|
+
* [Analytics](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/analytics.md)
|
|
156
|
+
* [Miscellaneous](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/controllers/miscellaneous.md)
|
|
157
|
+
|
|
158
|
+
## SDK Infrastructure
|
|
159
|
+
|
|
160
|
+
### Configuration
|
|
161
|
+
|
|
162
|
+
* [ProxySettings](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
|
|
163
|
+
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
|
|
164
|
+
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
|
|
165
|
+
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
|
|
166
|
+
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
|
|
167
|
+
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
|
|
168
|
+
|
|
169
|
+
### HTTP
|
|
170
|
+
|
|
171
|
+
* [HttpResponse](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/http-response.md)
|
|
172
|
+
* [HttpRequest](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/http-request.md)
|
|
173
|
+
|
|
174
|
+
### Utilities
|
|
175
|
+
|
|
176
|
+
* [ApiResponse](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/api-response.md)
|
|
177
|
+
* [ApiHelper](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/api-helper.md)
|
|
178
|
+
* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-apollo-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
|
|
179
|
+
|
data/bin/console
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
# Load the lib folder into Ruby's load path
|
|
4
|
+
$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
|
|
5
|
+
|
|
6
|
+
# Require the gem
|
|
7
|
+
require 'apollo_rest_api'
|
|
8
|
+
|
|
9
|
+
puts 'ApolloRestApi SDK loaded!'
|
|
10
|
+
puts 'You can now create a client with: client = ApolloRestApi::Client.new'
|
|
11
|
+
puts 'Or use from_env: client = ApolloRestApi::Client.from_env'
|
|
12
|
+
|
|
13
|
+
# Start an interactive IRB session
|
|
14
|
+
require 'irb'
|
|
15
|
+
IRB.start
|
|
@@ -0,0 +1,400 @@
|
|
|
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
|
+
# AccountsApi
|
|
8
|
+
class AccountsApi < 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
|
+
# An <a
|
|
12
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and
|
|
13
|
+
# -Edit-Accounts" target="_blank">account</a> is a company saved in
|
|
14
|
+
# Apollo.<br><br>Use the Create an Account endpoint to add a new account to
|
|
15
|
+
# your team's Apollo account.<br><br>Apollo doesn't apply deduplication
|
|
16
|
+
# processes when you create a new account via the API. If your entry has the
|
|
17
|
+
# same name, domain, or other details as an existing account, Apollo creates
|
|
18
|
+
# a new account instead of updating the existing account. To update an
|
|
19
|
+
# existing account, use the <a
|
|
20
|
+
# href="https://docs.apollo.io/reference/update-an-account">Update an
|
|
21
|
+
# Account endpoint</a> instead.<br><br>This endpoint requires a master API
|
|
22
|
+
# key. If you call the endpoint without a master key, you receive a `403`
|
|
23
|
+
# response. Check out <a
|
|
24
|
+
# href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
|
|
25
|
+
# learn how to create a master key.
|
|
26
|
+
# @param [AccountsRequest] body Required parameter: TODO: type description
|
|
27
|
+
# here
|
|
28
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
29
|
+
def create_an_account(body)
|
|
30
|
+
@api_call
|
|
31
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
32
|
+
'/accounts',
|
|
33
|
+
Server::DEFAULT)
|
|
34
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
35
|
+
.body_param(new_parameter(body)
|
|
36
|
+
.is_required(true))
|
|
37
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
38
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
39
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
40
|
+
.response(new_response_handler
|
|
41
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
42
|
+
.deserialize_into(AccountsResponse.method(:from_hash))
|
|
43
|
+
.is_api_response(true)
|
|
44
|
+
.local_error('401',
|
|
45
|
+
'401',
|
|
46
|
+
APIException)
|
|
47
|
+
.local_error('403',
|
|
48
|
+
'403',
|
|
49
|
+
NeedMasterApiKeyException)
|
|
50
|
+
.local_error('422',
|
|
51
|
+
'422',
|
|
52
|
+
Accounts422ErrorException)
|
|
53
|
+
.local_error('429',
|
|
54
|
+
'429',
|
|
55
|
+
Accounts429ErrorException))
|
|
56
|
+
.execute
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
60
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
61
|
+
# An <a
|
|
62
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and
|
|
63
|
+
# -Edit-Accounts" target="_blank">account</a> is a company saved in
|
|
64
|
+
# Apollo.<br><br>Use the Search for Accounts endpoint to search for an
|
|
65
|
+
# account that has been saved to Apollo.<br><br>This endpoint only returns
|
|
66
|
+
# accounts in the search results. To search for companies in Apollo, call
|
|
67
|
+
# the <a
|
|
68
|
+
# href="https://docs.apollo.io/reference/organization-search">Organization
|
|
69
|
+
# Search endpoint</a>.<br><br>To protect Apollo's performance for all users,
|
|
70
|
+
# this endpoint has a display limit of 50,000 records (100 records per page,
|
|
71
|
+
# up to 500 pages). Add more filters to narrow your search results as much
|
|
72
|
+
# as possible.
|
|
73
|
+
# @param [AccountsSearchRequest] body Required parameter: TODO: type
|
|
74
|
+
# description here
|
|
75
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
76
|
+
def search_for_accounts(body)
|
|
77
|
+
@api_call
|
|
78
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
79
|
+
'/accounts/search',
|
|
80
|
+
Server::DEFAULT)
|
|
81
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
82
|
+
.body_param(new_parameter(body)
|
|
83
|
+
.is_required(true))
|
|
84
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
85
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
86
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
87
|
+
.response(new_response_handler
|
|
88
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
89
|
+
.deserialize_into(AccountsSearchResponse.method(:from_hash))
|
|
90
|
+
.is_api_response(true)
|
|
91
|
+
.local_error('401',
|
|
92
|
+
'401',
|
|
93
|
+
APIException)
|
|
94
|
+
.local_error('403',
|
|
95
|
+
'403',
|
|
96
|
+
AccountsSearch403ErrorException)
|
|
97
|
+
.local_error('422',
|
|
98
|
+
'422',
|
|
99
|
+
APIException)
|
|
100
|
+
.local_error('429',
|
|
101
|
+
'429',
|
|
102
|
+
AccountsSearch429ErrorException))
|
|
103
|
+
.execute
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
107
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
108
|
+
# An <a
|
|
109
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and
|
|
110
|
+
# -Edit-Accounts" target="_blank">account</a> is a company saved in
|
|
111
|
+
# Apollo.<br><br>Use the bulk create accounts endpoint to create up to one
|
|
112
|
+
# hundred accounts in a single API request. This endpoint supports
|
|
113
|
+
# intelligent deduplication and returns separate arrays for newly created
|
|
114
|
+
# and existing accounts. <br><br>**Important**: This endpoint creates new
|
|
115
|
+
# accounts but doesn't update existing ones. Existing accounts that match
|
|
116
|
+
# the criteria are returned in the <code>existing_accounts</code> array
|
|
117
|
+
# without modification. <br><br>To update existing accounts, use the <a
|
|
118
|
+
# href="https://docs.apollo.io/reference/bulk-update-accounts">Bulk Update
|
|
119
|
+
# Accounts endpoint</a>.
|
|
120
|
+
# @param [AccountsBulkCreateRequest] body Required parameter: TODO: type
|
|
121
|
+
# description here
|
|
122
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
123
|
+
def bulk_create_accounts(body)
|
|
124
|
+
@api_call
|
|
125
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
126
|
+
'/accounts/bulk_create',
|
|
127
|
+
Server::DEFAULT)
|
|
128
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
129
|
+
.body_param(new_parameter(body)
|
|
130
|
+
.is_required(true))
|
|
131
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
132
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
133
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
134
|
+
.response(new_response_handler
|
|
135
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
136
|
+
.deserialize_into(AccountsBulkCreateResponse.method(:from_hash))
|
|
137
|
+
.is_api_response(true)
|
|
138
|
+
.local_error('401',
|
|
139
|
+
'401 - Unauthorized',
|
|
140
|
+
APIException)
|
|
141
|
+
.local_error('422',
|
|
142
|
+
'422 - Unprocessable Entity',
|
|
143
|
+
AccountsBulkCreate422ErrorException)
|
|
144
|
+
.local_error('429',
|
|
145
|
+
'429 - Too Many Requests',
|
|
146
|
+
AccountsBulkCreate429ErrorException)
|
|
147
|
+
.local_error('500',
|
|
148
|
+
'500 - Internal Server Error',
|
|
149
|
+
AccountsBulkCreate500ErrorException))
|
|
150
|
+
.execute
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
154
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
155
|
+
# An <a
|
|
156
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and
|
|
157
|
+
# -Edit-Accounts" target="_blank">account</a> is a company saved in
|
|
158
|
+
# Apollo.<br><br>Use the Bulk Update Accounts endpoint to simultaneously
|
|
159
|
+
# update multiple accounts in your team's Apollo account. <br><br>This
|
|
160
|
+
# endpoint allows you to update common fields across multiple accounts
|
|
161
|
+
# efficiently, such as account stages, owners, names, and custom fields.
|
|
162
|
+
# <br><br>You can update up to 1,000 accounts per
|
|
163
|
+
# request.<br><br><b>Important:</b> Asynchronous processing (async
|
|
164
|
+
# parameter) is only supported when using <code>account_ids</code> to apply
|
|
165
|
+
# the same updates to all accounts. If you use async with
|
|
166
|
+
# <code>account_attributes</code> (individual updates per account), the
|
|
167
|
+
# request fails with a 422 error.
|
|
168
|
+
# @param [AccountsBulkUpdateRequest] body Required parameter: TODO: type
|
|
169
|
+
# description here
|
|
170
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
171
|
+
def bulk_update_accounts(body)
|
|
172
|
+
@api_call
|
|
173
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
174
|
+
'/accounts/bulk_update',
|
|
175
|
+
Server::DEFAULT)
|
|
176
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
177
|
+
.body_param(new_parameter(body)
|
|
178
|
+
.is_required(true))
|
|
179
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
180
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
181
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
182
|
+
.response(new_response_handler
|
|
183
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
184
|
+
.deserialize_into(AccountsBulkUpdateResponse.method(:from_hash))
|
|
185
|
+
.is_api_response(true)
|
|
186
|
+
.local_error('401',
|
|
187
|
+
'401',
|
|
188
|
+
APIException)
|
|
189
|
+
.local_error('403',
|
|
190
|
+
'403',
|
|
191
|
+
NeedMasterApiKeyException)
|
|
192
|
+
.local_error('422',
|
|
193
|
+
'422',
|
|
194
|
+
AccountsBulkUpdate422ErrorException)
|
|
195
|
+
.local_error('429',
|
|
196
|
+
'429',
|
|
197
|
+
AccountsBulkUpdate429ErrorException))
|
|
198
|
+
.execute
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
202
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
203
|
+
# <a
|
|
204
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5631686093069-Edit-a-C
|
|
205
|
+
# ontact-or-Account-Owner" target="_blank">Account owners</a> manage saved
|
|
206
|
+
# accounts in Apollo.<br><br>Use the Update Account Owner for Multiple
|
|
207
|
+
# Accounts endpoint to assign multiple accounts to a different user in your
|
|
208
|
+
# team's Apollo account.<br><br>To update more than the account owner, such
|
|
209
|
+
# as domains or phone numbers, use the <a
|
|
210
|
+
# href="https://docs.apollo.io/reference/update-an-account">Update an
|
|
211
|
+
# Account endpoint</a> instead. <br><br>This endpoint requires a master API
|
|
212
|
+
# key. If you call the endpoint without a master key, you receive a `403`
|
|
213
|
+
# response. Check out <a href="https://docs.apollo.io/docs/create-api-key"
|
|
214
|
+
# target="_blank">Create an API Key</a> to learn how to create a master key.
|
|
215
|
+
# @param [Array[String]] account_ids Required parameter: The Apollo IDs for
|
|
216
|
+
# the account that you want to assign to an owner. <br><br>To find account
|
|
217
|
+
# IDs, call the <a
|
|
218
|
+
# href="https://docs.apollo.io/reference/search-for-accounts"
|
|
219
|
+
# target="_blank">Search for Accounts endpoint</a> and identify the `id`
|
|
220
|
+
# value for the account. <br><br>Example: `66e9abf95ac32901b20d1a0d`
|
|
221
|
+
# @param [String] owner_id Required parameter: The ID for the account owner
|
|
222
|
+
# within your team's Apollo account. This user will be assigned ownership of
|
|
223
|
+
# the accounts. <br><br>Use the <a
|
|
224
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-users"
|
|
225
|
+
# target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
|
|
226
|
+
# of the users within your Apollo account. <br><br>Example:
|
|
227
|
+
# `66302798d03b9601c7934ebf`
|
|
228
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
229
|
+
def update_account_ownership(account_ids,
|
|
230
|
+
owner_id)
|
|
231
|
+
@api_call
|
|
232
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
233
|
+
'/accounts/update_owners',
|
|
234
|
+
Server::DEFAULT)
|
|
235
|
+
.query_param(new_parameter(account_ids, key: 'account_ids[]')
|
|
236
|
+
.is_required(true))
|
|
237
|
+
.query_param(new_parameter(owner_id, key: 'owner_id')
|
|
238
|
+
.is_required(true))
|
|
239
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
240
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
241
|
+
.response(new_response_handler
|
|
242
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
243
|
+
.deserialize_into(AccountsUpdateOwnersResponse.method(:from_hash))
|
|
244
|
+
.is_api_response(true)
|
|
245
|
+
.local_error('401',
|
|
246
|
+
'401',
|
|
247
|
+
APIException)
|
|
248
|
+
.local_error('403',
|
|
249
|
+
'403',
|
|
250
|
+
NeedMasterApiKeyException)
|
|
251
|
+
.local_error('422',
|
|
252
|
+
'422',
|
|
253
|
+
APIException)
|
|
254
|
+
.local_error('429',
|
|
255
|
+
'429',
|
|
256
|
+
AccountsUpdateOwners429ErrorException))
|
|
257
|
+
.execute
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
261
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
262
|
+
# <a
|
|
263
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-
|
|
264
|
+
# and-Account-Stages-Overview" target="_blank">Account stages</a> help you
|
|
265
|
+
# track progress on sales and marketing pipelines.<br><br>Use the List
|
|
266
|
+
# Accounts Stages endpoint to retrieve the IDs for the available account
|
|
267
|
+
# stages in your team's Apollo account. This endpoint doesn't require
|
|
268
|
+
# parameters. <br><br>Account stage IDs can be used to <a
|
|
269
|
+
# href="https://docs.apollo.io/reference/update-an-account">update
|
|
270
|
+
# individual accounts</a> and <a
|
|
271
|
+
# href="https://docs.apollo.io/reference/bulk-update-accounts">update the
|
|
272
|
+
# account stages for multiple accounts</a> via Apollo API. <br><br>This
|
|
273
|
+
# endpoint requires a master API key. If you call the endpoint without a
|
|
274
|
+
# master key, you receive a `403` response. Check out <a
|
|
275
|
+
# href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
|
|
276
|
+
# learn how to create a master key.
|
|
277
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
278
|
+
def list_account_stages
|
|
279
|
+
@api_call
|
|
280
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
281
|
+
'/account_stages',
|
|
282
|
+
Server::DEFAULT)
|
|
283
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
284
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
285
|
+
.response(new_response_handler
|
|
286
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
287
|
+
.deserialize_into(AccountStagesResponse.method(:from_hash))
|
|
288
|
+
.is_api_response(true)
|
|
289
|
+
.local_error('401',
|
|
290
|
+
'401',
|
|
291
|
+
APIException)
|
|
292
|
+
.local_error('403',
|
|
293
|
+
'403',
|
|
294
|
+
NeedMasterApiKeyException)
|
|
295
|
+
.local_error('429',
|
|
296
|
+
'429',
|
|
297
|
+
AccountStages429ErrorException))
|
|
298
|
+
.execute
|
|
299
|
+
end
|
|
300
|
+
|
|
301
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
302
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
303
|
+
# An <a
|
|
304
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and
|
|
305
|
+
# -Edit-Accounts" target="_blank">account</a> is a company saved in
|
|
306
|
+
# Apollo.<br><br>Use the View an Account endpoint to retrieve details for an
|
|
307
|
+
# existing account.<br><br>This endpoint requires a master API key. If you
|
|
308
|
+
# call the endpoint without a master key, you receive a `403` response.
|
|
309
|
+
# Check out <a href="https://docs.apollo.io/docs/create-api-key">Create API
|
|
310
|
+
# keys</a> to learn how to create a master key.
|
|
311
|
+
# @param [String] id Required parameter: The Apollo ID for the account that
|
|
312
|
+
# you want to retrieve. <br><br>To find account IDs, call the <a
|
|
313
|
+
# href="https://docs.apollo.io/reference/search-for-accounts#/"
|
|
314
|
+
# target="_blank">Search for Accounts endpoint</a> and identify the `id`
|
|
315
|
+
# value for the account. <br><br>Example: `6518c6184f20350001a0b9c0`
|
|
316
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
317
|
+
def get_accounts_id(id)
|
|
318
|
+
@api_call
|
|
319
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
320
|
+
'/accounts/{id}',
|
|
321
|
+
Server::DEFAULT)
|
|
322
|
+
.template_param(new_parameter(id, key: 'id')
|
|
323
|
+
.is_required(true)
|
|
324
|
+
.should_encode(true))
|
|
325
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
326
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
327
|
+
.response(new_response_handler
|
|
328
|
+
.deserializer(APIHelper.method(:dynamic_deserializer))
|
|
329
|
+
.is_api_response(true)
|
|
330
|
+
.local_error('401',
|
|
331
|
+
'Unauthorized',
|
|
332
|
+
APIException)
|
|
333
|
+
.local_error('403',
|
|
334
|
+
'Forbidden',
|
|
335
|
+
APIException)
|
|
336
|
+
.local_error('422',
|
|
337
|
+
'Unprocessable Entity',
|
|
338
|
+
APIException))
|
|
339
|
+
.execute
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
# This endpoint doesn't consume Apollo credits. Learn more about [API
|
|
343
|
+
# pricing and credits](https://docs.apollo.io/docs/api-pricing).
|
|
344
|
+
# An <a
|
|
345
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and
|
|
346
|
+
# -Edit-Accounts" target="_blank">account</a> is a company saved in
|
|
347
|
+
# Apollo.<br><br>Use the Update an Account endpoint to update existing
|
|
348
|
+
# accounts in your team's Apollo account.<br><br>To create a new account,
|
|
349
|
+
# use the <a
|
|
350
|
+
# href="https://docs.apollo.io/reference/create-an-account">Create an
|
|
351
|
+
# Account endpoint</a> instead. To update the account stage for multiple
|
|
352
|
+
# accounts, use the <a
|
|
353
|
+
# href="https://docs.apollo.io/reference/bulk-update-accounts">Bulk Update
|
|
354
|
+
# Accounts endpoint</a>.<br><br>This endpoint requires a master API key. If
|
|
355
|
+
# you call the endpoint without a master key, you receive a `403` response.
|
|
356
|
+
# Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an
|
|
357
|
+
# API Key</a> to learn how to create a master key.
|
|
358
|
+
# @param [String] id Required parameter: The Apollo ID for the account that
|
|
359
|
+
# you want to update. <br><br>To find account IDs, call the <a
|
|
360
|
+
# href="https://docs.apollo.io/reference/search-for-accounts"
|
|
361
|
+
# target="_blank">Search for Accounts endpoint</a> and identify the `id`
|
|
362
|
+
# value for the contact. <br><br>Example: `66e9abf95ac32901b20d1a0d`
|
|
363
|
+
# @param [AccountsRequest1] body Required parameter: TODO: type description
|
|
364
|
+
# here
|
|
365
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
366
|
+
def update_an_account(id,
|
|
367
|
+
body)
|
|
368
|
+
@api_call
|
|
369
|
+
.request(new_request_builder(HttpMethodEnum::PATCH,
|
|
370
|
+
'/accounts/{id}',
|
|
371
|
+
Server::DEFAULT)
|
|
372
|
+
.template_param(new_parameter(id, key: 'id')
|
|
373
|
+
.is_required(true)
|
|
374
|
+
.should_encode(true))
|
|
375
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
376
|
+
.body_param(new_parameter(body)
|
|
377
|
+
.is_required(true))
|
|
378
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
379
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
380
|
+
.auth(Or.new('bearerAuth', 'apiKey')))
|
|
381
|
+
.response(new_response_handler
|
|
382
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
383
|
+
.deserialize_into(AccountsResponse1.method(:from_hash))
|
|
384
|
+
.is_api_response(true)
|
|
385
|
+
.local_error('401',
|
|
386
|
+
'401',
|
|
387
|
+
APIException)
|
|
388
|
+
.local_error('403',
|
|
389
|
+
'403',
|
|
390
|
+
NeedMasterApiKeyException)
|
|
391
|
+
.local_error('422',
|
|
392
|
+
'422',
|
|
393
|
+
APIException)
|
|
394
|
+
.local_error('429',
|
|
395
|
+
'429',
|
|
396
|
+
Accounts429ErrorException))
|
|
397
|
+
.execute
|
|
398
|
+
end
|
|
399
|
+
end
|
|
400
|
+
end
|