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,269 @@
|
|
|
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
|
+
# ContactsRequest Model.
|
|
8
|
+
class ContactsRequest < BaseModel
|
|
9
|
+
SKIP = Object.new
|
|
10
|
+
private_constant :SKIP
|
|
11
|
+
|
|
12
|
+
# The first name of the contact you want to create. Example: `Tim`
|
|
13
|
+
# @return [String]
|
|
14
|
+
attr_accessor :first_name
|
|
15
|
+
|
|
16
|
+
# The last name of the contact you want to create. Example: `Zheng`
|
|
17
|
+
# @return [String]
|
|
18
|
+
attr_accessor :last_name
|
|
19
|
+
|
|
20
|
+
# The name of the contact's employer (company). Example: `apollo`
|
|
21
|
+
# @return [String]
|
|
22
|
+
attr_accessor :organization_name
|
|
23
|
+
|
|
24
|
+
# The current job title that the contact holds. Example: `senior research
|
|
25
|
+
# analyst`
|
|
26
|
+
# @return [String]
|
|
27
|
+
attr_accessor :title
|
|
28
|
+
|
|
29
|
+
# The Apollo ID for the account. Example: `63f53afe4ceeca00016bdd2f`
|
|
30
|
+
# @return [String]
|
|
31
|
+
attr_accessor :account_id
|
|
32
|
+
|
|
33
|
+
# The email address of the contact. Example: `example@email.com`
|
|
34
|
+
# @return [String]
|
|
35
|
+
attr_accessor :email
|
|
36
|
+
|
|
37
|
+
# The corporate website URL. Example: `https://www.apollo.io/`
|
|
38
|
+
# @return [String]
|
|
39
|
+
attr_accessor :website_url
|
|
40
|
+
|
|
41
|
+
# Lists to which the contact belongs.
|
|
42
|
+
# @return [Array[String]]
|
|
43
|
+
attr_accessor :label_names
|
|
44
|
+
|
|
45
|
+
# The Apollo ID for the contact stage. Example: `6095a710bd01d100a506d4ae`
|
|
46
|
+
# @return [String]
|
|
47
|
+
attr_accessor :contact_stage_id
|
|
48
|
+
|
|
49
|
+
# The personal location for the contact. Example: `Atlanta, United States`
|
|
50
|
+
# @return [String]
|
|
51
|
+
attr_accessor :present_raw_address
|
|
52
|
+
|
|
53
|
+
# The primary phone number. Example: `555-555-0133`
|
|
54
|
+
# @return [String]
|
|
55
|
+
attr_accessor :direct_phone
|
|
56
|
+
|
|
57
|
+
# The work/office phone number. Example: `+44 7700 900852`
|
|
58
|
+
# @return [String]
|
|
59
|
+
attr_accessor :corporate_phone
|
|
60
|
+
|
|
61
|
+
# The mobile phone number. Example: `555-555-0133`
|
|
62
|
+
# @return [String]
|
|
63
|
+
attr_accessor :mobile_phone
|
|
64
|
+
|
|
65
|
+
# The home phone number. Example: `555-555-0133`
|
|
66
|
+
# @return [String]
|
|
67
|
+
attr_accessor :home_phone
|
|
68
|
+
|
|
69
|
+
# Alternative phone number. Example: `555-555-0133`
|
|
70
|
+
# @return [String]
|
|
71
|
+
attr_accessor :other_phone
|
|
72
|
+
|
|
73
|
+
# Add information to <a
|
|
74
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/4412498825869-Create-C
|
|
75
|
+
# ustom-Contact-Fields" target="_blank">custom fields</a> in Apollo.
|
|
76
|
+
# <br><br><b>Your custom fields are unique to your team's Apollo account.
|
|
77
|
+
# This means that the examples in this documentation may not work for your
|
|
78
|
+
# testing purposes.</b> <br><br>To utilize this parameter successfully, call
|
|
79
|
+
# the <a
|
|
80
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
|
|
81
|
+
# t a List of All Custom Fields</a> endpoint and identify the `id` value for
|
|
82
|
+
# the custom field, as well as the appropriate data type. For example, if a
|
|
83
|
+
# custom field accepts picklist entries, you need to pass the accompanying
|
|
84
|
+
# `id` value for the picklist entry that you want to use as the input value.
|
|
85
|
+
# <br><br><b>Example</b>: When the <a
|
|
86
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
|
|
87
|
+
# t a List of All Custom Fields</a> endpoint returns an `id` of field:
|
|
88
|
+
# * `"60c39ed82bd02f01154c470a"` (datetime)
|
|
89
|
+
#
|
|
90
|
+
# then the value passed should be:
|
|
91
|
+
# `{"60c39ed82bd02f01154c470a": "2025-08-07"}`
|
|
92
|
+
# @return [Hash[String, String]]
|
|
93
|
+
attr_accessor :typed_custom_fields
|
|
94
|
+
|
|
95
|
+
# Set to `true` to enable deduplication logic that prevents creating
|
|
96
|
+
# duplicate contacts. When enabled, Apollo will check for existing contacts
|
|
97
|
+
# with matching email addresses, names, or other identifying information and
|
|
98
|
+
# return the existing contact instead of creating a duplicate. The default
|
|
99
|
+
# value is `false`. <br><br>When deduplication is enabled, performance may
|
|
100
|
+
# be slightly impacted due to the additional validation checks, but this
|
|
101
|
+
# ensures data integrity and prevents duplicate entries in your database.
|
|
102
|
+
# @return [TrueClass | FalseClass]
|
|
103
|
+
attr_accessor :run_dedupe
|
|
104
|
+
|
|
105
|
+
# A mapping from model property names to API property names.
|
|
106
|
+
def self.names
|
|
107
|
+
@_hash = {} if @_hash.nil?
|
|
108
|
+
@_hash['first_name'] = 'first_name'
|
|
109
|
+
@_hash['last_name'] = 'last_name'
|
|
110
|
+
@_hash['organization_name'] = 'organization_name'
|
|
111
|
+
@_hash['title'] = 'title'
|
|
112
|
+
@_hash['account_id'] = 'account_id'
|
|
113
|
+
@_hash['email'] = 'email'
|
|
114
|
+
@_hash['website_url'] = 'website_url'
|
|
115
|
+
@_hash['label_names'] = 'label_names'
|
|
116
|
+
@_hash['contact_stage_id'] = 'contact_stage_id'
|
|
117
|
+
@_hash['present_raw_address'] = 'present_raw_address'
|
|
118
|
+
@_hash['direct_phone'] = 'direct_phone'
|
|
119
|
+
@_hash['corporate_phone'] = 'corporate_phone'
|
|
120
|
+
@_hash['mobile_phone'] = 'mobile_phone'
|
|
121
|
+
@_hash['home_phone'] = 'home_phone'
|
|
122
|
+
@_hash['other_phone'] = 'other_phone'
|
|
123
|
+
@_hash['typed_custom_fields'] = 'typed_custom_fields'
|
|
124
|
+
@_hash['run_dedupe'] = 'run_dedupe'
|
|
125
|
+
@_hash
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# An array for optional fields
|
|
129
|
+
def self.optionals
|
|
130
|
+
%w[
|
|
131
|
+
first_name
|
|
132
|
+
last_name
|
|
133
|
+
organization_name
|
|
134
|
+
title
|
|
135
|
+
account_id
|
|
136
|
+
email
|
|
137
|
+
website_url
|
|
138
|
+
label_names
|
|
139
|
+
contact_stage_id
|
|
140
|
+
present_raw_address
|
|
141
|
+
direct_phone
|
|
142
|
+
corporate_phone
|
|
143
|
+
mobile_phone
|
|
144
|
+
home_phone
|
|
145
|
+
other_phone
|
|
146
|
+
typed_custom_fields
|
|
147
|
+
run_dedupe
|
|
148
|
+
]
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# An array for nullable fields
|
|
152
|
+
def self.nullables
|
|
153
|
+
[]
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
def initialize(first_name: SKIP, last_name: SKIP, organization_name: SKIP,
|
|
157
|
+
title: SKIP, account_id: SKIP, email: SKIP,
|
|
158
|
+
website_url: SKIP, label_names: SKIP, contact_stage_id: SKIP,
|
|
159
|
+
present_raw_address: SKIP, direct_phone: SKIP,
|
|
160
|
+
corporate_phone: SKIP, mobile_phone: SKIP, home_phone: SKIP,
|
|
161
|
+
other_phone: SKIP, typed_custom_fields: SKIP,
|
|
162
|
+
run_dedupe: false, additional_properties: nil)
|
|
163
|
+
# Add additional model properties to the instance
|
|
164
|
+
additional_properties = {} if additional_properties.nil?
|
|
165
|
+
|
|
166
|
+
@first_name = first_name unless first_name == SKIP
|
|
167
|
+
@last_name = last_name unless last_name == SKIP
|
|
168
|
+
@organization_name = organization_name unless organization_name == SKIP
|
|
169
|
+
@title = title unless title == SKIP
|
|
170
|
+
@account_id = account_id unless account_id == SKIP
|
|
171
|
+
@email = email unless email == SKIP
|
|
172
|
+
@website_url = website_url unless website_url == SKIP
|
|
173
|
+
@label_names = label_names unless label_names == SKIP
|
|
174
|
+
@contact_stage_id = contact_stage_id unless contact_stage_id == SKIP
|
|
175
|
+
@present_raw_address = present_raw_address unless present_raw_address == SKIP
|
|
176
|
+
@direct_phone = direct_phone unless direct_phone == SKIP
|
|
177
|
+
@corporate_phone = corporate_phone unless corporate_phone == SKIP
|
|
178
|
+
@mobile_phone = mobile_phone unless mobile_phone == SKIP
|
|
179
|
+
@home_phone = home_phone unless home_phone == SKIP
|
|
180
|
+
@other_phone = other_phone unless other_phone == SKIP
|
|
181
|
+
@typed_custom_fields = typed_custom_fields unless typed_custom_fields == SKIP
|
|
182
|
+
@run_dedupe = run_dedupe unless run_dedupe == SKIP
|
|
183
|
+
@additional_properties = additional_properties
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# Creates an instance of the object from a hash.
|
|
187
|
+
def self.from_hash(hash)
|
|
188
|
+
return nil unless hash
|
|
189
|
+
|
|
190
|
+
# Extract variables from the hash.
|
|
191
|
+
first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
|
|
192
|
+
last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
|
|
193
|
+
organization_name =
|
|
194
|
+
hash.key?('organization_name') ? hash['organization_name'] : SKIP
|
|
195
|
+
title = hash.key?('title') ? hash['title'] : SKIP
|
|
196
|
+
account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
|
|
197
|
+
email = hash.key?('email') ? hash['email'] : SKIP
|
|
198
|
+
website_url = hash.key?('website_url') ? hash['website_url'] : SKIP
|
|
199
|
+
label_names = hash.key?('label_names') ? hash['label_names'] : SKIP
|
|
200
|
+
contact_stage_id =
|
|
201
|
+
hash.key?('contact_stage_id') ? hash['contact_stage_id'] : SKIP
|
|
202
|
+
present_raw_address =
|
|
203
|
+
hash.key?('present_raw_address') ? hash['present_raw_address'] : SKIP
|
|
204
|
+
direct_phone = hash.key?('direct_phone') ? hash['direct_phone'] : SKIP
|
|
205
|
+
corporate_phone =
|
|
206
|
+
hash.key?('corporate_phone') ? hash['corporate_phone'] : SKIP
|
|
207
|
+
mobile_phone = hash.key?('mobile_phone') ? hash['mobile_phone'] : SKIP
|
|
208
|
+
home_phone = hash.key?('home_phone') ? hash['home_phone'] : SKIP
|
|
209
|
+
other_phone = hash.key?('other_phone') ? hash['other_phone'] : SKIP
|
|
210
|
+
typed_custom_fields =
|
|
211
|
+
hash.key?('typed_custom_fields') ? hash['typed_custom_fields'] : SKIP
|
|
212
|
+
run_dedupe = hash['run_dedupe'] ||= false
|
|
213
|
+
|
|
214
|
+
# Create a new hash for additional properties, removing known properties.
|
|
215
|
+
new_hash = hash.reject { |k, _| names.value?(k) }
|
|
216
|
+
|
|
217
|
+
additional_properties = APIHelper.get_additional_properties(
|
|
218
|
+
new_hash, proc { |value| value }
|
|
219
|
+
)
|
|
220
|
+
|
|
221
|
+
# Create object from extracted values.
|
|
222
|
+
ContactsRequest.new(first_name: first_name,
|
|
223
|
+
last_name: last_name,
|
|
224
|
+
organization_name: organization_name,
|
|
225
|
+
title: title,
|
|
226
|
+
account_id: account_id,
|
|
227
|
+
email: email,
|
|
228
|
+
website_url: website_url,
|
|
229
|
+
label_names: label_names,
|
|
230
|
+
contact_stage_id: contact_stage_id,
|
|
231
|
+
present_raw_address: present_raw_address,
|
|
232
|
+
direct_phone: direct_phone,
|
|
233
|
+
corporate_phone: corporate_phone,
|
|
234
|
+
mobile_phone: mobile_phone,
|
|
235
|
+
home_phone: home_phone,
|
|
236
|
+
other_phone: other_phone,
|
|
237
|
+
typed_custom_fields: typed_custom_fields,
|
|
238
|
+
run_dedupe: run_dedupe,
|
|
239
|
+
additional_properties: additional_properties)
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# Provides a human-readable string representation of the object.
|
|
243
|
+
def to_s
|
|
244
|
+
class_name = self.class.name.split('::').last
|
|
245
|
+
"<#{class_name} first_name: #{@first_name}, last_name: #{@last_name}, organization_name:"\
|
|
246
|
+
" #{@organization_name}, title: #{@title}, account_id: #{@account_id}, email: #{@email},"\
|
|
247
|
+
" website_url: #{@website_url}, label_names: #{@label_names}, contact_stage_id:"\
|
|
248
|
+
" #{@contact_stage_id}, present_raw_address: #{@present_raw_address}, direct_phone:"\
|
|
249
|
+
" #{@direct_phone}, corporate_phone: #{@corporate_phone}, mobile_phone: #{@mobile_phone},"\
|
|
250
|
+
" home_phone: #{@home_phone}, other_phone: #{@other_phone}, typed_custom_fields:"\
|
|
251
|
+
" #{@typed_custom_fields}, run_dedupe: #{@run_dedupe}, additional_properties:"\
|
|
252
|
+
" #{@additional_properties}>"
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# Provides a debugging-friendly string with detailed object information.
|
|
256
|
+
def inspect
|
|
257
|
+
class_name = self.class.name.split('::').last
|
|
258
|
+
"<#{class_name} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
|
|
259
|
+
" organization_name: #{@organization_name.inspect}, title: #{@title.inspect}, account_id:"\
|
|
260
|
+
" #{@account_id.inspect}, email: #{@email.inspect}, website_url: #{@website_url.inspect},"\
|
|
261
|
+
" label_names: #{@label_names.inspect}, contact_stage_id: #{@contact_stage_id.inspect},"\
|
|
262
|
+
" present_raw_address: #{@present_raw_address.inspect}, direct_phone:"\
|
|
263
|
+
" #{@direct_phone.inspect}, corporate_phone: #{@corporate_phone.inspect}, mobile_phone:"\
|
|
264
|
+
" #{@mobile_phone.inspect}, home_phone: #{@home_phone.inspect}, other_phone:"\
|
|
265
|
+
" #{@other_phone.inspect}, typed_custom_fields: #{@typed_custom_fields.inspect}, run_dedupe:"\
|
|
266
|
+
" #{@run_dedupe.inspect}, additional_properties: #{@additional_properties}>"
|
|
267
|
+
end
|
|
268
|
+
end
|
|
269
|
+
end
|
|
@@ -0,0 +1,253 @@
|
|
|
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
|
+
# ContactsRequest1 Model.
|
|
8
|
+
class ContactsRequest1 < BaseModel
|
|
9
|
+
SKIP = Object.new
|
|
10
|
+
private_constant :SKIP
|
|
11
|
+
|
|
12
|
+
# Update the contact's first name. Example: `Tim`
|
|
13
|
+
# @return [String]
|
|
14
|
+
attr_accessor :first_name
|
|
15
|
+
|
|
16
|
+
# Update the contact's last name. Example: `Zheng`
|
|
17
|
+
# @return [String]
|
|
18
|
+
attr_accessor :last_name
|
|
19
|
+
|
|
20
|
+
# Update the employer (company) name. Example: `apollo`
|
|
21
|
+
# @return [String]
|
|
22
|
+
attr_accessor :organization_name
|
|
23
|
+
|
|
24
|
+
# Update the job title. Example: `senior research analyst`
|
|
25
|
+
# @return [String]
|
|
26
|
+
attr_accessor :title
|
|
27
|
+
|
|
28
|
+
# Update the account ID. Example: `63f53afe4ceeca00016bdd2f`
|
|
29
|
+
# @return [String]
|
|
30
|
+
attr_accessor :account_id
|
|
31
|
+
|
|
32
|
+
# Update the contact email. Example: `example@email.com`
|
|
33
|
+
# @return [String]
|
|
34
|
+
attr_accessor :email
|
|
35
|
+
|
|
36
|
+
# Update the employer website URL. Example: `https://www.apollo.io/`
|
|
37
|
+
# @return [String]
|
|
38
|
+
attr_accessor :website_url
|
|
39
|
+
|
|
40
|
+
# Replace lists this contact belongs to. (Passing new values will overwrite
|
|
41
|
+
# existing lists.)
|
|
42
|
+
# @return [Array[String]]
|
|
43
|
+
attr_accessor :label_names
|
|
44
|
+
|
|
45
|
+
# Update the contact stage ID. Example: `6095a710bd01d100a506d4af`
|
|
46
|
+
# @return [String]
|
|
47
|
+
attr_accessor :contact_stage_id
|
|
48
|
+
|
|
49
|
+
# Update location (city/state/country). Example: `Atlanta, United States`
|
|
50
|
+
# @return [String]
|
|
51
|
+
attr_accessor :present_raw_address
|
|
52
|
+
|
|
53
|
+
# Primary phone.
|
|
54
|
+
# @return [String]
|
|
55
|
+
attr_accessor :direct_phone
|
|
56
|
+
|
|
57
|
+
# Work/office phone.
|
|
58
|
+
# @return [String]
|
|
59
|
+
attr_accessor :corporate_phone
|
|
60
|
+
|
|
61
|
+
# Mobile phone.
|
|
62
|
+
# @return [String]
|
|
63
|
+
attr_accessor :mobile_phone
|
|
64
|
+
|
|
65
|
+
# Home phone.
|
|
66
|
+
# @return [String]
|
|
67
|
+
attr_accessor :home_phone
|
|
68
|
+
|
|
69
|
+
# Alternate phone.
|
|
70
|
+
# @return [String]
|
|
71
|
+
attr_accessor :other_phone
|
|
72
|
+
|
|
73
|
+
# Add information to <a
|
|
74
|
+
# href="https://knowledge.apollo.io/hc/en-us/articles/4412498825869-Create-C
|
|
75
|
+
# ustom-Contact-Fields" target="_blank">custom fields</a> in Apollo.
|
|
76
|
+
# <br><br><b>Your custom fields are unique to your team's Apollo account.
|
|
77
|
+
# This means that the examples in this documentation may not work for your
|
|
78
|
+
# testing purposes.</b> <br><br>To utilize this parameter successfully, call
|
|
79
|
+
# the <a
|
|
80
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
|
|
81
|
+
# t a List of All Custom Fields</a> endpoint and identify the `id` value for
|
|
82
|
+
# the custom field, as well as the appropriate data type. For example, if a
|
|
83
|
+
# custom field accepts picklist entries, you need to pass the accompanying
|
|
84
|
+
# `id` value for the picklist entry that you want to use as the input value.
|
|
85
|
+
# <br><br><b>Example</b>: When the <a
|
|
86
|
+
# href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
|
|
87
|
+
# t a List of All Custom Fields</a> endpoint returns an `id` of field:
|
|
88
|
+
# * `"60c39ed82bd02f01154c470a"` (datetime)
|
|
89
|
+
#
|
|
90
|
+
# then the value passed should be:
|
|
91
|
+
# `{"60c39ed82bd02f01154c470a": "2025-08-07"}`
|
|
92
|
+
# @return [Hash[String, String]]
|
|
93
|
+
attr_accessor :typed_custom_fields
|
|
94
|
+
|
|
95
|
+
# A mapping from model property names to API property names.
|
|
96
|
+
def self.names
|
|
97
|
+
@_hash = {} if @_hash.nil?
|
|
98
|
+
@_hash['first_name'] = 'first_name'
|
|
99
|
+
@_hash['last_name'] = 'last_name'
|
|
100
|
+
@_hash['organization_name'] = 'organization_name'
|
|
101
|
+
@_hash['title'] = 'title'
|
|
102
|
+
@_hash['account_id'] = 'account_id'
|
|
103
|
+
@_hash['email'] = 'email'
|
|
104
|
+
@_hash['website_url'] = 'website_url'
|
|
105
|
+
@_hash['label_names'] = 'label_names'
|
|
106
|
+
@_hash['contact_stage_id'] = 'contact_stage_id'
|
|
107
|
+
@_hash['present_raw_address'] = 'present_raw_address'
|
|
108
|
+
@_hash['direct_phone'] = 'direct_phone'
|
|
109
|
+
@_hash['corporate_phone'] = 'corporate_phone'
|
|
110
|
+
@_hash['mobile_phone'] = 'mobile_phone'
|
|
111
|
+
@_hash['home_phone'] = 'home_phone'
|
|
112
|
+
@_hash['other_phone'] = 'other_phone'
|
|
113
|
+
@_hash['typed_custom_fields'] = 'typed_custom_fields'
|
|
114
|
+
@_hash
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# An array for optional fields
|
|
118
|
+
def self.optionals
|
|
119
|
+
%w[
|
|
120
|
+
first_name
|
|
121
|
+
last_name
|
|
122
|
+
organization_name
|
|
123
|
+
title
|
|
124
|
+
account_id
|
|
125
|
+
email
|
|
126
|
+
website_url
|
|
127
|
+
label_names
|
|
128
|
+
contact_stage_id
|
|
129
|
+
present_raw_address
|
|
130
|
+
direct_phone
|
|
131
|
+
corporate_phone
|
|
132
|
+
mobile_phone
|
|
133
|
+
home_phone
|
|
134
|
+
other_phone
|
|
135
|
+
typed_custom_fields
|
|
136
|
+
]
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# An array for nullable fields
|
|
140
|
+
def self.nullables
|
|
141
|
+
[]
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
def initialize(first_name: SKIP, last_name: SKIP, organization_name: SKIP,
|
|
145
|
+
title: SKIP, account_id: SKIP, email: SKIP,
|
|
146
|
+
website_url: SKIP, label_names: SKIP, contact_stage_id: SKIP,
|
|
147
|
+
present_raw_address: SKIP, direct_phone: SKIP,
|
|
148
|
+
corporate_phone: SKIP, mobile_phone: SKIP, home_phone: SKIP,
|
|
149
|
+
other_phone: SKIP, typed_custom_fields: SKIP,
|
|
150
|
+
additional_properties: nil)
|
|
151
|
+
# Add additional model properties to the instance
|
|
152
|
+
additional_properties = {} if additional_properties.nil?
|
|
153
|
+
|
|
154
|
+
@first_name = first_name unless first_name == SKIP
|
|
155
|
+
@last_name = last_name unless last_name == SKIP
|
|
156
|
+
@organization_name = organization_name unless organization_name == SKIP
|
|
157
|
+
@title = title unless title == SKIP
|
|
158
|
+
@account_id = account_id unless account_id == SKIP
|
|
159
|
+
@email = email unless email == SKIP
|
|
160
|
+
@website_url = website_url unless website_url == SKIP
|
|
161
|
+
@label_names = label_names unless label_names == SKIP
|
|
162
|
+
@contact_stage_id = contact_stage_id unless contact_stage_id == SKIP
|
|
163
|
+
@present_raw_address = present_raw_address unless present_raw_address == SKIP
|
|
164
|
+
@direct_phone = direct_phone unless direct_phone == SKIP
|
|
165
|
+
@corporate_phone = corporate_phone unless corporate_phone == SKIP
|
|
166
|
+
@mobile_phone = mobile_phone unless mobile_phone == SKIP
|
|
167
|
+
@home_phone = home_phone unless home_phone == SKIP
|
|
168
|
+
@other_phone = other_phone unless other_phone == SKIP
|
|
169
|
+
@typed_custom_fields = typed_custom_fields unless typed_custom_fields == SKIP
|
|
170
|
+
@additional_properties = additional_properties
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Creates an instance of the object from a hash.
|
|
174
|
+
def self.from_hash(hash)
|
|
175
|
+
return nil unless hash
|
|
176
|
+
|
|
177
|
+
# Extract variables from the hash.
|
|
178
|
+
first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
|
|
179
|
+
last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
|
|
180
|
+
organization_name =
|
|
181
|
+
hash.key?('organization_name') ? hash['organization_name'] : SKIP
|
|
182
|
+
title = hash.key?('title') ? hash['title'] : SKIP
|
|
183
|
+
account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
|
|
184
|
+
email = hash.key?('email') ? hash['email'] : SKIP
|
|
185
|
+
website_url = hash.key?('website_url') ? hash['website_url'] : SKIP
|
|
186
|
+
label_names = hash.key?('label_names') ? hash['label_names'] : SKIP
|
|
187
|
+
contact_stage_id =
|
|
188
|
+
hash.key?('contact_stage_id') ? hash['contact_stage_id'] : SKIP
|
|
189
|
+
present_raw_address =
|
|
190
|
+
hash.key?('present_raw_address') ? hash['present_raw_address'] : SKIP
|
|
191
|
+
direct_phone = hash.key?('direct_phone') ? hash['direct_phone'] : SKIP
|
|
192
|
+
corporate_phone =
|
|
193
|
+
hash.key?('corporate_phone') ? hash['corporate_phone'] : SKIP
|
|
194
|
+
mobile_phone = hash.key?('mobile_phone') ? hash['mobile_phone'] : SKIP
|
|
195
|
+
home_phone = hash.key?('home_phone') ? hash['home_phone'] : SKIP
|
|
196
|
+
other_phone = hash.key?('other_phone') ? hash['other_phone'] : SKIP
|
|
197
|
+
typed_custom_fields =
|
|
198
|
+
hash.key?('typed_custom_fields') ? hash['typed_custom_fields'] : SKIP
|
|
199
|
+
|
|
200
|
+
# Create a new hash for additional properties, removing known properties.
|
|
201
|
+
new_hash = hash.reject { |k, _| names.value?(k) }
|
|
202
|
+
|
|
203
|
+
additional_properties = APIHelper.get_additional_properties(
|
|
204
|
+
new_hash, proc { |value| value }
|
|
205
|
+
)
|
|
206
|
+
|
|
207
|
+
# Create object from extracted values.
|
|
208
|
+
ContactsRequest1.new(first_name: first_name,
|
|
209
|
+
last_name: last_name,
|
|
210
|
+
organization_name: organization_name,
|
|
211
|
+
title: title,
|
|
212
|
+
account_id: account_id,
|
|
213
|
+
email: email,
|
|
214
|
+
website_url: website_url,
|
|
215
|
+
label_names: label_names,
|
|
216
|
+
contact_stage_id: contact_stage_id,
|
|
217
|
+
present_raw_address: present_raw_address,
|
|
218
|
+
direct_phone: direct_phone,
|
|
219
|
+
corporate_phone: corporate_phone,
|
|
220
|
+
mobile_phone: mobile_phone,
|
|
221
|
+
home_phone: home_phone,
|
|
222
|
+
other_phone: other_phone,
|
|
223
|
+
typed_custom_fields: typed_custom_fields,
|
|
224
|
+
additional_properties: additional_properties)
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
# Provides a human-readable string representation of the object.
|
|
228
|
+
def to_s
|
|
229
|
+
class_name = self.class.name.split('::').last
|
|
230
|
+
"<#{class_name} first_name: #{@first_name}, last_name: #{@last_name}, organization_name:"\
|
|
231
|
+
" #{@organization_name}, title: #{@title}, account_id: #{@account_id}, email: #{@email},"\
|
|
232
|
+
" website_url: #{@website_url}, label_names: #{@label_names}, contact_stage_id:"\
|
|
233
|
+
" #{@contact_stage_id}, present_raw_address: #{@present_raw_address}, direct_phone:"\
|
|
234
|
+
" #{@direct_phone}, corporate_phone: #{@corporate_phone}, mobile_phone: #{@mobile_phone},"\
|
|
235
|
+
" home_phone: #{@home_phone}, other_phone: #{@other_phone}, typed_custom_fields:"\
|
|
236
|
+
" #{@typed_custom_fields}, additional_properties: #{@additional_properties}>"
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
# Provides a debugging-friendly string with detailed object information.
|
|
240
|
+
def inspect
|
|
241
|
+
class_name = self.class.name.split('::').last
|
|
242
|
+
"<#{class_name} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
|
|
243
|
+
" organization_name: #{@organization_name.inspect}, title: #{@title.inspect}, account_id:"\
|
|
244
|
+
" #{@account_id.inspect}, email: #{@email.inspect}, website_url: #{@website_url.inspect},"\
|
|
245
|
+
" label_names: #{@label_names.inspect}, contact_stage_id: #{@contact_stage_id.inspect},"\
|
|
246
|
+
" present_raw_address: #{@present_raw_address.inspect}, direct_phone:"\
|
|
247
|
+
" #{@direct_phone.inspect}, corporate_phone: #{@corporate_phone.inspect}, mobile_phone:"\
|
|
248
|
+
" #{@mobile_phone.inspect}, home_phone: #{@home_phone.inspect}, other_phone:"\
|
|
249
|
+
" #{@other_phone.inspect}, typed_custom_fields: #{@typed_custom_fields.inspect},"\
|
|
250
|
+
" additional_properties: #{@additional_properties}>"
|
|
251
|
+
end
|
|
252
|
+
end
|
|
253
|
+
end
|
|
@@ -0,0 +1,94 @@
|
|
|
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
|
+
# ContactsResponse Model.
|
|
8
|
+
class ContactsResponse < BaseModel
|
|
9
|
+
SKIP = Object.new
|
|
10
|
+
private_constant :SKIP
|
|
11
|
+
|
|
12
|
+
# TODO: Write general description for this method
|
|
13
|
+
# @return [Contact1]
|
|
14
|
+
attr_accessor :contact
|
|
15
|
+
|
|
16
|
+
# TODO: Write general description for this method
|
|
17
|
+
# @return [Array[Label]]
|
|
18
|
+
attr_accessor :labels
|
|
19
|
+
|
|
20
|
+
# A mapping from model property names to API property names.
|
|
21
|
+
def self.names
|
|
22
|
+
@_hash = {} if @_hash.nil?
|
|
23
|
+
@_hash['contact'] = 'contact'
|
|
24
|
+
@_hash['labels'] = 'labels'
|
|
25
|
+
@_hash
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# An array for optional fields
|
|
29
|
+
def self.optionals
|
|
30
|
+
%w[
|
|
31
|
+
contact
|
|
32
|
+
labels
|
|
33
|
+
]
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# An array for nullable fields
|
|
37
|
+
def self.nullables
|
|
38
|
+
[]
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def initialize(contact: SKIP, labels: SKIP, additional_properties: nil)
|
|
42
|
+
# Add additional model properties to the instance
|
|
43
|
+
additional_properties = {} if additional_properties.nil?
|
|
44
|
+
|
|
45
|
+
@contact = contact unless contact == SKIP
|
|
46
|
+
@labels = labels unless labels == SKIP
|
|
47
|
+
@additional_properties = additional_properties
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Creates an instance of the object from a hash.
|
|
51
|
+
def self.from_hash(hash)
|
|
52
|
+
return nil unless hash
|
|
53
|
+
|
|
54
|
+
# Extract variables from the hash.
|
|
55
|
+
contact = Contact1.from_hash(hash['contact']) if hash['contact']
|
|
56
|
+
# Parameter is an array, so we need to iterate through it
|
|
57
|
+
labels = nil
|
|
58
|
+
unless hash['labels'].nil?
|
|
59
|
+
labels = []
|
|
60
|
+
hash['labels'].each do |structure|
|
|
61
|
+
labels << (Label.from_hash(structure) if structure)
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
labels = SKIP unless hash.key?('labels')
|
|
66
|
+
|
|
67
|
+
# Create a new hash for additional properties, removing known properties.
|
|
68
|
+
new_hash = hash.reject { |k, _| names.value?(k) }
|
|
69
|
+
|
|
70
|
+
additional_properties = APIHelper.get_additional_properties(
|
|
71
|
+
new_hash, proc { |value| value }
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
# Create object from extracted values.
|
|
75
|
+
ContactsResponse.new(contact: contact,
|
|
76
|
+
labels: labels,
|
|
77
|
+
additional_properties: additional_properties)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Provides a human-readable string representation of the object.
|
|
81
|
+
def to_s
|
|
82
|
+
class_name = self.class.name.split('::').last
|
|
83
|
+
"<#{class_name} contact: #{@contact}, labels: #{@labels}, additional_properties:"\
|
|
84
|
+
" #{@additional_properties}>"
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Provides a debugging-friendly string with detailed object information.
|
|
88
|
+
def inspect
|
|
89
|
+
class_name = self.class.name.split('::').last
|
|
90
|
+
"<#{class_name} contact: #{@contact.inspect}, labels: #{@labels.inspect},"\
|
|
91
|
+
" additional_properties: #{@additional_properties}>"
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
end
|