constant_contact_client 1.0.0 → 1.5.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 +4 -4
- data/CHANGELOG.md +653 -27
- data/Gemfile.lock +52 -23
- data/README.md +23 -6
- data/constant_contact_client.gemspec +3 -3
- data/docs/AccountServicesApi.md +2 -2
- data/docs/BulkActivitiesApi.md +16 -12
- data/docs/ContactListsApi.md +5 -1
- data/docs/ContactsApi.md +84 -10
- data/docs/ContactsCustomFieldsApi.md +22 -22
- data/docs/EmailCampaignsApi.md +1 -1
- data/docs/EmailSchedulingApi.md +1 -1
- data/docs/EventsApi.md +881 -0
- data/docs/SMSReportingApi.md +86 -0
- data/docs/SocialApi.md +302 -0
- data/lib/constant_contact_client/api/account_services_api.rb +4 -4
- data/lib/constant_contact_client/api/bulk_activities_api.rb +19 -16
- data/lib/constant_contact_client/api/contact_lists_api.rb +12 -2
- data/lib/constant_contact_client/api/contact_tags_api.rb +2 -2
- data/lib/constant_contact_client/api/contacts_api.rb +89 -17
- data/lib/constant_contact_client/api/contacts_custom_fields_api.rb +29 -29
- data/lib/constant_contact_client/api/contacts_reporting_api.rb +2 -2
- data/lib/constant_contact_client/api/email_campaigns_ab_tests_api.rb +2 -2
- data/lib/constant_contact_client/api/email_campaigns_api.rb +4 -4
- data/lib/constant_contact_client/api/email_reporting_api.rb +2 -2
- data/lib/constant_contact_client/api/email_scheduling_api.rb +4 -4
- data/lib/constant_contact_client/api/events_api.rb +881 -0
- data/lib/constant_contact_client/api/landing_pages_reporting_api.rb +2 -2
- data/lib/constant_contact_client/api/segments_api.rb +2 -2
- data/lib/constant_contact_client/api/sms_reporting_api.rb +92 -0
- data/lib/constant_contact_client/api/social_api.rb +286 -0
- data/lib/constant_contact_client/api_client.rb +3 -3
- data/lib/constant_contact_client/api_error.rb +2 -2
- data/lib/constant_contact_client/configuration.rb +2 -2
- data/lib/constant_contact_client/models/ab_test_data.rb +2 -2
- data/lib/constant_contact_client/models/access_token_response.rb +2 -2
- data/lib/constant_contact_client/models/account_cancellation.rb +2 -2
- data/lib/constant_contact_client/models/account_email_create_response.rb +2 -2
- data/lib/constant_contact_client/models/account_email_input.rb +2 -2
- data/lib/constant_contact_client/models/account_info_dto.rb +266 -0
- data/lib/constant_contact_client/models/account_physical_address.rb +2 -2
- data/lib/constant_contact_client/models/account_suspension.rb +2 -2
- data/lib/constant_contact_client/models/activities.rb +2 -2
- data/lib/constant_contact_client/models/activity.rb +2 -2
- data/lib/constant_contact_client/models/activity_delete_custom_fields.rb +2 -2
- data/lib/constant_contact_client/models/activity_delete_list_response.rb +3 -3
- data/lib/constant_contact_client/models/activity_delete_lists_response.rb +2 -2
- data/lib/constant_contact_client/models/activity_delete_status.rb +2 -2
- data/lib/constant_contact_client/models/activity_errors.rb +2 -2
- data/lib/constant_contact_client/models/activity_export_status.rb +2 -2
- data/lib/constant_contact_client/models/activity_generic.rb +2 -2
- data/lib/constant_contact_client/models/activity_generic_status.rb +2 -2
- data/lib/constant_contact_client/models/activity_import.rb +2 -2
- data/lib/constant_contact_client/models/activity_links.rb +2 -2
- data/lib/constant_contact_client/models/activity_lists_membership.rb +2 -2
- data/lib/constant_contact_client/models/activity_reference.rb +2 -2
- data/lib/constant_contact_client/models/activity_status.rb +2 -2
- data/lib/constant_contact_client/models/activity_status_export_link.rb +2 -2
- data/lib/constant_contact_client/models/activity_status_link.rb +2 -2
- data/lib/constant_contact_client/models/activity_tagging.rb +2 -2
- data/lib/constant_contact_client/models/activity_tagging_status.rb +2 -2
- data/lib/constant_contact_client/models/add_account_email_address201_response.rb +2 -2
- data/lib/constant_contact_client/models/add_account_email_address_request.rb +2 -2
- data/lib/constant_contact_client/models/address_dto.rb +604 -0
- data/lib/constant_contact_client/models/address_dto1.rb +604 -0
- data/lib/constant_contact_client/models/api_error_schema_inner.rb +2 -2
- data/lib/constant_contact_client/models/attribute_dto.rb +323 -0
- data/lib/constant_contact_client/models/attribute_dto1.rb +323 -0
- data/lib/constant_contact_client/models/authorization_error_schema.rb +2 -2
- data/lib/constant_contact_client/models/automation_campaign.rb +274 -0
- data/lib/constant_contact_client/models/automation_campaign_active_definition.rb +235 -0
- data/lib/constant_contact_client/models/automation_campaign_structured_tags_inner.rb +232 -0
- data/lib/constant_contact_client/models/automation_flow.rb +215 -0
- data/lib/constant_contact_client/models/automation_flow_workflow_def.rb +262 -0
- data/lib/constant_contact_client/models/automation_structured_tag.rb +232 -0
- data/lib/constant_contact_client/models/automation_workflow_def.rb +262 -0
- data/lib/constant_contact_client/models/automation_workflow_definition.rb +235 -0
- data/lib/constant_contact_client/models/automation_workflow_definition_workflow.rb +215 -0
- data/lib/constant_contact_client/models/bounces_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/bounces_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/bulk_campaign_summary.rb +289 -0
- data/lib/constant_contact_client/models/bulk_email_campaign_summaries_page.rb +2 -16
- data/lib/constant_contact_client/models/bulk_email_campaign_summaries_percents.rb +2 -2
- data/lib/constant_contact_client/models/bulk_email_campaign_summary.rb +2 -23
- data/lib/constant_contact_client/models/bulk_sms_campaign_summaries_percents.rb +245 -0
- data/lib/constant_contact_client/models/campaign_activity_stats_query_result_email.rb +2 -2
- data/lib/constant_contact_client/models/campaign_activity_stats_result_generic_stats_email_activity.rb +2 -2
- data/lib/constant_contact_client/models/campaign_activity_summary.rb +2 -2
- data/lib/constant_contact_client/models/campaign_stats_query_result_email.rb +2 -2
- data/lib/constant_contact_client/models/campaign_stats_result_generic_stats_email_percents_email.rb +2 -2
- data/lib/constant_contact_client/models/check_in_tickets_request.rb +225 -0
- data/lib/constant_contact_client/models/clicks_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/clicks_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/company_logo.rb +2 -2
- data/lib/constant_contact_client/models/connection_dto.rb +224 -0
- data/lib/constant_contact_client/models/connection_response_dto.rb +218 -0
- data/lib/constant_contact_client/models/connection_status_dto.rb +276 -0
- data/lib/constant_contact_client/models/contact_campaign_activities_summary.rb +2 -2
- data/lib/constant_contact_client/models/contact_create_or_update_input.rb +17 -15
- data/lib/constant_contact_client/models/contact_create_or_update_response.rb +2 -2
- data/lib/constant_contact_client/models/contact_custom_field.rb +22 -17
- data/lib/constant_contact_client/models/contact_delete.rb +2 -2
- data/lib/constant_contact_client/models/contact_dto.rb +429 -0
- data/lib/constant_contact_client/models/contact_dto1.rb +430 -0
- data/lib/constant_contact_client/models/contact_list.rb +2 -2
- data/lib/constant_contact_client/models/contact_list_array.rb +2 -2
- data/lib/constant_contact_client/models/contact_list_put_post.rb +2 -2
- data/lib/constant_contact_client/models/contact_open_and_click_rates.rb +2 -2
- data/lib/constant_contact_client/models/contact_post_request.rb +15 -6
- data/lib/constant_contact_client/models/contact_put_request.rb +15 -6
- data/lib/constant_contact_client/models/contact_resource.rb +2 -2
- data/lib/constant_contact_client/models/contact_resubscribe_request.rb +224 -0
- data/lib/constant_contact_client/models/contact_sms_channel.rb +241 -0
- data/lib/constant_contact_client/models/contact_sms_channel_consents.rb +249 -0
- data/lib/constant_contact_client/models/contact_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/contact_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/contact_xref.rb +2 -2
- data/lib/constant_contact_client/models/contact_xrefs.rb +2 -2
- data/lib/constant_contact_client/models/contacts.rb +2 -2
- data/lib/constant_contact_client/models/contacts_counts.rb +2 -2
- data/lib/constant_contact_client/models/contacts_export.rb +62 -12
- data/lib/constant_contact_client/models/contacts_json_import.rb +2 -2
- data/lib/constant_contact_client/models/copy_event_request.rb +235 -0
- data/lib/constant_contact_client/models/create_contact_request.rb +15 -6
- data/lib/constant_contact_client/models/create_contact_request_email_address.rb +2 -2
- data/lib/constant_contact_client/models/create_csv_import_activity201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_csv_import_activity201_response_links.rb +2 -2
- data/lib/constant_contact_client/models/create_csv_import_activity201_response_status.rb +2 -2
- data/lib/constant_contact_client/models/create_custom_fields_request.rb +313 -0
- data/lib/constant_contact_client/models/create_custom_fields_request_choices_inner.rb +245 -0
- data/lib/constant_contact_client/models/create_delete_activity201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_delete_activity201_response_links.rb +2 -2
- data/lib/constant_contact_client/models/create_delete_activity201_response_links_self.rb +2 -2
- data/lib/constant_contact_client/models/create_delete_activity201_response_status.rb +2 -2
- data/lib/constant_contact_client/models/create_delete_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_email_campaign200_response.rb +2 -2
- data/lib/constant_contact_client/models/create_email_campaign200_response_campaign_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/create_email_campaign_request.rb +2 -2
- data/lib/constant_contact_client/models/create_email_campaign_request_email_campaign_activities_inner.rb +21 -2
- data/lib/constant_contact_client/models/create_email_campaign_request_email_campaign_activities_inner_physical_address_in_footer.rb +2 -2
- data/lib/constant_contact_client/models/create_event201_response.rb +708 -0
- data/lib/constant_contact_client/models/create_event201_response_event_promotions_inner.rb +256 -0
- data/lib/constant_contact_client/models/create_event201_response_event_settings.rb +265 -0
- data/lib/constant_contact_client/models/create_export_activity201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_export_activity201_response_status.rb +2 -2
- data/lib/constant_contact_client/models/create_export_activity_request.rb +62 -12
- data/lib/constant_contact_client/models/create_export_activity_request_exclude.rb +217 -0
- data/lib/constant_contact_client/models/create_import_json_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_import_json_activity_request_import_data_inner.rb +7 -14
- data/lib/constant_contact_client/models/create_list_add_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_list_add_activity_request_exclude.rb +2 -2
- data/lib/constant_contact_client/models/create_list_add_activity_request_source.rb +2 -2
- data/lib/constant_contact_client/models/create_list_delete_activity201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_list_delete_activity201_response_links.rb +2 -2
- data/lib/constant_contact_client/models/create_list_delete_activity201_response_links_self.rb +2 -2
- data/lib/constant_contact_client/models/create_list_delete_activity201_response_status.rb +2 -2
- data/lib/constant_contact_client/models/create_list_delete_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_list_remove_activity201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_list_remove_activity201_response_status.rb +2 -2
- data/lib/constant_contact_client/models/create_list_remove_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_list_remove_activity_request_exclude.rb +2 -2
- data/lib/constant_contact_client/models/create_list_remove_activity_request_source.rb +2 -2
- data/lib/constant_contact_client/models/create_or_update_contact200_response.rb +2 -2
- data/lib/constant_contact_client/models/create_or_update_contact_custom_field.rb +2 -2
- data/lib/constant_contact_client/models/create_or_update_contact_request.rb +17 -15
- data/lib/constant_contact_client/models/create_or_update_contact_request_custom_fields_inner.rb +2 -2
- data/lib/constant_contact_client/models/create_or_update_contact_request_sms_channel.rb +276 -0
- data/lib/constant_contact_client/models/create_or_update_contact_request_sms_channel_sms_channel_consents_inner.rb +310 -0
- data/lib/constant_contact_client/models/create_or_update_contact_request_street_address.rb +2 -2
- data/lib/constant_contact_client/models/create_resend_email_campaign201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_resend_email_campaign_request.rb +2 -2
- data/lib/constant_contact_client/models/create_segment201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_segment_request.rb +2 -2
- data/lib/constant_contact_client/models/create_social_post200_response.rb +272 -0
- data/lib/constant_contact_client/models/create_social_post_request.rb +262 -0
- data/lib/constant_contact_client/models/create_social_post_request_profile_posts_inner.rb +269 -0
- data/lib/constant_contact_client/models/create_social_post_request_profile_posts_inner_images_inner.rb +233 -0
- data/lib/constant_contact_client/models/create_social_post_request_profile_posts_inner_profiles_inner.rb +323 -0
- data/lib/constant_contact_client/models/create_tag_delete_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links_results.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links_self.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity201_response_status.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity_request_exclude.rb +2 -2
- data/lib/constant_contact_client/models/create_tag_remove_activity_request_source.rb +2 -2
- data/lib/constant_contact_client/models/cross_reference.rb +2 -2
- data/lib/constant_contact_client/models/cross_reference_response.rb +2 -2
- data/lib/constant_contact_client/models/{custom_field_resource.rb → custom_field.rb} +80 -11
- data/lib/constant_contact_client/models/custom_field_choice.rb +295 -0
- data/lib/constant_contact_client/models/custom_field_choice_put_request.rb +255 -0
- data/lib/constant_contact_client/models/custom_field_choice_request.rb +245 -0
- data/lib/constant_contact_client/models/custom_field_id100.rb +2 -2
- data/lib/constant_contact_client/models/custom_field_metadata.rb +266 -0
- data/lib/constant_contact_client/models/{custom_field_input.rb → custom_field_put_request.rb} +35 -28
- data/lib/constant_contact_client/models/custom_field_request.rb +313 -0
- data/lib/constant_contact_client/models/custom_fields.rb +2 -3
- data/lib/constant_contact_client/models/customer.rb +13 -3
- data/lib/constant_contact_client/models/customer_put.rb +2 -2
- data/lib/constant_contact_client/models/delete_list202_response.rb +3 -3
- data/lib/constant_contact_client/models/delete_tag202_response.rb +2 -2
- data/lib/constant_contact_client/models/delete_tag202_response_activity_errors_inner.rb +2 -2
- data/lib/constant_contact_client/models/delete_tag202_response_links.rb +2 -2
- data/lib/constant_contact_client/models/delete_tag202_response_links_self.rb +2 -2
- data/lib/constant_contact_client/models/delete_tag202_response_status.rb +2 -2
- data/lib/constant_contact_client/models/detailed_registration_dto.rb +316 -0
- data/lib/constant_contact_client/models/device_flow_response.rb +2 -2
- data/lib/constant_contact_client/models/did_not_opens_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/did_not_opens_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/email_address.rb +2 -2
- data/lib/constant_contact_client/models/email_address_post.rb +2 -2
- data/lib/constant_contact_client/models/email_address_put.rb +2 -2
- data/lib/constant_contact_client/models/email_campaign.rb +2 -2
- data/lib/constant_contact_client/models/email_campaign_account_information.rb +417 -0
- data/lib/constant_contact_client/models/email_campaign_account_information_message_settings.rb +256 -0
- data/lib/constant_contact_client/models/email_campaign_account_information_physical_address.rb +336 -0
- data/lib/constant_contact_client/models/email_campaign_activity.rb +2 -2
- data/lib/constant_contact_client/models/email_campaign_activity_input.rb +21 -2
- data/lib/constant_contact_client/models/email_campaign_activity_preview.rb +2 -2
- data/lib/constant_contact_client/models/email_campaign_complete.rb +2 -2
- data/lib/constant_contact_client/models/email_campaign_name.rb +2 -2
- data/lib/constant_contact_client/models/email_campaigns.rb +2 -2
- data/lib/constant_contact_client/models/email_link_click_count.rb +2 -2
- data/lib/constant_contact_client/models/email_links.rb +2 -2
- data/lib/constant_contact_client/models/email_physical_address.rb +2 -2
- data/lib/constant_contact_client/models/email_schedule_input.rb +2 -2
- data/lib/constant_contact_client/models/email_test_send_input.rb +2 -2
- data/lib/constant_contact_client/models/emails_link.rb +2 -2
- data/lib/constant_contact_client/models/emails_paging_links.rb +2 -2
- data/lib/constant_contact_client/models/event_copy_request_dto.rb +235 -0
- data/lib/constant_contact_client/models/event_dto.rb +708 -0
- data/lib/constant_contact_client/models/event_listing_dto.rb +344 -0
- data/lib/constant_contact_client/models/event_media_asset_dto.rb +265 -0
- data/lib/constant_contact_client/models/event_media_asset_dto1.rb +265 -0
- data/lib/constant_contact_client/models/event_meta_data_dto.rb +236 -0
- data/lib/constant_contact_client/models/event_meta_data_dto1.rb +236 -0
- data/lib/constant_contact_client/models/event_promotion_dto.rb +256 -0
- data/lib/constant_contact_client/models/event_registration_summary_metric_dto.rb +235 -0
- data/lib/constant_contact_client/models/event_settings_dto.rb +265 -0
- data/lib/constant_contact_client/models/file_object.rb +2 -2
- data/lib/constant_contact_client/models/file_status_array_inner.rb +2 -2
- data/lib/constant_contact_client/models/find_events200_response.rb +256 -0
- data/lib/constant_contact_client/models/find_events200_response_links.rb +233 -0
- data/lib/constant_contact_client/models/find_events200_response_records_inner.rb +344 -0
- data/lib/constant_contact_client/models/find_events200_response_records_inner_event_registration_summary_metrics.rb +235 -0
- data/lib/constant_contact_client/models/find_registrations_using_get200_response.rb +255 -0
- data/lib/constant_contact_client/models/find_registrations_using_get200_response_links.rb +232 -0
- data/lib/constant_contact_client/models/find_registrations_using_get200_response_records_inner.rb +345 -0
- data/lib/constant_contact_client/models/forwards_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/forwards_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/get_ab_test_email_campaign200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_account_details200_response.rb +13 -3
- data/lib/constant_contact_client/models/get_account_details200_response_company_logo.rb +2 -2
- data/lib/constant_contact_client/models/get_account_details200_response_physical_address.rb +2 -2
- data/lib/constant_contact_client/models/get_activity_by_id200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_account_email_addresses200_response_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links_results.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links_self.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_status.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_links.rb +2 -2
- data/lib/constant_contact_client/models/get_all_activities200_response_links_next.rb +2 -2
- data/lib/constant_contact_client/models/get_all_bulk_sms_campaign_summaries200_response.rb +235 -0
- data/lib/constant_contact_client/models/get_all_bulk_sms_campaign_summaries200_response_aggregate_percents.rb +246 -0
- data/lib/constant_contact_client/models/get_all_bulk_sms_campaign_summaries200_response_bulk_sms_campaign_summaries_inner.rb +289 -0
- data/lib/constant_contact_client/models/get_all_bulk_sms_campaign_summaries200_response_bulk_sms_campaign_summaries_inner_unique_counts.rb +284 -0
- data/lib/constant_contact_client/models/get_all_bulk_sms_campaign_summaries200_response_links.rb +215 -0
- data/lib/constant_contact_client/models/get_all_bulk_sms_campaign_summaries200_response_links_next.rb +223 -0
- data/lib/constant_contact_client/models/get_all_contacts200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_custom_fields200_response.rb +2 -3
- data/lib/constant_contact_client/models/get_all_email_campaigns200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_email_campaigns200_response_campaigns_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_all_email_campaigns200_response_links.rb +2 -2
- data/lib/constant_contact_client/models/get_all_lists200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_segments200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_segments200_response_links.rb +2 -2
- data/lib/constant_contact_client/models/get_all_segments200_response_links_next.rb +2 -2
- data/lib/constant_contact_client/models/get_all_segments200_response_segments_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_all_tags200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_all_tags200_response_links.rb +2 -2
- data/lib/constant_contact_client/models/get_all_tags200_response_links_next.rb +2 -2
- data/lib/constant_contact_client/models/get_all_tags200_response_links_next_next.rb +2 -9
- data/lib/constant_contact_client/models/get_bounces_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_bounces_report200_response_links.rb +2 -9
- data/lib/constant_contact_client/models/get_bounces_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_campaign_activity_link_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_campaign_activity_link_report200_response_link_click_counts_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_clicks_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_clicks_report200_response_links.rb +2 -9
- data/lib/constant_contact_client/models/get_clicks_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_adds200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_adds200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response_custom_fields_inner.rb +22 -17
- data/lib/constant_contact_client/models/get_contact_by_id200_response_email_address.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response_notes_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response_phone_numbers_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response_sms_channel.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response_sms_channel_sms_channel_consents_inner.rb +3 -2
- data/lib/constant_contact_client/models/get_contact_by_id200_response_street_addresses_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_counts200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_id_xrefs200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_id_xrefs200_response_xrefs_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_open_click_rate_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response_campaign_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response_links.rb +2 -9
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response_links.rb +2 -9
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response_links_next.rb +2 -9
- data/lib/constant_contact_client/models/get_contact_tracking_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_custom_field200_response.rb +77 -8
- data/lib/constant_contact_client/models/get_custom_field200_response_choices_inner.rb +295 -0
- data/lib/constant_contact_client/models/get_custom_field200_response_metadata.rb +266 -0
- data/lib/constant_contact_client/models/get_did_not_opens_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_did_not_opens_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity200_response_document_properties.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity200_response_physical_address_in_footer.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity_preview200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response_results_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response_results_inner_stats.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity_schedule200_response_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_activity_send_history200_response_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_report200_response.rb +2 -16
- data/lib/constant_contact_client/models/get_email_campaign_report200_response_aggregate_percents.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_report200_response_bulk_email_campaign_summaries_inner.rb +2 -23
- data/lib/constant_contact_client/models/get_email_campaign_report200_response_bulk_email_campaign_summaries_inner_unique_counts.rb +2 -58
- data/lib/constant_contact_client/models/get_email_campaign_xrefs200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_campaign_xrefs200_response_xrefs_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_opens_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_opens_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_sends_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_sends_report200_response_links.rb +2 -9
- data/lib/constant_contact_client/models/get_email_sends_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_stats_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_email_stats_report200_response_errors_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_percents.rb +2 -2
- data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb +2 -2
- data/lib/constant_contact_client/models/get_forwards_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_forwards_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_hashtag_groups200_response.rb +257 -0
- data/lib/constant_contact_client/models/get_hashtag_groups200_response_hashtag_groups_inner.rb +252 -0
- data/lib/constant_contact_client/models/get_hashtag_groups200_response_links.rb +215 -0
- data/lib/constant_contact_client/models/get_hashtag_groups200_response_links_next.rb +223 -0
- data/lib/constant_contact_client/models/get_hashtag_groups200_response_page.rb +274 -0
- data/lib/constant_contact_client/models/get_list200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_list_id_xrefs200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_list_id_xrefs200_response_xrefs_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_optouts_report200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_optouts_report200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_registration_info200_response.rb +316 -0
- data/lib/constant_contact_client/models/get_registration_info200_response_contact_inner.rb +278 -0
- data/lib/constant_contact_client/models/get_registration_info200_response_order_summary.rb +296 -0
- data/lib/constant_contact_client/models/get_registration_info200_response_order_summary_details_inner.rb +245 -0
- data/lib/constant_contact_client/models/get_registration_info200_response_tickets_inner.rb +266 -0
- data/lib/constant_contact_client/models/get_resend_email_campaign200_response_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_sms_engagement_history200_response_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb +3 -13
- data/lib/constant_contact_client/models/get_social_connections200_response.rb +218 -0
- data/lib/constant_contact_client/models/get_social_connections200_response_connections_inner.rb +224 -0
- data/lib/constant_contact_client/models/get_social_connections200_response_connections_inner_account_info.rb +266 -0
- data/lib/constant_contact_client/models/get_social_connections200_response_connections_inner_connection_status.rb +276 -0
- data/lib/constant_contact_client/models/get_social_profiles200_response_inner.rb +348 -0
- data/lib/constant_contact_client/models/get_social_profiles200_response_inner_account_info.rb +266 -0
- data/lib/constant_contact_client/models/get_tag200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_links.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_links_next.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_tracking_activities_inner_sms_channel.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_opens200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_opens200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_sms_opt_ins200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_sms_opt_ins200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_updates200_response.rb +2 -2
- data/lib/constant_contact_client/models/get_unique_contact_updates200_response_tracking_activities_inner.rb +2 -2
- data/lib/constant_contact_client/models/get_user_privileges200_response_inner.rb +2 -2
- data/lib/constant_contact_client/models/hashtag_group_dto.rb +252 -0
- data/lib/constant_contact_client/models/headers_object.rb +2 -2
- data/lib/constant_contact_client/models/history_details.rb +3 -13
- data/lib/constant_contact_client/models/href.rb +214 -0
- data/lib/constant_contact_client/models/image_dto.rb +233 -0
- data/lib/constant_contact_client/models/item_dto.rb +444 -0
- data/lib/constant_contact_client/models/item_dto1.rb +444 -0
- data/lib/constant_contact_client/models/item_summary_dto.rb +263 -0
- data/lib/constant_contact_client/models/item_summary_dto1.rb +263 -0
- data/lib/constant_contact_client/models/jmml_sms_channel.rb +276 -0
- data/lib/constant_contact_client/models/jmml_sms_channel_consents.rb +310 -0
- data/lib/constant_contact_client/models/json_import_contact.rb +7 -14
- data/lib/constant_contact_client/models/line_item_details_dto.rb +245 -0
- data/lib/constant_contact_client/models/link.rb +2 -2
- data/lib/constant_contact_client/models/links.rb +25 -13
- data/lib/constant_contact_client/models/list_activity_add_contacts.rb +2 -2
- data/lib/constant_contact_client/models/list_activity_remove_contacts.rb +2 -2
- data/lib/constant_contact_client/models/list_id_list100.rb +2 -2
- data/lib/constant_contact_client/models/list_input.rb +2 -2
- data/lib/constant_contact_client/models/list_xref.rb +2 -2
- data/lib/constant_contact_client/models/list_xrefs.rb +2 -2
- data/lib/constant_contact_client/models/lpreporting_links.rb +2 -2
- data/lib/constant_contact_client/models/lpreporting_next.rb +2 -2
- data/lib/constant_contact_client/models/model_next.rb +2 -2
- data/lib/constant_contact_client/models/my_library_file_collection_inner.rb +2 -2
- data/lib/constant_contact_client/models/my_library_file_collection_inner_thumbnail.rb +2 -2
- data/lib/constant_contact_client/models/note.rb +2 -2
- data/lib/constant_contact_client/models/o_auth_error.rb +2 -2
- data/lib/constant_contact_client/models/online_meeting_dto.rb +272 -0
- data/lib/constant_contact_client/models/online_meeting_dto1.rb +273 -0
- data/lib/constant_contact_client/models/opens_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/opens_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/optouts_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/optouts_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/order_details_dto.rb +296 -0
- data/lib/constant_contact_client/models/order_ticket_keys_request_dto.rb +225 -0
- data/lib/constant_contact_client/models/p_contact_add_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_add_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_click_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_click_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_open_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_opens_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_sms_opt_in_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_sms_opt_in_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_update_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/p_contact_update_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/page_metadata_dto.rb +274 -0
- data/lib/constant_contact_client/models/paged_email_campaign_response.rb +2 -2
- data/lib/constant_contact_client/models/paged_hashtag_groups_dto.rb +257 -0
- data/lib/constant_contact_client/models/paged_response_link_rel_dto.rb +223 -0
- data/lib/constant_contact_client/models/paged_response_links_dto.rb +215 -0
- data/lib/constant_contact_client/models/paginated_registrations.rb +255 -0
- data/lib/constant_contact_client/models/pagination_dto_event_listing_dto.rb +256 -0
- data/lib/constant_contact_client/models/pagination_links.rb +2 -2
- data/lib/constant_contact_client/models/pagination_links_next.rb +2 -2
- data/lib/constant_contact_client/models/paging_links.rb +2 -2
- data/lib/constant_contact_client/models/partner_account.rb +2 -2
- data/lib/constant_contact_client/models/partner_account_links.rb +2 -2
- data/lib/constant_contact_client/models/partner_account_operations_request.rb +2 -2
- data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_headers_inner.rb +2 -2
- data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_path_parameters_inner.rb +2 -2
- data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_query_parameters_inner.rb +2 -2
- data/lib/constant_contact_client/models/partner_account_site_owner_list_inner.rb +2 -2
- data/lib/constant_contact_client/models/partner_unsubscribe_response.rb +216 -0
- data/lib/constant_contact_client/models/partners_link.rb +2 -2
- data/lib/constant_contact_client/models/patch_email_campaign_name_request.rb +2 -2
- data/lib/constant_contact_client/models/path_param_object.rb +2 -2
- data/lib/constant_contact_client/models/payment_status_update_request_dto.rb +242 -0
- data/lib/constant_contact_client/models/percents_email.rb +2 -2
- data/lib/constant_contact_client/models/phone_number.rb +2 -2
- data/lib/constant_contact_client/models/phone_number_put.rb +2 -2
- data/lib/constant_contact_client/models/plan_info.rb +2 -2
- data/lib/constant_contact_client/models/plan_tiers_object.rb +2 -2
- data/lib/constant_contact_client/models/plan_tiers_object_current_tiers_inner.rb +2 -2
- data/lib/constant_contact_client/models/post_create_dto.rb +262 -0
- data/lib/constant_contact_client/models/post_custom_field_delete201_response.rb +2 -2
- data/lib/constant_contact_client/models/post_custom_field_delete_request.rb +2 -2
- data/lib/constant_contact_client/models/post_dto.rb +272 -0
- data/lib/constant_contact_client/models/post_tag_request.rb +2 -2
- data/lib/constant_contact_client/models/profile_dto.rb +348 -0
- data/lib/constant_contact_client/models/profile_post_dto.rb +269 -0
- data/lib/constant_contact_client/models/profile_post_profile_dto.rb +323 -0
- data/lib/constant_contact_client/models/promo_code_dto.rb +408 -0
- data/lib/constant_contact_client/models/promo_code_dto1.rb +408 -0
- data/lib/constant_contact_client/models/provision.rb +2 -2
- data/lib/constant_contact_client/models/provision_response.rb +2 -2
- data/lib/constant_contact_client/models/put_tag_request.rb +2 -2
- data/lib/constant_contact_client/models/query_param_object.rb +2 -2
- data/lib/constant_contact_client/models/registrant_information_lite_dto.rb +345 -0
- data/lib/constant_contact_client/models/registration_status_update_request_dto.rb +242 -0
- data/lib/constant_contact_client/models/registration_status_update_response_dto.rb +218 -0
- data/lib/constant_contact_client/models/registration_ticket_dto.rb +266 -0
- data/lib/constant_contact_client/models/registrations_links.rb +232 -0
- data/lib/constant_contact_client/models/reporting_links.rb +2 -9
- data/lib/constant_contact_client/models/reporting_next.rb +2 -9
- data/lib/constant_contact_client/models/reportingsms_links.rb +214 -0
- data/lib/constant_contact_client/models/reportingsms_next.rb +222 -0
- data/lib/constant_contact_client/models/resend_to_non_openers_input.rb +2 -2
- data/lib/constant_contact_client/models/resend_to_non_openers_object.rb +2 -2
- data/lib/constant_contact_client/models/resubscribe_contact_request.rb +224 -0
- data/lib/constant_contact_client/models/schedule_email_campaign_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/segment_data.rb +2 -2
- data/lib/constant_contact_client/models/segment_detail.rb +2 -2
- data/lib/constant_contact_client/models/segment_master.rb +2 -2
- data/lib/constant_contact_client/models/segment_name.rb +2 -2
- data/lib/constant_contact_client/models/segments_dto.rb +2 -2
- data/lib/constant_contact_client/models/segments_links.rb +221 -0
- data/lib/constant_contact_client/models/sends_tracking_activities_page.rb +2 -2
- data/lib/constant_contact_client/models/sends_tracking_activity.rb +2 -2
- data/lib/constant_contact_client/models/simple_field_dto.rb +278 -0
- data/lib/constant_contact_client/models/sms_campaign_summaries_page.rb +235 -0
- data/lib/constant_contact_client/models/sms_channel_consent_details.rb +3 -2
- data/lib/constant_contact_client/models/sso_user.rb +3 -3
- data/lib/constant_contact_client/models/stats_email.rb +2 -2
- data/lib/constant_contact_client/models/stats_email_activity.rb +2 -2
- data/lib/constant_contact_client/models/stats_error.rb +2 -2
- data/lib/constant_contact_client/models/status_display_label_dto.rb +226 -0
- data/lib/constant_contact_client/models/status_display_label_dto1.rb +226 -0
- data/lib/constant_contact_client/models/street_address.rb +2 -2
- data/lib/constant_contact_client/models/street_address_put.rb +2 -2
- data/lib/constant_contact_client/models/tag.rb +2 -2
- data/lib/constant_contact_client/models/tag_add_remove_contacts.rb +2 -2
- data/lib/constant_contact_client/models/tag_id_list500_limit.rb +2 -2
- data/lib/constant_contact_client/models/tag_post.rb +2 -2
- data/lib/constant_contact_client/models/tag_put.rb +2 -2
- data/lib/constant_contact_client/models/tags.rb +2 -2
- data/lib/constant_contact_client/models/tags_activity_links.rb +2 -2
- data/lib/constant_contact_client/models/tags_links.rb +2 -2
- data/lib/constant_contact_client/models/tags_paging_links.rb +2 -2
- data/lib/constant_contact_client/models/test_send_email_campaign_activity_request.rb +2 -2
- data/lib/constant_contact_client/models/ticket_summary_dto.rb +279 -0
- data/lib/constant_contact_client/models/ticket_summary_dto1.rb +279 -0
- data/lib/constant_contact_client/models/tier_object.rb +2 -2
- data/lib/constant_contact_client/models/track_dto.rb +377 -0
- data/lib/constant_contact_client/models/track_dto1.rb +377 -0
- data/lib/constant_contact_client/models/tracking_activity_sms_channel_dto.rb +2 -2
- data/lib/constant_contact_client/models/unique_email_counts.rb +2 -58
- data/lib/constant_contact_client/models/unique_sms_counts.rb +283 -0
- data/lib/constant_contact_client/models/update_account_request.rb +2 -2
- data/lib/constant_contact_client/models/update_contact_request.rb +15 -6
- data/lib/constant_contact_client/models/update_contact_request_email_address.rb +2 -2
- data/lib/constant_contact_client/models/update_contact_request_phone_numbers_inner.rb +2 -2
- data/lib/constant_contact_client/models/update_contact_request_sms_channel.rb +241 -0
- data/lib/constant_contact_client/models/update_contact_request_sms_channel_sms_channel_consents_inner.rb +249 -0
- data/lib/constant_contact_client/models/update_contact_request_street_addresses_inner.rb +2 -2
- data/lib/constant_contact_client/models/update_custom_field_request.rb +32 -25
- data/lib/constant_contact_client/models/update_custom_field_request_choices_inner.rb +255 -0
- data/lib/constant_contact_client/models/update_list200_response.rb +2 -2
- data/lib/constant_contact_client/models/update_list_request.rb +2 -2
- data/lib/constant_contact_client/models/update_registration_payment_status_using_put_request.rb +242 -0
- data/lib/constant_contact_client/models/update_registration_status_using_put207_response.rb +218 -0
- data/lib/constant_contact_client/models/update_registration_status_using_put_request.rb +242 -0
- data/lib/constant_contact_client/models/update_segment_name_request.rb +2 -2
- data/lib/constant_contact_client/models/webhooks_subscription_body.rb +2 -2
- data/lib/constant_contact_client/models/webhooks_subscription_collection_inner.rb +2 -2
- data/lib/constant_contact_client/models/webhooks_subscription_put_resp.rb +2 -2
- data/lib/constant_contact_client/models/webhooks_subscription_response.rb +2 -2
- data/lib/constant_contact_client/models/webhooks_test_send.rb +2 -2
- data/lib/constant_contact_client/version.rb +3 -3
- data/lib/constant_contact_client.rb +149 -4
- data/spec/spec_helper.rb +2 -2
- metadata +157 -9
data/Gemfile.lock
CHANGED
|
@@ -1,49 +1,68 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
constant_contact_client (1.
|
|
4
|
+
constant_contact_client (1.5.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
8
8
|
remote: https://rubygems.org/
|
|
9
9
|
specs:
|
|
10
|
-
ast (2.4.
|
|
11
|
-
byebug (
|
|
10
|
+
ast (2.4.3)
|
|
11
|
+
byebug (13.0.0)
|
|
12
|
+
reline (>= 0.6.0)
|
|
12
13
|
coderay (1.1.3)
|
|
13
|
-
|
|
14
|
-
|
|
14
|
+
date (3.5.1)
|
|
15
|
+
diff-lcs (1.6.2)
|
|
16
|
+
ethon (0.18.0)
|
|
15
17
|
ffi (>= 1.15.0)
|
|
16
|
-
|
|
18
|
+
logger
|
|
19
|
+
ffi (1.17.4)
|
|
20
|
+
ffi (1.17.4-aarch64-linux-gnu)
|
|
21
|
+
ffi (1.17.4-aarch64-linux-musl)
|
|
22
|
+
ffi (1.17.4-arm-linux-gnu)
|
|
23
|
+
ffi (1.17.4-arm-linux-musl)
|
|
24
|
+
ffi (1.17.4-arm64-darwin)
|
|
25
|
+
ffi (1.17.4-x86-linux-gnu)
|
|
26
|
+
ffi (1.17.4-x86-linux-musl)
|
|
27
|
+
ffi (1.17.4-x86_64-darwin)
|
|
28
|
+
ffi (1.17.4-x86_64-linux-gnu)
|
|
29
|
+
ffi (1.17.4-x86_64-linux-musl)
|
|
30
|
+
io-console (0.8.2)
|
|
17
31
|
jaro_winkler (1.5.6)
|
|
32
|
+
logger (1.7.0)
|
|
18
33
|
method_source (1.1.0)
|
|
19
|
-
parallel (1.
|
|
20
|
-
parser (3.3.
|
|
34
|
+
parallel (1.28.0)
|
|
35
|
+
parser (3.3.11.1)
|
|
21
36
|
ast (~> 2.4.1)
|
|
22
37
|
racc
|
|
23
|
-
pry (0.
|
|
38
|
+
pry (0.16.0)
|
|
24
39
|
coderay (~> 1.1)
|
|
25
40
|
method_source (~> 1.0)
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
41
|
+
reline (>= 0.6.0)
|
|
42
|
+
pry-byebug (3.12.0)
|
|
43
|
+
byebug (~> 13.0)
|
|
44
|
+
pry (>= 0.13, < 0.17)
|
|
45
|
+
psych (5.4.0)
|
|
46
|
+
date
|
|
30
47
|
stringio
|
|
31
48
|
racc (1.8.1)
|
|
32
49
|
rainbow (3.1.1)
|
|
33
50
|
rake (13.0.6)
|
|
34
|
-
|
|
51
|
+
reline (0.6.3)
|
|
52
|
+
io-console (~> 0.5)
|
|
53
|
+
rspec (3.13.2)
|
|
35
54
|
rspec-core (~> 3.13.0)
|
|
36
55
|
rspec-expectations (~> 3.13.0)
|
|
37
56
|
rspec-mocks (~> 3.13.0)
|
|
38
|
-
rspec-core (3.13.
|
|
57
|
+
rspec-core (3.13.6)
|
|
39
58
|
rspec-support (~> 3.13.0)
|
|
40
|
-
rspec-expectations (3.13.
|
|
59
|
+
rspec-expectations (3.13.5)
|
|
41
60
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
42
61
|
rspec-support (~> 3.13.0)
|
|
43
|
-
rspec-mocks (3.13.
|
|
62
|
+
rspec-mocks (3.13.8)
|
|
44
63
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
45
64
|
rspec-support (~> 3.13.0)
|
|
46
|
-
rspec-support (3.13.
|
|
65
|
+
rspec-support (3.13.7)
|
|
47
66
|
rubocop (0.66.0)
|
|
48
67
|
jaro_winkler (~> 1.5.1)
|
|
49
68
|
parallel (~> 1.10)
|
|
@@ -53,13 +72,23 @@ GEM
|
|
|
53
72
|
ruby-progressbar (~> 1.7)
|
|
54
73
|
unicode-display_width (>= 1.4.0, < 1.6)
|
|
55
74
|
ruby-progressbar (1.13.0)
|
|
56
|
-
stringio (3.
|
|
57
|
-
typhoeus (1.
|
|
58
|
-
ethon (>= 0.
|
|
75
|
+
stringio (3.2.0)
|
|
76
|
+
typhoeus (1.6.0)
|
|
77
|
+
ethon (>= 0.18.0)
|
|
59
78
|
unicode-display_width (1.5.0)
|
|
60
79
|
|
|
61
80
|
PLATFORMS
|
|
62
|
-
|
|
81
|
+
aarch64-linux-gnu
|
|
82
|
+
aarch64-linux-musl
|
|
83
|
+
arm-linux-gnu
|
|
84
|
+
arm-linux-musl
|
|
85
|
+
arm64-darwin
|
|
86
|
+
ruby
|
|
87
|
+
x86-linux-gnu
|
|
88
|
+
x86-linux-musl
|
|
89
|
+
x86_64-darwin
|
|
90
|
+
x86_64-linux-gnu
|
|
91
|
+
x86_64-linux-musl
|
|
63
92
|
|
|
64
93
|
DEPENDENCIES
|
|
65
94
|
constant_contact_client!
|
|
@@ -69,4 +98,4 @@ DEPENDENCIES
|
|
|
69
98
|
rubocop (~> 0.66.0)
|
|
70
99
|
|
|
71
100
|
BUNDLED WITH
|
|
72
|
-
2.
|
|
101
|
+
2.5.21
|
data/README.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
ConstantContactClient - the Ruby gem for the Constant Contact API v3
|
|
4
4
|
|
|
5
|
-
Swagger build version 3.0.
|
|
5
|
+
Swagger build version 3.0.161
|
|
6
6
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
|
-
- API version: 1.0.
|
|
10
|
-
- Package version: 1.
|
|
9
|
+
- API version: 1.0.220
|
|
10
|
+
- Package version: 1.5.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
@@ -23,11 +23,11 @@ gem build constant_contact_client.gemspec
|
|
|
23
23
|
Then either install the gem locally:
|
|
24
24
|
|
|
25
25
|
```shell
|
|
26
|
-
gem install ./constant_contact_client-1.
|
|
26
|
+
gem install ./constant_contact_client-1.5.0.gem
|
|
27
27
|
```
|
|
28
28
|
Finally add this to the Gemfile:
|
|
29
29
|
|
|
30
|
-
gem 'constant_contact_client', '~> 1.
|
|
30
|
+
gem 'constant_contact_client', '~> 1.5.0'
|
|
31
31
|
|
|
32
32
|
Or install from rubygems:
|
|
33
33
|
```shell
|
|
@@ -145,12 +145,13 @@ Class | Method | HTTP request | Description
|
|
|
145
145
|
*ConstantContactClient::ContactsApi* | [**get_contact_counts**](docs/ContactsApi.md#get_contact_counts) | **GET** /contacts/counts | GET Contact Consent Counts
|
|
146
146
|
*ConstantContactClient::ContactsApi* | [**get_contact_id_xrefs**](docs/ContactsApi.md#get_contact_id_xrefs) | **GET** /contacts/contact_id_xrefs | GET a collection of V2 and V3 API contact IDs
|
|
147
147
|
*ConstantContactClient::ContactsApi* | [**get_sms_engagement_history**](docs/ContactsApi.md#get_sms_engagement_history) | **GET** /contacts/sms_engagement_history/{contact_id} | GET SMS Engagement History for a Contact
|
|
148
|
+
*ConstantContactClient::ContactsApi* | [**resubscribe_contact**](docs/ContactsApi.md#resubscribe_contact) | **PUT** /contacts/resubscribe/{contact_id} | PUT Resubscribe a Contact
|
|
148
149
|
*ConstantContactClient::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{contact_id} | PUT (update) a Contact
|
|
149
150
|
*ConstantContactClient::ContactsCustomFieldsApi* | [**create_custom_fields**](docs/ContactsCustomFieldsApi.md#create_custom_fields) | **POST** /contact_custom_fields | POST (create) a custom_field
|
|
150
151
|
*ConstantContactClient::ContactsCustomFieldsApi* | [**delete_custom_field**](docs/ContactsCustomFieldsApi.md#delete_custom_field) | **DELETE** /contact_custom_fields/{custom_field_id} | DELETE a custom_field
|
|
151
152
|
*ConstantContactClient::ContactsCustomFieldsApi* | [**get_all_custom_fields**](docs/ContactsCustomFieldsApi.md#get_all_custom_fields) | **GET** /contact_custom_fields | GET custom_fields Collection
|
|
152
153
|
*ConstantContactClient::ContactsCustomFieldsApi* | [**get_custom_field**](docs/ContactsCustomFieldsApi.md#get_custom_field) | **GET** /contact_custom_fields/{custom_field_id} | GET a custom_field
|
|
153
|
-
*ConstantContactClient::ContactsCustomFieldsApi* | [**update_custom_field**](docs/ContactsCustomFieldsApi.md#update_custom_field) | **PUT** /contact_custom_fields/{custom_field_id} |
|
|
154
|
+
*ConstantContactClient::ContactsCustomFieldsApi* | [**update_custom_field**](docs/ContactsCustomFieldsApi.md#update_custom_field) | **PUT** /contact_custom_fields/{custom_field_id} | Update a custom field.
|
|
154
155
|
*ConstantContactClient::ContactsReportingApi* | [**get_contact_open_click_rate_report**](docs/ContactsReportingApi.md#get_contact_open_click_rate_report) | **GET** /reports/contact_reports/{contact_id}/open_and_click_rates | GET Average Open and Click Rates
|
|
155
156
|
*ConstantContactClient::ContactsReportingApi* | [**get_contact_tracking_count_report**](docs/ContactsReportingApi.md#get_contact_tracking_count_report) | **GET** /reports/contact_reports/{contact_id}/activity_summary | GET Contact Action Summary
|
|
156
157
|
*ConstantContactClient::ContactsReportingApi* | [**get_contact_tracking_report**](docs/ContactsReportingApi.md#get_contact_tracking_report) | **GET** /reports/contact_reports/{contact_id}/activity_details | GET Contact Activity Details
|
|
@@ -186,16 +187,32 @@ Class | Method | HTTP request | Description
|
|
|
186
187
|
*ConstantContactClient::EmailSchedulingApi* | [**schedule_email_campaign_activity**](docs/EmailSchedulingApi.md#schedule_email_campaign_activity) | **POST** /emails/activities/{campaign_activity_id}/schedules | POST (Create) an Email Campaign Activity Schedule
|
|
187
188
|
*ConstantContactClient::EmailSchedulingApi* | [**test_send_email_campaign_activity**](docs/EmailSchedulingApi.md#test_send_email_campaign_activity) | **POST** /emails/activities/{campaign_activity_id}/tests | POST Test Send an Email Campaign Activity
|
|
188
189
|
*ConstantContactClient::EmailSchedulingApi* | [**unschedule_email_campaign_activity**](docs/EmailSchedulingApi.md#unschedule_email_campaign_activity) | **DELETE** /emails/activities/{campaign_activity_id}/schedules | DELETE an Email Campaign Activity Schedule
|
|
190
|
+
*ConstantContactClient::EventsApi* | [**check_in_tickets**](docs/EventsApi.md#check_in_tickets) | **POST** /events/{event_id}/check_in/tickets | Check in event tickets.
|
|
191
|
+
*ConstantContactClient::EventsApi* | [**copy_event**](docs/EventsApi.md#copy_event) | **POST** /events/{event_id}/copy | POST (copy) an existing event.
|
|
192
|
+
*ConstantContactClient::EventsApi* | [**create_event**](docs/EventsApi.md#create_event) | **POST** /events/default | POST (create) a new event.
|
|
193
|
+
*ConstantContactClient::EventsApi* | [**find_events**](docs/EventsApi.md#find_events) | **GET** /events | GET a collection of events.
|
|
194
|
+
*ConstantContactClient::EventsApi* | [**find_registrations_using_get**](docs/EventsApi.md#find_registrations_using_get) | **GET** /events/{event_id}/tracks/{track_id}/registrations | Get a list of registrations for an event.
|
|
195
|
+
*ConstantContactClient::EventsApi* | [**get_event2**](docs/EventsApi.md#get_event2) | **GET** /events/{event_id} | GET details for a single event.
|
|
196
|
+
*ConstantContactClient::EventsApi* | [**get_registration_info**](docs/EventsApi.md#get_registration_info) | **GET** /events/{event_id}/tracks/{track_id}/registrations/{registration_id} | Get registration details for an event.
|
|
197
|
+
*ConstantContactClient::EventsApi* | [**undo_check_in_tickets**](docs/EventsApi.md#undo_check_in_tickets) | **POST** /events/{event_id}/undo_check_in/tickets | Undo event ticket check-in.
|
|
198
|
+
*ConstantContactClient::EventsApi* | [**update_event**](docs/EventsApi.md#update_event) | **PATCH** /events/{event_id} | PATCH (update) an event.
|
|
199
|
+
*ConstantContactClient::EventsApi* | [**update_registration_payment_status_using_put**](docs/EventsApi.md#update_registration_payment_status_using_put) | **PUT** /events/{event_id}/tracks/{track_id}/registrations/payment_status | Update payment status for event registrations.
|
|
200
|
+
*ConstantContactClient::EventsApi* | [**update_registration_status_using_put**](docs/EventsApi.md#update_registration_status_using_put) | **PUT** /events/{event_id}/tracks/{track_id}/registrations | Update status for event registrations.
|
|
189
201
|
*ConstantContactClient::LandingPagesReportingApi* | [**get_contact_adds**](docs/LandingPagesReportingApi.md#get_contact_adds) | **GET** /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_adds | GET a Unique Contacts Adds Landing Page Report
|
|
190
202
|
*ConstantContactClient::LandingPagesReportingApi* | [**get_contact_opens**](docs/LandingPagesReportingApi.md#get_contact_opens) | **GET** /reports/landing_pages/campaign_details/{campaign_activity_id}/p_contact_opens | GET a Contacts Opens Landing Page Report
|
|
191
203
|
*ConstantContactClient::LandingPagesReportingApi* | [**get_unique_contact_clicks**](docs/LandingPagesReportingApi.md#get_unique_contact_clicks) | **GET** /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_clicks | GET a Unique Contacts Clicks Landing Page Report
|
|
192
204
|
*ConstantContactClient::LandingPagesReportingApi* | [**get_unique_contact_opens**](docs/LandingPagesReportingApi.md#get_unique_contact_opens) | **GET** /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_opens | GET a Unique Contacts Opens Landing Page Report
|
|
193
205
|
*ConstantContactClient::LandingPagesReportingApi* | [**get_unique_contact_sms_opt_ins**](docs/LandingPagesReportingApi.md#get_unique_contact_sms_opt_ins) | **GET** /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_sms_optins | GET a Unique Contacts SMS Opt-In Landing Page Report
|
|
194
206
|
*ConstantContactClient::LandingPagesReportingApi* | [**get_unique_contact_updates**](docs/LandingPagesReportingApi.md#get_unique_contact_updates) | **GET** /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_updates | GET a Unique Contacts Updates Landing Page Report
|
|
207
|
+
*ConstantContactClient::SMSReportingApi* | [**get_all_bulk_sms_campaign_summaries**](docs/SMSReportingApi.md#get_all_bulk_sms_campaign_summaries) | **GET** /reports/summary_reports/sms_campaign_summaries | GET an SMS Campaigns Summary Report
|
|
195
208
|
*ConstantContactClient::SegmentsApi* | [**create_segment**](docs/SegmentsApi.md#create_segment) | **POST** /segments | POST (create) a Segment
|
|
196
209
|
*ConstantContactClient::SegmentsApi* | [**delete_segment**](docs/SegmentsApi.md#delete_segment) | **DELETE** /segments/{segment_id} | DELETE a Segment
|
|
197
210
|
*ConstantContactClient::SegmentsApi* | [**get_all_segments**](docs/SegmentsApi.md#get_all_segments) | **GET** /segments | GET all Segments
|
|
198
211
|
*ConstantContactClient::SegmentsApi* | [**get_segment_by_id**](docs/SegmentsApi.md#get_segment_by_id) | **GET** /segments/{segment_id} | GET a Segment's Details
|
|
199
212
|
*ConstantContactClient::SegmentsApi* | [**update_segment**](docs/SegmentsApi.md#update_segment) | **PUT** /segments/{segment_id} | PUT (update) a Segment
|
|
200
213
|
*ConstantContactClient::SegmentsApi* | [**update_segment_name**](docs/SegmentsApi.md#update_segment_name) | **PATCH** /segments/{segment_id}/name | PATCH (rename) a Segment
|
|
214
|
+
*ConstantContactClient::SocialApi* | [**create_social_post**](docs/SocialApi.md#create_social_post) | **POST** /social/posts | POST (create) a social media post
|
|
215
|
+
*ConstantContactClient::SocialApi* | [**get_hashtag_groups**](docs/SocialApi.md#get_hashtag_groups) | **GET** /social/hashtags/groups | GET hashtag groups
|
|
216
|
+
*ConstantContactClient::SocialApi* | [**get_social_connections**](docs/SocialApi.md#get_social_connections) | **GET** /social/connections | GET social network connections
|
|
217
|
+
*ConstantContactClient::SocialApi* | [**get_social_profiles**](docs/SocialApi.md#get_social_profiles) | **GET** /social/profiles | GET social media profiles
|
|
201
218
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#Constant Contact API v3
|
|
5
5
|
|
|
6
|
-
#Swagger build version 3.0.
|
|
6
|
+
#Swagger build version 3.0.161
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 1.0.
|
|
8
|
+
The version of the OpenAPI document: 1.0.220
|
|
9
9
|
Contact: webservices@constantcontact.com
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
OpenAPI Generator version: 7.2.0
|
|
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
|
|
|
23
23
|
s.email = ["ctct-publicapi@constantcontact.com"]
|
|
24
24
|
s.homepage = "https://v3.developer.constantcontact.com/"
|
|
25
25
|
s.summary = "Constant Contact API v3 Ruby Gem"
|
|
26
|
-
s.description = "Swagger build version 3.0.
|
|
26
|
+
s.description = "Swagger build version 3.0.161"
|
|
27
27
|
s.license = "BSD 3-Clause"
|
|
28
28
|
s.required_ruby_version = ">= 2.7"
|
|
29
29
|
s.metadata = {}
|
data/docs/AccountServicesApi.md
CHANGED
|
@@ -109,7 +109,7 @@ ConstantContactClient.configure do |config|
|
|
|
109
109
|
end
|
|
110
110
|
|
|
111
111
|
api_instance = ConstantContactClient::AccountServicesApi.new
|
|
112
|
-
get_account_details200_response_physical_address = ConstantContactClient::GetAccountDetails200ResponsePhysicalAddress.new({address_line1: '123 Maple Street', city: 'Boston', country_code: 'US'}) # GetAccountDetails200ResponsePhysicalAddress | Include all `AccountPhysicalAddress` properties required for the specified `country_code
|
|
112
|
+
get_account_details200_response_physical_address = ConstantContactClient::GetAccountDetails200ResponsePhysicalAddress.new({address_line1: '123 Maple Street', city: 'Boston', country_code: 'US'}) # GetAccountDetails200ResponsePhysicalAddress | Include all `AccountPhysicalAddress` properties required for the specified `country_code`. If a required property is not included or incorrectly formatted, a 400 error message is returned. If the address already exists, a 409 error message is returned.
|
|
113
113
|
|
|
114
114
|
begin
|
|
115
115
|
# POST the Physical Address for the Account
|
|
@@ -142,7 +142,7 @@ end
|
|
|
142
142
|
|
|
143
143
|
| Name | Type | Description | Notes |
|
|
144
144
|
| ---- | ---- | ----------- | ----- |
|
|
145
|
-
| **get_account_details200_response_physical_address** | [**GetAccountDetails200ResponsePhysicalAddress**](GetAccountDetails200ResponsePhysicalAddress.md) | Include all `AccountPhysicalAddress` properties required for the specified `country_code`
|
|
145
|
+
| **get_account_details200_response_physical_address** | [**GetAccountDetails200ResponsePhysicalAddress**](GetAccountDetails200ResponsePhysicalAddress.md) | Include all `AccountPhysicalAddress` properties required for the specified `country_code`. If a required property is not included or incorrectly formatted, a 400 error message is returned. If the address already exists, a 409 error message is returned. | |
|
|
146
146
|
|
|
147
147
|
### Return type
|
|
148
148
|
|
data/docs/BulkActivitiesApi.md
CHANGED
|
@@ -22,11 +22,11 @@ All URIs are relative to *https://api.cc.email/v3*
|
|
|
22
22
|
|
|
23
23
|
## create_csv_import_activity
|
|
24
24
|
|
|
25
|
-
> <CreateCSVImportActivity201Response> create_csv_import_activity(file, list_ids)
|
|
25
|
+
> <CreateCSVImportActivity201Response> create_csv_import_activity(file, list_ids, opts)
|
|
26
26
|
|
|
27
27
|
Import Contacts using a CSV File
|
|
28
28
|
|
|
29
|
-
This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method. Importing a new contact automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB). Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
|
|
29
|
+
This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method. Importing a new contact email address automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. Importing contacts with `sms_number`s requires using the `sms_permission_to_send` parameter to specify permissions for all contacts being imported. Set to `explicit` to specify that all contacts either provided explicit permission. Set to `not_set` if permission was not provided. If `explicit`, you must also include the `sms_consent_date` as a column header to include the date the contact consented to receiving SMS messages. Contacts must have either an email address or an SMS number defined. The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB). Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
|
|
30
30
|
|
|
31
31
|
### Examples
|
|
32
32
|
|
|
@@ -43,12 +43,15 @@ ConstantContactClient.configure do |config|
|
|
|
43
43
|
end
|
|
44
44
|
|
|
45
45
|
api_instance = ConstantContactClient::BulkActivitiesApi.new
|
|
46
|
-
file = File.new('/path/to/some/file') # File | The CSV file you are importing
|
|
47
|
-
list_ids =
|
|
46
|
+
file = File.new('/path/to/some/file') # File | The CSV file you are importing must include either `email` or `sms_number` as a column heading. Other properties you can include using column headings are: `first_name`. `last_name`, `phone`, `job_title`, `anniversary`, `birthday_day`, `birthday_month`, `company_name`, `street`, `street2`, `city`, `state`, `zip`, `country`, and `sms_consent_date`. If adding an `sms_number`, you must also include the `sms_permission_to_send` parameter and set it to either `not_set` or `explicit`. If `explicit`, requires including `sms_consent_date` as a column header to specify the date the contact consented to receiving SMS messages. You can also use custom fields as column headings. Enter the custom field name prefixed with `cf:` as the column heading. For example, use `cf:first_name` as the header name if you have a custom field named \\\"first_name\\\". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
|
|
47
|
+
list_ids = 'list_ids_example' # String | Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact `list_id` values.
|
|
48
|
+
opts = {
|
|
49
|
+
sms_permission_to_send: 'not_set' # String | If importing contact `sms_number`s, use this parameter to specify how SMS consent was provided. If all contacts in the file provided their consent, set to `explicit` and include each contact's `sms_consent_date`. If all contacts in the file have not yet provided consent, set to `not_set` (`sms_consent_date` is not required). You cannot message a contact that does not have a sms consent date set.
|
|
50
|
+
}
|
|
48
51
|
|
|
49
52
|
begin
|
|
50
53
|
# Import Contacts using a CSV File
|
|
51
|
-
result = api_instance.create_csv_import_activity(file, list_ids)
|
|
54
|
+
result = api_instance.create_csv_import_activity(file, list_ids, opts)
|
|
52
55
|
p result
|
|
53
56
|
rescue ConstantContactClient::ApiError => e
|
|
54
57
|
puts "Error when calling BulkActivitiesApi->create_csv_import_activity: #{e}"
|
|
@@ -59,12 +62,12 @@ end
|
|
|
59
62
|
|
|
60
63
|
This returns an Array which contains the response data, status code and headers.
|
|
61
64
|
|
|
62
|
-
> <Array(<CreateCSVImportActivity201Response>, Integer, Hash)> create_csv_import_activity_with_http_info(file, list_ids)
|
|
65
|
+
> <Array(<CreateCSVImportActivity201Response>, Integer, Hash)> create_csv_import_activity_with_http_info(file, list_ids, opts)
|
|
63
66
|
|
|
64
67
|
```ruby
|
|
65
68
|
begin
|
|
66
69
|
# Import Contacts using a CSV File
|
|
67
|
-
data, status_code, headers = api_instance.create_csv_import_activity_with_http_info(file, list_ids)
|
|
70
|
+
data, status_code, headers = api_instance.create_csv_import_activity_with_http_info(file, list_ids, opts)
|
|
68
71
|
p status_code # => 2xx
|
|
69
72
|
p headers # => { ... }
|
|
70
73
|
p data # => <CreateCSVImportActivity201Response>
|
|
@@ -77,8 +80,9 @@ end
|
|
|
77
80
|
|
|
78
81
|
| Name | Type | Description | Notes |
|
|
79
82
|
| ---- | ---- | ----------- | ----- |
|
|
80
|
-
| **file** | **File** | The CSV file you are importing
|
|
81
|
-
| **list_ids** |
|
|
83
|
+
| **file** | **File** | The CSV file you are importing must include either `email` or `sms_number` as a column heading. Other properties you can include using column headings are: `first_name`. `last_name`, `phone`, `job_title`, `anniversary`, `birthday_day`, `birthday_month`, `company_name`, `street`, `street2`, `city`, `state`, `zip`, `country`, and `sms_consent_date`. If adding an `sms_number`, you must also include the `sms_permission_to_send` parameter and set it to either `not_set` or `explicit`. If `explicit`, requires including `sms_consent_date` as a column header to specify the date the contact consented to receiving SMS messages. You can also use custom fields as column headings. Enter the custom field name prefixed with `cf:` as the column heading. For example, use `cf:first_name` as the header name if you have a custom field named \\\"first_name\\\". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields. | |
|
|
84
|
+
| **list_ids** | **String** | Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact `list_id` values. | |
|
|
85
|
+
| **sms_permission_to_send** | **String** | If importing contact `sms_number`s, use this parameter to specify how SMS consent was provided. If all contacts in the file provided their consent, set to `explicit` and include each contact's `sms_consent_date`. If all contacts in the file have not yet provided consent, set to `not_set` (`sms_consent_date` is not required). You cannot message a contact that does not have a sms consent date set. | [optional] |
|
|
82
86
|
|
|
83
87
|
### Return type
|
|
84
88
|
|
|
@@ -172,7 +176,7 @@ end
|
|
|
172
176
|
|
|
173
177
|
Export Contacts to a File
|
|
174
178
|
|
|
175
|
-
Use this method to create an activity that exports contacts and contact details to a CSV file.
|
|
179
|
+
Use this method to create an activity that exports contacts and contact details to a CSV file. You can choose to export all contacts in your account (default) or you can use parameters to filter on which contacts to export. After Constant Contact finishes processing the activity, use the `results` link in the response body to retrieve the CSV file.
|
|
176
180
|
|
|
177
181
|
### Examples
|
|
178
182
|
|
|
@@ -244,7 +248,7 @@ end
|
|
|
244
248
|
|
|
245
249
|
Import Contacts using a JSON Payload
|
|
246
250
|
|
|
247
|
-
Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. Importing a new contact automatically sets the contact's `permission_to_send` property
|
|
251
|
+
Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. A contact's data must include an `email` address and/or `sms_number`. The `sms_number` must be a US phone number to associate with the contact's SMS-enabled phone. Valid formats are <code>1231231234</code> or <code>123-123-1234</code> (the country code must be valid). Importing a new contact using this method automatically sets the contact's email `permission_to_send` property to `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported. To import custom fields, prefix the custom field name with `cf:` and add it as a contact property. For example, use the property name `cf:first_name` if you have a custom field named `first_name`. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields. To include a contact's `sms_number`, if the contact provided explicit permission to receive SMS messages, you must set the `sms_permission_to_send` property to `explicit` and specify the date of consent using the `sms_consent_date` column header. If explicit permission was not provided, set `sms_permission_to_send` to `not_set` (the `sms_consent_date` is not required). If the `sms_consent_date` is not set, SMS messages cannot be sent to contacts and `sms_permission_to_send` defaults to `not_set`. Valid value formats for `sms_consent_date` include MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY. The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
|
|
248
252
|
|
|
249
253
|
### Examples
|
|
250
254
|
|
|
@@ -261,7 +265,7 @@ ConstantContactClient.configure do |config|
|
|
|
261
265
|
end
|
|
262
266
|
|
|
263
267
|
api_instance = ConstantContactClient::BulkActivitiesApi.new
|
|
264
|
-
create_import_json_activity_request = ConstantContactClient::CreateImportJSONActivityRequest.new({import_data: [ConstantContactClient::CreateImportJSONActivityRequestImportDataInner.new
|
|
268
|
+
create_import_json_activity_request = ConstantContactClient::CreateImportJSONActivityRequest.new({import_data: [ConstantContactClient::CreateImportJSONActivityRequestImportDataInner.new], list_ids: ['04fe9a97-a579-43c5-bb1a-58ed29bf0a6a']}) # CreateImportJSONActivityRequest | The JSON request payload that contains the contact data and contact lists for the import.
|
|
265
269
|
|
|
266
270
|
begin
|
|
267
271
|
# Import Contacts using a JSON Payload
|
data/docs/ContactListsApi.md
CHANGED
|
@@ -184,7 +184,9 @@ opts = {
|
|
|
184
184
|
include_count: true, # Boolean | Set `include_count` to `true` to return the total number of contact lists that meet your selection criteria.
|
|
185
185
|
include_membership_count: 'all', # String | Use to include the total number of contacts per list. Set to `active`, to count only active (mailable) contacts, or `all` to count all contacts.
|
|
186
186
|
name: 'TopTier', # String | Use to get details for a single list by entering the full name of the list.
|
|
187
|
-
status: 'all' # String | Use to get lists by status. Accepts comma-separated status values.
|
|
187
|
+
status: 'all', # String | Use to get lists by status. Accepts comma-separated status values.
|
|
188
|
+
channel_type: 'email', # String | Use to return lists by channel type. The default value is `email`.
|
|
189
|
+
include_sms_membership_count: false # Boolean | Set to `true` to return the total number of SMS members in each list. Only applicable when `channel_type` is `sms`. Default is `false`.
|
|
188
190
|
}
|
|
189
191
|
|
|
190
192
|
begin
|
|
@@ -223,6 +225,8 @@ end
|
|
|
223
225
|
| **include_membership_count** | **String** | Use to include the total number of contacts per list. Set to `active`, to count only active (mailable) contacts, or `all` to count all contacts. | [optional] |
|
|
224
226
|
| **name** | **String** | Use to get details for a single list by entering the full name of the list. | [optional] |
|
|
225
227
|
| **status** | **String** | Use to get lists by status. Accepts comma-separated status values. | [optional] |
|
|
228
|
+
| **channel_type** | **String** | Use to return lists by channel type. The default value is `email`. | [optional] |
|
|
229
|
+
| **include_sms_membership_count** | **Boolean** | Set to `true` to return the total number of SMS members in each list. Only applicable when `channel_type` is `sms`. Default is `false`. | [optional] |
|
|
226
230
|
|
|
227
231
|
### Return type
|
|
228
232
|
|
data/docs/ContactsApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.cc.email/v3*
|
|
|
12
12
|
| [**get_contact_counts**](ContactsApi.md#get_contact_counts) | **GET** /contacts/counts | GET Contact Consent Counts |
|
|
13
13
|
| [**get_contact_id_xrefs**](ContactsApi.md#get_contact_id_xrefs) | **GET** /contacts/contact_id_xrefs | GET a collection of V2 and V3 API contact IDs |
|
|
14
14
|
| [**get_sms_engagement_history**](ContactsApi.md#get_sms_engagement_history) | **GET** /contacts/sms_engagement_history/{contact_id} | GET SMS Engagement History for a Contact |
|
|
15
|
+
| [**resubscribe_contact**](ContactsApi.md#resubscribe_contact) | **PUT** /contacts/resubscribe/{contact_id} | PUT Resubscribe a Contact |
|
|
15
16
|
| [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{contact_id} | PUT (update) a Contact |
|
|
16
17
|
|
|
17
18
|
|
|
@@ -21,7 +22,7 @@ All URIs are relative to *https://api.cc.email/v3*
|
|
|
21
22
|
|
|
22
23
|
POST (create) a Contact
|
|
23
24
|
|
|
24
|
-
Creates a new contact resource
|
|
25
|
+
Creates a new contact resource. You must include the `create_source` property and at least one of the following properties: `first_name`, `last_name`, a unique `email_address` (specified using the `EmailAddress` object), or the `sms_channel` property (specified using the `ContactSmsChannel` object). <div class=\"Msg\"><p class=\"note-text\">If `email_address` is specified: **Only use this method when a contact gives you their explicit permission to send them an email. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.</p></div> If `sms_channel` is specified: <div class=\"Msg\"><p class=\"note-text\">Only use this method when a contact gives you their explicit permission to send them an SMS. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.</p></div>
|
|
25
26
|
|
|
26
27
|
### Examples
|
|
27
28
|
|
|
@@ -93,7 +94,7 @@ end
|
|
|
93
94
|
|
|
94
95
|
Create or Update a Contact
|
|
95
96
|
|
|
96
|
-
Use this method to create a new contact or update an existing contact.
|
|
97
|
+
Use this method to create a new contact or update an existing contact. In the request body, this method requires including the `list_memberships` array as well as either the contact's `email_address` string or `sms_channel` object which includes the contact's SMS number. The information you specify determines if a new contact is either created (the email address or SMS number does not already exist in the account), or if an existing contact is updated (the email address or SMS number already exists). The SMS product feature does not need to be enabled to include a contacts SMS details. Updates to existing contacts are partial updates. This method only updates the contact properties you include in the request body. Updates append new contact lists or custom fields to the existing `list_memberships` or `custom_fields` arrays. If `email_address` is specified: <div class=\"Msg\"><p class=\"note-text\">Only use this method when a contact gives you their explicit permission to send them an email. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.</p></div> If `sms_channel` is specified: <div class=\"Msg\"><p class=\"note-text\">Only use this method when a contact gives you their explicit permission to send them an SMS. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.</p></div> When this method creates a new contact, it returns a 201 response code.When this method updates an existing contact, it returns a 200 response code. Updating a deleted contact restores the contact. The method automatically modifies the contact's `permission_to_send` and `opt_in_source` properties depending on the [Confirmed Opt-In](https://knowledgebase.constantcontact.com/articles/KnowledgeBase/5533-obtain-permission-to-send-email-campaigns-to-your-contacts-by-using-confirmed-opt-in) Constant Contact account setting: If Confirmed Opt-in is _enabled_, this method automatically sets the `permission_to_send` property as `pending_confirmation` for new contacts. If Confirmed Opt-in is _disabled_, this method automatically sets the `permission_to_send` property as explicit and the `opt_in_source` property as `Contact` for new contacts. Updated contacts have their `permission_to_send` property set as explicit.
|
|
97
98
|
|
|
98
99
|
### Examples
|
|
99
100
|
|
|
@@ -110,7 +111,7 @@ ConstantContactClient.configure do |config|
|
|
|
110
111
|
end
|
|
111
112
|
|
|
112
113
|
api_instance = ConstantContactClient::ContactsApi.new
|
|
113
|
-
create_or_update_contact_request = ConstantContactClient::CreateOrUpdateContactRequest.new({
|
|
114
|
+
create_or_update_contact_request = ConstantContactClient::CreateOrUpdateContactRequest.new({list_memberships: ['07936f78-662a-11eb-af0a-fa163e56c9b0']}) # CreateOrUpdateContactRequest | A JSON request body payload that contains the contact resource you are creating or updating. The request body must contain the `email_address` property and `list_memberships` array, or the `sms_channel` object.
|
|
114
115
|
|
|
115
116
|
begin
|
|
116
117
|
# Create or Update a Contact
|
|
@@ -143,7 +144,7 @@ end
|
|
|
143
144
|
|
|
144
145
|
| Name | Type | Description | Notes |
|
|
145
146
|
| ---- | ---- | ----------- | ----- |
|
|
146
|
-
| **create_or_update_contact_request** | [**CreateOrUpdateContactRequest**](CreateOrUpdateContactRequest.md) | A JSON request body payload that contains the contact resource you are creating or updating. The request body must contain the `email_address` property and the `
|
|
147
|
+
| **create_or_update_contact_request** | [**CreateOrUpdateContactRequest**](CreateOrUpdateContactRequest.md) | A JSON request body payload that contains the contact resource you are creating or updating. The request body must contain the `email_address` property and `list_memberships` array, or the `sms_channel` object. | |
|
|
147
148
|
|
|
148
149
|
### Return type
|
|
149
150
|
|
|
@@ -236,7 +237,7 @@ nil (empty response body)
|
|
|
236
237
|
|
|
237
238
|
GET Contacts Collection
|
|
238
239
|
|
|
239
|
-
Use this method to return a collection of contacts. Use the query parameters to search for contacts that match specific contact properties and
|
|
240
|
+
Use this method to return a collection of contacts. Use the query parameters to search for contacts that match specific contact properties and sub-resource properties as criteria. For example, you can search using the contact's `email` address, `lists` memberships, and by the date range that a contact was created or updated. Use the `limit` query parameter to limit the number of results returned per page. Use the `include` query parameter to include contact sub-resources in the response and `include_count` to include the total number of contacts that meet your specified search criteria. By default, this method returns all contacts that are not deleted. Use the `status` query parameter with the value `all` to return all contacts including deleted contacts.
|
|
240
241
|
|
|
241
242
|
### Examples
|
|
242
243
|
|
|
@@ -265,7 +266,7 @@ opts = {
|
|
|
265
266
|
created_before: Time.parse('2022-07-16T16:37:59.091Z'), # Time | Use `created_before` to search for contacts created before a specified date. To search for contacts created within a date range, specify both `created_after` and `created_before` dates. Accepts ISO-8601 formatted dates.
|
|
266
267
|
optout_after: Time.parse('2022-11-16T16:20:59.091Z'), # Time | Use `optout_after` to search for contacts that unsubscribed after a specified date.
|
|
267
268
|
optout_before: Time.parse('2022-11-16T16:20:59.091Z'), # Time | Use `optout_before` to search for contacts that unsubscribed before a specified date.
|
|
268
|
-
include: 'custom_fields', # String | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `taggings`, `notes`,`phone_numbers`, `street_addresses
|
|
269
|
+
include: 'custom_fields', # String | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `taggings`, `notes`,`phone_numbers`, `street_addresses`.
|
|
269
270
|
sms_status: 'all', # String | Use to get contacts by their SMS status. This parameter accepts one or more comma separated values: `all`, `explicit`, `unsubscribed`, `pending_confirmation`, `not_set`.
|
|
270
271
|
include_count: true, # Boolean | Set `include_count=true` to include the total number of contacts (`contacts_count`) that meet all search criteria in the response body.
|
|
271
272
|
limit: 25 # Integer | Specifies the number of results displayed per page of output in the response, from 1 - 500, default = 50.
|
|
@@ -313,7 +314,7 @@ end
|
|
|
313
314
|
| **created_before** | **Time** | Use `created_before` to search for contacts created before a specified date. To search for contacts created within a date range, specify both `created_after` and `created_before` dates. Accepts ISO-8601 formatted dates. | [optional] |
|
|
314
315
|
| **optout_after** | **Time** | Use `optout_after` to search for contacts that unsubscribed after a specified date. | [optional] |
|
|
315
316
|
| **optout_before** | **Time** | Use `optout_before` to search for contacts that unsubscribed before a specified date. | [optional] |
|
|
316
|
-
| **include** | **String** | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `taggings`, `notes`,`phone_numbers`, `street_addresses`
|
|
317
|
+
| **include** | **String** | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `taggings`, `notes`,`phone_numbers`, `street_addresses`. | [optional] |
|
|
317
318
|
| **sms_status** | **String** | Use to get contacts by their SMS status. This parameter accepts one or more comma separated values: `all`, `explicit`, `unsubscribed`, `pending_confirmation`, `not_set`. | [optional] |
|
|
318
319
|
| **include_count** | **Boolean** | Set `include_count=true` to include the total number of contacts (`contacts_count`) that meet all search criteria in the response body. | [optional] |
|
|
319
320
|
| **limit** | **Integer** | Specifies the number of results displayed per page of output in the response, from 1 - 500, default = 50. | [optional][default to 50] |
|
|
@@ -357,7 +358,7 @@ end
|
|
|
357
358
|
api_instance = ConstantContactClient::ContactsApi.new
|
|
358
359
|
contact_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | Unique ID of contact to GET
|
|
359
360
|
opts = {
|
|
360
|
-
include: 'custom_fields' # String | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `phone_numbers`, `street_addresses`, `notes`,
|
|
361
|
+
include: 'custom_fields' # String | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `phone_numbers`, `street_addresses`, `notes`, and `taggings`.
|
|
361
362
|
}
|
|
362
363
|
|
|
363
364
|
begin
|
|
@@ -392,7 +393,7 @@ end
|
|
|
392
393
|
| Name | Type | Description | Notes |
|
|
393
394
|
| ---- | ---- | ----------- | ----- |
|
|
394
395
|
| **contact_id** | **String** | Unique ID of contact to GET | |
|
|
395
|
-
| **include** | **String** | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `phone_numbers`, `street_addresses`, `notes`,
|
|
396
|
+
| **include** | **String** | Use `include` to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: `custom_fields`, `list_memberships`, `phone_numbers`, `street_addresses`, `notes`, and `taggings`. | [optional] |
|
|
396
397
|
|
|
397
398
|
### Return type
|
|
398
399
|
|
|
@@ -626,13 +627,86 @@ end
|
|
|
626
627
|
- **Accept**: application/json
|
|
627
628
|
|
|
628
629
|
|
|
630
|
+
## resubscribe_contact
|
|
631
|
+
|
|
632
|
+
> resubscribe_contact(contact_id, resubscribe_contact_request)
|
|
633
|
+
|
|
634
|
+
PUT Resubscribe a Contact
|
|
635
|
+
|
|
636
|
+
Use this endpoint to send a confirmation resubscribe email to a contact in order to get their confirmation to resubscribe. This endpoint also adds the resubscribed contact to the contact lists you specify in the request body. You can only send a resubscribe email to the unsubscribed contact once. The contact is not resubscribed until after you receive their confirmation.
|
|
637
|
+
|
|
638
|
+
### Examples
|
|
639
|
+
|
|
640
|
+
```ruby
|
|
641
|
+
require 'time'
|
|
642
|
+
require 'constant_contact_client'
|
|
643
|
+
# setup authorization
|
|
644
|
+
ConstantContactClient.configure do |config|
|
|
645
|
+
# Configure OAuth2 access token for authorization: oauth2_access_code
|
|
646
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
647
|
+
|
|
648
|
+
# Configure OAuth2 access token for authorization: oauth2_implicit
|
|
649
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
650
|
+
end
|
|
651
|
+
|
|
652
|
+
api_instance = ConstantContactClient::ContactsApi.new
|
|
653
|
+
contact_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | The ID that uniquely identifies the contact to resubscribe.
|
|
654
|
+
resubscribe_contact_request = ConstantContactClient::ResubscribeContactRequest.new({list_ids: ['04fe9a97-a579-43c5-bb1a-58ed29bf0a6a']}) # ResubscribeContactRequest | The JSON payload used to specify one (or more) contact lists to which the contact requested to be resubscribed.
|
|
655
|
+
|
|
656
|
+
begin
|
|
657
|
+
# PUT Resubscribe a Contact
|
|
658
|
+
api_instance.resubscribe_contact(contact_id, resubscribe_contact_request)
|
|
659
|
+
rescue ConstantContactClient::ApiError => e
|
|
660
|
+
puts "Error when calling ContactsApi->resubscribe_contact: #{e}"
|
|
661
|
+
end
|
|
662
|
+
```
|
|
663
|
+
|
|
664
|
+
#### Using the resubscribe_contact_with_http_info variant
|
|
665
|
+
|
|
666
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
667
|
+
|
|
668
|
+
> <Array(nil, Integer, Hash)> resubscribe_contact_with_http_info(contact_id, resubscribe_contact_request)
|
|
669
|
+
|
|
670
|
+
```ruby
|
|
671
|
+
begin
|
|
672
|
+
# PUT Resubscribe a Contact
|
|
673
|
+
data, status_code, headers = api_instance.resubscribe_contact_with_http_info(contact_id, resubscribe_contact_request)
|
|
674
|
+
p status_code # => 2xx
|
|
675
|
+
p headers # => { ... }
|
|
676
|
+
p data # => nil
|
|
677
|
+
rescue ConstantContactClient::ApiError => e
|
|
678
|
+
puts "Error when calling ContactsApi->resubscribe_contact_with_http_info: #{e}"
|
|
679
|
+
end
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
### Parameters
|
|
683
|
+
|
|
684
|
+
| Name | Type | Description | Notes |
|
|
685
|
+
| ---- | ---- | ----------- | ----- |
|
|
686
|
+
| **contact_id** | **String** | The ID that uniquely identifies the contact to resubscribe. | |
|
|
687
|
+
| **resubscribe_contact_request** | [**ResubscribeContactRequest**](ResubscribeContactRequest.md) | The JSON payload used to specify one (or more) contact lists to which the contact requested to be resubscribed. | |
|
|
688
|
+
|
|
689
|
+
### Return type
|
|
690
|
+
|
|
691
|
+
nil (empty response body)
|
|
692
|
+
|
|
693
|
+
### Authorization
|
|
694
|
+
|
|
695
|
+
[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
|
|
696
|
+
|
|
697
|
+
### HTTP request headers
|
|
698
|
+
|
|
699
|
+
- **Content-Type**: application/json
|
|
700
|
+
- **Accept**: Not defined
|
|
701
|
+
|
|
702
|
+
|
|
629
703
|
## update_contact
|
|
630
704
|
|
|
631
705
|
> <GetContactById200Response> update_contact(contact_id, update_contact_request)
|
|
632
706
|
|
|
633
707
|
PUT (update) a Contact
|
|
634
708
|
|
|
635
|
-
The PUT method updates an existing contact. You must include the `update_source` property in the PUT request payload. To restore a deleted contact you must specify the `update_source` as `Account`. When updating any resource using PUT, all properties are updated, overwriting all previous values. Any properties left blank or not included in the request are overwritten with null value - however this does not apply to contact subresources.
|
|
709
|
+
The PUT method updates an existing contact. You must include the `update_source` property in the PUT request payload. To restore a deleted contact you must specify the `update_source` as `Account`. When updating any resource using PUT, all properties are updated, overwriting all previous values. Any properties left blank or not included in the request are overwritten with null value - however this does not apply to contact subresources. Add or change any of the subresources by including them in the PUT request payload. Omitted subresources are not overwritten with null. If the contact being updated is deleted, the contact will be revived. If `email_address` is specified: <div class=\"Msg\"><p class=\"note-text\"> **Only use this method when a contact gives you their explicit permission to send them an email. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.</p></div> If `sms_channel` is specified: <div class=\"Msg\"><p class=\"note-text\">Only use this method when a contact gives you their explicit permission to send them an SMS. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.</p></div>
|
|
636
710
|
|
|
637
711
|
### Examples
|
|
638
712
|
|