bombbomb 2.0.24005 → 2.0.25797

data/lib/bombbomb/api/socials_api.rb

@@ -3,7 +3,7 @@
 
 #We make it easy to build relationships using simple videos.
 
-OpenAPI spec version: 2.0.24005
+OpenAPI spec version: 2.0.25797
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -31,43 +31,85 @@ module BombBomb
       @api_client = api_client
     end
 
+    # Gets facebook pages
+    # Gets facebook pages by client id
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_facebook_pages(opts = {})
+      get_facebook_pages_with_http_info(opts)
+      return nil
+    end
+
+    # Gets facebook pages
+    # Gets facebook pages by client id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_facebook_pages_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SocialsApi.get_facebook_pages ..."
+      end
+      # resource path
+      local_var_path = "/socials/facebook/pages".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['BBOAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SocialsApi#get_facebook_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets the social email properties
     # Gets the social email properties
-    # @param jericho_id associated jericho Id
     # @param email_id This is the email Id for the email url
-    # @param originator_id This is the originator Id
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def get_social_article_properties(jericho_id, email_id, originator_id, opts = {})
-      get_social_article_properties_with_http_info(jericho_id, email_id, originator_id, opts)
+    def get_social_article_properties(email_id, opts = {})
+      get_social_article_properties_with_http_info(email_id, opts)
       return nil
     end
 
     # Gets the social email properties
     # Gets the social email properties
-    # @param jericho_id associated jericho Id
     # @param email_id This is the email Id for the email url
-    # @param originator_id This is the originator Id
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_social_article_properties_with_http_info(jericho_id, email_id, originator_id, opts = {})
+    def get_social_article_properties_with_http_info(email_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: SocialsApi.get_social_article_properties ..."
       end
-      # verify the required parameter 'jericho_id' is set
-      fail ArgumentError, "Missing the required parameter 'jericho_id' when calling SocialsApi.get_social_article_properties" if jericho_id.nil?
       # verify the required parameter 'email_id' is set
       fail ArgumentError, "Missing the required parameter 'email_id' when calling SocialsApi.get_social_article_properties" if email_id.nil?
-      # verify the required parameter 'originator_id' is set
-      fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.get_social_article_properties" if originator_id.nil?
       # resource path
       local_var_path = "/socials/properties".sub('{format}','json')
 
       # query parameters
       query_params = {}
-      query_params[:'jerichoId'] = jericho_id
       query_params[:'emailId'] = email_id
-      query_params[:'originatorId'] = originator_id
 
       # header parameters
       header_params = {}
@@ -98,33 +140,31 @@ module BombBomb
       return data, status_code, headers
     end
 
-    # Gets the auto shares from the client group assoc id
-    # Gets the auto shares from the client group assoc id
-    # @param client_group_id ID of the client group association
+    # Get authorizations for all social integration
+    # Get authorizations and autoshares for all social integration and has redirect for user to login
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :client_group_id ID of the client group association
     # @return [nil]
-    def get_social_auto_shares(client_group_id, opts = {})
-      get_social_auto_shares_with_http_info(client_group_id, opts)
+    def get_social_authorizations(opts = {})
+      get_social_authorizations_with_http_info(opts)
       return nil
     end
 
-    # Gets the auto shares from the client group assoc id
-    # Gets the auto shares from the client group assoc id
-    # @param client_group_id ID of the client group association
+    # Get authorizations for all social integration
+    # Get authorizations and autoshares for all social integration and has redirect for user to login
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :client_group_id ID of the client group association
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_social_auto_shares_with_http_info(client_group_id, opts = {})
+    def get_social_authorizations_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SocialsApi.get_social_auto_shares ..."
+        @api_client.config.logger.debug "Calling API: SocialsApi.get_social_authorizations ..."
       end
-      # verify the required parameter 'client_group_id' is set
-      fail ArgumentError, "Missing the required parameter 'client_group_id' when calling SocialsApi.get_social_auto_shares" if client_group_id.nil?
       # resource path
-      local_var_path = "/socials/shares".sub('{format}','json')
+      local_var_path = "/socials/authorizations".sub('{format}','json')
 
       # query parameters
       query_params = {}
-      query_params[:'clientGroupId'] = client_group_id
+      query_params[:'clientGroupId'] = opts[:'client_group_id'] if !opts[:'client_group_id'].nil?
 
       # header parameters
       header_params = {}
@@ -150,34 +190,34 @@ module BombBomb
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SocialsApi#get_social_auto_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SocialsApi#get_social_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get permissions for social integration
-    # Get permissions for social integration and has redirect for user to login
-    # @param social_type Type of social integration
+    # Gets the profile properties
+    # Gets the social profile properties
+    # @param social_type The social type
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def get_social_permissions(social_type, opts = {})
-      get_social_permissions_with_http_info(social_type, opts)
+    def get_social_profile_properties(social_type, opts = {})
+      get_social_profile_properties_with_http_info(social_type, opts)
       return nil
     end
 
-    # Get permissions for social integration
-    # Get permissions for social integration and has redirect for user to login
-    # @param social_type Type of social integration
+    # Gets the profile properties
+    # Gets the social profile properties
+    # @param social_type The social type
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_social_permissions_with_http_info(social_type, opts = {})
+    def get_social_profile_properties_with_http_info(social_type, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SocialsApi.get_social_permissions ..."
+        @api_client.config.logger.debug "Calling API: SocialsApi.get_social_profile_properties ..."
       end
       # verify the required parameter 'social_type' is set
-      fail ArgumentError, "Missing the required parameter 'social_type' when calling SocialsApi.get_social_permissions" if social_type.nil?
+      fail ArgumentError, "Missing the required parameter 'social_type' when calling SocialsApi.get_social_profile_properties" if social_type.nil?
       # resource path
-      local_var_path = "/socials/permissions".sub('{format}','json')
+      local_var_path = "/socials/profile".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -207,38 +247,37 @@ module BombBomb
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SocialsApi#get_social_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SocialsApi#get_social_profile_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Gets the social state
-    # Gets the social state
-    # @param originator_id associated originatorId
+    # Get social stats for a prompt
+    # Get social stats for a prompt by id
+    # @param prompt_id ID of the prompt
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def get_social_status(originator_id, opts = {})
-      get_social_status_with_http_info(originator_id, opts)
+    def get_social_stats(prompt_id, opts = {})
+      get_social_stats_with_http_info(prompt_id, opts)
       return nil
     end
 
-    # Gets the social state
-    # Gets the social state
-    # @param originator_id associated originatorId
+    # Get social stats for a prompt
+    # Get social stats for a prompt by id
+    # @param prompt_id ID of the prompt
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_social_status_with_http_info(originator_id, opts = {})
+    def get_social_stats_with_http_info(prompt_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SocialsApi.get_social_status ..."
+        @api_client.config.logger.debug "Calling API: SocialsApi.get_social_stats ..."
       end
-      # verify the required parameter 'originator_id' is set
-      fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.get_social_status" if originator_id.nil?
+      # verify the required parameter 'prompt_id' is set
+      fail ArgumentError, "Missing the required parameter 'prompt_id' when calling SocialsApi.get_social_stats" if prompt_id.nil?
       # resource path
-      local_var_path = "/socials/states".sub('{format}','json')
+      local_var_path = "/socials/{promptId}/stats".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
 
       # query parameters
       query_params = {}
-      query_params[:'originatorId'] = originator_id
 
       # header parameters
       header_params = {}
@@ -264,38 +303,97 @@ module BombBomb
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SocialsApi#get_social_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SocialsApi#get_social_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Creates social content
+    # Creates social content for an email
+    # @param email_id The email&#39;s id
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_social_content(email_id, opts = {})
+      post_social_content_with_http_info(email_id, opts)
+      return nil
+    end
+
+    # Creates social content
+    # Creates social content for an email
+    # @param email_id The email&#39;s id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def post_social_content_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SocialsApi.post_social_content ..."
+      end
+      # verify the required parameter 'email_id' is set
+      fail ArgumentError, "Missing the required parameter 'email_id' when calling SocialsApi.post_social_content" if email_id.nil?
+      # resource path
+      local_var_path = "/socials/content".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+      form_params["emailId"] = email_id
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['BBOAuth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SocialsApi#post_social_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Gets the auto shares from the client group assoc id
     # Gets the auto shares from the client group assoc id
-    # @param auto_share The social share that will auto share to
+    # @param send_mechanism The send mechanism for the prompt
     # @param client_group_id ID of the client group association
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :enabled Is the send mechanism enabled?
     # @return [nil]
-    def update_social_auto_shares(auto_share, client_group_id, opts = {})
-      update_social_auto_shares_with_http_info(auto_share, client_group_id, opts)
+    def update_client_group_send_mechanism(send_mechanism, client_group_id, opts = {})
+      update_client_group_send_mechanism_with_http_info(send_mechanism, client_group_id, opts)
       return nil
     end
 
     # Gets the auto shares from the client group assoc id
     # Gets the auto shares from the client group assoc id
-    # @param auto_share The social share that will auto share to
+    # @param send_mechanism The send mechanism for the prompt
     # @param client_group_id ID of the client group association
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :enabled Is the send mechanism enabled?
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def update_social_auto_shares_with_http_info(auto_share, client_group_id, opts = {})
+    def update_client_group_send_mechanism_with_http_info(send_mechanism, client_group_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SocialsApi.update_social_auto_shares ..."
+        @api_client.config.logger.debug "Calling API: SocialsApi.update_client_group_send_mechanism ..."
       end
-      # verify the required parameter 'auto_share' is set
-      fail ArgumentError, "Missing the required parameter 'auto_share' when calling SocialsApi.update_social_auto_shares" if auto_share.nil?
+      # verify the required parameter 'send_mechanism' is set
+      fail ArgumentError, "Missing the required parameter 'send_mechanism' when calling SocialsApi.update_client_group_send_mechanism" if send_mechanism.nil?
       # verify the required parameter 'client_group_id' is set
-      fail ArgumentError, "Missing the required parameter 'client_group_id' when calling SocialsApi.update_social_auto_shares" if client_group_id.nil?
+      fail ArgumentError, "Missing the required parameter 'client_group_id' when calling SocialsApi.update_client_group_send_mechanism" if client_group_id.nil?
       # resource path
-      local_var_path = "/socials/shares".sub('{format}','json')
+      local_var_path = "/socials/client/sendMechanism".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -313,8 +411,9 @@ module BombBomb
 
       # form parameters
       form_params = {}
-      form_params["autoShare"] = auto_share
+      form_params["sendMechanism"] = send_mechanism
       form_params["clientGroupId"] = client_group_id
+      form_params["enabled"] = opts[:'enabled'] if !opts[:'enabled'].nil?
 
       # http body (model)
       post_body = nil
@@ -326,38 +425,34 @@ module BombBomb
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SocialsApi#update_social_auto_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SocialsApi#update_client_group_send_mechanism\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Sets the users social message to what they typed in
-    # Sets the users social message to what they typed in
-    # @param message The social message the user typed in
-    # @param originator_id The parent id tied to the social share
+    # Updates facebook page Ids
+    # Updates facebook page Ids to be sent to for prompts
+    # @param page_ids Page Ids for the prompt
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def update_social_message(message, originator_id, opts = {})
-      update_social_message_with_http_info(message, originator_id, opts)
+    def update_facebook_pages(page_ids, opts = {})
+      update_facebook_pages_with_http_info(page_ids, opts)
       return nil
     end
 
-    # Sets the users social message to what they typed in
-    # Sets the users social message to what they typed in
-    # @param message The social message the user typed in
-    # @param originator_id The parent id tied to the social share
+    # Updates facebook page Ids
+    # Updates facebook page Ids to be sent to for prompts
+    # @param page_ids Page Ids for the prompt
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def update_social_message_with_http_info(message, originator_id, opts = {})
+    def update_facebook_pages_with_http_info(page_ids, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SocialsApi.update_social_message ..."
+        @api_client.config.logger.debug "Calling API: SocialsApi.update_facebook_pages ..."
       end
-      # verify the required parameter 'message' is set
-      fail ArgumentError, "Missing the required parameter 'message' when calling SocialsApi.update_social_message" if message.nil?
-      # verify the required parameter 'originator_id' is set
-      fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.update_social_message" if originator_id.nil?
+      # verify the required parameter 'page_ids' is set
+      fail ArgumentError, "Missing the required parameter 'page_ids' when calling SocialsApi.update_facebook_pages" if page_ids.nil?
       # resource path
-      local_var_path = "/socials/message".sub('{format}','json')
+      local_var_path = "/socials/facebook/pages".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -375,8 +470,7 @@ module BombBomb
 
       # form parameters
       form_params = {}
-      form_params["message"] = message
-      form_params["originatorId"] = originator_id
+      form_params["pageIds"] = page_ids
 
       # http body (model)
       post_body = nil
@@ -388,38 +482,42 @@ module BombBomb
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SocialsApi#update_social_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SocialsApi#update_facebook_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Updates the social state for the object
-    # Updates the social state for the object
-    # @param state The state to set to
-    # @param originator_id The parent id tied to the social share
+    # Updates social content
+    # Updates social content for an email
+    # @param social_id The social id
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :title The title for the article
+    # @option opts [String] :description The article description
+    # @option opts [String] :picture_url The article picture url
+    # @option opts [String] :suggested_message The suggested message to use
     # @return [nil]
-    def update_social_status(state, originator_id, opts = {})
-      update_social_status_with_http_info(state, originator_id, opts)
+    def update_social_content(social_id, opts = {})
+      update_social_content_with_http_info(social_id, opts)
       return nil
     end
 
-    # Updates the social state for the object
-    # Updates the social state for the object
-    # @param state The state to set to
-    # @param originator_id The parent id tied to the social share
+    # Updates social content
+    # Updates social content for an email
+    # @param social_id The social id
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :title The title for the article
+    # @option opts [String] :description The article description
+    # @option opts [String] :picture_url The article picture url
+    # @option opts [String] :suggested_message The suggested message to use
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def update_social_status_with_http_info(state, originator_id, opts = {})
+    def update_social_content_with_http_info(social_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SocialsApi.update_social_status ..."
+        @api_client.config.logger.debug "Calling API: SocialsApi.update_social_content ..."
       end
-      # verify the required parameter 'state' is set
-      fail ArgumentError, "Missing the required parameter 'state' when calling SocialsApi.update_social_status" if state.nil?
-      # verify the required parameter 'originator_id' is set
-      fail ArgumentError, "Missing the required parameter 'originator_id' when calling SocialsApi.update_social_status" if originator_id.nil?
+      # verify the required parameter 'social_id' is set
+      fail ArgumentError, "Missing the required parameter 'social_id' when calling SocialsApi.update_social_content" if social_id.nil?
       # resource path
-      local_var_path = "/socials/state".sub('{format}','json')
+      local_var_path = "/socials/content".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -437,8 +535,11 @@ module BombBomb
 
       # form parameters
       form_params = {}
-      form_params["state"] = state
-      form_params["originatorId"] = originator_id
+      form_params["socialId"] = social_id
+      form_params["title"] = opts[:'title'] if !opts[:'title'].nil?
+      form_params["description"] = opts[:'description'] if !opts[:'description'].nil?
+      form_params["pictureUrl"] = opts[:'picture_url'] if !opts[:'picture_url'].nil?
+      form_params["suggestedMessage"] = opts[:'suggested_message'] if !opts[:'suggested_message'].nil?
 
       # http body (model)
       post_body = nil
@@ -450,7 +551,7 @@ module BombBomb
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SocialsApi#update_social_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SocialsApi#update_social_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end