moov_ruby 0.1.17 → 0.1.18

data/lib/moov/models/operations/getstatement_response.rb

@@ -0,0 +1,53 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class GetStatementResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+        # The request has succeeded.
+        field :statement, Crystalline::Nilable.new(Models::Components::Statement)
+        # The request has succeeded.
+        field :bytes, Crystalline::Nilable.new(::String)
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, headers: T::Hash[Symbol, T::Array[::String]], statement: T.nilable(Models::Components::Statement), bytes: T.nilable(::String)).void }
+        def initialize(content_type:, status_code:, raw_response:, headers:, statement: nil, bytes: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @headers = headers
+          @statement = statement
+          @bytes = bytes
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @headers == other.headers
+          return false unless @statement == other.statement
+          return false unless @bytes == other.bytes
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/getstatement_response.rbi

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::GetStatementResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::GetStatementResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def headers(); end
+  def headers=(str_); end
+  def statement(); end
+  def statement=(str_); end
+  def bytes(); end
+  def bytes=(str_); end
+end

data/lib/moov/models/operations/liststatements_request.rb

@@ -0,0 +1,61 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class ListStatementsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :account_id, ::String, { 'path_param': { 'field_name': 'accountID', 'style': 'simple', 'explode': false } }
+        # Optional date-time which inclusively filters all statements where billing period is on or after this date-time.
+        field :billing_period_start_date_time, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'billingPeriodStartDateTime', 'style': 'form', 'explode': false } }
+        # Optional date-time which exclusively filters all statements where billing period is before this date-time.
+        field :billing_period_end_date_time, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'billingPeriodEndDateTime', 'style': 'form', 'explode': false } }
+
+        field :skip, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'skip', 'style': 'form', 'explode': false } }
+
+        field :count, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'count', 'style': 'form', 'explode': false } }
+        # Specify an API version.
+        # 
+        # API versioning follows the format `vYYYY.QQ.BB`, where 
+        #   - `YYYY` is the year
+        #   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+        #   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. 
+        #     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+        # 
+        # The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+        field :x_moov_version, Crystalline::Nilable.new(::String), { 'header': { 'field_name': 'x-moov-version', 'style': 'simple', 'explode': false } }
+
+        sig { params(account_id: ::String, billing_period_start_date_time: T.nilable(::DateTime), billing_period_end_date_time: T.nilable(::DateTime), skip: T.nilable(::Integer), count: T.nilable(::Integer), x_moov_version: T.nilable(::String)).void }
+        def initialize(account_id:, billing_period_start_date_time: nil, billing_period_end_date_time: nil, skip: nil, count: nil, x_moov_version: 'v2024.01.00')
+          @account_id = account_id
+          @billing_period_start_date_time = billing_period_start_date_time
+          @billing_period_end_date_time = billing_period_end_date_time
+          @skip = skip
+          @count = count
+          @x_moov_version = x_moov_version
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @account_id == other.account_id
+          return false unless @billing_period_start_date_time == other.billing_period_start_date_time
+          return false unless @billing_period_end_date_time == other.billing_period_end_date_time
+          return false unless @skip == other.skip
+          return false unless @count == other.count
+          return false unless @x_moov_version == other.x_moov_version
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/liststatements_request.rbi

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::ListStatementsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::ListStatementsRequest
+  def account_id(); end
+  def account_id=(str_); end
+  def billing_period_start_date_time(); end
+  def billing_period_start_date_time=(str_); end
+  def billing_period_end_date_time(); end
+  def billing_period_end_date_time=(str_); end
+  def skip(); end
+  def skip=(str_); end
+  def count(); end
+  def count=(str_); end
+  def x_moov_version(); end
+  def x_moov_version=(str_); end
+end

data/lib/moov/models/operations/liststatements_response.rb

@@ -0,0 +1,49 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class ListStatementsResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+        # The request completed successfully.
+        field :statements, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Statement))
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, headers: T::Hash[Symbol, T::Array[::String]], statements: T.nilable(T::Array[Models::Components::Statement])).void }
+        def initialize(content_type:, status_code:, raw_response:, headers:, statements: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @headers = headers
+          @statements = statements
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @headers == other.headers
+          return false unless @statements == other.statements
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/liststatements_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::ListStatementsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::ListStatementsResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def headers(); end
+  def headers=(str_); end
+  def statements(); end
+  def statements=(str_); end
+end

data/lib/moov/models/operations.rb

@@ -134,6 +134,8 @@ module Moov
       autoload :GetScheduledOccurrenceResponse, 'moov/models/operations/getscheduledoccurrence_response.rb'
       autoload :GetSchedulesRequest, 'moov/models/operations/getschedules_request.rb'
       autoload :GetSchedulesResponse, 'moov/models/operations/getschedules_response.rb'
+      autoload :GetStatementRequest, 'moov/models/operations/getstatement_request.rb'
+      autoload :GetStatementResponse, 'moov/models/operations/getstatement_response.rb'
       autoload :GetSweepConfigRequest, 'moov/models/operations/getsweepconfig_request.rb'
       autoload :GetSweepConfigResponse, 'moov/models/operations/getsweepconfig_response.rb'
       autoload :GetSweepRequest, 'moov/models/operations/getsweep_request.rb'
@@ -223,6 +225,8 @@ module Moov
       autoload :ListRepresentativesResponse, 'moov/models/operations/listrepresentatives_response.rb'
       autoload :ListSchedulesRequest, 'moov/models/operations/listschedules_request.rb'
       autoload :ListSchedulesResponse, 'moov/models/operations/listschedules_response.rb'
+      autoload :ListStatementsRequest, 'moov/models/operations/liststatements_request.rb'
+      autoload :ListStatementsResponse, 'moov/models/operations/liststatements_response.rb'
       autoload :ListSweepConfigsRequest, 'moov/models/operations/listsweepconfigs_request.rb'
       autoload :ListSweepConfigsResponse, 'moov/models/operations/listsweepconfigs_response.rb'
       autoload :ListSweepsRequest, 'moov/models/operations/listsweeps_request.rb'

data/lib/moov/sdkconfiguration.rb

@@ -95,9 +95,9 @@ module Moov
       @globals = globals.nil? ? {} : globals
       @language = 'ruby'
       @openapi_doc_version = 'latest'
-      @sdk_version = '0.1.17'
-      @gen_version = '2.701.8'
-      @user_agent = 'speakeasy-sdk/ruby 0.1.17 2.701.8 latest moov_ruby'
+      @sdk_version = '0.1.18'
+      @gen_version = '2.706.1'
+      @user_agent = 'speakeasy-sdk/ruby 0.1.18 2.706.1 latest moov_ruby'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

data/lib/moov/statements.rb

@@ -0,0 +1,315 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/retry'
+require 'sorbet-runtime'
+require_relative 'sdk_hooks/hooks'
+require_relative 'utils/retries'
+
+module Moov
+  extend T::Sig
+  class Statements
+    extend T::Sig
+    
+
+
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
+      
+    end
+
+    sig { params(base_url: String, url_variables: T.nilable(T::Hash[Symbol, T.any(String, T::Enum)])).returns(String) }
+    def get_url(base_url:, url_variables: nil)
+      sd_base_url, sd_options = @sdk_configuration.get_server_details
+
+      if base_url.nil?
+        base_url = sd_base_url
+      end
+
+      if url_variables.nil?
+        url_variables = sd_options
+      end
+
+      return Utils.template_url base_url, url_variables
+    end
+
+
+    sig { params(request: Models::Operations::ListStatementsRequest, timeout_ms: T.nilable(Integer)).returns(Models::Operations::ListStatementsResponse) }
+    def list(request:, timeout_ms: nil)
+      # list - Retrieve all statements associated with an account.
+      # 
+      # To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+      # you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Models::Operations::ListStatementsRequest,
+        base_url,
+        '/accounts/{accountID}/statements',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      query_params = Utils.get_query_params(Models::Operations::ListStatementsRequest, request, nil, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: [],
+        operation_id: 'listStatements',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+      
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Crystalline::Array.new(Models::Components::Statement))
+          response = Models::Operations::ListStatementsResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            headers: http_response.headers,
+            statements: T.unsafe(obj)
+          )
+
+          return response
+        else
+          raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['400'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::GenericError)
+          obj.raw_response = http_response
+          raise obj
+        else
+          raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['401', '403', '429'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['500', '504'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+
+
+    sig { params(account_id: ::String, statement_id: ::String, x_moov_version: T.nilable(::String), timeout_ms: T.nilable(Integer)).returns(Models::Operations::GetStatementResponse) }
+    def get(account_id:, statement_id:, x_moov_version: nil, timeout_ms: nil)
+      # get - Retrieve a statement by its ID.
+      # 
+      # Use the `Accept` header to specify the format of the response. Supported formats are `application/json` and `application/pdf`.
+      # 
+      # To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+      # you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+      request = Models::Operations::GetStatementRequest.new(
+        account_id: account_id,
+        statement_id: statement_id,
+        x_moov_version: x_moov_version
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Models::Operations::GetStatementRequest,
+        base_url,
+        '/accounts/{accountID}/statements/{statementID}',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      headers['Accept'] = 'application/json;q=1, application/pdf;q=0'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: [],
+        operation_id: 'getStatement',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+      
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Components::Statement)
+          response = Models::Operations::GetStatementResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            headers: http_response.headers,
+            statement: T.unsafe(obj)
+          )
+
+          return response
+        elsif Utils.match_content_type(content_type, 'application/pdf')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          obj = http_response.env.body
+
+          return Models::Operations::GetStatementResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            headers: http_response.headers,
+            bytes: T.unsafe(obj)
+          )
+        else
+          raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['401', '403', '404', '429'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['500', '504'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+  end
+end

data/lib/moov_ruby.rb

@@ -19,6 +19,7 @@ module Moov
   autoload :PaymentMethods, 'moov/payment_methods'
   autoload :Representatives, 'moov/representatives'
   autoload :Scheduling, 'moov/scheduling'
+  autoload :Statements, 'moov/statements'
   autoload :Sweeps, 'moov/sweeps'
   autoload :AccountTerminalApplications, 'moov/account_terminal_applications'
   autoload :Support, 'moov/support'