apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/ach_return_api.rb

@@ -0,0 +1,115 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AchReturnApi
+  class AchReturnApi < BaseApi
+    # :::warning
+    # The features documented here are in a beta state, and this documentation
+    # is considered draft material subject to frequent change.
+    # :::
+    # Use this endpoint to get an ACH return by its `guid` or `id`.
+    # @param [String] ach_return_guid Required parameter: The unique identifier
+    # (`guid`) for the ACH return. Defined by MX.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_ach_retrun(ach_return_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ach_returns/{ach_return_guid}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(ach_return_guid, key: 'ach_return_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AchReturnResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # :::warning
+    # The features documented here are in a beta state, and this documentation
+    # is considered draft material subject to frequent change.
+    # :::
+    # Use this endpoint to get all ACH returns.
+    # @param [String] institution_guid Optional parameter: The identifier for
+    # the institution associated with the ACH return. Defined by MX.
+    # @param [String] returned_at Optional parameter: The date and time when the
+    # return was reported by the Receiving Financial Depository Institution
+    # (RDFI) in ISO 8601 format without timestamp.
+    # @param [String] resolved_status_at Optional parameter: The date and time
+    # when the return was resolved by the Receiving Financial Depository
+    # Institution (RDFI) in ISO 8601 format without timestamp
+    # @param [String] return_code Optional parameter: The associated ACH return
+    # code and notice of change code. See [Return
+    # Codes](/api-reference/platform-api/reference/ach-return-fields/#return-cod
+    # es) for a complete list.
+    # @param [String] return_status Optional parameter: The status of the
+    # return. See [Return
+    # Statuses](/api-reference/platform-api/reference/ach-return-fields/#return-
+    # status) for a complete list.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_ach_retruns(institution_guid: nil,
+                         returned_at: nil,
+                         resolved_status_at: nil,
+                         return_code: nil,
+                         return_status: nil,
+                         page: nil,
+                         records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ach_returns',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(institution_guid, key: 'institution_guid'))
+                   .query_param(new_parameter(returned_at, key: 'returned_at'))
+                   .query_param(new_parameter(resolved_status_at, key: 'resolved_status_at'))
+                   .query_param(new_parameter(return_code, key: 'return_code'))
+                   .query_param(new_parameter(return_status, key: 'return_status'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AchReturnsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # :::warning
+    # The features documented here are in a beta state, and this documentation
+    # is considered draft material subject to frequent change.
+    # :::
+    # Use this endpoint to create an ACH return in our system.
+    # @param [AchReturnCreateRequestBody] body Required parameter: ACH return
+    # object to be created.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_ach_return(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/ach_returns',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AchReturnResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/mx_platform_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/mx_platform_api/apis/budgets_api.rb

@@ -0,0 +1,212 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # BudgetsApi
+  class BudgetsApi < BaseApi
+    # This endpoint will automatically create budgets for several categories
+    # based on existing transactions; these budgets are returned as an array.
+    # Specifically, budgets will only be generated if the `user` has at least
+    # one `transaction` in a given category during each of the two previous
+    # calendar months. For example, if the request is made on March 6, and there
+    # is at least one "Bills & Utilities" `transaction` in both January and
+    # February, a budget will be generated for "Bills & Utilities." If there are
+    # two "Bills & Utilities" transactions in February but none in January, no
+    # budget will be generated for that category. If budgets already exist for
+    # particular categories, new budgets will be generated and returned based on
+    # the available transactions. If one or more budgets remain unchanged, they
+    # will nevertheless be returned in the response. If no transaction data for
+    # the `user` meet the above criteria, a `422 Unprocessable Entity` error
+    # will be returned with status code 4221 along with the message, `There
+    # aren't enough transactions to automatically create any budgets`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def auto_generate_budgets(accept_version,
+                              user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_guid}/budgets/generate',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BudgetResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Create a budget. This endpoint accepts the optional `MX-Skip-Webhook`
+    # header and `skip_webhook` parameter. You cannot create a duplicate budget.
+    # For example, if you attempt to create a budget for "Gas", but that budget
+    # already exist, the request will fail. You can retrieve a list of all
+    # existing categories by using the List Categories endpoint.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [BudgetCreateRequestBody] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_budget(accept_version,
+                      user_guid,
+                      body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_guid}/budgets',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BudgetResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # List all budgets
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_all_budgets(accept_version,
+                         user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/budgets',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BudgetResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Read a specific budget.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] budget_guid Required parameter: The unique identifier for
+    # the budget. Defined by MX.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_specific_budget(accept_version,
+                             user_guid,
+                             budget_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/budgets/{budget_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(budget_guid, key: 'budget_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BudgetResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update a specific budget.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] budget_guid Required parameter: The unique identifier for
+    # the budget. Defined by MX.
+    # @param [BudgetUpdateRequestBody] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_specific_budget(accept_version,
+                               user_guid,
+                               budget_guid,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_guid}/budgets/{budget_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(budget_guid, key: 'budget_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BudgetResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Delete a budget.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] budget_guid Required parameter: The unique identifier for
+    # the budget. Defined by MX.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_budget(accept_version,
+                      user_guid,
+                      budget_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/users/{user_guid}/budgets/{budget_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(budget_guid, key: 'budget_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end