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
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -20,7 +20,7 @@ module ConstantContactClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# POST (create) a Contact
|
|
23
|
-
#
|
|
23
|
+
# 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>
|
|
24
24
|
# @param create_contact_request [CreateContactRequest] The JSON payload defining the contact
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [GetContactById200Response]
|
|
@@ -30,7 +30,7 @@ module ConstantContactClient
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# POST (create) a Contact
|
|
33
|
-
#
|
|
33
|
+
# 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>
|
|
34
34
|
# @param create_contact_request [CreateContactRequest] The JSON payload defining the contact
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(GetContactById200Response, Integer, Hash)>] GetContactById200Response data, response status code and response headers
|
|
@@ -88,8 +88,8 @@ module ConstantContactClient
|
|
|
88
88
|
end
|
|
89
89
|
|
|
90
90
|
# Create or Update a Contact
|
|
91
|
-
# Use this method to create a new contact or update an existing contact.
|
|
92
|
-
# @param create_or_update_contact_request [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 the `
|
|
91
|
+
# 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.
|
|
92
|
+
# @param create_or_update_contact_request [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.
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @return [CreateOrUpdateContact200Response]
|
|
95
95
|
def create_or_update_contact(create_or_update_contact_request, opts = {})
|
|
@@ -98,8 +98,8 @@ module ConstantContactClient
|
|
|
98
98
|
end
|
|
99
99
|
|
|
100
100
|
# Create or Update a Contact
|
|
101
|
-
# Use this method to create a new contact or update an existing contact.
|
|
102
|
-
# @param create_or_update_contact_request [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 the `
|
|
101
|
+
# 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.
|
|
102
|
+
# @param create_or_update_contact_request [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.
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
104
104
|
# @return [Array<(CreateOrUpdateContact200Response, Integer, Hash)>] CreateOrUpdateContact200Response data, response status code and response headers
|
|
105
105
|
def create_or_update_contact_with_http_info(create_or_update_contact_request, opts = {})
|
|
@@ -217,7 +217,7 @@ module ConstantContactClient
|
|
|
217
217
|
end
|
|
218
218
|
|
|
219
219
|
# GET Contacts Collection
|
|
220
|
-
# Use this method to return a collection of contacts. Use the query parameters to search for contacts that match specific contact properties and
|
|
220
|
+
# 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.
|
|
221
221
|
# @param [Hash] opts the optional parameters
|
|
222
222
|
# @option opts [String] :status Use the `status` query parameter to search for contacts by status. This parameter accepts one or more comma separated values: `all`, `active`, `deleted`, `not_set`, `pending_confirmation`, `temp_hold`, and `unsubscribed`.
|
|
223
223
|
# @option opts [String] :email Use the `email` query parameter to search for a contact using a specific email address.
|
|
@@ -230,7 +230,7 @@ module ConstantContactClient
|
|
|
230
230
|
# @option opts [Time] :created_before 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.
|
|
231
231
|
# @option opts [Time] :optout_after Use `optout_after` to search for contacts that unsubscribed after a specified date.
|
|
232
232
|
# @option opts [Time] :optout_before Use `optout_before` to search for contacts that unsubscribed before a specified date.
|
|
233
|
-
# @option opts [String] :include 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`
|
|
233
|
+
# @option opts [String] :include 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`.
|
|
234
234
|
# @option opts [String] :sms_status Use to get contacts by their SMS status. This parameter accepts one or more comma separated values: `all`, `explicit`, `unsubscribed`, `pending_confirmation`, `not_set`.
|
|
235
235
|
# @option opts [Boolean] :include_count Set `include_count=true` to include the total number of contacts (`contacts_count`) that meet all search criteria in the response body.
|
|
236
236
|
# @option opts [Integer] :limit Specifies the number of results displayed per page of output in the response, from 1 - 500, default = 50. (default to 50)
|
|
@@ -241,7 +241,7 @@ module ConstantContactClient
|
|
|
241
241
|
end
|
|
242
242
|
|
|
243
243
|
# GET Contacts Collection
|
|
244
|
-
# Use this method to return a collection of contacts. Use the query parameters to search for contacts that match specific contact properties and
|
|
244
|
+
# 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.
|
|
245
245
|
# @param [Hash] opts the optional parameters
|
|
246
246
|
# @option opts [String] :status Use the `status` query parameter to search for contacts by status. This parameter accepts one or more comma separated values: `all`, `active`, `deleted`, `not_set`, `pending_confirmation`, `temp_hold`, and `unsubscribed`.
|
|
247
247
|
# @option opts [String] :email Use the `email` query parameter to search for a contact using a specific email address.
|
|
@@ -254,7 +254,7 @@ module ConstantContactClient
|
|
|
254
254
|
# @option opts [Time] :created_before 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.
|
|
255
255
|
# @option opts [Time] :optout_after Use `optout_after` to search for contacts that unsubscribed after a specified date.
|
|
256
256
|
# @option opts [Time] :optout_before Use `optout_before` to search for contacts that unsubscribed before a specified date.
|
|
257
|
-
# @option opts [String] :include 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`
|
|
257
|
+
# @option opts [String] :include 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`.
|
|
258
258
|
# @option opts [String] :sms_status Use to get contacts by their SMS status. This parameter accepts one or more comma separated values: `all`, `explicit`, `unsubscribed`, `pending_confirmation`, `not_set`.
|
|
259
259
|
# @option opts [Boolean] :include_count Set `include_count=true` to include the total number of contacts (`contacts_count`) that meet all search criteria in the response body.
|
|
260
260
|
# @option opts [Integer] :limit Specifies the number of results displayed per page of output in the response, from 1 - 500, default = 50. (default to 50)
|
|
@@ -267,7 +267,7 @@ module ConstantContactClient
|
|
|
267
267
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
268
268
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
269
269
|
end
|
|
270
|
-
allowable_values = ["custom_fields", "list_memberships", "phone_numbers", "street_addresses", "taggings", "notes"
|
|
270
|
+
allowable_values = ["custom_fields", "list_memberships", "phone_numbers", "street_addresses", "taggings", "notes"]
|
|
271
271
|
if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
|
|
272
272
|
fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
|
|
273
273
|
end
|
|
@@ -342,7 +342,7 @@ module ConstantContactClient
|
|
|
342
342
|
# This endpoint GETs a specific contact resource (contact_id). Use the `include` query parameter to add any of the available contact sub-resources to the response payload.
|
|
343
343
|
# @param contact_id [String] Unique ID of contact to GET
|
|
344
344
|
# @param [Hash] opts the optional parameters
|
|
345
|
-
# @option opts [String] :include 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`,
|
|
345
|
+
# @option opts [String] :include 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`.
|
|
346
346
|
# @return [GetContactById200Response]
|
|
347
347
|
def get_contact_by_id(contact_id, opts = {})
|
|
348
348
|
data, _status_code, _headers = get_contact_by_id_with_http_info(contact_id, opts)
|
|
@@ -353,7 +353,7 @@ module ConstantContactClient
|
|
|
353
353
|
# This endpoint GETs a specific contact resource (contact_id). Use the `include` query parameter to add any of the available contact sub-resources to the response payload.
|
|
354
354
|
# @param contact_id [String] Unique ID of contact to GET
|
|
355
355
|
# @param [Hash] opts the optional parameters
|
|
356
|
-
# @option opts [String] :include 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`,
|
|
356
|
+
# @option opts [String] :include 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`.
|
|
357
357
|
# @return [Array<(GetContactById200Response, Integer, Hash)>] GetContactById200Response data, response status code and response headers
|
|
358
358
|
def get_contact_by_id_with_http_info(contact_id, opts = {})
|
|
359
359
|
if @api_client.config.debugging
|
|
@@ -599,8 +599,80 @@ module ConstantContactClient
|
|
|
599
599
|
return data, status_code, headers
|
|
600
600
|
end
|
|
601
601
|
|
|
602
|
+
# PUT Resubscribe a Contact
|
|
603
|
+
# 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.
|
|
604
|
+
# @param contact_id [String] The ID that uniquely identifies the contact to resubscribe.
|
|
605
|
+
# @param resubscribe_contact_request [ResubscribeContactRequest] The JSON payload used to specify one (or more) contact lists to which the contact requested to be resubscribed.
|
|
606
|
+
# @param [Hash] opts the optional parameters
|
|
607
|
+
# @return [nil]
|
|
608
|
+
def resubscribe_contact(contact_id, resubscribe_contact_request, opts = {})
|
|
609
|
+
resubscribe_contact_with_http_info(contact_id, resubscribe_contact_request, opts)
|
|
610
|
+
nil
|
|
611
|
+
end
|
|
612
|
+
|
|
613
|
+
# PUT Resubscribe a Contact
|
|
614
|
+
# 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.
|
|
615
|
+
# @param contact_id [String] The ID that uniquely identifies the contact to resubscribe.
|
|
616
|
+
# @param resubscribe_contact_request [ResubscribeContactRequest] The JSON payload used to specify one (or more) contact lists to which the contact requested to be resubscribed.
|
|
617
|
+
# @param [Hash] opts the optional parameters
|
|
618
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
619
|
+
def resubscribe_contact_with_http_info(contact_id, resubscribe_contact_request, opts = {})
|
|
620
|
+
if @api_client.config.debugging
|
|
621
|
+
@api_client.config.logger.debug 'Calling API: ContactsApi.resubscribe_contact ...'
|
|
622
|
+
end
|
|
623
|
+
# verify the required parameter 'contact_id' is set
|
|
624
|
+
if @api_client.config.client_side_validation && contact_id.nil?
|
|
625
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.resubscribe_contact"
|
|
626
|
+
end
|
|
627
|
+
# verify the required parameter 'resubscribe_contact_request' is set
|
|
628
|
+
if @api_client.config.client_side_validation && resubscribe_contact_request.nil?
|
|
629
|
+
fail ArgumentError, "Missing the required parameter 'resubscribe_contact_request' when calling ContactsApi.resubscribe_contact"
|
|
630
|
+
end
|
|
631
|
+
# resource path
|
|
632
|
+
local_var_path = '/contacts/resubscribe/{contact_id}'.sub('{' + 'contact_id' + '}', CGI.escape(contact_id.to_s))
|
|
633
|
+
|
|
634
|
+
# query parameters
|
|
635
|
+
query_params = opts[:query_params] || {}
|
|
636
|
+
|
|
637
|
+
# header parameters
|
|
638
|
+
header_params = opts[:header_params] || {}
|
|
639
|
+
# HTTP header 'Content-Type'
|
|
640
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
641
|
+
if !content_type.nil?
|
|
642
|
+
header_params['Content-Type'] = content_type
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
# form parameters
|
|
646
|
+
form_params = opts[:form_params] || {}
|
|
647
|
+
|
|
648
|
+
# http body (model)
|
|
649
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(resubscribe_contact_request)
|
|
650
|
+
|
|
651
|
+
# return_type
|
|
652
|
+
return_type = opts[:debug_return_type]
|
|
653
|
+
|
|
654
|
+
# auth_names
|
|
655
|
+
auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
|
|
656
|
+
|
|
657
|
+
new_options = opts.merge(
|
|
658
|
+
:operation => :"ContactsApi.resubscribe_contact",
|
|
659
|
+
:header_params => header_params,
|
|
660
|
+
:query_params => query_params,
|
|
661
|
+
:form_params => form_params,
|
|
662
|
+
:body => post_body,
|
|
663
|
+
:auth_names => auth_names,
|
|
664
|
+
:return_type => return_type
|
|
665
|
+
)
|
|
666
|
+
|
|
667
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
668
|
+
if @api_client.config.debugging
|
|
669
|
+
@api_client.config.logger.debug "API called: ContactsApi#resubscribe_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
670
|
+
end
|
|
671
|
+
return data, status_code, headers
|
|
672
|
+
end
|
|
673
|
+
|
|
602
674
|
# PUT (update) a Contact
|
|
603
|
-
# 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.
|
|
675
|
+
# 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>
|
|
604
676
|
# @param contact_id [String] Unique ID of contact to update
|
|
605
677
|
# @param update_contact_request [UpdateContactRequest] JSON payload defining the contact object, with updates. Any properties left blank or not included in the PUT payload are overwritten with null value - does not apply to contact subresources.
|
|
606
678
|
# @param [Hash] opts the optional parameters
|
|
@@ -611,7 +683,7 @@ module ConstantContactClient
|
|
|
611
683
|
end
|
|
612
684
|
|
|
613
685
|
# PUT (update) a Contact
|
|
614
|
-
# 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.
|
|
686
|
+
# 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>
|
|
615
687
|
# @param contact_id [String] Unique ID of contact to update
|
|
616
688
|
# @param update_contact_request [UpdateContactRequest] JSON payload defining the contact object, with updates. Any properties left blank or not included in the PUT payload are overwritten with null value - does not apply to contact subresources.
|
|
617
689
|
# @param [Hash] opts the optional parameters
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -20,27 +20,27 @@ module ConstantContactClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# POST (create) a custom_field
|
|
23
|
-
#
|
|
24
|
-
# @param
|
|
23
|
+
# Custom fields are extra data fields you create to store additional information about your contacts, such as preferences, membership levels, and interests. Use custom fields to organize contacts, send personalized email campaigns, and to identify a targeted audience for a specific campaign. Custom fields types include text, number, date, drop-down lists, radio buttons, and checkboxes. A user can configure up to 100 `custom_fields` in their account.
|
|
24
|
+
# @param create_custom_fields_request [CreateCustomFieldsRequest] The JSON payload required to create a new custom field.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [GetCustomField200Response]
|
|
27
|
-
def create_custom_fields(
|
|
28
|
-
data, _status_code, _headers = create_custom_fields_with_http_info(
|
|
27
|
+
def create_custom_fields(create_custom_fields_request, opts = {})
|
|
28
|
+
data, _status_code, _headers = create_custom_fields_with_http_info(create_custom_fields_request, opts)
|
|
29
29
|
data
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# POST (create) a custom_field
|
|
33
|
-
#
|
|
34
|
-
# @param
|
|
33
|
+
# Custom fields are extra data fields you create to store additional information about your contacts, such as preferences, membership levels, and interests. Use custom fields to organize contacts, send personalized email campaigns, and to identify a targeted audience for a specific campaign. Custom fields types include text, number, date, drop-down lists, radio buttons, and checkboxes. A user can configure up to 100 `custom_fields` in their account.
|
|
34
|
+
# @param create_custom_fields_request [CreateCustomFieldsRequest] The JSON payload required to create a new custom field.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(GetCustomField200Response, Integer, Hash)>] GetCustomField200Response data, response status code and response headers
|
|
37
|
-
def create_custom_fields_with_http_info(
|
|
37
|
+
def create_custom_fields_with_http_info(create_custom_fields_request, opts = {})
|
|
38
38
|
if @api_client.config.debugging
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: ContactsCustomFieldsApi.create_custom_fields ...'
|
|
40
40
|
end
|
|
41
|
-
# verify the required parameter '
|
|
42
|
-
if @api_client.config.client_side_validation &&
|
|
43
|
-
fail ArgumentError, "Missing the required parameter '
|
|
41
|
+
# verify the required parameter 'create_custom_fields_request' is set
|
|
42
|
+
if @api_client.config.client_side_validation && create_custom_fields_request.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'create_custom_fields_request' when calling ContactsCustomFieldsApi.create_custom_fields"
|
|
44
44
|
end
|
|
45
45
|
# resource path
|
|
46
46
|
local_var_path = '/contact_custom_fields'
|
|
@@ -62,7 +62,7 @@ module ConstantContactClient
|
|
|
62
62
|
form_params = opts[:form_params] || {}
|
|
63
63
|
|
|
64
64
|
# http body (model)
|
|
65
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_custom_fields_request)
|
|
66
66
|
|
|
67
67
|
# return_type
|
|
68
68
|
return_type = opts[:debug_return_type] || 'GetCustomField200Response'
|
|
@@ -88,8 +88,8 @@ module ConstantContactClient
|
|
|
88
88
|
end
|
|
89
89
|
|
|
90
90
|
# DELETE a custom_field
|
|
91
|
-
#
|
|
92
|
-
# @param custom_field_id [String]
|
|
91
|
+
# Delete a custom field from the user's account.
|
|
92
|
+
# @param custom_field_id [String] The ID that uniquely identifies the custom field to delete.
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @return [nil]
|
|
95
95
|
def delete_custom_field(custom_field_id, opts = {})
|
|
@@ -98,8 +98,8 @@ module ConstantContactClient
|
|
|
98
98
|
end
|
|
99
99
|
|
|
100
100
|
# DELETE a custom_field
|
|
101
|
-
#
|
|
102
|
-
# @param custom_field_id [String]
|
|
101
|
+
# Delete a custom field from the user's account.
|
|
102
|
+
# @param custom_field_id [String] The ID that uniquely identifies the custom field to delete.
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
104
104
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
105
105
|
def delete_custom_field_with_http_info(custom_field_id, opts = {})
|
|
@@ -149,7 +149,7 @@ module ConstantContactClient
|
|
|
149
149
|
end
|
|
150
150
|
|
|
151
151
|
# GET custom_fields Collection
|
|
152
|
-
#
|
|
152
|
+
# Get all custom fields defined in the user's account. <div class=\"Msg\"><p class=\"note-text\">This method does not currently support filtering results using the custom field update date.</p></div>
|
|
153
153
|
# @param [Hash] opts the optional parameters
|
|
154
154
|
# @option opts [Integer] :limit Specifies the number of results displayed per page of output, from 1 - 100, default = 50. (default to 50)
|
|
155
155
|
# @return [GetAllCustomFields200Response]
|
|
@@ -159,7 +159,7 @@ module ConstantContactClient
|
|
|
159
159
|
end
|
|
160
160
|
|
|
161
161
|
# GET custom_fields Collection
|
|
162
|
-
#
|
|
162
|
+
# Get all custom fields defined in the user's account. <div class=\"Msg\"><p class=\"note-text\">This method does not currently support filtering results using the custom field update date.</p></div>
|
|
163
163
|
# @param [Hash] opts the optional parameters
|
|
164
164
|
# @option opts [Integer] :limit Specifies the number of results displayed per page of output, from 1 - 100, default = 50. (default to 50)
|
|
165
165
|
# @return [Array<(GetAllCustomFields200Response, Integer, Hash)>] GetAllCustomFields200Response data, response status code and response headers
|
|
@@ -217,8 +217,8 @@ module ConstantContactClient
|
|
|
217
217
|
end
|
|
218
218
|
|
|
219
219
|
# GET a custom_field
|
|
220
|
-
#
|
|
221
|
-
# @param custom_field_id [String]
|
|
220
|
+
# Get details for a specified custom field.
|
|
221
|
+
# @param custom_field_id [String] The ID that uniquely identifies the custom field.
|
|
222
222
|
# @param [Hash] opts the optional parameters
|
|
223
223
|
# @return [GetCustomField200Response]
|
|
224
224
|
def get_custom_field(custom_field_id, opts = {})
|
|
@@ -227,8 +227,8 @@ module ConstantContactClient
|
|
|
227
227
|
end
|
|
228
228
|
|
|
229
229
|
# GET a custom_field
|
|
230
|
-
#
|
|
231
|
-
# @param custom_field_id [String]
|
|
230
|
+
# Get details for a specified custom field.
|
|
231
|
+
# @param custom_field_id [String] The ID that uniquely identifies the custom field.
|
|
232
232
|
# @param [Hash] opts the optional parameters
|
|
233
233
|
# @return [Array<(GetCustomField200Response, Integer, Hash)>] GetCustomField200Response data, response status code and response headers
|
|
234
234
|
def get_custom_field_with_http_info(custom_field_id, opts = {})
|
|
@@ -279,9 +279,9 @@ module ConstantContactClient
|
|
|
279
279
|
return data, status_code, headers
|
|
280
280
|
end
|
|
281
281
|
|
|
282
|
-
#
|
|
283
|
-
#
|
|
284
|
-
# @param custom_field_id [String]
|
|
282
|
+
# Update a custom field.
|
|
283
|
+
# Update an existing custom field.
|
|
284
|
+
# @param custom_field_id [String] The ID that uniquely identifies the custom field to update.
|
|
285
285
|
# @param update_custom_field_request [UpdateCustomFieldRequest] The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value.
|
|
286
286
|
# @param [Hash] opts the optional parameters
|
|
287
287
|
# @return [GetCustomField200Response]
|
|
@@ -290,9 +290,9 @@ module ConstantContactClient
|
|
|
290
290
|
data
|
|
291
291
|
end
|
|
292
292
|
|
|
293
|
-
#
|
|
294
|
-
#
|
|
295
|
-
# @param custom_field_id [String]
|
|
293
|
+
# Update a custom field.
|
|
294
|
+
# Update an existing custom field.
|
|
295
|
+
# @param custom_field_id [String] The ID that uniquely identifies the custom field to update.
|
|
296
296
|
# @param update_custom_field_request [UpdateCustomFieldRequest] The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value.
|
|
297
297
|
# @param [Hash] opts the optional parameters
|
|
298
298
|
# @return [Array<(GetCustomField200Response, Integer, Hash)>] GetCustomField200Response data, response status code and response headers
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -20,7 +20,7 @@ module ConstantContactClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# POST (Create) a New Email Campaign
|
|
23
|
-
# Use this method to create a new email campaign. This method also creates new `primary_email` and `permalink` email campaign activities and associates them with the new email campaign.
|
|
23
|
+
# Use this method to create a new email campaign. You must include a tracking image (`[[trackingImage]]`) in the email body in order for Constant Contact to report on the email performance. This method also creates new `primary_email` and `permalink` email campaign activities and associates them with the new email campaign. The request body must contain the `name` property and the `email_campaign_activities` array. The `name` must be unique. The `email_campaign_activities` array contains the main content of your email campaign and must include `format_type`, `from_name`, `from_email`, `reply_to_email`, `subject`, and `html_content` properties. The `from_email` address you use must use a verified email address for your account. NOTE: If you create an email campaign using a legacy (V7) format, Constant Contact automatically converts it to the newer custom code format.
|
|
24
24
|
# @param create_email_campaign_request [CreateEmailCampaignRequest] A JSON request body that contains the email content.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreateEmailCampaign200Response]
|
|
@@ -30,7 +30,7 @@ module ConstantContactClient
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# POST (Create) a New Email Campaign
|
|
33
|
-
# Use this method to create a new email campaign. This method also creates new `primary_email` and `permalink` email campaign activities and associates them with the new email campaign.
|
|
33
|
+
# Use this method to create a new email campaign. You must include a tracking image (`[[trackingImage]]`) in the email body in order for Constant Contact to report on the email performance. This method also creates new `primary_email` and `permalink` email campaign activities and associates them with the new email campaign. The request body must contain the `name` property and the `email_campaign_activities` array. The `name` must be unique. The `email_campaign_activities` array contains the main content of your email campaign and must include `format_type`, `from_name`, `from_email`, `reply_to_email`, `subject`, and `html_content` properties. The `from_email` address you use must use a verified email address for your account. NOTE: If you create an email campaign using a legacy (V7) format, Constant Contact automatically converts it to the newer custom code format.
|
|
34
34
|
# @param create_email_campaign_request [CreateEmailCampaignRequest] A JSON request body that contains the email content.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreateEmailCampaign200Response, Integer, Hash)>] CreateEmailCampaign200Response data, response status code and response headers
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Constant Contact API v3
|
|
3
3
|
|
|
4
|
-
#Swagger build version 3.0.
|
|
4
|
+
#Swagger build version 3.0.161
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.220
|
|
7
7
|
Contact: webservices@constantcontact.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.2.0
|
|
@@ -209,7 +209,7 @@ module ConstantContactClient
|
|
|
209
209
|
end
|
|
210
210
|
|
|
211
211
|
# POST (Create) an Email Campaign Activity Schedule
|
|
212
|
-
# Use this method to
|
|
212
|
+
# Use this method to send an email campaign activity to contacts either immediately or on a specific date. To send the email campaign activity immediately, specify `0` for the `scheduled_date` request property (results return an empty array). To send the email campaign activity on a specific date, specify the date using the `scheduled_date` request property (results return the scheduled date in an array). Before you schedule an email campaign activity, you must update the email campaign activity and specify which contacts you want Constant Contact to send the email to. When you make a PUT call to update an email campaign activity, use the `contact_list_ids` or `segment_ids` array to add contacts. You can only schedule email campaign activities that have the `primary_email` role and are in `DRAFT`, `DONE`, or `ERROR` status. When you schedule an email campaign activity in `DONE` status, Constant Contact does not send the email campaign activity to contacts that already received it. Constant Contact only sends the email campaign activity to any new contacts in the contact lists or segment you use.
|
|
213
213
|
# @param campaign_activity_id [String] The unique ID for an email campaign activity. You can only schedule email campaign activities that have the `primary_email` role.
|
|
214
214
|
# @param schedule_email_campaign_activity_request [ScheduleEmailCampaignActivityRequest] A request body payload that contains the date that you want Constant Contact to send your email campaign activity on. Use `\"0\"` as the date to have Constant Contact immediately send the email campaign activity.
|
|
215
215
|
# @param [Hash] opts the optional parameters
|
|
@@ -220,7 +220,7 @@ module ConstantContactClient
|
|
|
220
220
|
end
|
|
221
221
|
|
|
222
222
|
# POST (Create) an Email Campaign Activity Schedule
|
|
223
|
-
# Use this method to
|
|
223
|
+
# Use this method to send an email campaign activity to contacts either immediately or on a specific date. To send the email campaign activity immediately, specify `0` for the `scheduled_date` request property (results return an empty array). To send the email campaign activity on a specific date, specify the date using the `scheduled_date` request property (results return the scheduled date in an array). Before you schedule an email campaign activity, you must update the email campaign activity and specify which contacts you want Constant Contact to send the email to. When you make a PUT call to update an email campaign activity, use the `contact_list_ids` or `segment_ids` array to add contacts. You can only schedule email campaign activities that have the `primary_email` role and are in `DRAFT`, `DONE`, or `ERROR` status. When you schedule an email campaign activity in `DONE` status, Constant Contact does not send the email campaign activity to contacts that already received it. Constant Contact only sends the email campaign activity to any new contacts in the contact lists or segment you use.
|
|
224
224
|
# @param campaign_activity_id [String] The unique ID for an email campaign activity. You can only schedule email campaign activities that have the `primary_email` role.
|
|
225
225
|
# @param schedule_email_campaign_activity_request [ScheduleEmailCampaignActivityRequest] A request body payload that contains the date that you want Constant Contact to send your email campaign activity on. Use `\"0\"` as the date to have Constant Contact immediately send the email campaign activity.
|
|
226
226
|
# @param [Hash] opts the optional parameters
|