mx-platform-ruby 1.10.0 → 1.10.1

data/lib/mx-platform-ruby/api/notifications_api.rb

@@ -0,0 +1,243 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'cgi'
+
+module MxPlatformRuby
+  class NotificationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a notification
+    # All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity.  No other channels are supported.  This will only have an effect for clients using an MX mobile application.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param content [String] The information related to the notification.
+    # @param subject [String] The subject related to the notification.
+    # @param [Hash] opts the optional parameters
+    # @return [NotificationResponseBody]
+    def create_notification(user_guid, content, subject, opts = {})
+      data, _status_code, _headers = create_notification_with_http_info(user_guid, content, subject, opts)
+      data
+    end
+
+    # Create a notification
+    # All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity.  No other channels are supported.  This will only have an effect for clients using an MX mobile application.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param content [String] The information related to the notification.
+    # @param subject [String] The subject related to the notification.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NotificationResponseBody, Integer, Hash)>] NotificationResponseBody data, response status code and response headers
+    def create_notification_with_http_info(user_guid, content, subject, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.create_notification ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling NotificationsApi.create_notification"
+      end
+      # verify the required parameter 'content' is set
+      if @api_client.config.client_side_validation && content.nil?
+        fail ArgumentError, "Missing the required parameter 'content' when calling NotificationsApi.create_notification"
+      end
+      # verify the required parameter 'subject' is set
+      if @api_client.config.client_side_validation && subject.nil?
+        fail ArgumentError, "Missing the required parameter 'subject' when calling NotificationsApi.create_notification"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/notifications'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'content'] = content
+      query_params[:'subject'] = subject
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NotificationResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotificationsApi.create_notification",
+        :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: NotificationsApi#create_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List notifications
+    # All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
+    # @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [NotificationsResponseBody]
+    def list_notifications(user_guid, opts = {})
+      data, _status_code, _headers = list_notifications_with_http_info(user_guid, opts)
+      data
+    end
+
+    # List notifications
+    # All notifications for the user can be listed, including notifications created by MX for other channels besides &#x60;PUSH&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
+    # @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [Array<(NotificationsResponseBody, Integer, Hash)>] NotificationsResponseBody data, response status code and response headers
+    def list_notifications_with_http_info(user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.list_notifications ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling NotificationsApi.list_notifications"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/notifications'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
+      query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NotificationsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotificationsApi.list_notifications",
+        :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: NotificationsApi#list_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read notifications
+    # Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`. 
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param notification_guid [String] The unique identifier for notifications. Defined by MX.
+    # @param [Hash] opts the optional parameters
+    # @return [NotificationResponseBody]
+    def read_notifications(user_guid, notification_guid, opts = {})
+      data, _status_code, _headers = read_notifications_with_http_info(user_guid, notification_guid, opts)
+      data
+    end
+
+    # Read notifications
+    # Can pull up any notification associated with the user, including notifications created by MX for other channels besides &#x60;PUSH&#x60;. 
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param notification_guid [String] The unique identifier for notifications. Defined by MX.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NotificationResponseBody, Integer, Hash)>] NotificationResponseBody data, response status code and response headers
+    def read_notifications_with_http_info(user_guid, notification_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.read_notifications ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling NotificationsApi.read_notifications"
+      end
+      # verify the required parameter 'notification_guid' is set
+      if @api_client.config.client_side_validation && notification_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_guid' when calling NotificationsApi.read_notifications"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/notifications/{notification_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'notification_guid' + '}', CGI.escape(notification_guid.to_s))
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NotificationResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotificationsApi.read_notifications",
+        :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: NotificationsApi#read_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end