constant_contact_client 1.0.0
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/CHANGELOG.md +56 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +72 -0
- data/LICENSE +29 -0
- data/README.md +201 -0
- data/Rakefile +10 -0
- data/constant_contact_client.gemspec +39 -0
- data/docs/AccountServicesApi.md +593 -0
- data/docs/BulkActivitiesApi.md +1035 -0
- data/docs/ContactListsApi.md +461 -0
- data/docs/ContactTagsApi.md +382 -0
- data/docs/ContactsApi.md +701 -0
- data/docs/ContactsCustomFieldsApi.md +375 -0
- data/docs/ContactsReportingApi.md +244 -0
- data/docs/EmailCampaignsABTestsApi.md +227 -0
- data/docs/EmailCampaignsApi.md +826 -0
- data/docs/EmailReportingApi.md +925 -0
- data/docs/EmailSchedulingApi.md +447 -0
- data/docs/LandingPagesReportingApi.md +481 -0
- data/docs/SegmentsApi.md +452 -0
- data/lib/constant_contact_client/api/account_services_api.rb +546 -0
- data/lib/constant_contact_client/api/bulk_activities_api.rb +983 -0
- data/lib/constant_contact_client/api/contact_lists_api.rb +449 -0
- data/lib/constant_contact_client/api/contact_tags_api.rb +356 -0
- data/lib/constant_contact_client/api/contacts_api.rb +676 -0
- data/lib/constant_contact_client/api/contacts_custom_fields_api.rb +356 -0
- data/lib/constant_contact_client/api/contacts_reporting_api.rb +255 -0
- data/lib/constant_contact_client/api/email_campaigns_ab_tests_api.rb +220 -0
- data/lib/constant_contact_client/api/email_campaigns_api.rb +766 -0
- data/lib/constant_contact_client/api/email_reporting_api.rb +812 -0
- data/lib/constant_contact_client/api/email_scheduling_api.rb +418 -0
- data/lib/constant_contact_client/api/landing_pages_reporting_api.rb +436 -0
- data/lib/constant_contact_client/api/segments_api.rb +425 -0
- data/lib/constant_contact_client/api_client.rb +394 -0
- data/lib/constant_contact_client/api_error.rb +58 -0
- data/lib/constant_contact_client/configuration.rb +305 -0
- data/lib/constant_contact_client/models/ab_test_data.rb +256 -0
- data/lib/constant_contact_client/models/access_token_response.rb +265 -0
- data/lib/constant_contact_client/models/account_cancellation.rb +226 -0
- data/lib/constant_contact_client/models/account_email_create_response.rb +273 -0
- data/lib/constant_contact_client/models/account_email_input.rb +234 -0
- data/lib/constant_contact_client/models/account_physical_address.rb +409 -0
- data/lib/constant_contact_client/models/account_suspension.rb +289 -0
- data/lib/constant_contact_client/models/activities.rb +226 -0
- data/lib/constant_contact_client/models/activity.rb +316 -0
- data/lib/constant_contact_client/models/activity_delete_custom_fields.rb +297 -0
- data/lib/constant_contact_client/models/activity_delete_list_response.rb +276 -0
- data/lib/constant_contact_client/models/activity_delete_lists_response.rb +305 -0
- data/lib/constant_contact_client/models/activity_delete_status.rb +306 -0
- data/lib/constant_contact_client/models/activity_errors.rb +215 -0
- data/lib/constant_contact_client/models/activity_export_status.rb +306 -0
- data/lib/constant_contact_client/models/activity_generic.rb +299 -0
- data/lib/constant_contact_client/models/activity_generic_status.rb +225 -0
- data/lib/constant_contact_client/models/activity_import.rb +316 -0
- data/lib/constant_contact_client/models/activity_links.rb +223 -0
- data/lib/constant_contact_client/models/activity_lists_membership.rb +305 -0
- data/lib/constant_contact_client/models/activity_reference.rb +225 -0
- data/lib/constant_contact_client/models/activity_status.rb +275 -0
- data/lib/constant_contact_client/models/activity_status_export_link.rb +223 -0
- data/lib/constant_contact_client/models/activity_status_link.rb +214 -0
- data/lib/constant_contact_client/models/activity_tagging.rb +319 -0
- data/lib/constant_contact_client/models/activity_tagging_status.rb +226 -0
- data/lib/constant_contact_client/models/add_account_email_address201_response.rb +273 -0
- data/lib/constant_contact_client/models/add_account_email_address_request.rb +234 -0
- data/lib/constant_contact_client/models/api_error_schema_inner.rb +225 -0
- data/lib/constant_contact_client/models/authorization_error_schema.rb +225 -0
- data/lib/constant_contact_client/models/bounces_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/bounces_tracking_activity.rb +347 -0
- data/lib/constant_contact_client/models/bulk_email_campaign_summaries_page.rb +249 -0
- data/lib/constant_contact_client/models/bulk_email_campaign_summaries_percents.rb +255 -0
- data/lib/constant_contact_client/models/bulk_email_campaign_summary.rb +272 -0
- data/lib/constant_contact_client/models/campaign_activity_stats_query_result_email.rb +229 -0
- data/lib/constant_contact_client/models/campaign_activity_stats_result_generic_stats_email_activity.rb +244 -0
- data/lib/constant_contact_client/models/campaign_activity_summary.rb +341 -0
- data/lib/constant_contact_client/models/campaign_stats_query_result_email.rb +229 -0
- data/lib/constant_contact_client/models/campaign_stats_result_generic_stats_email_percents_email.rb +243 -0
- data/lib/constant_contact_client/models/clicks_tracking_activities_page.rb +233 -0
- data/lib/constant_contact_client/models/clicks_tracking_activity.rb +364 -0
- data/lib/constant_contact_client/models/company_logo.rb +235 -0
- data/lib/constant_contact_client/models/contact_campaign_activities_summary.rb +250 -0
- data/lib/constant_contact_client/models/contact_create_or_update_input.rb +503 -0
- data/lib/constant_contact_client/models/contact_create_or_update_response.rb +225 -0
- data/lib/constant_contact_client/models/contact_custom_field.rb +259 -0
- data/lib/constant_contact_client/models/contact_delete.rb +267 -0
- data/lib/constant_contact_client/models/contact_list.rb +301 -0
- data/lib/constant_contact_client/models/contact_list_array.rb +235 -0
- data/lib/constant_contact_client/models/contact_list_put_post.rb +291 -0
- data/lib/constant_contact_client/models/contact_open_and_click_rates.rb +274 -0
- data/lib/constant_contact_client/models/contact_post_request.rb +575 -0
- data/lib/constant_contact_client/models/contact_put_request.rb +582 -0
- data/lib/constant_contact_client/models/contact_resource.rb +635 -0
- data/lib/constant_contact_client/models/contact_tracking_activities_page.rb +227 -0
- data/lib/constant_contact_client/models/contact_tracking_activity.rb +270 -0
- data/lib/constant_contact_client/models/contact_xref.rb +226 -0
- data/lib/constant_contact_client/models/contact_xrefs.rb +236 -0
- data/lib/constant_contact_client/models/contacts.rb +246 -0
- data/lib/constant_contact_client/models/contacts_counts.rb +265 -0
- data/lib/constant_contact_client/models/contacts_export.rb +300 -0
- data/lib/constant_contact_client/models/contacts_json_import.rb +281 -0
- data/lib/constant_contact_client/models/create_contact_request.rb +575 -0
- data/lib/constant_contact_client/models/create_contact_request_email_address.rb +252 -0
- data/lib/constant_contact_client/models/create_csv_import_activity201_response.rb +316 -0
- data/lib/constant_contact_client/models/create_csv_import_activity201_response_links.rb +214 -0
- data/lib/constant_contact_client/models/create_csv_import_activity201_response_status.rb +255 -0
- data/lib/constant_contact_client/models/create_delete_activity201_response.rb +306 -0
- data/lib/constant_contact_client/models/create_delete_activity201_response_links.rb +214 -0
- data/lib/constant_contact_client/models/create_delete_activity201_response_links_self.rb +215 -0
- data/lib/constant_contact_client/models/create_delete_activity201_response_status.rb +235 -0
- data/lib/constant_contact_client/models/create_delete_activity_request.rb +267 -0
- data/lib/constant_contact_client/models/create_email_campaign200_response.rb +306 -0
- data/lib/constant_contact_client/models/create_email_campaign200_response_campaign_activities_inner.rb +225 -0
- data/lib/constant_contact_client/models/create_email_campaign_request.rb +260 -0
- data/lib/constant_contact_client/models/create_email_campaign_request_email_campaign_activities_inner.rb +402 -0
- data/lib/constant_contact_client/models/create_email_campaign_request_email_campaign_activities_inner_physical_address_in_footer.rb +347 -0
- data/lib/constant_contact_client/models/create_export_activity201_response.rb +306 -0
- data/lib/constant_contact_client/models/create_export_activity201_response_status.rb +225 -0
- data/lib/constant_contact_client/models/create_export_activity_request.rb +300 -0
- data/lib/constant_contact_client/models/create_import_json_activity_request.rb +281 -0
- data/lib/constant_contact_client/models/create_import_json_activity_request_import_data_inner.rb +1315 -0
- data/lib/constant_contact_client/models/create_list_add_activity_request.rb +268 -0
- data/lib/constant_contact_client/models/create_list_add_activity_request_exclude.rb +217 -0
- data/lib/constant_contact_client/models/create_list_add_activity_request_source.rb +331 -0
- data/lib/constant_contact_client/models/create_list_delete_activity201_response.rb +305 -0
- data/lib/constant_contact_client/models/create_list_delete_activity201_response_links.rb +214 -0
- data/lib/constant_contact_client/models/create_list_delete_activity201_response_links_self.rb +215 -0
- data/lib/constant_contact_client/models/create_list_delete_activity201_response_status.rb +215 -0
- data/lib/constant_contact_client/models/create_list_delete_activity_request.rb +243 -0
- data/lib/constant_contact_client/models/create_list_remove_activity201_response.rb +305 -0
- data/lib/constant_contact_client/models/create_list_remove_activity201_response_status.rb +235 -0
- data/lib/constant_contact_client/models/create_list_remove_activity_request.rb +268 -0
- data/lib/constant_contact_client/models/create_list_remove_activity_request_exclude.rb +217 -0
- data/lib/constant_contact_client/models/create_list_remove_activity_request_source.rb +321 -0
- data/lib/constant_contact_client/models/create_or_update_contact200_response.rb +225 -0
- data/lib/constant_contact_client/models/create_or_update_contact_custom_field.rb +244 -0
- data/lib/constant_contact_client/models/create_or_update_contact_request.rb +503 -0
- data/lib/constant_contact_client/models/create_or_update_contact_request_custom_fields_inner.rb +244 -0
- data/lib/constant_contact_client/models/create_or_update_contact_request_street_address.rb +367 -0
- data/lib/constant_contact_client/models/create_resend_email_campaign201_response.rb +255 -0
- data/lib/constant_contact_client/models/create_resend_email_campaign_request.rb +242 -0
- data/lib/constant_contact_client/models/create_segment201_response.rb +274 -0
- data/lib/constant_contact_client/models/create_segment_request.rb +258 -0
- data/lib/constant_contact_client/models/create_tag_delete_activity_request.rb +243 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response.rb +319 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links.rb +223 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links_results.rb +215 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links_self.rb +214 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_status.rb +226 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity_request.rb +268 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity_request_exclude.rb +218 -0
- data/lib/constant_contact_client/models/create_tag_remove_activity_request_source.rb +319 -0
- data/lib/constant_contact_client/models/cross_reference.rb +235 -0
- data/lib/constant_contact_client/models/cross_reference_response.rb +217 -0
- data/lib/constant_contact_client/models/custom_field_id100.rb +243 -0
- data/lib/constant_contact_client/models/custom_field_input.rb +258 -0
- data/lib/constant_contact_client/models/custom_field_resource.rb +318 -0
- data/lib/constant_contact_client/models/custom_fields.rb +245 -0
- data/lib/constant_contact_client/models/customer.rb +352 -0
- data/lib/constant_contact_client/models/customer_put.rb +334 -0
- data/lib/constant_contact_client/models/delete_list202_response.rb +276 -0
- data/lib/constant_contact_client/models/delete_tag202_response.rb +299 -0
- data/lib/constant_contact_client/models/delete_tag202_response_activity_errors_inner.rb +215 -0
- data/lib/constant_contact_client/models/delete_tag202_response_links.rb +214 -0
- data/lib/constant_contact_client/models/delete_tag202_response_links_self.rb +215 -0
- data/lib/constant_contact_client/models/delete_tag202_response_status.rb +225 -0
- data/lib/constant_contact_client/models/device_flow_response.rb +265 -0
- data/lib/constant_contact_client/models/did_not_opens_tracking_activities_page.rb +233 -0
- data/lib/constant_contact_client/models/did_not_opens_tracking_activity.rb +320 -0
- data/lib/constant_contact_client/models/email_address.rb +351 -0
- data/lib/constant_contact_client/models/email_address_post.rb +252 -0
- data/lib/constant_contact_client/models/email_address_put.rb +341 -0
- data/lib/constant_contact_client/models/email_campaign.rb +306 -0
- data/lib/constant_contact_client/models/email_campaign_activity.rb +405 -0
- data/lib/constant_contact_client/models/email_campaign_activity_input.rb +402 -0
- data/lib/constant_contact_client/models/email_campaign_activity_preview.rb +285 -0
- data/lib/constant_contact_client/models/email_campaign_complete.rb +260 -0
- data/lib/constant_contact_client/models/email_campaign_name.rb +241 -0
- data/lib/constant_contact_client/models/email_campaigns.rb +294 -0
- data/lib/constant_contact_client/models/email_link_click_count.rb +265 -0
- data/lib/constant_contact_client/models/email_links.rb +227 -0
- data/lib/constant_contact_client/models/email_physical_address.rb +346 -0
- data/lib/constant_contact_client/models/email_schedule_input.rb +222 -0
- data/lib/constant_contact_client/models/email_test_send_input.rb +253 -0
- data/lib/constant_contact_client/models/emails_link.rb +214 -0
- data/lib/constant_contact_client/models/emails_paging_links.rb +214 -0
- data/lib/constant_contact_client/models/file_object.rb +384 -0
- data/lib/constant_contact_client/models/file_status_array_inner.rb +235 -0
- data/lib/constant_contact_client/models/forwards_tracking_activities_page.rb +233 -0
- data/lib/constant_contact_client/models/forwards_tracking_activity.rb +320 -0
- data/lib/constant_contact_client/models/get_ab_test_email_campaign200_response.rb +256 -0
- data/lib/constant_contact_client/models/get_account_details200_response.rb +352 -0
- data/lib/constant_contact_client/models/get_account_details200_response_company_logo.rb +236 -0
- data/lib/constant_contact_client/models/get_account_details200_response_physical_address.rb +409 -0
- data/lib/constant_contact_client/models/get_activity_by_id200_response.rb +316 -0
- data/lib/constant_contact_client/models/get_all_account_email_addresses200_response_inner.rb +317 -0
- data/lib/constant_contact_client/models/get_all_activities200_response.rb +226 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner.rb +316 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links.rb +223 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links_results.rb +215 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links_self.rb +215 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_status.rb +275 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_links.rb +214 -0
- data/lib/constant_contact_client/models/get_all_activities200_response_links_next.rb +214 -0
- data/lib/constant_contact_client/models/get_all_contacts200_response.rb +246 -0
- data/lib/constant_contact_client/models/get_all_custom_fields200_response.rb +245 -0
- data/lib/constant_contact_client/models/get_all_email_campaigns200_response.rb +225 -0
- data/lib/constant_contact_client/models/get_all_email_campaigns200_response_campaigns_inner.rb +294 -0
- data/lib/constant_contact_client/models/get_all_email_campaigns200_response_links.rb +214 -0
- data/lib/constant_contact_client/models/get_all_lists200_response.rb +235 -0
- data/lib/constant_contact_client/models/get_all_segments200_response.rb +233 -0
- data/lib/constant_contact_client/models/get_all_segments200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_all_segments200_response_links_next.rb +223 -0
- data/lib/constant_contact_client/models/get_all_segments200_response_segments_inner.rb +245 -0
- data/lib/constant_contact_client/models/get_all_tags200_response.rb +226 -0
- data/lib/constant_contact_client/models/get_all_tags200_response_links.rb +215 -0
- data/lib/constant_contact_client/models/get_all_tags200_response_links_next.rb +224 -0
- data/lib/constant_contact_client/models/get_all_tags200_response_links_next_next.rb +223 -0
- data/lib/constant_contact_client/models/get_bounces_report200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_bounces_report200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_bounces_report200_response_tracking_activities_inner.rb +347 -0
- data/lib/constant_contact_client/models/get_campaign_activity_link_report200_response.rb +227 -0
- data/lib/constant_contact_client/models/get_campaign_activity_link_report200_response_link_click_counts_inner.rb +265 -0
- data/lib/constant_contact_client/models/get_clicks_report200_response.rb +233 -0
- data/lib/constant_contact_client/models/get_clicks_report200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_clicks_report200_response_tracking_activities_inner.rb +364 -0
- data/lib/constant_contact_client/models/get_contact_adds200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_contact_adds200_response_tracking_activities_inner.rb +329 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response.rb +635 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_custom_fields_inner.rb +259 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_email_address.rb +351 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_notes_inner.rb +255 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_phone_numbers_inner.rb +294 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_sms_channel.rb +278 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_sms_channel_sms_channel_consents_inner.rb +285 -0
- data/lib/constant_contact_client/models/get_contact_by_id200_response_street_addresses_inner.rb +397 -0
- data/lib/constant_contact_client/models/get_contact_counts200_response.rb +265 -0
- data/lib/constant_contact_client/models/get_contact_id_xrefs200_response.rb +236 -0
- data/lib/constant_contact_client/models/get_contact_id_xrefs200_response_xrefs_inner.rb +226 -0
- data/lib/constant_contact_client/models/get_contact_open_click_rate_report200_response.rb +274 -0
- data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response.rb +250 -0
- data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response_campaign_activities_inner.rb +341 -0
- data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response.rb +227 -0
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response_links_next.rb +223 -0
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response_tracking_activities_inner.rb +270 -0
- data/lib/constant_contact_client/models/get_custom_field200_response.rb +318 -0
- data/lib/constant_contact_client/models/get_did_not_opens_report200_response.rb +233 -0
- data/lib/constant_contact_client/models/get_did_not_opens_report200_response_tracking_activities_inner.rb +320 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity200_response.rb +405 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity200_response_document_properties.rb +520 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity200_response_physical_address_in_footer.rb +347 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity_preview200_response.rb +285 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response.rb +229 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response_results_inner.rb +244 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response_results_inner_stats.rb +476 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity_schedule200_response_inner.rb +215 -0
- data/lib/constant_contact_client/models/get_email_campaign_activity_send_history200_response_inner.rb +298 -0
- data/lib/constant_contact_client/models/get_email_campaign_report200_response.rb +249 -0
- data/lib/constant_contact_client/models/get_email_campaign_report200_response_aggregate_percents.rb +256 -0
- data/lib/constant_contact_client/models/get_email_campaign_report200_response_bulk_email_campaign_summaries_inner.rb +272 -0
- data/lib/constant_contact_client/models/get_email_campaign_report200_response_bulk_email_campaign_summaries_inner_unique_counts.rb +342 -0
- data/lib/constant_contact_client/models/get_email_campaign_xrefs200_response.rb +217 -0
- data/lib/constant_contact_client/models/get_email_campaign_xrefs200_response_xrefs_inner.rb +235 -0
- data/lib/constant_contact_client/models/get_email_opens_report200_response.rb +233 -0
- data/lib/constant_contact_client/models/get_email_opens_report200_response_tracking_activities_inner.rb +330 -0
- data/lib/constant_contact_client/models/get_email_sends_report200_response.rb +233 -0
- data/lib/constant_contact_client/models/get_email_sends_report200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_email_sends_report200_response_tracking_activities_inner.rb +320 -0
- data/lib/constant_contact_client/models/get_email_stats_report200_response.rb +229 -0
- data/lib/constant_contact_client/models/get_email_stats_report200_response_errors_inner.rb +225 -0
- data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner.rb +243 -0
- data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_percents.rb +296 -0
- data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb +396 -0
- data/lib/constant_contact_client/models/get_forwards_report200_response.rb +233 -0
- data/lib/constant_contact_client/models/get_forwards_report200_response_tracking_activities_inner.rb +320 -0
- data/lib/constant_contact_client/models/get_list200_response.rb +301 -0
- data/lib/constant_contact_client/models/get_list_id_xrefs200_response.rb +236 -0
- data/lib/constant_contact_client/models/get_list_id_xrefs200_response_xrefs_inner.rb +226 -0
- data/lib/constant_contact_client/models/get_optouts_report200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_optouts_report200_response_tracking_activities_inner.rb +330 -0
- data/lib/constant_contact_client/models/get_resend_email_campaign200_response_inner.rb +265 -0
- data/lib/constant_contact_client/models/get_sms_engagement_history200_response_inner.rb +255 -0
- data/lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb +316 -0
- data/lib/constant_contact_client/models/get_tag200_response.rb +265 -0
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_links.rb +222 -0
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_links_next.rb +223 -0
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_tracking_activities_inner.rb +366 -0
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_tracking_activities_inner_sms_channel.rb +246 -0
- data/lib/constant_contact_client/models/get_unique_contact_opens200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_unique_contact_opens200_response_tracking_activities_inner.rb +339 -0
- data/lib/constant_contact_client/models/get_unique_contact_sms_opt_ins200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_unique_contact_sms_opt_ins200_response_tracking_activities_inner.rb +329 -0
- data/lib/constant_contact_client/models/get_unique_contact_updates200_response.rb +240 -0
- data/lib/constant_contact_client/models/get_unique_contact_updates200_response_tracking_activities_inner.rb +329 -0
- data/lib/constant_contact_client/models/get_user_privileges200_response_inner.rb +225 -0
- data/lib/constant_contact_client/models/headers_object.rb +225 -0
- data/lib/constant_contact_client/models/history_details.rb +316 -0
- data/lib/constant_contact_client/models/json_import_contact.rb +1315 -0
- data/lib/constant_contact_client/models/link.rb +214 -0
- data/lib/constant_contact_client/models/links.rb +221 -0
- data/lib/constant_contact_client/models/list_activity_add_contacts.rb +268 -0
- data/lib/constant_contact_client/models/list_activity_remove_contacts.rb +268 -0
- data/lib/constant_contact_client/models/list_id_list100.rb +243 -0
- data/lib/constant_contact_client/models/list_input.rb +263 -0
- data/lib/constant_contact_client/models/list_xref.rb +226 -0
- data/lib/constant_contact_client/models/list_xrefs.rb +236 -0
- data/lib/constant_contact_client/models/lpreporting_links.rb +221 -0
- data/lib/constant_contact_client/models/lpreporting_next.rb +222 -0
- data/lib/constant_contact_client/models/model_next.rb +222 -0
- data/lib/constant_contact_client/models/my_library_file_collection_inner.rb +384 -0
- data/lib/constant_contact_client/models/my_library_file_collection_inner_thumbnail.rb +235 -0
- data/lib/constant_contact_client/models/note.rb +255 -0
- data/lib/constant_contact_client/models/o_auth_error.rb +223 -0
- data/lib/constant_contact_client/models/opens_tracking_activities_page.rb +233 -0
- data/lib/constant_contact_client/models/opens_tracking_activity.rb +330 -0
- data/lib/constant_contact_client/models/optouts_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/optouts_tracking_activity.rb +330 -0
- data/lib/constant_contact_client/models/p_contact_add_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/p_contact_add_tracking_activity.rb +329 -0
- data/lib/constant_contact_client/models/p_contact_click_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/p_contact_click_tracking_activity.rb +366 -0
- data/lib/constant_contact_client/models/p_contact_open_tracking_activity.rb +339 -0
- data/lib/constant_contact_client/models/p_contact_opens_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/p_contact_sms_opt_in_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/p_contact_sms_opt_in_tracking_activity.rb +329 -0
- data/lib/constant_contact_client/models/p_contact_update_tracking_activities_page.rb +240 -0
- data/lib/constant_contact_client/models/p_contact_update_tracking_activity.rb +329 -0
- data/lib/constant_contact_client/models/paged_email_campaign_response.rb +225 -0
- data/lib/constant_contact_client/models/pagination_links.rb +214 -0
- data/lib/constant_contact_client/models/pagination_links_next.rb +215 -0
- data/lib/constant_contact_client/models/paging_links.rb +214 -0
- data/lib/constant_contact_client/models/partner_account.rb +233 -0
- data/lib/constant_contact_client/models/partner_account_links.rb +215 -0
- data/lib/constant_contact_client/models/partner_account_operations_request.rb +286 -0
- data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_headers_inner.rb +225 -0
- data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_path_parameters_inner.rb +225 -0
- data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_query_parameters_inner.rb +225 -0
- data/lib/constant_contact_client/models/partner_account_site_owner_list_inner.rb +265 -0
- data/lib/constant_contact_client/models/partners_link.rb +214 -0
- data/lib/constant_contact_client/models/patch_email_campaign_name_request.rb +241 -0
- data/lib/constant_contact_client/models/path_param_object.rb +225 -0
- data/lib/constant_contact_client/models/percents_email.rb +295 -0
- data/lib/constant_contact_client/models/phone_number.rb +294 -0
- data/lib/constant_contact_client/models/phone_number_put.rb +244 -0
- data/lib/constant_contact_client/models/plan_info.rb +236 -0
- data/lib/constant_contact_client/models/plan_tiers_object.rb +248 -0
- data/lib/constant_contact_client/models/plan_tiers_object_current_tiers_inner.rb +278 -0
- data/lib/constant_contact_client/models/post_custom_field_delete201_response.rb +297 -0
- data/lib/constant_contact_client/models/post_custom_field_delete_request.rb +243 -0
- data/lib/constant_contact_client/models/post_tag_request.rb +260 -0
- data/lib/constant_contact_client/models/provision.rb +723 -0
- data/lib/constant_contact_client/models/provision_response.rb +225 -0
- data/lib/constant_contact_client/models/put_tag_request.rb +250 -0
- data/lib/constant_contact_client/models/query_param_object.rb +225 -0
- data/lib/constant_contact_client/models/reporting_links.rb +221 -0
- data/lib/constant_contact_client/models/reporting_next.rb +222 -0
- data/lib/constant_contact_client/models/resend_to_non_openers_input.rb +242 -0
- data/lib/constant_contact_client/models/resend_to_non_openers_object.rb +255 -0
- data/lib/constant_contact_client/models/schedule_email_campaign_activity_request.rb +222 -0
- data/lib/constant_contact_client/models/segment_data.rb +258 -0
- data/lib/constant_contact_client/models/segment_detail.rb +274 -0
- data/lib/constant_contact_client/models/segment_master.rb +245 -0
- data/lib/constant_contact_client/models/segment_name.rb +222 -0
- data/lib/constant_contact_client/models/segments_dto.rb +233 -0
- data/lib/constant_contact_client/models/sends_tracking_activities_page.rb +233 -0
- data/lib/constant_contact_client/models/sends_tracking_activity.rb +320 -0
- data/lib/constant_contact_client/models/sms_channel_consent_details.rb +285 -0
- data/lib/constant_contact_client/models/sso_user.rb +439 -0
- data/lib/constant_contact_client/models/stats_email.rb +395 -0
- data/lib/constant_contact_client/models/stats_email_activity.rb +475 -0
- data/lib/constant_contact_client/models/stats_error.rb +225 -0
- data/lib/constant_contact_client/models/street_address.rb +397 -0
- data/lib/constant_contact_client/models/street_address_put.rb +367 -0
- data/lib/constant_contact_client/models/tag.rb +265 -0
- data/lib/constant_contact_client/models/tag_add_remove_contacts.rb +268 -0
- data/lib/constant_contact_client/models/tag_id_list500_limit.rb +243 -0
- data/lib/constant_contact_client/models/tag_post.rb +260 -0
- data/lib/constant_contact_client/models/tag_put.rb +250 -0
- data/lib/constant_contact_client/models/tags.rb +226 -0
- data/lib/constant_contact_client/models/tags_activity_links.rb +214 -0
- data/lib/constant_contact_client/models/tags_links.rb +223 -0
- data/lib/constant_contact_client/models/tags_paging_links.rb +214 -0
- data/lib/constant_contact_client/models/test_send_email_campaign_activity_request.rb +253 -0
- data/lib/constant_contact_client/models/tier_object.rb +278 -0
- data/lib/constant_contact_client/models/tracking_activity_sms_channel_dto.rb +245 -0
- data/lib/constant_contact_client/models/unique_email_counts.rb +341 -0
- data/lib/constant_contact_client/models/update_account_request.rb +334 -0
- data/lib/constant_contact_client/models/update_contact_request.rb +582 -0
- data/lib/constant_contact_client/models/update_contact_request_email_address.rb +341 -0
- data/lib/constant_contact_client/models/update_contact_request_phone_numbers_inner.rb +244 -0
- data/lib/constant_contact_client/models/update_contact_request_street_addresses_inner.rb +367 -0
- data/lib/constant_contact_client/models/update_custom_field_request.rb +258 -0
- data/lib/constant_contact_client/models/update_list200_response.rb +291 -0
- data/lib/constant_contact_client/models/update_list_request.rb +263 -0
- data/lib/constant_contact_client/models/update_segment_name_request.rb +222 -0
- data/lib/constant_contact_client/models/webhooks_subscription_body.rb +215 -0
- data/lib/constant_contact_client/models/webhooks_subscription_collection_inner.rb +245 -0
- data/lib/constant_contact_client/models/webhooks_subscription_put_resp.rb +225 -0
- data/lib/constant_contact_client/models/webhooks_subscription_response.rb +245 -0
- data/lib/constant_contact_client/models/webhooks_test_send.rb +245 -0
- data/lib/constant_contact_client/version.rb +15 -0
- data/lib/constant_contact_client.rb +417 -0
- data/spec/spec_helper.rb +111 -0
- metadata +488 -0
@@ -0,0 +1,546 @@
|
|
1
|
+
=begin
|
2
|
+
#Constant Contact API v3
|
3
|
+
|
4
|
+
#Swagger build version 3.0.2475
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.101
|
7
|
+
Contact: webservices@constantcontact.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.2.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module ConstantContactClient
|
16
|
+
class AccountServicesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# POST Add an Account Email Address
|
23
|
+
# Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from `UNCONFIRMED` to `CONFIRMED`. You can use confirmed account email addresses in the email campaign `from_email` and `reply_to_email` headers. For more use case information, see [Add an Account Email Address](/api_guide/account_post_emails.html) in the API guide.
|
24
|
+
# @param add_account_email_address_request [AddAccountEmailAddressRequest] A JSON request payload containing the new email address you want to add to the Constant Contact account.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [AddAccountEmailAddress201Response]
|
27
|
+
def add_account_email_address(add_account_email_address_request, opts = {})
|
28
|
+
data, _status_code, _headers = add_account_email_address_with_http_info(add_account_email_address_request, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# POST Add an Account Email Address
|
33
|
+
# Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from `UNCONFIRMED` to `CONFIRMED`. You can use confirmed account email addresses in the email campaign `from_email` and `reply_to_email` headers. For more use case information, see [Add an Account Email Address](/api_guide/account_post_emails.html) in the API guide.
|
34
|
+
# @param add_account_email_address_request [AddAccountEmailAddressRequest] A JSON request payload containing the new email address you want to add to the Constant Contact account.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(AddAccountEmailAddress201Response, Integer, Hash)>] AddAccountEmailAddress201Response data, response status code and response headers
|
37
|
+
def add_account_email_address_with_http_info(add_account_email_address_request, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.add_account_email_address ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'add_account_email_address_request' is set
|
42
|
+
if @api_client.config.client_side_validation && add_account_email_address_request.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'add_account_email_address_request' when calling AccountServicesApi.add_account_email_address"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/account/emails'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
57
|
+
if !content_type.nil?
|
58
|
+
header_params['Content-Type'] = content_type
|
59
|
+
end
|
60
|
+
|
61
|
+
# form parameters
|
62
|
+
form_params = opts[:form_params] || {}
|
63
|
+
|
64
|
+
# http body (model)
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(add_account_email_address_request)
|
66
|
+
|
67
|
+
# return_type
|
68
|
+
return_type = opts[:debug_return_type] || 'AddAccountEmailAddress201Response'
|
69
|
+
|
70
|
+
# auth_names
|
71
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
72
|
+
|
73
|
+
new_options = opts.merge(
|
74
|
+
:operation => :"AccountServicesApi.add_account_email_address",
|
75
|
+
:header_params => header_params,
|
76
|
+
:query_params => query_params,
|
77
|
+
:form_params => form_params,
|
78
|
+
:body => post_body,
|
79
|
+
:auth_names => auth_names,
|
80
|
+
:return_type => return_type
|
81
|
+
)
|
82
|
+
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
84
|
+
if @api_client.config.debugging
|
85
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#add_account_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
+
end
|
87
|
+
return data, status_code, headers
|
88
|
+
end
|
89
|
+
|
90
|
+
# POST the Physical Address for the Account
|
91
|
+
# Use this method to add the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (<code>country_code</code>) where the account organization resides determines whether you use the <code>state_code</code> to specify United States (<code>US</code>) and Canada (<code>CA</code>) addresses, or use the <code>state_name</code> to specify all other countries.
|
92
|
+
# @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [GetAccountDetails200ResponsePhysicalAddress]
|
95
|
+
def add_physical_address(get_account_details200_response_physical_address, opts = {})
|
96
|
+
data, _status_code, _headers = add_physical_address_with_http_info(get_account_details200_response_physical_address, opts)
|
97
|
+
data
|
98
|
+
end
|
99
|
+
|
100
|
+
# POST the Physical Address for the Account
|
101
|
+
# Use this method to add the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (<code>country_code</code>) where the account organization resides determines whether you use the <code>state_code</code> to specify United States (<code>US</code>) and Canada (<code>CA</code>) addresses, or use the <code>state_name</code> to specify all other countries.
|
102
|
+
# @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<(GetAccountDetails200ResponsePhysicalAddress, Integer, Hash)>] GetAccountDetails200ResponsePhysicalAddress data, response status code and response headers
|
105
|
+
def add_physical_address_with_http_info(get_account_details200_response_physical_address, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.add_physical_address ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'get_account_details200_response_physical_address' is set
|
110
|
+
if @api_client.config.client_side_validation && get_account_details200_response_physical_address.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'get_account_details200_response_physical_address' when calling AccountServicesApi.add_physical_address"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/account/summary/physical_address'
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = opts[:query_params] || {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = opts[:header_params] || {}
|
121
|
+
# HTTP header 'Accept' (if needed)
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
123
|
+
# HTTP header 'Content-Type'
|
124
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
125
|
+
if !content_type.nil?
|
126
|
+
header_params['Content-Type'] = content_type
|
127
|
+
end
|
128
|
+
|
129
|
+
# form parameters
|
130
|
+
form_params = opts[:form_params] || {}
|
131
|
+
|
132
|
+
# http body (model)
|
133
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_account_details200_response_physical_address)
|
134
|
+
|
135
|
+
# return_type
|
136
|
+
return_type = opts[:debug_return_type] || 'GetAccountDetails200ResponsePhysicalAddress'
|
137
|
+
|
138
|
+
# auth_names
|
139
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
140
|
+
|
141
|
+
new_options = opts.merge(
|
142
|
+
:operation => :"AccountServicesApi.add_physical_address",
|
143
|
+
:header_params => header_params,
|
144
|
+
:query_params => query_params,
|
145
|
+
:form_params => form_params,
|
146
|
+
:body => post_body,
|
147
|
+
:auth_names => auth_names,
|
148
|
+
:return_type => return_type
|
149
|
+
)
|
150
|
+
|
151
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#add_physical_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
|
+
end
|
155
|
+
return data, status_code, headers
|
156
|
+
end
|
157
|
+
|
158
|
+
# GET a Summary of Account Details
|
159
|
+
# Get account related details for a Constant Contact user account. Use the `extra_fields` query parameter to include the `company_logo` and/or `physical_address` details in the response body. For more details, see [Get Account Summary Details](/api_guide/account_details_get.html).
|
160
|
+
# @param [Hash] opts the optional parameters
|
161
|
+
# @option opts [String] :extra_fields Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo).
|
162
|
+
# @return [GetAccountDetails200Response]
|
163
|
+
def get_account_details(opts = {})
|
164
|
+
data, _status_code, _headers = get_account_details_with_http_info(opts)
|
165
|
+
data
|
166
|
+
end
|
167
|
+
|
168
|
+
# GET a Summary of Account Details
|
169
|
+
# Get account related details for a Constant Contact user account. Use the `extra_fields` query parameter to include the `company_logo` and/or `physical_address` details in the response body. For more details, see [Get Account Summary Details](/api_guide/account_details_get.html).
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @option opts [String] :extra_fields Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo).
|
172
|
+
# @return [Array<(GetAccountDetails200Response, Integer, Hash)>] GetAccountDetails200Response data, response status code and response headers
|
173
|
+
def get_account_details_with_http_info(opts = {})
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.get_account_details ...'
|
176
|
+
end
|
177
|
+
allowable_values = ["physical_address", "company_logo"]
|
178
|
+
if @api_client.config.client_side_validation && opts[:'extra_fields'] && !allowable_values.include?(opts[:'extra_fields'])
|
179
|
+
fail ArgumentError, "invalid value for \"extra_fields\", must be one of #{allowable_values}"
|
180
|
+
end
|
181
|
+
# resource path
|
182
|
+
local_var_path = '/account/summary'
|
183
|
+
|
184
|
+
# query parameters
|
185
|
+
query_params = opts[:query_params] || {}
|
186
|
+
query_params[:'extra_fields'] = opts[:'extra_fields'] if !opts[:'extra_fields'].nil?
|
187
|
+
|
188
|
+
# header parameters
|
189
|
+
header_params = opts[:header_params] || {}
|
190
|
+
# HTTP header 'Accept' (if needed)
|
191
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
192
|
+
|
193
|
+
# form parameters
|
194
|
+
form_params = opts[:form_params] || {}
|
195
|
+
|
196
|
+
# http body (model)
|
197
|
+
post_body = opts[:debug_body]
|
198
|
+
|
199
|
+
# return_type
|
200
|
+
return_type = opts[:debug_return_type] || 'GetAccountDetails200Response'
|
201
|
+
|
202
|
+
# auth_names
|
203
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
204
|
+
|
205
|
+
new_options = opts.merge(
|
206
|
+
:operation => :"AccountServicesApi.get_account_details",
|
207
|
+
:header_params => header_params,
|
208
|
+
:query_params => query_params,
|
209
|
+
:form_params => form_params,
|
210
|
+
:body => post_body,
|
211
|
+
:auth_names => auth_names,
|
212
|
+
:return_type => return_type
|
213
|
+
)
|
214
|
+
|
215
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
216
|
+
if @api_client.config.debugging
|
217
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#get_account_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
218
|
+
end
|
219
|
+
return data, status_code, headers
|
220
|
+
end
|
221
|
+
|
222
|
+
# GET the Physical Address for the Account
|
223
|
+
# Use this method to get the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account.
|
224
|
+
# @param [Hash] opts the optional parameters
|
225
|
+
# @return [GetAccountDetails200ResponsePhysicalAddress]
|
226
|
+
def get_account_physical_address(opts = {})
|
227
|
+
data, _status_code, _headers = get_account_physical_address_with_http_info(opts)
|
228
|
+
data
|
229
|
+
end
|
230
|
+
|
231
|
+
# GET the Physical Address for the Account
|
232
|
+
# Use this method to get the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account.
|
233
|
+
# @param [Hash] opts the optional parameters
|
234
|
+
# @return [Array<(GetAccountDetails200ResponsePhysicalAddress, Integer, Hash)>] GetAccountDetails200ResponsePhysicalAddress data, response status code and response headers
|
235
|
+
def get_account_physical_address_with_http_info(opts = {})
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.get_account_physical_address ...'
|
238
|
+
end
|
239
|
+
# resource path
|
240
|
+
local_var_path = '/account/summary/physical_address'
|
241
|
+
|
242
|
+
# query parameters
|
243
|
+
query_params = opts[:query_params] || {}
|
244
|
+
|
245
|
+
# header parameters
|
246
|
+
header_params = opts[:header_params] || {}
|
247
|
+
# HTTP header 'Accept' (if needed)
|
248
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
249
|
+
|
250
|
+
# form parameters
|
251
|
+
form_params = opts[:form_params] || {}
|
252
|
+
|
253
|
+
# http body (model)
|
254
|
+
post_body = opts[:debug_body]
|
255
|
+
|
256
|
+
# return_type
|
257
|
+
return_type = opts[:debug_return_type] || 'GetAccountDetails200ResponsePhysicalAddress'
|
258
|
+
|
259
|
+
# auth_names
|
260
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
261
|
+
|
262
|
+
new_options = opts.merge(
|
263
|
+
:operation => :"AccountServicesApi.get_account_physical_address",
|
264
|
+
:header_params => header_params,
|
265
|
+
:query_params => query_params,
|
266
|
+
:form_params => form_params,
|
267
|
+
:body => post_body,
|
268
|
+
:auth_names => auth_names,
|
269
|
+
:return_type => return_type
|
270
|
+
)
|
271
|
+
|
272
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
273
|
+
if @api_client.config.debugging
|
274
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#get_account_physical_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
275
|
+
end
|
276
|
+
return data, status_code, headers
|
277
|
+
end
|
278
|
+
|
279
|
+
# GET a Collection of Account Email Addresses
|
280
|
+
# Use this method to return a collection of email addresses for the account associated with your access token. When you <a href=\"https://v3.developer.constantcontact.com/api_reference/index.html#!/Email_Campaigns/createEmailCampaignUsingPOST\" target=\"_blank\">Create an Email Campaign<a/>, you must use an account email address with a `CONFIRMED` status in the email campaign `from_email` and `reply_to_email` headers. Use the query parameters to filter results. You can filter using `confirm_status`, `role_code`, or `email_address`. For example, searching with `confirm_status=CONFIRMED` returns all confirmed email addresses in the account. This method only supports one query parameter at a time.
|
281
|
+
# @param [Hash] opts the optional parameters
|
282
|
+
# @option opts [String] :confirm_status Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`.
|
283
|
+
# @option opts [String] :role_code Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`.
|
284
|
+
# @option opts [String] :email_address Use the `email_address` query parameter to search for a specific account email address.
|
285
|
+
# @return [Array<GetAllAccountEmailAddresses200ResponseInner>]
|
286
|
+
def get_all_account_email_addresses(opts = {})
|
287
|
+
data, _status_code, _headers = get_all_account_email_addresses_with_http_info(opts)
|
288
|
+
data
|
289
|
+
end
|
290
|
+
|
291
|
+
# GET a Collection of Account Email Addresses
|
292
|
+
# Use this method to return a collection of email addresses for the account associated with your access token. When you <a href=\"https://v3.developer.constantcontact.com/api_reference/index.html#!/Email_Campaigns/createEmailCampaignUsingPOST\" target=\"_blank\">Create an Email Campaign<a/>, you must use an account email address with a `CONFIRMED` status in the email campaign `from_email` and `reply_to_email` headers. Use the query parameters to filter results. You can filter using `confirm_status`, `role_code`, or `email_address`. For example, searching with `confirm_status=CONFIRMED` returns all confirmed email addresses in the account. This method only supports one query parameter at a time.
|
293
|
+
# @param [Hash] opts the optional parameters
|
294
|
+
# @option opts [String] :confirm_status Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`.
|
295
|
+
# @option opts [String] :role_code Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`.
|
296
|
+
# @option opts [String] :email_address Use the `email_address` query parameter to search for a specific account email address.
|
297
|
+
# @return [Array<(Array<GetAllAccountEmailAddresses200ResponseInner>, Integer, Hash)>] Array<GetAllAccountEmailAddresses200ResponseInner> data, response status code and response headers
|
298
|
+
def get_all_account_email_addresses_with_http_info(opts = {})
|
299
|
+
if @api_client.config.debugging
|
300
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.get_all_account_email_addresses ...'
|
301
|
+
end
|
302
|
+
allowable_values = ["CONFIRMED", "C", "UNCONFIRMED", "U"]
|
303
|
+
if @api_client.config.client_side_validation && opts[:'confirm_status'] && !allowable_values.include?(opts[:'confirm_status'])
|
304
|
+
fail ArgumentError, "invalid value for \"confirm_status\", must be one of #{allowable_values}"
|
305
|
+
end
|
306
|
+
allowable_values = ["CONTACT", "C", "BILLING", "B", "JOURNALING", "J", "REPLY_TO", "R", "OTHER", "O"]
|
307
|
+
if @api_client.config.client_side_validation && opts[:'role_code'] && !allowable_values.include?(opts[:'role_code'])
|
308
|
+
fail ArgumentError, "invalid value for \"role_code\", must be one of #{allowable_values}"
|
309
|
+
end
|
310
|
+
# resource path
|
311
|
+
local_var_path = '/account/emails'
|
312
|
+
|
313
|
+
# query parameters
|
314
|
+
query_params = opts[:query_params] || {}
|
315
|
+
query_params[:'confirm_status'] = opts[:'confirm_status'] if !opts[:'confirm_status'].nil?
|
316
|
+
query_params[:'role_code'] = opts[:'role_code'] if !opts[:'role_code'].nil?
|
317
|
+
query_params[:'email_address'] = opts[:'email_address'] if !opts[:'email_address'].nil?
|
318
|
+
|
319
|
+
# header parameters
|
320
|
+
header_params = opts[:header_params] || {}
|
321
|
+
# HTTP header 'Accept' (if needed)
|
322
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
323
|
+
|
324
|
+
# form parameters
|
325
|
+
form_params = opts[:form_params] || {}
|
326
|
+
|
327
|
+
# http body (model)
|
328
|
+
post_body = opts[:debug_body]
|
329
|
+
|
330
|
+
# return_type
|
331
|
+
return_type = opts[:debug_return_type] || 'Array<GetAllAccountEmailAddresses200ResponseInner>'
|
332
|
+
|
333
|
+
# auth_names
|
334
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
335
|
+
|
336
|
+
new_options = opts.merge(
|
337
|
+
:operation => :"AccountServicesApi.get_all_account_email_addresses",
|
338
|
+
:header_params => header_params,
|
339
|
+
:query_params => query_params,
|
340
|
+
:form_params => form_params,
|
341
|
+
:body => post_body,
|
342
|
+
:auth_names => auth_names,
|
343
|
+
:return_type => return_type
|
344
|
+
)
|
345
|
+
|
346
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
347
|
+
if @api_client.config.debugging
|
348
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#get_all_account_email_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
349
|
+
end
|
350
|
+
return data, status_code, headers
|
351
|
+
end
|
352
|
+
|
353
|
+
# GET User Privileges
|
354
|
+
# Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the [User Privileges and Roles Overview](/api_guide/user_privileges.html).
|
355
|
+
# @param [Hash] opts the optional parameters
|
356
|
+
# @return [Array<GetUserPrivileges200ResponseInner>]
|
357
|
+
def get_user_privileges(opts = {})
|
358
|
+
data, _status_code, _headers = get_user_privileges_with_http_info(opts)
|
359
|
+
data
|
360
|
+
end
|
361
|
+
|
362
|
+
# GET User Privileges
|
363
|
+
# Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the [User Privileges and Roles Overview](/api_guide/user_privileges.html).
|
364
|
+
# @param [Hash] opts the optional parameters
|
365
|
+
# @return [Array<(Array<GetUserPrivileges200ResponseInner>, Integer, Hash)>] Array<GetUserPrivileges200ResponseInner> data, response status code and response headers
|
366
|
+
def get_user_privileges_with_http_info(opts = {})
|
367
|
+
if @api_client.config.debugging
|
368
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.get_user_privileges ...'
|
369
|
+
end
|
370
|
+
# resource path
|
371
|
+
local_var_path = '/account/user/privileges'
|
372
|
+
|
373
|
+
# query parameters
|
374
|
+
query_params = opts[:query_params] || {}
|
375
|
+
|
376
|
+
# header parameters
|
377
|
+
header_params = opts[:header_params] || {}
|
378
|
+
# HTTP header 'Accept' (if needed)
|
379
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
380
|
+
|
381
|
+
# form parameters
|
382
|
+
form_params = opts[:form_params] || {}
|
383
|
+
|
384
|
+
# http body (model)
|
385
|
+
post_body = opts[:debug_body]
|
386
|
+
|
387
|
+
# return_type
|
388
|
+
return_type = opts[:debug_return_type] || 'Array<GetUserPrivileges200ResponseInner>'
|
389
|
+
|
390
|
+
# auth_names
|
391
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
392
|
+
|
393
|
+
new_options = opts.merge(
|
394
|
+
:operation => :"AccountServicesApi.get_user_privileges",
|
395
|
+
:header_params => header_params,
|
396
|
+
:query_params => query_params,
|
397
|
+
:form_params => form_params,
|
398
|
+
:body => post_body,
|
399
|
+
:auth_names => auth_names,
|
400
|
+
:return_type => return_type
|
401
|
+
)
|
402
|
+
|
403
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
404
|
+
if @api_client.config.debugging
|
405
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#get_user_privileges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
406
|
+
end
|
407
|
+
return data, status_code, headers
|
408
|
+
end
|
409
|
+
|
410
|
+
# PUT (update) Account Details
|
411
|
+
# Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see [Put (update) Account Summary Details](/api_guide/account_details_put.html).
|
412
|
+
# @param update_account_request [UpdateAccountRequest] In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored.
|
413
|
+
# @param [Hash] opts the optional parameters
|
414
|
+
# @return [UpdateAccountRequest]
|
415
|
+
def update_account(update_account_request, opts = {})
|
416
|
+
data, _status_code, _headers = update_account_with_http_info(update_account_request, opts)
|
417
|
+
data
|
418
|
+
end
|
419
|
+
|
420
|
+
# PUT (update) Account Details
|
421
|
+
# Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see [Put (update) Account Summary Details](/api_guide/account_details_put.html).
|
422
|
+
# @param update_account_request [UpdateAccountRequest] In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored.
|
423
|
+
# @param [Hash] opts the optional parameters
|
424
|
+
# @return [Array<(UpdateAccountRequest, Integer, Hash)>] UpdateAccountRequest data, response status code and response headers
|
425
|
+
def update_account_with_http_info(update_account_request, opts = {})
|
426
|
+
if @api_client.config.debugging
|
427
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.update_account ...'
|
428
|
+
end
|
429
|
+
# verify the required parameter 'update_account_request' is set
|
430
|
+
if @api_client.config.client_side_validation && update_account_request.nil?
|
431
|
+
fail ArgumentError, "Missing the required parameter 'update_account_request' when calling AccountServicesApi.update_account"
|
432
|
+
end
|
433
|
+
# resource path
|
434
|
+
local_var_path = '/account/summary'
|
435
|
+
|
436
|
+
# query parameters
|
437
|
+
query_params = opts[:query_params] || {}
|
438
|
+
|
439
|
+
# header parameters
|
440
|
+
header_params = opts[:header_params] || {}
|
441
|
+
# HTTP header 'Accept' (if needed)
|
442
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
443
|
+
# HTTP header 'Content-Type'
|
444
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
445
|
+
if !content_type.nil?
|
446
|
+
header_params['Content-Type'] = content_type
|
447
|
+
end
|
448
|
+
|
449
|
+
# form parameters
|
450
|
+
form_params = opts[:form_params] || {}
|
451
|
+
|
452
|
+
# http body (model)
|
453
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_account_request)
|
454
|
+
|
455
|
+
# return_type
|
456
|
+
return_type = opts[:debug_return_type] || 'UpdateAccountRequest'
|
457
|
+
|
458
|
+
# auth_names
|
459
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
460
|
+
|
461
|
+
new_options = opts.merge(
|
462
|
+
:operation => :"AccountServicesApi.update_account",
|
463
|
+
:header_params => header_params,
|
464
|
+
:query_params => query_params,
|
465
|
+
:form_params => form_params,
|
466
|
+
:body => post_body,
|
467
|
+
:auth_names => auth_names,
|
468
|
+
:return_type => return_type
|
469
|
+
)
|
470
|
+
|
471
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
472
|
+
if @api_client.config.debugging
|
473
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#update_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
474
|
+
end
|
475
|
+
return data, status_code, headers
|
476
|
+
end
|
477
|
+
|
478
|
+
# PUT (update) the Physical Address for an Account
|
479
|
+
# Use this method to update the organization's physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to `/account/summary/physical_address`. The country (<code>country_code</code>) where the account organization resides determines whether you use the <code>state_code</code> to specify United States (<code>US</code>) and Canada (<code>CA</code>) addresses, or use the <code>state_name</code> to specify all other countries. For more details, see [Put (update) the Physical Address for the Account](/api_guide/account_address_put.html). You must have the role of Account Owner assigned to update account level details.
|
480
|
+
# @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
|
481
|
+
# @param [Hash] opts the optional parameters
|
482
|
+
# @return [GetAccountDetails200ResponsePhysicalAddress]
|
483
|
+
def update_account_physical_address(get_account_details200_response_physical_address, opts = {})
|
484
|
+
data, _status_code, _headers = update_account_physical_address_with_http_info(get_account_details200_response_physical_address, opts)
|
485
|
+
data
|
486
|
+
end
|
487
|
+
|
488
|
+
# PUT (update) the Physical Address for an Account
|
489
|
+
# Use this method to update the organization's physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to `/account/summary/physical_address`. The country (<code>country_code</code>) where the account organization resides determines whether you use the <code>state_code</code> to specify United States (<code>US</code>) and Canada (<code>CA</code>) addresses, or use the <code>state_name</code> to specify all other countries. For more details, see [Put (update) the Physical Address for the Account](/api_guide/account_address_put.html). You must have the role of Account Owner assigned to update account level details.
|
490
|
+
# @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
|
491
|
+
# @param [Hash] opts the optional parameters
|
492
|
+
# @return [Array<(GetAccountDetails200ResponsePhysicalAddress, Integer, Hash)>] GetAccountDetails200ResponsePhysicalAddress data, response status code and response headers
|
493
|
+
def update_account_physical_address_with_http_info(get_account_details200_response_physical_address, opts = {})
|
494
|
+
if @api_client.config.debugging
|
495
|
+
@api_client.config.logger.debug 'Calling API: AccountServicesApi.update_account_physical_address ...'
|
496
|
+
end
|
497
|
+
# verify the required parameter 'get_account_details200_response_physical_address' is set
|
498
|
+
if @api_client.config.client_side_validation && get_account_details200_response_physical_address.nil?
|
499
|
+
fail ArgumentError, "Missing the required parameter 'get_account_details200_response_physical_address' when calling AccountServicesApi.update_account_physical_address"
|
500
|
+
end
|
501
|
+
# resource path
|
502
|
+
local_var_path = '/account/summary/physical_address'
|
503
|
+
|
504
|
+
# query parameters
|
505
|
+
query_params = opts[:query_params] || {}
|
506
|
+
|
507
|
+
# header parameters
|
508
|
+
header_params = opts[:header_params] || {}
|
509
|
+
# HTTP header 'Accept' (if needed)
|
510
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
511
|
+
# HTTP header 'Content-Type'
|
512
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
513
|
+
if !content_type.nil?
|
514
|
+
header_params['Content-Type'] = content_type
|
515
|
+
end
|
516
|
+
|
517
|
+
# form parameters
|
518
|
+
form_params = opts[:form_params] || {}
|
519
|
+
|
520
|
+
# http body (model)
|
521
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_account_details200_response_physical_address)
|
522
|
+
|
523
|
+
# return_type
|
524
|
+
return_type = opts[:debug_return_type] || 'GetAccountDetails200ResponsePhysicalAddress'
|
525
|
+
|
526
|
+
# auth_names
|
527
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
528
|
+
|
529
|
+
new_options = opts.merge(
|
530
|
+
:operation => :"AccountServicesApi.update_account_physical_address",
|
531
|
+
:header_params => header_params,
|
532
|
+
:query_params => query_params,
|
533
|
+
:form_params => form_params,
|
534
|
+
:body => post_body,
|
535
|
+
:auth_names => auth_names,
|
536
|
+
:return_type => return_type
|
537
|
+
)
|
538
|
+
|
539
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
540
|
+
if @api_client.config.debugging
|
541
|
+
@api_client.config.logger.debug "API called: AccountServicesApi#update_account_physical_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
542
|
+
end
|
543
|
+
return data, status_code, headers
|
544
|
+
end
|
545
|
+
end
|
546
|
+
end
|