constant_contact_client

ConstantContactClient - the Ruby gem for the Constant Contact API v3

Swagger build version 3.0.2475

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.109
• Package version: 1.2.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build constant_contact_client.gemspec

Then either install the gem locally:

gem install ./constant_contact_client-1.2.0.gem

Finally add this to the Gemfile:

gem 'constant_contact_client', '~> 1.2.0'

Or install from rubygems:

gem install constant_contact_client`

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'constant_contact_client'

# Setup authorization
ConstantContactClient.configure do |config|
  # Configure OAuth2 access token for authorization: oauth2_access_code
  config.access_token = 'YOUR ACCESS TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 

  # Configure OAuth2 access token for authorization: oauth2_implicit
  config.access_token = 'YOUR ACCESS TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = ConstantContactClient::AccountServicesApi.new
add_account_email_address_request = ConstantContactClient::AddAccountEmailAddressRequest.new # AddAccountEmailAddressRequest | A JSON request payload containing the new email address you want to add to the Constant Contact account.

begin
  #POST Add an Account Email Address
  result = api_instance.add_account_email_address(add_account_email_address_request)
  p result
rescue ConstantContactClient::ApiError => e
  puts "Exception when calling AccountServicesApi->add_account_email_address: #{e}"
end

Documentation for Authorization

Authentication schemes defined for the API:

oauth2_implicit

• Type: OAuth

• Flow: implicit

• Authorization URL: https://authz.constantcontact.com/oauth2/default/v1/token

• Scopes:

  • contact_data: Read or modify contact data.
  • campaign_data: Read or modify email campaign data.
  • account_read: Read account data.
  • account_update: Modify account data.

oauth2_access_code

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://authz.constantcontact.com/oauth2/default/v1/authorize
• Token URL: https://authz.constantcontact.com/oauth2/default/v1/token
• Scopes:
  • contact_data: Read or modify contact data.
  • campaign_data: Read or modify email campaign data.
  • account_read: Read account data.
  • account_update: Modify account data.

Documentation for API Endpoints

All URIs are relative to https://api.cc.email/v3

Class	Method	HTTP request	Description
ConstantContactClient::AccountServicesApi	add_account_email_address	POST /account/emails	POST Add an Account Email Address
ConstantContactClient::AccountServicesApi	add_physical_address	POST /account/summary/physical_address	POST the Physical Address for the Account
ConstantContactClient::AccountServicesApi	get_account_details	GET /account/summary	GET a Summary of Account Details
ConstantContactClient::AccountServicesApi	get_account_physical_address	GET /account/summary/physical_address	GET the Physical Address for the Account
ConstantContactClient::AccountServicesApi	get_all_account_email_addresses	GET /account/emails	GET a Collection of Account Email Addresses
ConstantContactClient::AccountServicesApi	get_user_privileges	GET /account/user/privileges	GET User Privileges
ConstantContactClient::AccountServicesApi	update_account	PUT /account/summary	PUT (update) Account Details
ConstantContactClient::AccountServicesApi	update_account_physical_address	PUT /account/summary/physical_address	PUT (update) the Physical Address for an Account
ConstantContactClient::BulkActivitiesApi	create_csv_import_activity	POST /activities/contacts_file_import	Import Contacts using a CSV File
ConstantContactClient::BulkActivitiesApi	create_delete_activity	POST /activities/contact_delete	Delete Contacts in Bulk
ConstantContactClient::BulkActivitiesApi	create_export_activity	POST /activities/contact_exports	Export Contacts to a File
ConstantContactClient::BulkActivitiesApi	create_import_json_activity	POST /activities/contacts_json_import	Import Contacts using a JSON Payload
ConstantContactClient::BulkActivitiesApi	create_list_add_activity	POST /activities/add_list_memberships	Add Contacts to Lists
ConstantContactClient::BulkActivitiesApi	create_list_delete_activity	POST /activities/list_delete	Delete Contact Lists
ConstantContactClient::BulkActivitiesApi	create_list_remove_activity	POST /activities/remove_list_memberships	Remove Contacts from Lists
ConstantContactClient::BulkActivitiesApi	create_tag_add_contact_activity	POST /activities/contacts_taggings_add	Add Tags to Contacts
ConstantContactClient::BulkActivitiesApi	create_tag_delete_activity	POST /activities/contacts_tags_delete	Delete Tags
ConstantContactClient::BulkActivitiesApi	create_tag_remove_activity	POST /activities/contacts_taggings_remove	Remove Tags from Contacts
ConstantContactClient::BulkActivitiesApi	get_activity_by_id	GET /activities/{activity_id}	GET an Activity Status
ConstantContactClient::BulkActivitiesApi	get_all_activities	GET /activities	GET Activity Status Collection
ConstantContactClient::BulkActivitiesApi	get_csv_export_file	GET /contact_exports/{file_export_id}	Retrieve Exported Contacts File
ConstantContactClient::BulkActivitiesApi	post_custom_field_delete	POST /activities/custom_fields_delete	Delete Custom Fields
ConstantContactClient::ContactListsApi	create_list	POST /contact_lists	POST (create) a List
ConstantContactClient::ContactListsApi	delete_list	DELETE /contact_lists/{list_id}	DELETE a List
ConstantContactClient::ContactListsApi	get_all_lists	GET /contact_lists	GET Lists Collection
ConstantContactClient::ContactListsApi	get_list	GET /contact_lists/{list_id}	GET a List
ConstantContactClient::ContactListsApi	get_list_id_xrefs	GET /contact_lists/list_id_xrefs	GET a collection of V2 and V3 API List IDs
ConstantContactClient::ContactListsApi	update_list	PUT /contact_lists/{list_id}	PUT (update) a List
ConstantContactClient::ContactTagsApi	delete_tag	DELETE /contact_tags/{tag_id}	DELETE a Tag
ConstantContactClient::ContactTagsApi	get_all_tags	GET /contact_tags	GET Details for All Tags
ConstantContactClient::ContactTagsApi	get_tag	GET /contact_tags/{tag_id}	GET Tag Details
ConstantContactClient::ContactTagsApi	post_tag	POST /contact_tags	POST (Create) a Tag
ConstantContactClient::ContactTagsApi	put_tag	PUT /contact_tags/{tag_id}	PUT (Update) a Tag
ConstantContactClient::ContactsApi	create_contact	POST /contacts	POST (create) a Contact
ConstantContactClient::ContactsApi	create_or_update_contact	POST /contacts/sign_up_form	Create or Update a Contact
ConstantContactClient::ContactsApi	delete_contact	DELETE /contacts/{contact_id}	DELETE a Contact
ConstantContactClient::ContactsApi	get_all_contacts	GET /contacts	GET Contacts Collection
ConstantContactClient::ContactsApi	get_contact_by_id	GET /contacts/{contact_id}	GET a Contact
ConstantContactClient::ContactsApi	get_contact_counts	GET /contacts/counts	GET Contact Consent Counts
ConstantContactClient::ContactsApi	get_contact_id_xrefs	GET /contacts/contact_id_xrefs	GET a collection of V2 and V3 API contact IDs
ConstantContactClient::ContactsApi	get_sms_engagement_history	GET /contacts/sms_engagement_history/{contact_id}	GET SMS Engagement History for a Contact
ConstantContactClient::ContactsApi	update_contact	PUT /contacts/{contact_id}	PUT (update) a Contact
ConstantContactClient::ContactsCustomFieldsApi	create_custom_fields	POST /contact_custom_fields	POST (create) a custom_field
ConstantContactClient::ContactsCustomFieldsApi	delete_custom_field	DELETE /contact_custom_fields/{custom_field_id}	DELETE a custom_field
ConstantContactClient::ContactsCustomFieldsApi	get_all_custom_fields	GET /contact_custom_fields	GET custom_fields Collection
ConstantContactClient::ContactsCustomFieldsApi	get_custom_field	GET /contact_custom_fields/{custom_field_id}	GET a custom_field
ConstantContactClient::ContactsCustomFieldsApi	update_custom_field	PUT /contact_custom_fields/{custom_field_id}	PUT (update) a custom_field
ConstantContactClient::ContactsReportingApi	get_contact_open_click_rate_report	GET /reports/contact_reports/{contact_id}/open_and_click_rates	GET Average Open and Click Rates
ConstantContactClient::ContactsReportingApi	get_contact_tracking_count_report	GET /reports/contact_reports/{contact_id}/activity_summary	GET Contact Action Summary
ConstantContactClient::ContactsReportingApi	get_contact_tracking_report	GET /reports/contact_reports/{contact_id}/activity_details	GET Contact Activity Details
ConstantContactClient::EmailCampaignsApi	create_email_campaign	POST /emails	POST (Create) a New Email Campaign
ConstantContactClient::EmailCampaignsApi	create_resend_email_campaign	POST /emails/activities/{campaign_activity_id}/non_opener_resends	POST a Resend to Non-openers Campaign Activity
ConstantContactClient::EmailCampaignsApi	delete_email_campaign	DELETE /emails/{campaign_id}	DELETE an Email Campaign
ConstantContactClient::EmailCampaignsApi	delete_resend_email_campaign	DELETE /emails/activities/{campaign_activity_id}/non_opener_resends/{resend_request_id}	DELETE a Resend to Non Openers Activity
ConstantContactClient::EmailCampaignsApi	get_all_email_campaigns	GET /emails	GET a Collection of Email Campaigns
ConstantContactClient::EmailCampaignsApi	get_email_campaign_activity	GET /emails/activities/{campaign_activity_id}	GET a Single Email Campaign Activity
ConstantContactClient::EmailCampaignsApi	get_email_campaign_by_id	GET /emails/{campaign_id}	GET Details About a Single Email Campaign
ConstantContactClient::EmailCampaignsApi	get_email_campaign_xrefs	GET /emails/campaign_id_xrefs	GET a Collection of V2 and V3 API Email Campaign Identifiers
ConstantContactClient::EmailCampaignsApi	get_resend_email_campaign	GET /emails/activities/{campaign_activity_id}/non_opener_resends	GET Details for a Resend to Non-openers Campaign Activity
ConstantContactClient::EmailCampaignsApi	patch_email_campaign_name	PATCH /emails/{campaign_id}	PATCH (Update) an Email Campaign Name
ConstantContactClient::EmailCampaignsApi	update_email_campaign_activity	PUT /emails/activities/{campaign_activity_id}	PUT (Update) An Email Campaign Activity
ConstantContactClient::EmailCampaignsABTestsApi	create_ab_test_email_campaign	POST /emails/activities/{campaign_activity_id}/abtest	POST (Create) an A/B Test for an Email Campaign Activity
ConstantContactClient::EmailCampaignsABTestsApi	delete_ab_test_email_campaign	DELETE /emails/activities/{campaign_activity_id}/abtest	DELETE an A/B Test for an Email Campaign Activity
ConstantContactClient::EmailCampaignsABTestsApi	get_ab_test_email_campaign	GET /emails/activities/{campaign_activity_id}/abtest	GET A/B Test Details for an Email Campaign Activity
ConstantContactClient::EmailReportingApi	get_bounces_report	GET /reports/email_reports/{campaign_activity_id}/tracking/bounces	GET an Email Bounces Report
ConstantContactClient::EmailReportingApi	get_campaign_activity_link_report	GET /reports/email_reports/{campaign_activity_id}/links	GET an Email Links Report
ConstantContactClient::EmailReportingApi	get_clicks_report	GET /reports/email_reports/{campaign_activity_id}/tracking/clicks	GET an Email Clicks Report
ConstantContactClient::EmailReportingApi	get_did_not_opens_report	GET /reports/email_reports/{campaign_activity_id}/tracking/didnotopens	GET an Email Did Not Opens Report
ConstantContactClient::EmailReportingApi	get_email_campaign_activity_report	GET /reports/stats/email_campaign_activities/{campaign_activity_ids}	GET an Email Campaign Activity Stats Report
ConstantContactClient::EmailReportingApi	get_email_campaign_report	GET /reports/summary_reports/email_campaign_summaries	GET an Email Campaigns Summary Report
ConstantContactClient::EmailReportingApi	get_email_opens_report	GET /reports/email_reports/{campaign_activity_id}/tracking/opens	GET an Email Opens Report
ConstantContactClient::EmailReportingApi	get_email_sends_report	GET /reports/email_reports/{campaign_activity_id}/tracking/sends	GET an Email Sends Report
ConstantContactClient::EmailReportingApi	get_email_stats_report	GET /reports/stats/email_campaigns/{campaign_ids}	GET an Email Campaign Stats Report
ConstantContactClient::EmailReportingApi	get_forwards_report	GET /reports/email_reports/{campaign_activity_id}/tracking/forwards	GET an Email Forwards Report
ConstantContactClient::EmailReportingApi	get_optouts_report	GET /reports/email_reports/{campaign_activity_id}/tracking/optouts	GET an Email Opt-outs Report
ConstantContactClient::EmailReportingApi	get_unique_opens_report	GET /reports/email_reports/{campaign_activity_id}/tracking/unique_opens	GET an Email Unique Opens Report
ConstantContactClient::EmailSchedulingApi	get_email_campaign_activity_preview	GET /emails/activities/{campaign_activity_id}/previews	GET the HTML Preview of an Email Campaign Activity
ConstantContactClient::EmailSchedulingApi	get_email_campaign_activity_schedule	GET /emails/activities/{campaign_activity_id}/schedules	GET an Email Campaign Activity Schedule
ConstantContactClient::EmailSchedulingApi	get_email_campaign_activity_send_history	GET /emails/activities/{campaign_activity_id}/send_history	GET the Send History of an Email Campaign Activity
ConstantContactClient::EmailSchedulingApi	schedule_email_campaign_activity	POST /emails/activities/{campaign_activity_id}/schedules	POST (Create) an Email Campaign Activity Schedule
ConstantContactClient::EmailSchedulingApi	test_send_email_campaign_activity	POST /emails/activities/{campaign_activity_id}/tests	POST Test Send an Email Campaign Activity
ConstantContactClient::EmailSchedulingApi	unschedule_email_campaign_activity	DELETE /emails/activities/{campaign_activity_id}/schedules	DELETE an Email Campaign Activity Schedule
ConstantContactClient::LandingPagesReportingApi	get_contact_adds	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_adds	GET a Unique Contacts Adds Landing Page Report
ConstantContactClient::LandingPagesReportingApi	get_contact_opens	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_contact_opens	GET a Contacts Opens Landing Page Report
ConstantContactClient::LandingPagesReportingApi	get_unique_contact_clicks	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_clicks	GET a Unique Contacts Clicks Landing Page Report
ConstantContactClient::LandingPagesReportingApi	get_unique_contact_opens	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_opens	GET a Unique Contacts Opens Landing Page Report
ConstantContactClient::LandingPagesReportingApi	get_unique_contact_sms_opt_ins	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_sms_optins	GET a Unique Contacts SMS Opt-In Landing Page Report
ConstantContactClient::LandingPagesReportingApi	get_unique_contact_updates	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_updates	GET a Unique Contacts Updates Landing Page Report
ConstantContactClient::SegmentsApi	create_segment	POST /segments	POST (create) a Segment
ConstantContactClient::SegmentsApi	delete_segment	DELETE /segments/{segment_id}	DELETE a Segment
ConstantContactClient::SegmentsApi	get_all_segments	GET /segments	GET all Segments
ConstantContactClient::SegmentsApi	get_segment_by_id	GET /segments/{segment_id}	GET a Segment's Details
ConstantContactClient::SegmentsApi	update_segment	PUT /segments/{segment_id}	PUT (update) a Segment
ConstantContactClient::SegmentsApi	update_segment_name	PATCH /segments/{segment_id}/name	PATCH (rename) a Segment