constant_contact_client 1.0.0 → 1.5.0

data/docs/ContactsCustomFieldsApi.md

@@ -8,16 +8,16 @@ All URIs are relative to *https://api.cc.email/v3*
 | [**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 |
+| [**update_custom_field**](ContactsCustomFieldsApi.md#update_custom_field) | **PUT** /contact_custom_fields/{custom_field_id} | Update a custom field. |
 
 
 ## create_custom_fields
 
-> <GetCustomField200Response> create_custom_fields(update_custom_field_request)
+> <GetCustomField200Response> create_custom_fields(create_custom_fields_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.
+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.
 
 ### Examples
 
@@ -34,11 +34,11 @@ ConstantContactClient.configure do |config|
 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`
+create_custom_fields_request = ConstantContactClient::CreateCustomFieldsRequest.new # CreateCustomFieldsRequest | 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)
+  result = api_instance.create_custom_fields(create_custom_fields_request)
   p result
 rescue ConstantContactClient::ApiError => e
   puts "Error when calling ContactsCustomFieldsApi->create_custom_fields: #{e}"
@@ -49,12 +49,12 @@ end
 
 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)
+> <Array(<GetCustomField200Response>, Integer, Hash)> create_custom_fields_with_http_info(create_custom_fields_request)
 
 ```ruby
 begin
   # POST (create) a custom_field
-  data, status_code, headers = api_instance.create_custom_fields_with_http_info(update_custom_field_request)
+  data, status_code, headers = api_instance.create_custom_fields_with_http_info(create_custom_fields_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <GetCustomField200Response>
@@ -67,7 +67,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **update_custom_field_request** | [**UpdateCustomFieldRequest**](UpdateCustomFieldRequest.md) | The JSON payload required to create a new &#x60;custom_field&#x60; |  |
+| **create_custom_fields_request** | [**CreateCustomFieldsRequest**](CreateCustomFieldsRequest.md) | The JSON payload required to create a new custom field. |  |
 
 ### Return type
 
@@ -89,7 +89,7 @@ end
 
 DELETE a custom_field
 
-This DELETE request deletes a custom_field from the user's account
+Delete a custom field from the user's account.
 
 ### Examples
 
@@ -106,7 +106,7 @@ ConstantContactClient.configure do |config|
 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.
+custom_field_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | The ID that uniquely identifies the custom field to delete.
 
 begin
   # DELETE a custom_field
@@ -138,7 +138,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **custom_field_id** | **String** | Unique ID of the custom_field on which to operate. |  |
+| **custom_field_id** | **String** | The ID that uniquely identifies the custom field to delete. |  |
 
 ### Return type
 
@@ -160,7 +160,7 @@ nil (empty response body)
 
 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>
+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>
 
 ### Examples
 
@@ -234,7 +234,7 @@ end
 
 GET a custom_field
 
-This GET call retrieves a `custom_field` resource, specified by `custom_field_id`.
+Get details for a specified custom field.
 
 ### Examples
 
@@ -251,7 +251,7 @@ ConstantContactClient.configure do |config|
 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.
+custom_field_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | The ID that uniquely identifies the custom field.
 
 begin
   # GET a custom_field
@@ -284,7 +284,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **custom_field_id** | **String** | Unique ID of the &#x60;custom_field&#x60; on which to operate. |  |
+| **custom_field_id** | **String** | The ID that uniquely identifies the custom field. |  |
 
 ### Return type
 
@@ -304,9 +304,9 @@ end
 
 > <GetCustomField200Response> update_custom_field(custom_field_id, update_custom_field_request)
 
-PUT (update) a custom_field
+Update a custom field.
 
-This PUT request updates an existing `custom_field` object.
+Update an existing custom field.
 
 ### Examples
 
@@ -323,11 +323,11 @@ ConstantContactClient.configure do |config|
 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.
+custom_field_id = '04fe9a-a579-43c5-bb1a-58ed29bf0a6a' # String | The ID that uniquely identifies the custom field to update.
+update_custom_field_request = ConstantContactClient::UpdateCustomFieldRequest.new # 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
+  # Update a custom field.
   result = api_instance.update_custom_field(custom_field_id, update_custom_field_request)
   p result
 rescue ConstantContactClient::ApiError => e
@@ -343,7 +343,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # PUT (update) a custom_field
+  # 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 # => { ... }
@@ -357,7 +357,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **custom_field_id** | **String** | Unique ID of the &#x60;custom_field&#x60; on which to operate. |  |
+| **custom_field_id** | **String** | The ID that uniquely identifies the custom field to update. |  |
 | **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

data/docs/EmailCampaignsApi.md

@@ -23,7 +23,7 @@ All URIs are relative to *https://api.cc.email/v3*
 
 POST (Create) a New Email Campaign
 
-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.  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. 
+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. 
 
 ### Examples
 

data/docs/EmailSchedulingApi.md

@@ -234,7 +234,7 @@ end
 
 POST (Create) an Email Campaign Activity Schedule
 
-Use this method to schedule when Constant Contact will send an email campaign activity to contacts. Use the `scheduled_date` request body property to enter the ISO-8601 format date that you want Constant Contact to send the email campaign activity on.   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. 
+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. 
 
 ### Examples