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,436 @@
|
|
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 LandingPagesReportingApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# GET a Unique Contacts Adds Landing Page Report
|
23
|
+
# Use this method to get details about each contact added to the account from a specified landing page. Contacts are identified by `contact_id`. The resulting contact data is listed with most recent activity first.
|
24
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact results.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
27
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
28
|
+
# @return [GetContactAdds200Response]
|
29
|
+
def get_contact_adds(campaign_activity_id, opts = {})
|
30
|
+
data, _status_code, _headers = get_contact_adds_with_http_info(campaign_activity_id, opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# GET a Unique Contacts Adds Landing Page Report
|
35
|
+
# Use this method to get details about each contact added to the account from a specified landing page. Contacts are identified by `contact_id`. The resulting contact data is listed with most recent activity first.
|
36
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact results.
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
39
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
40
|
+
# @return [Array<(GetContactAdds200Response, Integer, Hash)>] GetContactAdds200Response data, response status code and response headers
|
41
|
+
def get_contact_adds_with_http_info(campaign_activity_id, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_contact_adds ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'campaign_activity_id' is set
|
46
|
+
if @api_client.config.client_side_validation && campaign_activity_id.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_contact_adds"
|
48
|
+
end
|
49
|
+
# resource path
|
50
|
+
local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_adds'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))
|
51
|
+
|
52
|
+
# query parameters
|
53
|
+
query_params = opts[:query_params] || {}
|
54
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
55
|
+
query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = opts[:form_params] || {}
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = opts[:debug_body]
|
67
|
+
|
68
|
+
# return_type
|
69
|
+
return_type = opts[:debug_return_type] || 'GetContactAdds200Response'
|
70
|
+
|
71
|
+
# auth_names
|
72
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
73
|
+
|
74
|
+
new_options = opts.merge(
|
75
|
+
:operation => :"LandingPagesReportingApi.get_contact_adds",
|
76
|
+
:header_params => header_params,
|
77
|
+
:query_params => query_params,
|
78
|
+
:form_params => form_params,
|
79
|
+
:body => post_body,
|
80
|
+
:auth_names => auth_names,
|
81
|
+
:return_type => return_type
|
82
|
+
)
|
83
|
+
|
84
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "API called: LandingPagesReportingApi#get_contact_adds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
|
91
|
+
# GET a Contacts Opens Landing Page Report
|
92
|
+
# Use this method get contact details for each time a contact opens a link on a landing page. The resulting contact data is listed with most recent activity first.
|
93
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact open results.
|
94
|
+
# @param [Hash] opts the optional parameters
|
95
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
96
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
97
|
+
# @return [GetUniqueContactOpens200Response]
|
98
|
+
def get_contact_opens(campaign_activity_id, opts = {})
|
99
|
+
data, _status_code, _headers = get_contact_opens_with_http_info(campaign_activity_id, opts)
|
100
|
+
data
|
101
|
+
end
|
102
|
+
|
103
|
+
# GET a Contacts Opens Landing Page Report
|
104
|
+
# Use this method get contact details for each time a contact opens a link on a landing page. The resulting contact data is listed with most recent activity first.
|
105
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact open results.
|
106
|
+
# @param [Hash] opts the optional parameters
|
107
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
108
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
109
|
+
# @return [Array<(GetUniqueContactOpens200Response, Integer, Hash)>] GetUniqueContactOpens200Response data, response status code and response headers
|
110
|
+
def get_contact_opens_with_http_info(campaign_activity_id, opts = {})
|
111
|
+
if @api_client.config.debugging
|
112
|
+
@api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_contact_opens ...'
|
113
|
+
end
|
114
|
+
# verify the required parameter 'campaign_activity_id' is set
|
115
|
+
if @api_client.config.client_side_validation && campaign_activity_id.nil?
|
116
|
+
fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_contact_opens"
|
117
|
+
end
|
118
|
+
# resource path
|
119
|
+
local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_contact_opens'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))
|
120
|
+
|
121
|
+
# query parameters
|
122
|
+
query_params = opts[:query_params] || {}
|
123
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
124
|
+
query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?
|
125
|
+
|
126
|
+
# header parameters
|
127
|
+
header_params = opts[:header_params] || {}
|
128
|
+
# HTTP header 'Accept' (if needed)
|
129
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
130
|
+
|
131
|
+
# form parameters
|
132
|
+
form_params = opts[:form_params] || {}
|
133
|
+
|
134
|
+
# http body (model)
|
135
|
+
post_body = opts[:debug_body]
|
136
|
+
|
137
|
+
# return_type
|
138
|
+
return_type = opts[:debug_return_type] || 'GetUniqueContactOpens200Response'
|
139
|
+
|
140
|
+
# auth_names
|
141
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
142
|
+
|
143
|
+
new_options = opts.merge(
|
144
|
+
:operation => :"LandingPagesReportingApi.get_contact_opens",
|
145
|
+
:header_params => header_params,
|
146
|
+
:query_params => query_params,
|
147
|
+
:form_params => form_params,
|
148
|
+
:body => post_body,
|
149
|
+
:auth_names => auth_names,
|
150
|
+
:return_type => return_type
|
151
|
+
)
|
152
|
+
|
153
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
154
|
+
if @api_client.config.debugging
|
155
|
+
@api_client.config.logger.debug "API called: LandingPagesReportingApi#get_contact_opens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
156
|
+
end
|
157
|
+
return data, status_code, headers
|
158
|
+
end
|
159
|
+
|
160
|
+
# GET a Unique Contacts Clicks Landing Page Report
|
161
|
+
# Use this method get details about each contact that clicked a link on a landing page campaign activity. Unique contact clicks are identified by both the `contact_id` and `url_id`. The same contact may appear more than once in the results, if they clicked more than one link on the landing page. The resulting contact data is listed with most recent activity first.
|
162
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact click results.
|
163
|
+
# @param [Hash] opts the optional parameters
|
164
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
165
|
+
# @option opts [String] :contacts_filter Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.
|
166
|
+
# @return [GetUniqueContactClicks200Response]
|
167
|
+
def get_unique_contact_clicks(campaign_activity_id, opts = {})
|
168
|
+
data, _status_code, _headers = get_unique_contact_clicks_with_http_info(campaign_activity_id, opts)
|
169
|
+
data
|
170
|
+
end
|
171
|
+
|
172
|
+
# GET a Unique Contacts Clicks Landing Page Report
|
173
|
+
# Use this method get details about each contact that clicked a link on a landing page campaign activity. Unique contact clicks are identified by both the `contact_id` and `url_id`. The same contact may appear more than once in the results, if they clicked more than one link on the landing page. The resulting contact data is listed with most recent activity first.
|
174
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact click results.
|
175
|
+
# @param [Hash] opts the optional parameters
|
176
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
177
|
+
# @option opts [String] :contacts_filter Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.
|
178
|
+
# @return [Array<(GetUniqueContactClicks200Response, Integer, Hash)>] GetUniqueContactClicks200Response data, response status code and response headers
|
179
|
+
def get_unique_contact_clicks_with_http_info(campaign_activity_id, opts = {})
|
180
|
+
if @api_client.config.debugging
|
181
|
+
@api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_clicks ...'
|
182
|
+
end
|
183
|
+
# verify the required parameter 'campaign_activity_id' is set
|
184
|
+
if @api_client.config.client_side_validation && campaign_activity_id.nil?
|
185
|
+
fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_clicks"
|
186
|
+
end
|
187
|
+
# resource path
|
188
|
+
local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_clicks'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))
|
189
|
+
|
190
|
+
# query parameters
|
191
|
+
query_params = opts[:query_params] || {}
|
192
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
193
|
+
query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?
|
194
|
+
|
195
|
+
# header parameters
|
196
|
+
header_params = opts[:header_params] || {}
|
197
|
+
# HTTP header 'Accept' (if needed)
|
198
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
199
|
+
|
200
|
+
# form parameters
|
201
|
+
form_params = opts[:form_params] || {}
|
202
|
+
|
203
|
+
# http body (model)
|
204
|
+
post_body = opts[:debug_body]
|
205
|
+
|
206
|
+
# return_type
|
207
|
+
return_type = opts[:debug_return_type] || 'GetUniqueContactClicks200Response'
|
208
|
+
|
209
|
+
# auth_names
|
210
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
211
|
+
|
212
|
+
new_options = opts.merge(
|
213
|
+
:operation => :"LandingPagesReportingApi.get_unique_contact_clicks",
|
214
|
+
:header_params => header_params,
|
215
|
+
:query_params => query_params,
|
216
|
+
:form_params => form_params,
|
217
|
+
:body => post_body,
|
218
|
+
:auth_names => auth_names,
|
219
|
+
:return_type => return_type
|
220
|
+
)
|
221
|
+
|
222
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
223
|
+
if @api_client.config.debugging
|
224
|
+
@api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_clicks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
225
|
+
end
|
226
|
+
return data, status_code, headers
|
227
|
+
end
|
228
|
+
|
229
|
+
# GET a Unique Contacts Opens Landing Page Report
|
230
|
+
# Use this method get details about each contact that opens a link on a landing page. Contacts are uniquely identified by `contact_id`. The resulting contact data is listed with most recent activity first.
|
231
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact open results.
|
232
|
+
# @param [Hash] opts the optional parameters
|
233
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
234
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
235
|
+
# @return [GetUniqueContactOpens200Response]
|
236
|
+
def get_unique_contact_opens(campaign_activity_id, opts = {})
|
237
|
+
data, _status_code, _headers = get_unique_contact_opens_with_http_info(campaign_activity_id, opts)
|
238
|
+
data
|
239
|
+
end
|
240
|
+
|
241
|
+
# GET a Unique Contacts Opens Landing Page Report
|
242
|
+
# Use this method get details about each contact that opens a link on a landing page. Contacts are uniquely identified by `contact_id`. The resulting contact data is listed with most recent activity first.
|
243
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact open results.
|
244
|
+
# @param [Hash] opts the optional parameters
|
245
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
246
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
247
|
+
# @return [Array<(GetUniqueContactOpens200Response, Integer, Hash)>] GetUniqueContactOpens200Response data, response status code and response headers
|
248
|
+
def get_unique_contact_opens_with_http_info(campaign_activity_id, opts = {})
|
249
|
+
if @api_client.config.debugging
|
250
|
+
@api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_opens ...'
|
251
|
+
end
|
252
|
+
# verify the required parameter 'campaign_activity_id' is set
|
253
|
+
if @api_client.config.client_side_validation && campaign_activity_id.nil?
|
254
|
+
fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_opens"
|
255
|
+
end
|
256
|
+
# resource path
|
257
|
+
local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_opens'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))
|
258
|
+
|
259
|
+
# query parameters
|
260
|
+
query_params = opts[:query_params] || {}
|
261
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
262
|
+
query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?
|
263
|
+
|
264
|
+
# header parameters
|
265
|
+
header_params = opts[:header_params] || {}
|
266
|
+
# HTTP header 'Accept' (if needed)
|
267
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
268
|
+
|
269
|
+
# form parameters
|
270
|
+
form_params = opts[:form_params] || {}
|
271
|
+
|
272
|
+
# http body (model)
|
273
|
+
post_body = opts[:debug_body]
|
274
|
+
|
275
|
+
# return_type
|
276
|
+
return_type = opts[:debug_return_type] || 'GetUniqueContactOpens200Response'
|
277
|
+
|
278
|
+
# auth_names
|
279
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
280
|
+
|
281
|
+
new_options = opts.merge(
|
282
|
+
:operation => :"LandingPagesReportingApi.get_unique_contact_opens",
|
283
|
+
:header_params => header_params,
|
284
|
+
:query_params => query_params,
|
285
|
+
:form_params => form_params,
|
286
|
+
:body => post_body,
|
287
|
+
:auth_names => auth_names,
|
288
|
+
:return_type => return_type
|
289
|
+
)
|
290
|
+
|
291
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
292
|
+
if @api_client.config.debugging
|
293
|
+
@api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_opens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
294
|
+
end
|
295
|
+
return data, status_code, headers
|
296
|
+
end
|
297
|
+
|
298
|
+
# GET a Unique Contacts SMS Opt-In Landing Page Report
|
299
|
+
# Use this method get details about unique contacts that click a link on a landing page to opt in to receiving SMS text messages. Contacts are uniquely identified by `contact_id``. The resulting contact data is listed with most recent activity first.
|
300
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact click results.
|
301
|
+
# @param [Hash] opts the optional parameters
|
302
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
303
|
+
# @option opts [String] :contacts_filter Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.
|
304
|
+
# @return [GetUniqueContactSMSOptIns200Response]
|
305
|
+
def get_unique_contact_sms_opt_ins(campaign_activity_id, opts = {})
|
306
|
+
data, _status_code, _headers = get_unique_contact_sms_opt_ins_with_http_info(campaign_activity_id, opts)
|
307
|
+
data
|
308
|
+
end
|
309
|
+
|
310
|
+
# GET a Unique Contacts SMS Opt-In Landing Page Report
|
311
|
+
# Use this method get details about unique contacts that click a link on a landing page to opt in to receiving SMS text messages. Contacts are uniquely identified by `contact_id``. The resulting contact data is listed with most recent activity first.
|
312
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact click results.
|
313
|
+
# @param [Hash] opts the optional parameters
|
314
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
315
|
+
# @option opts [String] :contacts_filter Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.
|
316
|
+
# @return [Array<(GetUniqueContactSMSOptIns200Response, Integer, Hash)>] GetUniqueContactSMSOptIns200Response data, response status code and response headers
|
317
|
+
def get_unique_contact_sms_opt_ins_with_http_info(campaign_activity_id, opts = {})
|
318
|
+
if @api_client.config.debugging
|
319
|
+
@api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_sms_opt_ins ...'
|
320
|
+
end
|
321
|
+
# verify the required parameter 'campaign_activity_id' is set
|
322
|
+
if @api_client.config.client_side_validation && campaign_activity_id.nil?
|
323
|
+
fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_sms_opt_ins"
|
324
|
+
end
|
325
|
+
# resource path
|
326
|
+
local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_sms_optins'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))
|
327
|
+
|
328
|
+
# query parameters
|
329
|
+
query_params = opts[:query_params] || {}
|
330
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
331
|
+
query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?
|
332
|
+
|
333
|
+
# header parameters
|
334
|
+
header_params = opts[:header_params] || {}
|
335
|
+
# HTTP header 'Accept' (if needed)
|
336
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
337
|
+
|
338
|
+
# form parameters
|
339
|
+
form_params = opts[:form_params] || {}
|
340
|
+
|
341
|
+
# http body (model)
|
342
|
+
post_body = opts[:debug_body]
|
343
|
+
|
344
|
+
# return_type
|
345
|
+
return_type = opts[:debug_return_type] || 'GetUniqueContactSMSOptIns200Response'
|
346
|
+
|
347
|
+
# auth_names
|
348
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
349
|
+
|
350
|
+
new_options = opts.merge(
|
351
|
+
:operation => :"LandingPagesReportingApi.get_unique_contact_sms_opt_ins",
|
352
|
+
:header_params => header_params,
|
353
|
+
:query_params => query_params,
|
354
|
+
:form_params => form_params,
|
355
|
+
:body => post_body,
|
356
|
+
:auth_names => auth_names,
|
357
|
+
:return_type => return_type
|
358
|
+
)
|
359
|
+
|
360
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
361
|
+
if @api_client.config.debugging
|
362
|
+
@api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_sms_opt_ins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
363
|
+
end
|
364
|
+
return data, status_code, headers
|
365
|
+
end
|
366
|
+
|
367
|
+
# GET a Unique Contacts Updates Landing Page Report
|
368
|
+
# Use this method to get contact details for each contact that updated their contact data from a landing page. Contacts are uniquely identified by `contact_id`. The resulting contact data is listed with most recent activity first.
|
369
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact open results.
|
370
|
+
# @param [Hash] opts the optional parameters
|
371
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
372
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
373
|
+
# @return [GetUniqueContactUpdates200Response]
|
374
|
+
def get_unique_contact_updates(campaign_activity_id, opts = {})
|
375
|
+
data, _status_code, _headers = get_unique_contact_updates_with_http_info(campaign_activity_id, opts)
|
376
|
+
data
|
377
|
+
end
|
378
|
+
|
379
|
+
# GET a Unique Contacts Updates Landing Page Report
|
380
|
+
# Use this method to get contact details for each contact that updated their contact data from a landing page. Contacts are uniquely identified by `contact_id`. The resulting contact data is listed with most recent activity first.
|
381
|
+
# @param campaign_activity_id [String] The landing page `campaign_activity_id` (UUID's) to use to get unique contact open results.
|
382
|
+
# @param [Hash] opts the optional parameters
|
383
|
+
# @option opts [String] :limit Use to limit the number of contact tracking activities to return on a single page. The default is `50` and the maximum is `500` per page. (default to '50')
|
384
|
+
# @option opts [String] :contacts_filter Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
|
385
|
+
# @return [Array<(GetUniqueContactUpdates200Response, Integer, Hash)>] GetUniqueContactUpdates200Response data, response status code and response headers
|
386
|
+
def get_unique_contact_updates_with_http_info(campaign_activity_id, opts = {})
|
387
|
+
if @api_client.config.debugging
|
388
|
+
@api_client.config.logger.debug 'Calling API: LandingPagesReportingApi.get_unique_contact_updates ...'
|
389
|
+
end
|
390
|
+
# verify the required parameter 'campaign_activity_id' is set
|
391
|
+
if @api_client.config.client_side_validation && campaign_activity_id.nil?
|
392
|
+
fail ArgumentError, "Missing the required parameter 'campaign_activity_id' when calling LandingPagesReportingApi.get_unique_contact_updates"
|
393
|
+
end
|
394
|
+
# resource path
|
395
|
+
local_var_path = '/reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_updates'.sub('{' + 'campaign_activity_id' + '}', CGI.escape(campaign_activity_id.to_s))
|
396
|
+
|
397
|
+
# query parameters
|
398
|
+
query_params = opts[:query_params] || {}
|
399
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
400
|
+
query_params[:'contacts_filter'] = opts[:'contacts_filter'] if !opts[:'contacts_filter'].nil?
|
401
|
+
|
402
|
+
# header parameters
|
403
|
+
header_params = opts[:header_params] || {}
|
404
|
+
# HTTP header 'Accept' (if needed)
|
405
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
406
|
+
|
407
|
+
# form parameters
|
408
|
+
form_params = opts[:form_params] || {}
|
409
|
+
|
410
|
+
# http body (model)
|
411
|
+
post_body = opts[:debug_body]
|
412
|
+
|
413
|
+
# return_type
|
414
|
+
return_type = opts[:debug_return_type] || 'GetUniqueContactUpdates200Response'
|
415
|
+
|
416
|
+
# auth_names
|
417
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
418
|
+
|
419
|
+
new_options = opts.merge(
|
420
|
+
:operation => :"LandingPagesReportingApi.get_unique_contact_updates",
|
421
|
+
:header_params => header_params,
|
422
|
+
:query_params => query_params,
|
423
|
+
:form_params => form_params,
|
424
|
+
:body => post_body,
|
425
|
+
:auth_names => auth_names,
|
426
|
+
:return_type => return_type
|
427
|
+
)
|
428
|
+
|
429
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
430
|
+
if @api_client.config.debugging
|
431
|
+
@api_client.config.logger.debug "API called: LandingPagesReportingApi#get_unique_contact_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
432
|
+
end
|
433
|
+
return data, status_code, headers
|
434
|
+
end
|
435
|
+
end
|
436
|
+
end
|