smooch-api 1.0.0

data/lib/smooch-api/api/conversation_api.rb

@@ -0,0 +1,298 @@
+=begin
+#Smooch
+
+#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module SmoochApi
+  class ConversationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Clears the message history for a user, permanently deleting all messages, but leaving any connections to Messaging Channels and Business Systems intact. These connections allow for the conversation to continue in the future, while still being associated to the same appUser. 
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_messages(user_id, opts = {})
+      delete_messages_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # 
+    # Clears the message history for a user, permanently deleting all messages, but leaving any connections to Messaging Channels and Business Systems intact. These connections allow for the conversation to continue in the future, while still being associated to the same appUser. 
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_messages_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationApi.delete_messages ..."
+      end
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.delete_messages" if user_id.nil?
+      # resource path
+      local_var_path = "/appusers/{userId}/messages".sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['jwt']
+      data, status_code, headers = @api_client.call_api(:DELETE, 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: ConversationApi#delete_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Get the specified app user's messages.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :before Timestamp of message. The API will return 100 messages before the specified timestamp (excluding any messages with the provided timestamp).
+    # @option opts [String] :after Timestamp of message. The API will return 100 messages after the specified timestamp (excluding any messages with the provided timestamp).
+    # @return [GetMessagesResponse]
+    def get_messages(user_id, opts = {})
+      data, _status_code, _headers = get_messages_with_http_info(user_id, opts)
+      return data
+    end
+
+    # 
+    # Get the specified app user&#39;s messages.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :before Timestamp of message. The API will return 100 messages before the specified timestamp (excluding any messages with the provided timestamp).
+    # @option opts [String] :after Timestamp of message. The API will return 100 messages after the specified timestamp (excluding any messages with the provided timestamp).
+    # @return [Array<(GetMessagesResponse, Fixnum, Hash)>] GetMessagesResponse data, response status code and response headers
+    def get_messages_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationApi.get_messages ..."
+      end
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.get_messages" if user_id.nil?
+      # resource path
+      local_var_path = "/appusers/{userId}/messages".sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['jwt']
+      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,
+        :return_type => 'GetMessagesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Post a message to or from the app user.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param message_post_body Body for a postMessage request. Additional arguments are necessary based on message type ([text](https://docs.smooch.io/rest#text-message), [image](https://docs.smooch.io/rest#image-message), [carousel](https://docs.smooch.io/rest#carousel-message), [list](https://docs.smooch.io/rest#list-message)) 
+    # @param [Hash] opts the optional parameters
+    # @return [PostMessagesResponse]
+    def post_message(user_id, message_post_body, opts = {})
+      data, _status_code, _headers = post_message_with_http_info(user_id, message_post_body, opts)
+      return data
+    end
+
+    # 
+    # Post a message to or from the app user.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param message_post_body Body for a postMessage request. Additional arguments are necessary based on message type ([text](https://docs.smooch.io/rest#text-message), [image](https://docs.smooch.io/rest#image-message), [carousel](https://docs.smooch.io/rest#carousel-message), [list](https://docs.smooch.io/rest#list-message)) 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostMessagesResponse, Fixnum, Hash)>] PostMessagesResponse data, response status code and response headers
+    def post_message_with_http_info(user_id, message_post_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationApi.post_message ..."
+      end
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.post_message" if user_id.nil?
+      # verify the required parameter 'message_post_body' is set
+      fail ArgumentError, "Missing the required parameter 'message_post_body' when calling ConversationApi.post_message" if message_post_body.nil?
+      # resource path
+      local_var_path = "/appusers/{userId}/messages".sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(message_post_body)
+      auth_names = ['jwt']
+      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,
+        :return_type => 'PostMessagesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#post_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Reset the unread count of the conversation to 0.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def reset_unread_count(user_id, opts = {})
+      reset_unread_count_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # 
+    # Reset the unread count of the conversation to 0.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def reset_unread_count_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationApi.reset_unread_count ..."
+      end
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.reset_unread_count" if user_id.nil?
+      # resource path
+      local_var_path = "/appusers/{userId}/conversation/read".sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['jwt']
+      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: ConversationApi#reset_unread_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Notify Smooch when an app maker starts or stops typing a response.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param typing_activity_trigger_body Body for a triggerTypingActivity request.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def trigger_typing_activity(user_id, typing_activity_trigger_body, opts = {})
+      trigger_typing_activity_with_http_info(user_id, typing_activity_trigger_body, opts)
+      return nil
+    end
+
+    # 
+    # Notify Smooch when an app maker starts or stops typing a response.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param typing_activity_trigger_body Body for a triggerTypingActivity request.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def trigger_typing_activity_with_http_info(user_id, typing_activity_trigger_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationApi.trigger_typing_activity ..."
+      end
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.trigger_typing_activity" if user_id.nil?
+      # verify the required parameter 'typing_activity_trigger_body' is set
+      fail ArgumentError, "Missing the required parameter 'typing_activity_trigger_body' when calling ConversationApi.trigger_typing_activity" if typing_activity_trigger_body.nil?
+      # resource path
+      local_var_path = "/appusers/{userId}/conversation/activity".sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(typing_activity_trigger_body)
+      auth_names = ['jwt']
+      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: ConversationApi#trigger_typing_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/smooch-api/api/init_api.rb

@@ -0,0 +1,75 @@
+=begin
+#Smooch
+
+#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module SmoochApi
+  class InitApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # This API is called by an iOS, Android, or browser client when the app is first loaded. It serves a number of purposes. 1. Initializes a new *appUser* and *client* if they don’t yet exist. 2. Updates an existing app user’s profile and client information. 3. Authenticates the *appUser* if *jwt* credentials are provided. 
+    # @param init_body Body for an init request.
+    # @param [Hash] opts the optional parameters
+    # @return [InitResponse]
+    def init(init_body, opts = {})
+      data, _status_code, _headers = init_with_http_info(init_body, opts)
+      return data
+    end
+
+    # 
+    # This API is called by an iOS, Android, or browser client when the app is first loaded. It serves a number of purposes. 1. Initializes a new *appUser* and *client* if they don’t yet exist. 2. Updates an existing app user’s profile and client information. 3. Authenticates the *appUser* if *jwt* credentials are provided. 
+    # @param init_body Body for an init request.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InitResponse, Fixnum, Hash)>] InitResponse data, response status code and response headers
+    def init_with_http_info(init_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: InitApi.init ..."
+      end
+      # verify the required parameter 'init_body' is set
+      fail ArgumentError, "Missing the required parameter 'init_body' when calling InitApi.init" if init_body.nil?
+      # resource path
+      local_var_path = "/init"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(init_body)
+      auth_names = ['jwt']
+      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,
+        :return_type => 'InitResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InitApi#init\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/smooch-api/api/integration_api.rb

@@ -0,0 +1,135 @@
+=begin
+#Smooch
+
+#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module SmoochApi
+  class IntegrationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Create an integration for the specified app.
+    # @param app_id Identifies the app.
+    # @param integration_create_body Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) 
+    # @param [Hash] opts the optional parameters
+    # @return [IntegrationResponse]
+    def create_integration(app_id, integration_create_body, opts = {})
+      data, _status_code, _headers = create_integration_with_http_info(app_id, integration_create_body, opts)
+      return data
+    end
+
+    # 
+    # Create an integration for the specified app.
+    # @param app_id Identifies the app.
+    # @param integration_create_body Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IntegrationResponse, Fixnum, Hash)>] IntegrationResponse data, response status code and response headers
+    def create_integration_with_http_info(app_id, integration_create_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IntegrationApi.create_integration ..."
+      end
+      # verify the required parameter 'app_id' is set
+      fail ArgumentError, "Missing the required parameter 'app_id' when calling IntegrationApi.create_integration" if app_id.nil?
+      # verify the required parameter 'integration_create_body' is set
+      fail ArgumentError, "Missing the required parameter 'integration_create_body' when calling IntegrationApi.create_integration" if integration_create_body.nil?
+      # resource path
+      local_var_path = "/apps/{appId}/integrations".sub('{' + 'appId' + '}', app_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(integration_create_body)
+      auth_names = ['jwt']
+      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,
+        :return_type => 'IntegrationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationApi#create_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # List integrations for the specified app.
+    # @param app_id Identifies the app.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :types List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types&#x3D;*twilio*,*line*. 
+    # @return [ListIntegrationsResponse]
+    def list_integrations(app_id, opts = {})
+      data, _status_code, _headers = list_integrations_with_http_info(app_id, opts)
+      return data
+    end
+
+    # 
+    # List integrations for the specified app.
+    # @param app_id Identifies the app.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :types List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types&#x3D;*twilio*,*line*. 
+    # @return [Array<(ListIntegrationsResponse, Fixnum, Hash)>] ListIntegrationsResponse data, response status code and response headers
+    def list_integrations_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IntegrationApi.list_integrations ..."
+      end
+      # verify the required parameter 'app_id' is set
+      fail ArgumentError, "Missing the required parameter 'app_id' when calling IntegrationApi.list_integrations" if app_id.nil?
+      # resource path
+      local_var_path = "/apps/{appId}/integrations".sub('{' + 'appId' + '}', app_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'types'] = opts[:'types'] if !opts[:'types'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['jwt']
+      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,
+        :return_type => 'ListIntegrationsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationApi#list_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end