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,356 @@
|
|
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 ContactsCustomFieldsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# POST (create) a custom_field
|
23
|
+
# This POST request adds a new `custom_field` to the user's account. A user can configure up to 100 `custom_fields` in their account.
|
24
|
+
# @param update_custom_field_request [UpdateCustomFieldRequest] The JSON payload required to create a new `custom_field`
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [GetCustomField200Response]
|
27
|
+
def create_custom_fields(update_custom_field_request, opts = {})
|
28
|
+
data, _status_code, _headers = create_custom_fields_with_http_info(update_custom_field_request, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# POST (create) a custom_field
|
33
|
+
# This POST request adds a new `custom_field` to the user's account. A user can configure up to 100 `custom_fields` in their account.
|
34
|
+
# @param update_custom_field_request [UpdateCustomFieldRequest] The JSON payload required to create a new `custom_field`
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(GetCustomField200Response, Integer, Hash)>] GetCustomField200Response data, response status code and response headers
|
37
|
+
def create_custom_fields_with_http_info(update_custom_field_request, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: ContactsCustomFieldsApi.create_custom_fields ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'update_custom_field_request' is set
|
42
|
+
if @api_client.config.client_side_validation && update_custom_field_request.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'update_custom_field_request' when calling ContactsCustomFieldsApi.create_custom_fields"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/contact_custom_fields'
|
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(update_custom_field_request)
|
66
|
+
|
67
|
+
# return_type
|
68
|
+
return_type = opts[:debug_return_type] || 'GetCustomField200Response'
|
69
|
+
|
70
|
+
# auth_names
|
71
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
72
|
+
|
73
|
+
new_options = opts.merge(
|
74
|
+
:operation => :"ContactsCustomFieldsApi.create_custom_fields",
|
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: ContactsCustomFieldsApi#create_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
+
end
|
87
|
+
return data, status_code, headers
|
88
|
+
end
|
89
|
+
|
90
|
+
# DELETE a custom_field
|
91
|
+
# This DELETE request deletes a custom_field from the user's account
|
92
|
+
# @param custom_field_id [String] Unique ID of the custom_field on which to operate.
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [nil]
|
95
|
+
def delete_custom_field(custom_field_id, opts = {})
|
96
|
+
delete_custom_field_with_http_info(custom_field_id, opts)
|
97
|
+
nil
|
98
|
+
end
|
99
|
+
|
100
|
+
# DELETE a custom_field
|
101
|
+
# This DELETE request deletes a custom_field from the user's account
|
102
|
+
# @param custom_field_id [String] Unique ID of the custom_field on which to operate.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
105
|
+
def delete_custom_field_with_http_info(custom_field_id, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: ContactsCustomFieldsApi.delete_custom_field ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'custom_field_id' is set
|
110
|
+
if @api_client.config.client_side_validation && custom_field_id.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling ContactsCustomFieldsApi.delete_custom_field"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/contact_custom_fields/{custom_field_id}'.sub('{' + 'custom_field_id' + '}', CGI.escape(custom_field_id.to_s))
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = opts[:query_params] || {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = opts[:header_params] || {}
|
121
|
+
|
122
|
+
# form parameters
|
123
|
+
form_params = opts[:form_params] || {}
|
124
|
+
|
125
|
+
# http body (model)
|
126
|
+
post_body = opts[:debug_body]
|
127
|
+
|
128
|
+
# return_type
|
129
|
+
return_type = opts[:debug_return_type]
|
130
|
+
|
131
|
+
# auth_names
|
132
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
133
|
+
|
134
|
+
new_options = opts.merge(
|
135
|
+
:operation => :"ContactsCustomFieldsApi.delete_custom_field",
|
136
|
+
:header_params => header_params,
|
137
|
+
:query_params => query_params,
|
138
|
+
:form_params => form_params,
|
139
|
+
:body => post_body,
|
140
|
+
:auth_names => auth_names,
|
141
|
+
:return_type => return_type
|
142
|
+
)
|
143
|
+
|
144
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
145
|
+
if @api_client.config.debugging
|
146
|
+
@api_client.config.logger.debug "API called: ContactsCustomFieldsApi#delete_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
147
|
+
end
|
148
|
+
return data, status_code, headers
|
149
|
+
end
|
150
|
+
|
151
|
+
# GET custom_fields Collection
|
152
|
+
# This GET request returns all `custom_fields` defined in the user's account. <div class=\"Msg\"><p class=\"note-text\">This method does not currently support filtering results using the custom field update date.</p></div>
|
153
|
+
# @param [Hash] opts the optional parameters
|
154
|
+
# @option opts [Integer] :limit Specifies the number of results displayed per page of output, from 1 - 100, default = 50. (default to 50)
|
155
|
+
# @return [GetAllCustomFields200Response]
|
156
|
+
def get_all_custom_fields(opts = {})
|
157
|
+
data, _status_code, _headers = get_all_custom_fields_with_http_info(opts)
|
158
|
+
data
|
159
|
+
end
|
160
|
+
|
161
|
+
# GET custom_fields Collection
|
162
|
+
# This GET request returns all `custom_fields` defined in the user's account. <div class=\"Msg\"><p class=\"note-text\">This method does not currently support filtering results using the custom field update date.</p></div>
|
163
|
+
# @param [Hash] opts the optional parameters
|
164
|
+
# @option opts [Integer] :limit Specifies the number of results displayed per page of output, from 1 - 100, default = 50. (default to 50)
|
165
|
+
# @return [Array<(GetAllCustomFields200Response, Integer, Hash)>] GetAllCustomFields200Response data, response status code and response headers
|
166
|
+
def get_all_custom_fields_with_http_info(opts = {})
|
167
|
+
if @api_client.config.debugging
|
168
|
+
@api_client.config.logger.debug 'Calling API: ContactsCustomFieldsApi.get_all_custom_fields ...'
|
169
|
+
end
|
170
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
171
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsCustomFieldsApi.get_all_custom_fields, must be smaller than or equal to 100.'
|
172
|
+
end
|
173
|
+
|
174
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
175
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsCustomFieldsApi.get_all_custom_fields, must be greater than or equal to 1.'
|
176
|
+
end
|
177
|
+
|
178
|
+
# resource path
|
179
|
+
local_var_path = '/contact_custom_fields'
|
180
|
+
|
181
|
+
# query parameters
|
182
|
+
query_params = opts[:query_params] || {}
|
183
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
184
|
+
|
185
|
+
# header parameters
|
186
|
+
header_params = opts[:header_params] || {}
|
187
|
+
# HTTP header 'Accept' (if needed)
|
188
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
189
|
+
|
190
|
+
# form parameters
|
191
|
+
form_params = opts[:form_params] || {}
|
192
|
+
|
193
|
+
# http body (model)
|
194
|
+
post_body = opts[:debug_body]
|
195
|
+
|
196
|
+
# return_type
|
197
|
+
return_type = opts[:debug_return_type] || 'GetAllCustomFields200Response'
|
198
|
+
|
199
|
+
# auth_names
|
200
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
201
|
+
|
202
|
+
new_options = opts.merge(
|
203
|
+
:operation => :"ContactsCustomFieldsApi.get_all_custom_fields",
|
204
|
+
:header_params => header_params,
|
205
|
+
:query_params => query_params,
|
206
|
+
:form_params => form_params,
|
207
|
+
:body => post_body,
|
208
|
+
:auth_names => auth_names,
|
209
|
+
:return_type => return_type
|
210
|
+
)
|
211
|
+
|
212
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
213
|
+
if @api_client.config.debugging
|
214
|
+
@api_client.config.logger.debug "API called: ContactsCustomFieldsApi#get_all_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
215
|
+
end
|
216
|
+
return data, status_code, headers
|
217
|
+
end
|
218
|
+
|
219
|
+
# GET a custom_field
|
220
|
+
# This GET call retrieves a `custom_field` resource, specified by `custom_field_id`.
|
221
|
+
# @param custom_field_id [String] Unique ID of the `custom_field` on which to operate.
|
222
|
+
# @param [Hash] opts the optional parameters
|
223
|
+
# @return [GetCustomField200Response]
|
224
|
+
def get_custom_field(custom_field_id, opts = {})
|
225
|
+
data, _status_code, _headers = get_custom_field_with_http_info(custom_field_id, opts)
|
226
|
+
data
|
227
|
+
end
|
228
|
+
|
229
|
+
# GET a custom_field
|
230
|
+
# This GET call retrieves a `custom_field` resource, specified by `custom_field_id`.
|
231
|
+
# @param custom_field_id [String] Unique ID of the `custom_field` on which to operate.
|
232
|
+
# @param [Hash] opts the optional parameters
|
233
|
+
# @return [Array<(GetCustomField200Response, Integer, Hash)>] GetCustomField200Response data, response status code and response headers
|
234
|
+
def get_custom_field_with_http_info(custom_field_id, opts = {})
|
235
|
+
if @api_client.config.debugging
|
236
|
+
@api_client.config.logger.debug 'Calling API: ContactsCustomFieldsApi.get_custom_field ...'
|
237
|
+
end
|
238
|
+
# verify the required parameter 'custom_field_id' is set
|
239
|
+
if @api_client.config.client_side_validation && custom_field_id.nil?
|
240
|
+
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling ContactsCustomFieldsApi.get_custom_field"
|
241
|
+
end
|
242
|
+
# resource path
|
243
|
+
local_var_path = '/contact_custom_fields/{custom_field_id}'.sub('{' + 'custom_field_id' + '}', CGI.escape(custom_field_id.to_s))
|
244
|
+
|
245
|
+
# query parameters
|
246
|
+
query_params = opts[:query_params] || {}
|
247
|
+
|
248
|
+
# header parameters
|
249
|
+
header_params = opts[:header_params] || {}
|
250
|
+
# HTTP header 'Accept' (if needed)
|
251
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
252
|
+
|
253
|
+
# form parameters
|
254
|
+
form_params = opts[:form_params] || {}
|
255
|
+
|
256
|
+
# http body (model)
|
257
|
+
post_body = opts[:debug_body]
|
258
|
+
|
259
|
+
# return_type
|
260
|
+
return_type = opts[:debug_return_type] || 'GetCustomField200Response'
|
261
|
+
|
262
|
+
# auth_names
|
263
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
264
|
+
|
265
|
+
new_options = opts.merge(
|
266
|
+
:operation => :"ContactsCustomFieldsApi.get_custom_field",
|
267
|
+
:header_params => header_params,
|
268
|
+
:query_params => query_params,
|
269
|
+
:form_params => form_params,
|
270
|
+
:body => post_body,
|
271
|
+
:auth_names => auth_names,
|
272
|
+
:return_type => return_type
|
273
|
+
)
|
274
|
+
|
275
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
276
|
+
if @api_client.config.debugging
|
277
|
+
@api_client.config.logger.debug "API called: ContactsCustomFieldsApi#get_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
278
|
+
end
|
279
|
+
return data, status_code, headers
|
280
|
+
end
|
281
|
+
|
282
|
+
# PUT (update) a custom_field
|
283
|
+
# This PUT request updates an existing `custom_field` object.
|
284
|
+
# @param custom_field_id [String] Unique ID of the `custom_field` on which to operate.
|
285
|
+
# @param update_custom_field_request [UpdateCustomFieldRequest] The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value.
|
286
|
+
# @param [Hash] opts the optional parameters
|
287
|
+
# @return [GetCustomField200Response]
|
288
|
+
def update_custom_field(custom_field_id, update_custom_field_request, opts = {})
|
289
|
+
data, _status_code, _headers = update_custom_field_with_http_info(custom_field_id, update_custom_field_request, opts)
|
290
|
+
data
|
291
|
+
end
|
292
|
+
|
293
|
+
# PUT (update) a custom_field
|
294
|
+
# This PUT request updates an existing `custom_field` object.
|
295
|
+
# @param custom_field_id [String] Unique ID of the `custom_field` on which to operate.
|
296
|
+
# @param update_custom_field_request [UpdateCustomFieldRequest] The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value.
|
297
|
+
# @param [Hash] opts the optional parameters
|
298
|
+
# @return [Array<(GetCustomField200Response, Integer, Hash)>] GetCustomField200Response data, response status code and response headers
|
299
|
+
def update_custom_field_with_http_info(custom_field_id, update_custom_field_request, opts = {})
|
300
|
+
if @api_client.config.debugging
|
301
|
+
@api_client.config.logger.debug 'Calling API: ContactsCustomFieldsApi.update_custom_field ...'
|
302
|
+
end
|
303
|
+
# verify the required parameter 'custom_field_id' is set
|
304
|
+
if @api_client.config.client_side_validation && custom_field_id.nil?
|
305
|
+
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling ContactsCustomFieldsApi.update_custom_field"
|
306
|
+
end
|
307
|
+
# verify the required parameter 'update_custom_field_request' is set
|
308
|
+
if @api_client.config.client_side_validation && update_custom_field_request.nil?
|
309
|
+
fail ArgumentError, "Missing the required parameter 'update_custom_field_request' when calling ContactsCustomFieldsApi.update_custom_field"
|
310
|
+
end
|
311
|
+
# resource path
|
312
|
+
local_var_path = '/contact_custom_fields/{custom_field_id}'.sub('{' + 'custom_field_id' + '}', CGI.escape(custom_field_id.to_s))
|
313
|
+
|
314
|
+
# query parameters
|
315
|
+
query_params = opts[:query_params] || {}
|
316
|
+
|
317
|
+
# header parameters
|
318
|
+
header_params = opts[:header_params] || {}
|
319
|
+
# HTTP header 'Accept' (if needed)
|
320
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
321
|
+
# HTTP header 'Content-Type'
|
322
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
323
|
+
if !content_type.nil?
|
324
|
+
header_params['Content-Type'] = content_type
|
325
|
+
end
|
326
|
+
|
327
|
+
# form parameters
|
328
|
+
form_params = opts[:form_params] || {}
|
329
|
+
|
330
|
+
# http body (model)
|
331
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_custom_field_request)
|
332
|
+
|
333
|
+
# return_type
|
334
|
+
return_type = opts[:debug_return_type] || 'GetCustomField200Response'
|
335
|
+
|
336
|
+
# auth_names
|
337
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
338
|
+
|
339
|
+
new_options = opts.merge(
|
340
|
+
:operation => :"ContactsCustomFieldsApi.update_custom_field",
|
341
|
+
:header_params => header_params,
|
342
|
+
:query_params => query_params,
|
343
|
+
:form_params => form_params,
|
344
|
+
:body => post_body,
|
345
|
+
:auth_names => auth_names,
|
346
|
+
:return_type => return_type
|
347
|
+
)
|
348
|
+
|
349
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
350
|
+
if @api_client.config.debugging
|
351
|
+
@api_client.config.logger.debug "API called: ContactsCustomFieldsApi#update_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
352
|
+
end
|
353
|
+
return data, status_code, headers
|
354
|
+
end
|
355
|
+
end
|
356
|
+
end
|
@@ -0,0 +1,255 @@
|
|
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 ContactsReportingApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# GET Average Open and Click Rates
|
23
|
+
# <p>Gets the average open and click rate for a given account and contact.<p>Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.</p><p>Returns the rates and the number of campaign activities that were included in the calculation.</p><p>If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.</p>
|
24
|
+
# @param contact_id [String] The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
|
25
|
+
# @param start [String] The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
|
26
|
+
# @param _end [String] The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @return [GetContactOpenClickRateReport200Response]
|
29
|
+
def get_contact_open_click_rate_report(contact_id, start, _end, opts = {})
|
30
|
+
data, _status_code, _headers = get_contact_open_click_rate_report_with_http_info(contact_id, start, _end, opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# GET Average Open and Click Rates
|
35
|
+
# <p>Gets the average open and click rate for a given account and contact.<p>Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.</p><p>Returns the rates and the number of campaign activities that were included in the calculation.</p><p>If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.</p>
|
36
|
+
# @param contact_id [String] The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
|
37
|
+
# @param start [String] The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
|
38
|
+
# @param _end [String] The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [Array<(GetContactOpenClickRateReport200Response, Integer, Hash)>] GetContactOpenClickRateReport200Response data, response status code and response headers
|
41
|
+
def get_contact_open_click_rate_report_with_http_info(contact_id, start, _end, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: ContactsReportingApi.get_contact_open_click_rate_report ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'contact_id' is set
|
46
|
+
if @api_client.config.client_side_validation && contact_id.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsReportingApi.get_contact_open_click_rate_report"
|
48
|
+
end
|
49
|
+
# verify the required parameter 'start' is set
|
50
|
+
if @api_client.config.client_side_validation && start.nil?
|
51
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ContactsReportingApi.get_contact_open_click_rate_report"
|
52
|
+
end
|
53
|
+
# verify the required parameter '_end' is set
|
54
|
+
if @api_client.config.client_side_validation && _end.nil?
|
55
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ContactsReportingApi.get_contact_open_click_rate_report"
|
56
|
+
end
|
57
|
+
# resource path
|
58
|
+
local_var_path = '/reports/contact_reports/{contact_id}/open_and_click_rates'.sub('{' + 'contact_id' + '}', CGI.escape(contact_id.to_s))
|
59
|
+
|
60
|
+
# query parameters
|
61
|
+
query_params = opts[:query_params] || {}
|
62
|
+
query_params[:'start'] = start
|
63
|
+
query_params[:'end'] = _end
|
64
|
+
|
65
|
+
# header parameters
|
66
|
+
header_params = opts[:header_params] || {}
|
67
|
+
# HTTP header 'Accept' (if needed)
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
69
|
+
|
70
|
+
# form parameters
|
71
|
+
form_params = opts[:form_params] || {}
|
72
|
+
|
73
|
+
# http body (model)
|
74
|
+
post_body = opts[:debug_body]
|
75
|
+
|
76
|
+
# return_type
|
77
|
+
return_type = opts[:debug_return_type] || 'GetContactOpenClickRateReport200Response'
|
78
|
+
|
79
|
+
# auth_names
|
80
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
81
|
+
|
82
|
+
new_options = opts.merge(
|
83
|
+
:operation => :"ContactsReportingApi.get_contact_open_click_rate_report",
|
84
|
+
:header_params => header_params,
|
85
|
+
:query_params => query_params,
|
86
|
+
:form_params => form_params,
|
87
|
+
:body => post_body,
|
88
|
+
:auth_names => auth_names,
|
89
|
+
:return_type => return_type
|
90
|
+
)
|
91
|
+
|
92
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug "API called: ContactsReportingApi#get_contact_open_click_rate_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
95
|
+
end
|
96
|
+
return data, status_code, headers
|
97
|
+
end
|
98
|
+
|
99
|
+
# GET Contact Action Summary
|
100
|
+
# Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
|
101
|
+
# @param contact_id [String] The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
|
102
|
+
# @param start [String] The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
|
103
|
+
# @param _end [String] The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @return [GetContactTrackingCountReport200Response]
|
106
|
+
def get_contact_tracking_count_report(contact_id, start, _end, opts = {})
|
107
|
+
data, _status_code, _headers = get_contact_tracking_count_report_with_http_info(contact_id, start, _end, opts)
|
108
|
+
data
|
109
|
+
end
|
110
|
+
|
111
|
+
# GET Contact Action Summary
|
112
|
+
# Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
|
113
|
+
# @param contact_id [String] The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
|
114
|
+
# @param start [String] The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
|
115
|
+
# @param _end [String] The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
|
116
|
+
# @param [Hash] opts the optional parameters
|
117
|
+
# @return [Array<(GetContactTrackingCountReport200Response, Integer, Hash)>] GetContactTrackingCountReport200Response data, response status code and response headers
|
118
|
+
def get_contact_tracking_count_report_with_http_info(contact_id, start, _end, opts = {})
|
119
|
+
if @api_client.config.debugging
|
120
|
+
@api_client.config.logger.debug 'Calling API: ContactsReportingApi.get_contact_tracking_count_report ...'
|
121
|
+
end
|
122
|
+
# verify the required parameter 'contact_id' is set
|
123
|
+
if @api_client.config.client_side_validation && contact_id.nil?
|
124
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsReportingApi.get_contact_tracking_count_report"
|
125
|
+
end
|
126
|
+
# verify the required parameter 'start' is set
|
127
|
+
if @api_client.config.client_side_validation && start.nil?
|
128
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ContactsReportingApi.get_contact_tracking_count_report"
|
129
|
+
end
|
130
|
+
# verify the required parameter '_end' is set
|
131
|
+
if @api_client.config.client_side_validation && _end.nil?
|
132
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ContactsReportingApi.get_contact_tracking_count_report"
|
133
|
+
end
|
134
|
+
# resource path
|
135
|
+
local_var_path = '/reports/contact_reports/{contact_id}/activity_summary'.sub('{' + 'contact_id' + '}', CGI.escape(contact_id.to_s))
|
136
|
+
|
137
|
+
# query parameters
|
138
|
+
query_params = opts[:query_params] || {}
|
139
|
+
query_params[:'start'] = start
|
140
|
+
query_params[:'end'] = _end
|
141
|
+
|
142
|
+
# header parameters
|
143
|
+
header_params = opts[:header_params] || {}
|
144
|
+
# HTTP header 'Accept' (if needed)
|
145
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
146
|
+
|
147
|
+
# form parameters
|
148
|
+
form_params = opts[:form_params] || {}
|
149
|
+
|
150
|
+
# http body (model)
|
151
|
+
post_body = opts[:debug_body]
|
152
|
+
|
153
|
+
# return_type
|
154
|
+
return_type = opts[:debug_return_type] || 'GetContactTrackingCountReport200Response'
|
155
|
+
|
156
|
+
# auth_names
|
157
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
158
|
+
|
159
|
+
new_options = opts.merge(
|
160
|
+
:operation => :"ContactsReportingApi.get_contact_tracking_count_report",
|
161
|
+
:header_params => header_params,
|
162
|
+
:query_params => query_params,
|
163
|
+
:form_params => form_params,
|
164
|
+
:body => post_body,
|
165
|
+
:auth_names => auth_names,
|
166
|
+
:return_type => return_type
|
167
|
+
)
|
168
|
+
|
169
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
170
|
+
if @api_client.config.debugging
|
171
|
+
@api_client.config.logger.debug "API called: ContactsReportingApi#get_contact_tracking_count_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
172
|
+
end
|
173
|
+
return data, status_code, headers
|
174
|
+
end
|
175
|
+
|
176
|
+
# GET Contact Activity Details
|
177
|
+
# <p>Gets the tracking activity data for a single contact, sorted in descending activity date order.</p> <p>You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.</p> <table><tr><td colspan='2'>Valid tracking activity types</td></tr> <tr><td><b>em_sends</b></td><td>Send activities</td></tr> <tr><td><b>em_opens</b></td><td>Email open tracking activities</td></tr> <tr><td><b>em_clicks</b></td><td>Link click-through tracking activities</td></tr> <tr><td><b>em_bounces</b></td><td>Bounce tracking activities</td></tr> <tr><td><b>em_optouts</b></td><td>Opt-out tracking activities</td></tr><tr> <td><b>em_forwards</b></td><td>Forward to a friend tracking activities</td></tr> <tr><td><b>p_contact_open</b></td><td>Landing page opens</td></tr> <tr><td><b>p_contact_click</b></td><td>Landing page clicks</td></tr> <tr><td><b>p_contact_add</b></td><td>Landing page adds</td></tr> <tr><td><b>p_contact_update </b></td><td> Landing page updates</td></tr> </table>
|
178
|
+
# @param contact_id [String] The contact's ID for which tracking activity data is requested.
|
179
|
+
# @param [Hash] opts the optional parameters
|
180
|
+
# @option opts [Array<String>] :tracking_activities_list Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
|
181
|
+
# @option opts [Array<String>] :tracking_activity_type Specify one or more tracking activity types to include as an array. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
|
182
|
+
# @option opts [Boolean] :include_campaign_activity_names Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient. (default to true)
|
183
|
+
# @option opts [String] :limit The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100. (default to '100')
|
184
|
+
# @return [GetContactTrackingReport200Response]
|
185
|
+
def get_contact_tracking_report(contact_id, opts = {})
|
186
|
+
data, _status_code, _headers = get_contact_tracking_report_with_http_info(contact_id, opts)
|
187
|
+
data
|
188
|
+
end
|
189
|
+
|
190
|
+
# GET Contact Activity Details
|
191
|
+
# <p>Gets the tracking activity data for a single contact, sorted in descending activity date order.</p> <p>You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.</p> <table><tr><td colspan='2'>Valid tracking activity types</td></tr> <tr><td><b>em_sends</b></td><td>Send activities</td></tr> <tr><td><b>em_opens</b></td><td>Email open tracking activities</td></tr> <tr><td><b>em_clicks</b></td><td>Link click-through tracking activities</td></tr> <tr><td><b>em_bounces</b></td><td>Bounce tracking activities</td></tr> <tr><td><b>em_optouts</b></td><td>Opt-out tracking activities</td></tr><tr> <td><b>em_forwards</b></td><td>Forward to a friend tracking activities</td></tr> <tr><td><b>p_contact_open</b></td><td>Landing page opens</td></tr> <tr><td><b>p_contact_click</b></td><td>Landing page clicks</td></tr> <tr><td><b>p_contact_add</b></td><td>Landing page adds</td></tr> <tr><td><b>p_contact_update </b></td><td> Landing page updates</td></tr> </table>
|
192
|
+
# @param contact_id [String] The contact's ID for which tracking activity data is requested.
|
193
|
+
# @param [Hash] opts the optional parameters
|
194
|
+
# @option opts [Array<String>] :tracking_activities_list Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
|
195
|
+
# @option opts [Array<String>] :tracking_activity_type Specify one or more tracking activity types to include as an array. The `tracking_activities_list` and `tracking_activities_type` query parameters are mutually exclusive.
|
196
|
+
# @option opts [Boolean] :include_campaign_activity_names Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient. (default to true)
|
197
|
+
# @option opts [String] :limit The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100. (default to '100')
|
198
|
+
# @return [Array<(GetContactTrackingReport200Response, Integer, Hash)>] GetContactTrackingReport200Response data, response status code and response headers
|
199
|
+
def get_contact_tracking_report_with_http_info(contact_id, opts = {})
|
200
|
+
if @api_client.config.debugging
|
201
|
+
@api_client.config.logger.debug 'Calling API: ContactsReportingApi.get_contact_tracking_report ...'
|
202
|
+
end
|
203
|
+
# verify the required parameter 'contact_id' is set
|
204
|
+
if @api_client.config.client_side_validation && contact_id.nil?
|
205
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsReportingApi.get_contact_tracking_report"
|
206
|
+
end
|
207
|
+
allowable_values = ["em_sends", "em_opens", "em_clicks", "em_bounces", "em_optouts", "em_forwards", "p_contact_open", "p_contact_click", "p_contact_add", "p_contact_update"]
|
208
|
+
if @api_client.config.client_side_validation && opts[:'tracking_activities_list'] && !opts[:'tracking_activities_list'].all? { |item| allowable_values.include?(item) }
|
209
|
+
fail ArgumentError, "invalid value for \"tracking_activities_list\", must include one of #{allowable_values}"
|
210
|
+
end
|
211
|
+
# resource path
|
212
|
+
local_var_path = '/reports/contact_reports/{contact_id}/activity_details'.sub('{' + 'contact_id' + '}', CGI.escape(contact_id.to_s))
|
213
|
+
|
214
|
+
# query parameters
|
215
|
+
query_params = opts[:query_params] || {}
|
216
|
+
query_params[:'tracking_activities_list'] = @api_client.build_collection_param(opts[:'tracking_activities_list'], :multi) if !opts[:'tracking_activities_list'].nil?
|
217
|
+
query_params[:'tracking_activity_type'] = @api_client.build_collection_param(opts[:'tracking_activity_type'], :csv) if !opts[:'tracking_activity_type'].nil?
|
218
|
+
query_params[:'include_campaign_activity_names'] = opts[:'include_campaign_activity_names'] if !opts[:'include_campaign_activity_names'].nil?
|
219
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
220
|
+
|
221
|
+
# header parameters
|
222
|
+
header_params = opts[:header_params] || {}
|
223
|
+
# HTTP header 'Accept' (if needed)
|
224
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
225
|
+
|
226
|
+
# form parameters
|
227
|
+
form_params = opts[:form_params] || {}
|
228
|
+
|
229
|
+
# http body (model)
|
230
|
+
post_body = opts[:debug_body]
|
231
|
+
|
232
|
+
# return_type
|
233
|
+
return_type = opts[:debug_return_type] || 'GetContactTrackingReport200Response'
|
234
|
+
|
235
|
+
# auth_names
|
236
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
237
|
+
|
238
|
+
new_options = opts.merge(
|
239
|
+
:operation => :"ContactsReportingApi.get_contact_tracking_report",
|
240
|
+
:header_params => header_params,
|
241
|
+
:query_params => query_params,
|
242
|
+
:form_params => form_params,
|
243
|
+
:body => post_body,
|
244
|
+
:auth_names => auth_names,
|
245
|
+
:return_type => return_type
|
246
|
+
)
|
247
|
+
|
248
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
249
|
+
if @api_client.config.debugging
|
250
|
+
@api_client.config.logger.debug "API called: ContactsReportingApi#get_contact_tracking_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
251
|
+
end
|
252
|
+
return data, status_code, headers
|
253
|
+
end
|
254
|
+
end
|
255
|
+
end
|