constant_contact_client 1.0.0

data/docs/ContactsCustomFieldsApi.md

@@ -0,0 +1,375 @@
+# ConstantContactClient::ContactsCustomFieldsApi
+
+All URIs are relative to *https://api.cc.email/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_custom_fields**](ContactsCustomFieldsApi.md#create_custom_fields) | **POST** /contact_custom_fields | POST (create) a custom_field |
+| [**delete_custom_field**](ContactsCustomFieldsApi.md#delete_custom_field) | **DELETE** /contact_custom_fields/{custom_field_id} | DELETE a custom_field |
+| [**get_all_custom_fields**](ContactsCustomFieldsApi.md#get_all_custom_fields) | **GET** /contact_custom_fields | GET custom_fields Collection |
+| [**get_custom_field**](ContactsCustomFieldsApi.md#get_custom_field) | **GET** /contact_custom_fields/{custom_field_id} | GET a custom_field |
+| [**update_custom_field**](ContactsCustomFieldsApi.md#update_custom_field) | **PUT** /contact_custom_fields/{custom_field_id} | PUT (update) a custom_field |
+
+
+## create_custom_fields
+
+> <GetCustomField200Response> create_custom_fields(update_custom_field_request)
+
+POST (create) a custom_field
+
+This POST request adds a new `custom_field` to the user's account. A user can configure up to 100 `custom_fields` in their account.
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsCustomFieldsApi.new
+update_custom_field_request = ConstantContactClient::UpdateCustomFieldRequest.new({label: 'Vehicle make and model year', type: 'string'}) # UpdateCustomFieldRequest | The JSON payload required to create a new `custom_field`
+
+begin
+  # POST (create) a custom_field
+  result = api_instance.create_custom_fields(update_custom_field_request)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->create_custom_fields: #{e}"
+end
+```
+
+#### Using the create_custom_fields_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCustomField200Response>, Integer, Hash)> create_custom_fields_with_http_info(update_custom_field_request)
+
+```ruby
+begin
+  # POST (create) a custom_field
+  data, status_code, headers = api_instance.create_custom_fields_with_http_info(update_custom_field_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCustomField200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->create_custom_fields_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_custom_field_request** | [**UpdateCustomFieldRequest**](UpdateCustomFieldRequest.md) | The JSON payload required to create a new &#x60;custom_field&#x60; |  |
+
+### Return type
+
+[**GetCustomField200Response**](GetCustomField200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_custom_field
+
+> delete_custom_field(custom_field_id)
+
+DELETE a custom_field
+
+This DELETE request deletes a custom_field from the user's account
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsCustomFieldsApi.new
+custom_field_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | Unique ID of the custom_field on which to operate.
+
+begin
+  # DELETE a custom_field
+  api_instance.delete_custom_field(custom_field_id)
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->delete_custom_field: #{e}"
+end
+```
+
+#### Using the delete_custom_field_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_custom_field_with_http_info(custom_field_id)
+
+```ruby
+begin
+  # DELETE a custom_field
+  data, status_code, headers = api_instance.delete_custom_field_with_http_info(custom_field_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->delete_custom_field_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_field_id** | **String** | Unique ID of the custom_field on which to operate. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_all_custom_fields
+
+> <GetAllCustomFields200Response> get_all_custom_fields(opts)
+
+GET custom_fields Collection
+
+This GET request returns all `custom_fields` defined in the user's account. <div class=\"Msg\"><p class=\"note-text\">This method does not currently support filtering results using the custom field update date.</p></div>
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsCustomFieldsApi.new
+opts = {
+  limit: 56 # Integer | Specifies the number of results displayed per page of output, from 1 - 100, default = 50.
+}
+
+begin
+  # GET custom_fields Collection
+  result = api_instance.get_all_custom_fields(opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->get_all_custom_fields: #{e}"
+end
+```
+
+#### Using the get_all_custom_fields_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAllCustomFields200Response>, Integer, Hash)> get_all_custom_fields_with_http_info(opts)
+
+```ruby
+begin
+  # GET custom_fields Collection
+  data, status_code, headers = api_instance.get_all_custom_fields_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAllCustomFields200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->get_all_custom_fields_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Specifies the number of results displayed per page of output, from 1 - 100, default &#x3D; 50. | [optional][default to 50] |
+
+### Return type
+
+[**GetAllCustomFields200Response**](GetAllCustomFields200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_custom_field
+
+> <GetCustomField200Response> get_custom_field(custom_field_id)
+
+GET a custom_field
+
+This GET call retrieves a `custom_field` resource, specified by `custom_field_id`.
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsCustomFieldsApi.new
+custom_field_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | Unique ID of the `custom_field` on which to operate.
+
+begin
+  # GET a custom_field
+  result = api_instance.get_custom_field(custom_field_id)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->get_custom_field: #{e}"
+end
+```
+
+#### Using the get_custom_field_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCustomField200Response>, Integer, Hash)> get_custom_field_with_http_info(custom_field_id)
+
+```ruby
+begin
+  # GET a custom_field
+  data, status_code, headers = api_instance.get_custom_field_with_http_info(custom_field_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCustomField200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->get_custom_field_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_field_id** | **String** | Unique ID of the &#x60;custom_field&#x60; on which to operate. |  |
+
+### Return type
+
+[**GetCustomField200Response**](GetCustomField200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_custom_field
+
+> <GetCustomField200Response> update_custom_field(custom_field_id, update_custom_field_request)
+
+PUT (update) a custom_field
+
+This PUT request updates an existing `custom_field` object.
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsCustomFieldsApi.new
+custom_field_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | Unique ID of the `custom_field` on which to operate.
+update_custom_field_request = ConstantContactClient::UpdateCustomFieldRequest.new({label: 'Vehicle make and model year', type: 'string'}) # UpdateCustomFieldRequest | The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value.
+
+begin
+  # PUT (update) a custom_field
+  result = api_instance.update_custom_field(custom_field_id, update_custom_field_request)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->update_custom_field: #{e}"
+end
+```
+
+#### Using the update_custom_field_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCustomField200Response>, Integer, Hash)> update_custom_field_with_http_info(custom_field_id, update_custom_field_request)
+
+```ruby
+begin
+  # PUT (update) a custom_field
+  data, status_code, headers = api_instance.update_custom_field_with_http_info(custom_field_id, update_custom_field_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCustomField200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsCustomFieldsApi->update_custom_field_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_field_id** | **String** | Unique ID of the &#x60;custom_field&#x60; on which to operate. |  |
+| **update_custom_field_request** | [**UpdateCustomFieldRequest**](UpdateCustomFieldRequest.md) | The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value. |  |
+
+### Return type
+
+[**GetCustomField200Response**](GetCustomField200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ContactsReportingApi.md

@@ -0,0 +1,244 @@
+# ConstantContactClient::ContactsReportingApi
+
+All URIs are relative to *https://api.cc.email/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_contact_open_click_rate_report**](ContactsReportingApi.md#get_contact_open_click_rate_report) | **GET** /reports/contact_reports/{contact_id}/open_and_click_rates | GET Average Open and Click Rates |
+| [**get_contact_tracking_count_report**](ContactsReportingApi.md#get_contact_tracking_count_report) | **GET** /reports/contact_reports/{contact_id}/activity_summary | GET Contact Action Summary |
+| [**get_contact_tracking_report**](ContactsReportingApi.md#get_contact_tracking_report) | **GET** /reports/contact_reports/{contact_id}/activity_details | GET Contact Activity Details |
+
+
+## get_contact_open_click_rate_report
+
+> <GetContactOpenClickRateReport200Response> get_contact_open_click_rate_report(contact_id, start, _end)
+
+GET Average Open and Click Rates
+
+<p>Gets the average open and click rate for a given account and contact.<p>Looks at all tracking activities for bulk emails from a given contact over the given date range. Range cannot exceed 5 years.</p><p>Returns the rates and the number of campaign activities that were included in the calculation.</p><p>If no activities fall into the given date range, all rates will return 0 and the number of included activities will be 0.</p>
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsReportingApi.new
+contact_id = 'aa9ff7b0-478d-11e6-8059-00163e3c8e19' # String | The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
+start = 'start_example' # String | The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
+_end = '_end_example' # String | The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
+
+begin
+  # GET Average Open and Click Rates
+  result = api_instance.get_contact_open_click_rate_report(contact_id, start, _end)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsReportingApi->get_contact_open_click_rate_report: #{e}"
+end
+```
+
+#### Using the get_contact_open_click_rate_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetContactOpenClickRateReport200Response>, Integer, Hash)> get_contact_open_click_rate_report_with_http_info(contact_id, start, _end)
+
+```ruby
+begin
+  # GET Average Open and Click Rates
+  data, status_code, headers = api_instance.get_contact_open_click_rate_report_with_http_info(contact_id, start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetContactOpenClickRateReport200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsReportingApi->get_contact_open_click_rate_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** | The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19) |  |
+| **start** | **String** | The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500. |  |
+| **_end** | **String** | The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500. |  |
+
+### Return type
+
+[**GetContactOpenClickRateReport200Response**](GetContactOpenClickRateReport200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_contact_tracking_count_report
+
+> <GetContactTrackingCountReport200Response> get_contact_tracking_count_report(contact_id, start, _end)
+
+GET Contact Action Summary
+
+Get a list of the recent emails (aka, campaign activities) sent to a specific contact and a summary of the actions the contact took on that email for the most recent 200 campaigns.
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsReportingApi.new
+contact_id = 'aa9ff7b0-478d-11e6-8059-00163e3c8e19' # String | The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
+start = 'start_example' # String | The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
+_end = '_end_example' # String | The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
+
+begin
+  # GET Contact Action Summary
+  result = api_instance.get_contact_tracking_count_report(contact_id, start, _end)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsReportingApi->get_contact_tracking_count_report: #{e}"
+end
+```
+
+#### Using the get_contact_tracking_count_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetContactTrackingCountReport200Response>, Integer, Hash)> get_contact_tracking_count_report_with_http_info(contact_id, start, _end)
+
+```ruby
+begin
+  # GET Contact Action Summary
+  data, status_code, headers = api_instance.get_contact_tracking_count_report_with_http_info(contact_id, start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetContactTrackingCountReport200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsReportingApi->get_contact_tracking_count_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** | The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19) |  |
+| **start** | **String** | The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500. |  |
+| **_end** | **String** | The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500. |  |
+
+### Return type
+
+[**GetContactTrackingCountReport200Response**](GetContactTrackingCountReport200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_contact_tracking_report
+
+> <GetContactTrackingReport200Response> get_contact_tracking_report(contact_id, opts)
+
+GET Contact Activity Details
+
+<p>Gets the tracking activity data for a single contact, sorted in descending activity date order.</p> <p>You must chose either the `tracking_activities_list` query parameter and or the `tracking_activity_type` query parameter to specify one or more tracking activity types In the request. The `tracking_activities_list`  and `tracking_activities_type` query parameters are mutually exclusive.</p>       <table><tr><td colspan='2'>Valid tracking activity types</td></tr>         <tr><td><b>em_sends</b></td><td>Send activities</td></tr>         <tr><td><b>em_opens</b></td><td>Email open tracking activities</td></tr>         <tr><td><b>em_clicks</b></td><td>Link click-through tracking activities</td></tr>         <tr><td><b>em_bounces</b></td><td>Bounce tracking activities</td></tr>         <tr><td><b>em_optouts</b></td><td>Opt-out tracking activities</td></tr><tr>         <td><b>em_forwards</b></td><td>Forward to a friend tracking activities</td></tr>         <tr><td><b>p_contact_open</b></td><td>Landing page opens</td></tr>         <tr><td><b>p_contact_click</b></td><td>Landing page clicks</td></tr>         <tr><td><b>p_contact_add</b></td><td>Landing page adds</td></tr>         <tr><td><b>p_contact_update </b></td><td> Landing page updates</td></tr>       </table>
+
+### Examples
+
+```ruby
+require 'time'
+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 OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::ContactsReportingApi.new
+contact_id = 'aa9ff7b0-478d-11e6-8059-00163e3c8e19' # String | The contact's ID for which tracking activity data is requested.
+opts = {
+  tracking_activities_list: ['em_sends'], # Array<String> | Specify one or more tracking activity types to include as a comma-delimited string. The `tracking_activities_list`  and `tracking_activities_type` query parameters are mutually exclusive.
+  tracking_activity_type: ['inner_example'], # Array<String> | Specify one or more tracking activity types to include as an array. The `tracking_activities_list`  and `tracking_activities_type` query parameters are mutually exclusive.
+  include_campaign_activity_names: true, # Boolean | Default (`true`) returns campaign activity names in the results. Not including campaign activity names in the results (`false`), is more efficient.
+  limit: '20' # String | The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100.
+}
+
+begin
+  # GET Contact Activity Details
+  result = api_instance.get_contact_tracking_report(contact_id, opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsReportingApi->get_contact_tracking_report: #{e}"
+end
+```
+
+#### Using the get_contact_tracking_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetContactTrackingReport200Response>, Integer, Hash)> get_contact_tracking_report_with_http_info(contact_id, opts)
+
+```ruby
+begin
+  # GET Contact Activity Details
+  data, status_code, headers = api_instance.get_contact_tracking_report_with_http_info(contact_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetContactTrackingReport200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling ContactsReportingApi->get_contact_tracking_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** | The contact&#39;s ID for which tracking activity data is requested. |  |
+| **tracking_activities_list** | [**Array&lt;String&gt;**](String.md) | Specify one or more tracking activity types to include as a comma-delimited string. The &#x60;tracking_activities_list&#x60;  and &#x60;tracking_activities_type&#x60; query parameters are mutually exclusive. | [optional] |
+| **tracking_activity_type** | [**Array&lt;String&gt;**](String.md) | Specify one or more tracking activity types to include as an array. The &#x60;tracking_activities_list&#x60;  and &#x60;tracking_activities_type&#x60; query parameters are mutually exclusive. | [optional] |
+| **include_campaign_activity_names** | **Boolean** | Default (&#x60;true&#x60;) returns campaign activity names in the results. Not including campaign activity names in the results (&#x60;false&#x60;), is more efficient. | [optional][default to true] |
+| **limit** | **String** | The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100. | [optional][default to &#39;100&#39;] |
+
+### Return type
+
+[**GetContactTrackingReport200Response**](GetContactTrackingReport200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+