constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/api/landing_pages_reporting_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

data/lib/constant_contact_client/api/segments_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

data/lib/constant_contact_client/api/sms_reporting_api.rb

@@ -0,0 +1,92 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.161
+
+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
+
+=end
+
+require 'cgi'
+
+module ConstantContactClient
+  class SMSReportingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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. 
+    # @param start_at [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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :limit Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50. (default to '50')
+    # @option opts [String] :end_at 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.
+    # @return [GetAllBulkSmsCampaignSummaries200Response]
+    def get_all_bulk_sms_campaign_summaries(start_at, opts = {})
+      data, _status_code, _headers = get_all_bulk_sms_campaign_summaries_with_http_info(start_at, opts)
+      data
+    end
+
+    # 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. 
+    # @param start_at [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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :limit Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50. (default to '50')
+    # @option opts [String] :end_at 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.
+    # @return [Array<(GetAllBulkSmsCampaignSummaries200Response, Integer, Hash)>] GetAllBulkSmsCampaignSummaries200Response data, response status code and response headers
+    def get_all_bulk_sms_campaign_summaries_with_http_info(start_at, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSReportingApi.get_all_bulk_sms_campaign_summaries ...'
+      end
+      # verify the required parameter 'start_at' is set
+      if @api_client.config.client_side_validation && start_at.nil?
+        fail ArgumentError, "Missing the required parameter 'start_at' when calling SMSReportingApi.get_all_bulk_sms_campaign_summaries"
+      end
+      # resource path
+      local_var_path = '/reports/summary_reports/sms_campaign_summaries'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_at'] = start_at
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'end_at'] = opts[:'end_at'] if !opts[:'end_at'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAllBulkSmsCampaignSummaries200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
+
+      new_options = opts.merge(
+        :operation => :"SMSReportingApi.get_all_bulk_sms_campaign_summaries",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SMSReportingApi#get_all_bulk_sms_campaign_summaries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/constant_contact_client/api/social_api.rb

@@ -0,0 +1,286 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.161
+
+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
+
+=end
+
+require 'cgi'
+
+module ConstantContactClient
+  class SocialApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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`). 
+    # @param create_social_post_request [CreateSocialPostRequest] The social post content and configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSocialPost200Response]
+    def create_social_post(create_social_post_request, opts = {})
+      data, _status_code, _headers = create_social_post_with_http_info(create_social_post_request, opts)
+      data
+    end
+
+    # 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`). 
+    # @param create_social_post_request [CreateSocialPostRequest] The social post content and configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSocialPost200Response, Integer, Hash)>] CreateSocialPost200Response data, response status code and response headers
+    def create_social_post_with_http_info(create_social_post_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SocialApi.create_social_post ...'
+      end
+      # verify the required parameter 'create_social_post_request' is set
+      if @api_client.config.client_side_validation && create_social_post_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_social_post_request' when calling SocialApi.create_social_post"
+      end
+      # resource path
+      local_var_path = '/social/posts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_social_post_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSocialPost200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
+
+      new_options = opts.merge(
+        :operation => :"SocialApi.create_social_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SocialApi#create_social_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Maximum number of hashtag groups to retrieve per page. Default and maximum is &#x60;5&#x60;. (default to 5)
+    # @option opts [Integer] :page Page number to retrieve (0-based). (default to 0)
+    # @return [GetHashtagGroups200Response]
+    def get_hashtag_groups(opts = {})
+      data, _status_code, _headers = get_hashtag_groups_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;limit&#x60; and &#x60;page&#x60; query parameters to paginate through results. Navigate to the next page using the &#x60;_links.next&#x60; link in the response. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Maximum number of hashtag groups to retrieve per page. Default and maximum is &#x60;5&#x60;. (default to 5)
+    # @option opts [Integer] :page Page number to retrieve (0-based). (default to 0)
+    # @return [Array<(GetHashtagGroups200Response, Integer, Hash)>] GetHashtagGroups200Response data, response status code and response headers
+    def get_hashtag_groups_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SocialApi.get_hashtag_groups ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SocialApi.get_hashtag_groups, must be smaller than or equal to 5.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SocialApi.get_hashtag_groups, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SocialApi.get_hashtag_groups, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/social/hashtags/groups'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetHashtagGroups200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
+
+      new_options = opts.merge(
+        :operation => :"SocialApi.get_hashtag_groups",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SocialApi#get_hashtag_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @return [GetSocialConnections200Response]
+    def get_social_connections(opts = {})
+      data, _status_code, _headers = get_social_connections_with_http_info(opts)
+      data
+    end
+
+    # 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&#39;s active, rate-limited, or has any errors).  Note that a single connection may have multiple profiles (pages) associated with it — use &#x60;GET /social/profiles&#x60; to retrieve the individual profiles. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetSocialConnections200Response, Integer, Hash)>] GetSocialConnections200Response data, response status code and response headers
+    def get_social_connections_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SocialApi.get_social_connections ...'
+      end
+      # resource path
+      local_var_path = '/social/connections'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSocialConnections200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
+
+      new_options = opts.merge(
+        :operation => :"SocialApi.get_social_connections",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SocialApi#get_social_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :include Optional sub-resources to include. Use &#x60;accessible&#x60; to check if profiles are accessible on the network.
+    # @return [Array<GetSocialProfiles200ResponseInner>]
+    def get_social_profiles(opts = {})
+      data, _status_code, _headers = get_social_profiles_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;include&#x3D;accessible&#x60; 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :include Optional sub-resources to include. Use &#x60;accessible&#x60; to check if profiles are accessible on the network.
+    # @return [Array<(Array<GetSocialProfiles200ResponseInner>, Integer, Hash)>] Array<GetSocialProfiles200ResponseInner> data, response status code and response headers
+    def get_social_profiles_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SocialApi.get_social_profiles ...'
+      end
+      allowable_values = []
+      if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/social/profiles'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<GetSocialProfiles200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
+
+      new_options = opts.merge(
+        :operation => :"SocialApi.get_social_profiles",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SocialApi#get_social_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/constant_contact_client/api_client.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
@@ -32,7 +32,7 @@ module ConstantContactClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "ConstantContactApiRuby/1.2.0"
+      @user_agent = "ConstantContactApiRuby/1.5.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/constant_contact_client/api_error.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

data/lib/constant_contact_client/configuration.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

data/lib/constant_contact_client/models/ab_test_data.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

data/lib/constant_contact_client/models/access_token_response.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

data/lib/constant_contact_client/models/account_cancellation.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

data/lib/constant_contact_client/models/account_email_create_response.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

data/lib/constant_contact_client/models/account_email_input.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