constant_contact_client 1.2.0 → 1.5.0

data/docs/SMSReportingApi.md

@@ -0,0 +1,86 @@
+# ConstantContactClient::SMSReportingApi
+
+All URIs are relative to *https://api.cc.email/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_all_bulk_sms_campaign_summaries**](SMSReportingApi.md#get_all_bulk_sms_campaign_summaries) | **GET** /reports/summary_reports/sms_campaign_summaries | GET an SMS Campaigns Summary Report |
+
+
+## get_all_bulk_sms_campaign_summaries
+
+> <GetAllBulkSmsCampaignSummaries200Response> get_all_bulk_sms_campaign_summaries(start_at, opts)
+
+GET an SMS Campaigns Summary Report
+
+Use this method to get SMS campaign summary details, including the total number of times that each contact uniquely interacted with each tracked campaign activity and aggregate tracking statistics. Results are sorted in descending order by the date the SMS was last sent (`last_sent_date`). The `start_at` date is required. Use both the `start_at` and `end_at` date query parameters to return only SMS campaign summary details that occurred within a specified date range. Use the `limit` query parameter to limit the number of results returned per page. 
+
+### 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::SMSReportingApi.new
+start_at = '2023-01-27T21:56:37.011Z' # String | Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or after the required `start_at` date you specify. ISO 8601 format.
+opts = {
+  limit: '15', # String | Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50.
+  end_at: '2024-01-27T21:56:37.011Z' # String | Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or before the `end_at` date you specify. ISO 8601 format.
+}
+
+begin
+  # GET an SMS Campaigns Summary Report
+  result = api_instance.get_all_bulk_sms_campaign_summaries(start_at, opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SMSReportingApi->get_all_bulk_sms_campaign_summaries: #{e}"
+end
+```
+
+#### Using the get_all_bulk_sms_campaign_summaries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAllBulkSmsCampaignSummaries200Response>, Integer, Hash)> get_all_bulk_sms_campaign_summaries_with_http_info(start_at, opts)
+
+```ruby
+begin
+  # GET an SMS Campaigns Summary Report
+  data, status_code, headers = api_instance.get_all_bulk_sms_campaign_summaries_with_http_info(start_at, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAllBulkSmsCampaignSummaries200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SMSReportingApi->get_all_bulk_sms_campaign_summaries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_at** | **String** | Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or after the required &#x60;start_at&#x60; date you specify. ISO 8601 format. |  |
+| **limit** | **String** | Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50. | [optional][default to &#39;50&#39;] |
+| **end_at** | **String** | Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or before the &#x60;end_at&#x60; date you specify. ISO 8601 format. | [optional] |
+
+### Return type
+
+[**GetAllBulkSmsCampaignSummaries200Response**](GetAllBulkSmsCampaignSummaries200Response.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
+

data/docs/SocialApi.md

@@ -0,0 +1,302 @@
+# ConstantContactClient::SocialApi
+
+All URIs are relative to *https://api.cc.email/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_social_post**](SocialApi.md#create_social_post) | **POST** /social/posts | POST (create) a social media post |
+| [**get_hashtag_groups**](SocialApi.md#get_hashtag_groups) | **GET** /social/hashtags/groups | GET hashtag groups |
+| [**get_social_connections**](SocialApi.md#get_social_connections) | **GET** /social/connections | GET social network connections |
+| [**get_social_profiles**](SocialApi.md#get_social_profiles) | **GET** /social/profiles | GET social media profiles |
+
+
+## create_social_post
+
+> <CreateSocialPost200Response> create_social_post(create_social_post_request)
+
+POST (create) a social media post
+
+Creates a new social media post that can be published immediately or scheduled for later publication. A post can target one or more social profiles, and can include text, images, and network-specific settings.  Set `status` to `DRAFT` to save without publishing, or `SCHEDULED` to schedule for publication. Scheduled posts require a `scheduled_time` in ISO-8601 format.  Post content and settings can vary per profile — each `profile_posts` entry can have its own text, images, and network-specific settings (e.g., TikTok-specific settings like `disable_comment`). 
+
+### 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::SocialApi.new
+create_social_post_request = ConstantContactClient::CreateSocialPostRequest.new({profile_posts: [ConstantContactClient::CreateSocialPostRequestProfilePostsInner.new({profiles: [ConstantContactClient::CreateSocialPostRequestProfilePostsInnerProfilesInner.new({profile_id: 'profile_id_example'})]})], status: 'SCHEDULED'}) # CreateSocialPostRequest | The social post content and configuration.
+
+begin
+  # POST (create) a social media post
+  result = api_instance.create_social_post(create_social_post_request)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->create_social_post: #{e}"
+end
+```
+
+#### Using the create_social_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSocialPost200Response>, Integer, Hash)> create_social_post_with_http_info(create_social_post_request)
+
+```ruby
+begin
+  # POST (create) a social media post
+  data, status_code, headers = api_instance.create_social_post_with_http_info(create_social_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSocialPost200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->create_social_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_social_post_request** | [**CreateSocialPostRequest**](CreateSocialPostRequest.md) | The social post content and configuration. |  |
+
+### Return type
+
+[**CreateSocialPost200Response**](CreateSocialPost200Response.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
+
+
+## get_hashtag_groups
+
+> <GetHashtagGroups200Response> get_hashtag_groups(opts)
+
+GET hashtag groups
+
+Retrieves a paginated list of saved hashtag groups for the account. Hashtag groups allow users to save and organize reusable collections of hashtags that can be applied to social posts.  Use the `limit` and `page` query parameters to paginate through results. Navigate to the next page using the `_links.next` link in the response. 
+
+### 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::SocialApi.new
+opts = {
+  limit: 5, # Integer | Maximum number of hashtag groups to retrieve per page. Default and maximum is `5`.
+  page: 0 # Integer | Page number to retrieve (0-based).
+}
+
+begin
+  # GET hashtag groups
+  result = api_instance.get_hashtag_groups(opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->get_hashtag_groups: #{e}"
+end
+```
+
+#### Using the get_hashtag_groups_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetHashtagGroups200Response>, Integer, Hash)> get_hashtag_groups_with_http_info(opts)
+
+```ruby
+begin
+  # GET hashtag groups
+  data, status_code, headers = api_instance.get_hashtag_groups_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetHashtagGroups200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->get_hashtag_groups_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of hashtag groups to retrieve per page. Default and maximum is &#x60;5&#x60;. | [optional][default to 5] |
+| **page** | **Integer** | Page number to retrieve (0-based). | [optional][default to 0] |
+
+### Return type
+
+[**GetHashtagGroups200Response**](GetHashtagGroups200Response.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_social_connections
+
+> <GetSocialConnections200Response> get_social_connections
+
+GET social network connections
+
+Retrieves all social network accounts connected to the Constant Contact account, with support for multiple accounts per social network.  A connection represents the authorization link between a Constant Contact account and a single account on a social network (Facebook, Instagram, LinkedIn, TikTok, etc.). Each connection includes account information about the connected user on that network (display name, username, image, etc.) and the current status of the connection (whether it's active, rate-limited, or has any errors).  Note that a single connection may have multiple profiles (pages) associated with it — use `GET /social/profiles` to retrieve the individual profiles. 
+
+### 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::SocialApi.new
+
+begin
+  # GET social network connections
+  result = api_instance.get_social_connections
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->get_social_connections: #{e}"
+end
+```
+
+#### Using the get_social_connections_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSocialConnections200Response>, Integer, Hash)> get_social_connections_with_http_info
+
+```ruby
+begin
+  # GET social network connections
+  data, status_code, headers = api_instance.get_social_connections_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSocialConnections200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->get_social_connections_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetSocialConnections200Response**](GetSocialConnections200Response.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_social_profiles
+
+> <Array<GetSocialProfiles200ResponseInner>> get_social_profiles(opts)
+
+GET social media profiles
+
+Retrieves all social media profiles connected to the account. A profile represents a single account on a social network (such as a Facebook Business Page, a LinkedIn Company Page, or an Instagram Business account) that the user has connected to Constant Contact.  Use the `include=accessible` query parameter to additionally check whether each profile is currently accessible for posting. Profiles that are not currently accessible will fail if used to publish a post. 
+
+### 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::SocialApi.new
+opts = {
+  include: ['inner_example'] # Array<String> | Optional sub-resources to include. Use `accessible` to check if profiles are accessible on the network.
+}
+
+begin
+  # GET social media profiles
+  result = api_instance.get_social_profiles(opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->get_social_profiles: #{e}"
+end
+```
+
+#### Using the get_social_profiles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GetSocialProfiles200ResponseInner>>, Integer, Hash)> get_social_profiles_with_http_info(opts)
+
+```ruby
+begin
+  # GET social media profiles
+  data, status_code, headers = api_instance.get_social_profiles_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GetSocialProfiles200ResponseInner>>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling SocialApi->get_social_profiles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include** | [**Array&lt;String&gt;**](String.md) | Optional sub-resources to include. Use &#x60;accessible&#x60; to check if profiles are accessible on the network. | [optional] |
+
+### Return type
+
+[**Array&lt;GetSocialProfiles200ResponseInner&gt;**](GetSocialProfiles200ResponseInner.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
+

data/lib/constant_contact_client/api/account_services_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Constant Contact API v3
 
-#Swagger build version 3.0.2475
+#Swagger build version 3.0.161
 
-The version of the OpenAPI document: 1.0.109
+The version of the OpenAPI document: 1.0.220
 Contact: webservices@constantcontact.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.2.0
@@ -89,7 +89,7 @@ module ConstantContactClient
 
     # POST the Physical Address for the Account
     # Use this method to add the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (<code>country_code</code>) where the account organization resides determines whether you use the <code>state_code</code> to specify United States (<code>US</code>) and Canada (<code>CA</code>) addresses, or use the <code>state_name</code> to specify all other countries.
-    # @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all &#x60;AccountPhysicalAddress&#x60; properties required for the specified &#x60;country_code&#x60; and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
+    # @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all &#x60;AccountPhysicalAddress&#x60; properties required for the specified &#x60;country_code&#x60;. If a required property is not included or incorrectly formatted, a 400 error message is returned. If the address already exists, a 409 error message is returned.
     # @param [Hash] opts the optional parameters
     # @return [GetAccountDetails200ResponsePhysicalAddress]
     def add_physical_address(get_account_details200_response_physical_address, opts = {})
@@ -99,7 +99,7 @@ module ConstantContactClient
 
     # POST the Physical Address for the Account
     # Use this method to add the address where the account&#39;s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (&lt;code&gt;country_code&lt;/code&gt;) where the account organization resides determines whether you use the &lt;code&gt;state_code&lt;/code&gt; to specify United States (&lt;code&gt;US&lt;/code&gt;) and Canada (&lt;code&gt;CA&lt;/code&gt;) addresses, or use the &lt;code&gt;state_name&lt;/code&gt; to specify all other countries.
-    # @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all &#x60;AccountPhysicalAddress&#x60; properties required for the specified &#x60;country_code&#x60; and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
+    # @param get_account_details200_response_physical_address [GetAccountDetails200ResponsePhysicalAddress] Include all &#x60;AccountPhysicalAddress&#x60; properties required for the specified &#x60;country_code&#x60;. If a required property is not included or incorrectly formatted, a 400 error message is returned. If the address already exists, a 409 error message is returned.
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetAccountDetails200ResponsePhysicalAddress, Integer, Hash)>] GetAccountDetails200ResponsePhysicalAddress data, response status code and response headers
     def add_physical_address_with_http_info(get_account_details200_response_physical_address, opts = {})

data/lib/constant_contact_client/api/bulk_activities_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Constant Contact API v3
 
-#Swagger build version 3.0.2475
+#Swagger build version 3.0.161
 
-The version of the OpenAPI document: 1.0.109
+The version of the OpenAPI document: 1.0.220
 Contact: webservices@constantcontact.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.2.0
@@ -20,10 +20,11 @@ module ConstantContactClient
       @api_client = api_client
     end
     # Import Contacts using a CSV File
-    # This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method.  Importing a new contact automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request.  The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB).  Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
-    # @param file [File] The CSV file you are importing. The column headings that you can use in the file are: `first_name`, `last_name`, `email`, `phone`, `job_title`, `anniversary`, `birthday_day`, `birthday_month`, `company_name`, `street`, `street2`, `city`, `state`, `zip`, and `country`. The only required column heading is `email`.  You can also use custom fields as column headings. Enter the custom field name prefixed with `cf:` as the column heading. For example, use `cf:first_name` as the header name if you have a custom field named \\\"first_name\\\". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
-    # @param list_ids [Array<String>] Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact &#x60;list_id&#x60; values.
+    # This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method.  Importing a new contact email address automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. Importing contacts with `sms_number`s requires using the `sms_permission_to_send` parameter  to specify permissions for all contacts being imported. Set to `explicit` to specify that all contacts either provided explicit permission. Set to `not_set` if permission was not provided. If `explicit`, you must also include the `sms_consent_date` as a column header to include the date the contact consented to receiving SMS messages. Contacts must have either an email address or an SMS number defined.   The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB).  Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
+    # @param file [File] The CSV file you are importing  must include either &#x60;email&#x60; or &#x60;sms_number&#x60; as a column heading. Other properties you can include using column headings are: &#x60;first_name&#x60;.  &#x60;last_name&#x60;, &#x60;phone&#x60;, &#x60;job_title&#x60;, &#x60;anniversary&#x60;, &#x60;birthday_day&#x60;, &#x60;birthday_month&#x60;, &#x60;company_name&#x60;, &#x60;street&#x60;, &#x60;street2&#x60;, &#x60;city&#x60;, &#x60;state&#x60;, &#x60;zip&#x60;, &#x60;country&#x60;, and &#x60;sms_consent_date&#x60;.   If adding an &#x60;sms_number&#x60;, you must also include the &#x60;sms_permission_to_send&#x60; parameter and set it to either &#x60;not_set&#x60; or &#x60;explicit&#x60;. If &#x60;explicit&#x60;, requires including &#x60;sms_consent_date&#x60; as a column header to specify the date the contact consented to receiving SMS messages.   You can also use custom fields as column headings. Enter the custom field name prefixed with &#x60;cf:&#x60; as the column heading. For example, use &#x60;cf:first_name&#x60; as the header name if you have a custom field named \\\&quot;first_name\\\&quot;. The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
+    # @param list_ids [String] Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact &#x60;list_id&#x60; values.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :sms_permission_to_send If importing contact &#x60;sms_number&#x60;s, use this parameter to specify how SMS consent was provided. If all contacts in the file provided their consent, set to &#x60;explicit&#x60; and include each contact&#39;s &#x60;sms_consent_date&#x60;. If all contacts in the file have not yet provided consent, set to &#x60;not_set&#x60; (&#x60;sms_consent_date&#x60; is not required). You cannot message a contact that does not have a sms consent date set.
     # @return [CreateCSVImportActivity201Response]
     def create_csv_import_activity(file, list_ids, opts = {})
       data, _status_code, _headers = create_csv_import_activity_with_http_info(file, list_ids, opts)
@@ -31,10 +32,11 @@ module ConstantContactClient
     end
 
     # Import Contacts using a CSV File
-    # This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method.  Importing a new contact automatically sets the contact&#39;s &#x60;permission_to_send&#x60; property as &#x60;implicit&#x60; and the &#x60;opt_in_source&#x60; property as &#x60;Account&#x60;. Importing an existing contact only updates the contact properties you include in the request.  The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB).  Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
-    # @param file [File] The CSV file you are importing. The column headings that you can use in the file are: &#x60;first_name&#x60;, &#x60;last_name&#x60;, &#x60;email&#x60;, &#x60;phone&#x60;, &#x60;job_title&#x60;, &#x60;anniversary&#x60;, &#x60;birthday_day&#x60;, &#x60;birthday_month&#x60;, &#x60;company_name&#x60;, &#x60;street&#x60;, &#x60;street2&#x60;, &#x60;city&#x60;, &#x60;state&#x60;, &#x60;zip&#x60;, and &#x60;country&#x60;. The only required column heading is &#x60;email&#x60;.  You can also use custom fields as column headings. Enter the custom field name prefixed with &#x60;cf:&#x60; as the column heading. For example, use &#x60;cf:first_name&#x60; as the header name if you have a custom field named \\\&quot;first_name\\\&quot;. The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
-    # @param list_ids [Array<String>] Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact &#x60;list_id&#x60; values.
+    # This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method.  Importing a new contact email address automatically sets the contact&#39;s &#x60;permission_to_send&#x60; property as &#x60;implicit&#x60; and the &#x60;opt_in_source&#x60; property as &#x60;Account&#x60;. Importing an existing contact only updates the contact properties you include in the request. Importing contacts with &#x60;sms_number&#x60;s requires using the &#x60;sms_permission_to_send&#x60; parameter  to specify permissions for all contacts being imported. Set to &#x60;explicit&#x60; to specify that all contacts either provided explicit permission. Set to &#x60;not_set&#x60; if permission was not provided. If &#x60;explicit&#x60;, you must also include the &#x60;sms_consent_date&#x60; as a column header to include the date the contact consented to receiving SMS messages. Contacts must have either an email address or an SMS number defined.   The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB).  Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
+    # @param file [File] The CSV file you are importing  must include either &#x60;email&#x60; or &#x60;sms_number&#x60; as a column heading. Other properties you can include using column headings are: &#x60;first_name&#x60;.  &#x60;last_name&#x60;, &#x60;phone&#x60;, &#x60;job_title&#x60;, &#x60;anniversary&#x60;, &#x60;birthday_day&#x60;, &#x60;birthday_month&#x60;, &#x60;company_name&#x60;, &#x60;street&#x60;, &#x60;street2&#x60;, &#x60;city&#x60;, &#x60;state&#x60;, &#x60;zip&#x60;, &#x60;country&#x60;, and &#x60;sms_consent_date&#x60;.   If adding an &#x60;sms_number&#x60;, you must also include the &#x60;sms_permission_to_send&#x60; parameter and set it to either &#x60;not_set&#x60; or &#x60;explicit&#x60;. If &#x60;explicit&#x60;, requires including &#x60;sms_consent_date&#x60; as a column header to specify the date the contact consented to receiving SMS messages.   You can also use custom fields as column headings. Enter the custom field name prefixed with &#x60;cf:&#x60; as the column heading. For example, use &#x60;cf:first_name&#x60; as the header name if you have a custom field named \\\&quot;first_name\\\&quot;. The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
+    # @param list_ids [String] Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact &#x60;list_id&#x60; values.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :sms_permission_to_send If importing contact &#x60;sms_number&#x60;s, use this parameter to specify how SMS consent was provided. If all contacts in the file provided their consent, set to &#x60;explicit&#x60; and include each contact&#39;s &#x60;sms_consent_date&#x60;. If all contacts in the file have not yet provided consent, set to &#x60;not_set&#x60; (&#x60;sms_consent_date&#x60; is not required). You cannot message a contact that does not have a sms consent date set.
     # @return [Array<(CreateCSVImportActivity201Response, Integer, Hash)>] CreateCSVImportActivity201Response data, response status code and response headers
     def create_csv_import_activity_with_http_info(file, list_ids, opts = {})
       if @api_client.config.debugging
@@ -48,10 +50,10 @@ module ConstantContactClient
       if @api_client.config.client_side_validation && list_ids.nil?
         fail ArgumentError, "Missing the required parameter 'list_ids' when calling BulkActivitiesApi.create_csv_import_activity"
       end
-      if @api_client.config.client_side_validation && list_ids.length > 50
-        fail ArgumentError, 'invalid value for "list_ids" when calling BulkActivitiesApi.create_csv_import_activity, number of items must be less than or equal to 50.'
+      allowable_values = ["not_set", "explicit"]
+      if @api_client.config.client_side_validation && opts[:'sms_permission_to_send'] && !allowable_values.include?(opts[:'sms_permission_to_send'])
+        fail ArgumentError, "invalid value for \"sms_permission_to_send\", must be one of #{allowable_values}"
       end
-
       # resource path
       local_var_path = '/activities/contacts_file_import'
 
@@ -71,7 +73,8 @@ module ConstantContactClient
       # form parameters
       form_params = opts[:form_params] || {}
       form_params['file'] = file
-      form_params['list_ids'] = @api_client.build_collection_param(list_ids, :csv)
+      form_params['list_ids'] = list_ids
+      form_params['sms_permission_to_send'] = opts[:'sms_permission_to_send'] if !opts[:'sms_permission_to_send'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]
@@ -168,7 +171,7 @@ module ConstantContactClient
     end
 
     # Export Contacts to a File
-    # Use this method to create an activity that exports contacts and contact details to a CSV file. By default, all contacts are exported. To filter contacts to export, specify the source to use, `contact_id`, `list_id`, or `segment_id` (all mutually exclusive). By default, all contact related fields are exported. Use the fields array to only export specific contact fields. You must export `email_address` to successfully export `email_optin_source`, `email_optin_date`, `email_optout_source`, `email_optout_date`, or `email_optout_reason`. After Constant Contact finishes processing the activity, use the `results` link in the response body to retrieve the CSV file.
+    # Use this method to create an activity that exports contacts and contact details to a CSV file.  You can choose to export all contacts in your account (default) or you can use parameters to filter on which contacts to export. After Constant Contact finishes processing the activity, use the `results` link in the response body to retrieve the CSV file.
     # @param create_export_activity_request [CreateExportActivityRequest] A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
     # @param [Hash] opts the optional parameters
     # @return [CreateExportActivity201Response]
@@ -178,7 +181,7 @@ module ConstantContactClient
     end
 
     # Export Contacts to a File
-    # Use this method to create an activity that exports contacts and contact details to a CSV file. By default, all contacts are exported. To filter contacts to export, specify the source to use, &#x60;contact_id&#x60;, &#x60;list_id&#x60;, or &#x60;segment_id&#x60; (all mutually exclusive). By default, all contact related fields are exported. Use the fields array to only export specific contact fields. You must export &#x60;email_address&#x60; to successfully export &#x60;email_optin_source&#x60;, &#x60;email_optin_date&#x60;, &#x60;email_optout_source&#x60;, &#x60;email_optout_date&#x60;, or &#x60;email_optout_reason&#x60;. After Constant Contact finishes processing the activity, use the &#x60;results&#x60; link in the response body to retrieve the CSV file.
+    # Use this method to create an activity that exports contacts and contact details to a CSV file.  You can choose to export all contacts in your account (default) or you can use parameters to filter on which contacts to export. After Constant Contact finishes processing the activity, use the &#x60;results&#x60; link in the response body to retrieve the CSV file.
     # @param create_export_activity_request [CreateExportActivityRequest] A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateExportActivity201Response, Integer, Hash)>] CreateExportActivity201Response data, response status code and response headers
@@ -236,7 +239,7 @@ module ConstantContactClient
     end
 
     # Import Contacts using a JSON Payload
-    # Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. Importing a new contact automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported. To import custom fields, prefix the custom field name with `cf:` and add it as a contact property. For example, use the property name `cf:first_name` if you have a custom field named first_name. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields.  The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
+    # Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. A contact's data must include an `email` address and/or `sms_number`. The `sms_number` must be a US phone number to associate with the contact's SMS-enabled phone. Valid formats are <code>1231231234</code> or <code>123-123-1234</code> (the country code must be valid).  Importing a new contact using this method automatically sets the contact's email `permission_to_send` property to `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported.        To import custom fields, prefix the custom field name with `cf:` and add it as a contact property. For example, use the property name `cf:first_name` if you have a custom field named `first_name`. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields.  To include a contact's `sms_number`, if the contact provided explicit permission to receive SMS messages, you must set the `sms_permission_to_send` property to `explicit` and specify the date of consent using the `sms_consent_date` column header. If explicit permission was not provided, set `sms_permission_to_send` to `not_set` (the `sms_consent_date` is not required). If the `sms_consent_date` is not set, SMS messages cannot be sent to contacts and `sms_permission_to_send` defaults to `not_set`. Valid value formats for `sms_consent_date` include MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY.   The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
     # @param create_import_json_activity_request [CreateImportJSONActivityRequest] The JSON request payload that contains the contact data and contact lists for the import.
     # @param [Hash] opts the optional parameters
     # @return [CreateCSVImportActivity201Response]
@@ -246,7 +249,7 @@ module ConstantContactClient
     end
 
     # Import Contacts using a JSON Payload
-    # Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. Importing a new contact automatically sets the contact&#39;s &#x60;permission_to_send&#x60; property as &#x60;implicit&#x60; and the &#x60;opt_in_source&#x60; property as &#x60;Account&#x60;. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported. To import custom fields, prefix the custom field name with &#x60;cf:&#x60; and add it as a contact property. For example, use the property name &#x60;cf:first_name&#x60; if you have a custom field named first_name. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields.  The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
+    # Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. A contact&#39;s data must include an &#x60;email&#x60; address and/or &#x60;sms_number&#x60;. The &#x60;sms_number&#x60; must be a US phone number to associate with the contact&#39;s SMS-enabled phone. Valid formats are &lt;code&gt;1231231234&lt;/code&gt; or &lt;code&gt;123-123-1234&lt;/code&gt; (the country code must be valid).  Importing a new contact using this method automatically sets the contact&#39;s email &#x60;permission_to_send&#x60; property to &#x60;implicit&#x60; and the &#x60;opt_in_source&#x60; property as &#x60;Account&#x60;. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported.        To import custom fields, prefix the custom field name with &#x60;cf:&#x60; and add it as a contact property. For example, use the property name &#x60;cf:first_name&#x60; if you have a custom field named &#x60;first_name&#x60;. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields.  To include a contact&#39;s &#x60;sms_number&#x60;, if the contact provided explicit permission to receive SMS messages, you must set the &#x60;sms_permission_to_send&#x60; property to &#x60;explicit&#x60; and specify the date of consent using the &#x60;sms_consent_date&#x60; column header. If explicit permission was not provided, set &#x60;sms_permission_to_send&#x60; to &#x60;not_set&#x60; (the &#x60;sms_consent_date&#x60; is not required). If the &#x60;sms_consent_date&#x60; is not set, SMS messages cannot be sent to contacts and &#x60;sms_permission_to_send&#x60; defaults to &#x60;not_set&#x60;. Valid value formats for &#x60;sms_consent_date&#x60; include MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY.   The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
     # @param create_import_json_activity_request [CreateImportJSONActivityRequest] The JSON request payload that contains the contact data and contact lists for the import.
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateCSVImportActivity201Response, Integer, Hash)>] CreateCSVImportActivity201Response data, response status code and response headers

data/lib/constant_contact_client/api/contact_lists_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Constant Contact API v3
 
-#Swagger build version 3.0.2475
+#Swagger build version 3.0.161
 
-The version of the OpenAPI document: 1.0.109
+The version of the OpenAPI document: 1.0.220
 Contact: webservices@constantcontact.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.2.0
@@ -158,6 +158,8 @@ module ConstantContactClient
     # @option opts [String] :include_membership_count Use to include the total number of contacts per list. Set to  `active`, to count only active (mailable) contacts, or `all` to count all contacts.
     # @option opts [String] :name Use to get details for a single list by entering the full name of the list.
     # @option opts [String] :status Use to get lists by status. Accepts comma-separated status values.
+    # @option opts [String] :channel_type Use to return lists by channel type. The default value is `email`.
+    # @option opts [Boolean] :include_sms_membership_count Set to `true` to return the total number of SMS members in each list. Only applicable when `channel_type` is `sms`. Default is `false`.
     # @return [GetAllLists200Response]
     def get_all_lists(opts = {})
       data, _status_code, _headers = get_all_lists_with_http_info(opts)
@@ -172,6 +174,8 @@ module ConstantContactClient
     # @option opts [String] :include_membership_count Use to include the total number of contacts per list. Set to  `active`, to count only active (mailable) contacts, or `all` to count all contacts.
     # @option opts [String] :name Use to get details for a single list by entering the full name of the list.
     # @option opts [String] :status Use to get lists by status. Accepts comma-separated status values.
+    # @option opts [String] :channel_type Use to return lists by channel type. The default value is `email`.
+    # @option opts [Boolean] :include_sms_membership_count Set to `true` to return the total number of SMS members in each list. Only applicable when `channel_type` is `sms`. Default is `false`.
     # @return [Array<(GetAllLists200Response, Integer, Hash)>] GetAllLists200Response data, response status code and response headers
     def get_all_lists_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -193,6 +197,10 @@ module ConstantContactClient
       if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
         fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
       end
+      allowable_values = ["email", "sms"]
+      if @api_client.config.client_side_validation && opts[:'channel_type'] && !allowable_values.include?(opts[:'channel_type'])
+        fail ArgumentError, "invalid value for \"channel_type\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/contact_lists'
 
@@ -203,6 +211,8 @@ module ConstantContactClient
       query_params[:'include_membership_count'] = opts[:'include_membership_count'] if !opts[:'include_membership_count'].nil?
       query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'channel_type'] = opts[:'channel_type'] if !opts[:'channel_type'].nil?
+      query_params[:'include_sms_membership_count'] = opts[:'include_sms_membership_count'] if !opts[:'include_sms_membership_count'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/constant_contact_client/api/contact_tags_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Constant Contact API v3
 
-#Swagger build version 3.0.2475
+#Swagger build version 3.0.161
 
-The version of the OpenAPI document: 1.0.109
+The version of the OpenAPI document: 1.0.220
 Contact: webservices@constantcontact.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.2.0