finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/lib/finch-api/resources/hris/pay_statements.rb

@@ -16,7 +16,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::ResponsesPage<FinchAPI::Models::HRIS::PayStatementResponse>]
-        #
         def retrieve_many(params)
           parsed, options = FinchAPI::Models::HRIS::PayStatementRetrieveManyParams.dump_request(params)
           @client.request(
@@ -30,7 +29,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/hris/payments.rb

@@ -17,7 +17,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::SinglePage<FinchAPI::Models::HRIS::Payment>]
-        #
         def list(params)
           parsed, options = FinchAPI::Models::HRIS::PaymentListParams.dump_request(params)
           @client.request(
@@ -31,7 +30,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/hris.rb

@@ -28,7 +28,6 @@ module FinchAPI
       attr_reader :benefits
 
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
         @company = FinchAPI::Resources::HRIS::Company.new(client: client)

data/lib/finch-api/resources/jobs/automated.rb

@@ -28,7 +28,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Jobs::AutomatedCreateResponse]
-        #
         def create(params)
           parsed, options = FinchAPI::Models::Jobs::AutomatedCreateParams.dump_request(params)
           @client.request(
@@ -49,7 +48,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob]
-        #
         def retrieve(job_id, params = {})
           @client.request(
             method: :get,
@@ -71,22 +69,19 @@ module FinchAPI
         #
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
-        # @return [FinchAPI::Page<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
-        #
+        # @return [FinchAPI::Models::Jobs::AutomatedListResponse]
         def list(params = {})
           parsed, options = FinchAPI::Models::Jobs::AutomatedListParams.dump_request(params)
           @client.request(
             method: :get,
             path: "jobs/automated",
             query: parsed,
-            page: FinchAPI::Page,
-            model: FinchAPI::Models::Jobs::AutomatedAsyncJob,
+            model: FinchAPI::Models::Jobs::AutomatedListResponse,
             options: options
           )
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/jobs/manual.rb

@@ -14,7 +14,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Jobs::ManualAsyncJob]
-        #
         def retrieve(job_id, params = {})
           @client.request(
             method: :get,
@@ -25,7 +24,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/jobs.rb

@@ -10,7 +10,6 @@ module FinchAPI
       attr_reader :manual
 
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
         @automated = FinchAPI::Resources::Jobs::Automated.new(client: client)

data/lib/finch-api/resources/payroll/pay_groups.rb

@@ -13,7 +13,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Payroll::PayGroupRetrieveResponse]
-        #
         def retrieve(pay_group_id, params = {})
           @client.request(
             method: :get,
@@ -34,7 +33,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::SinglePage<FinchAPI::Models::Payroll::PayGroupListResponse>]
-        #
         def list(params = {})
           parsed, options = FinchAPI::Models::Payroll::PayGroupListParams.dump_request(params)
           @client.request(
@@ -48,7 +46,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/payroll.rb

@@ -7,7 +7,6 @@ module FinchAPI
       attr_reader :pay_groups
 
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
         @pay_groups = FinchAPI::Resources::Payroll::PayGroups.new(client: client)

data/lib/finch-api/resources/providers.rb

@@ -10,7 +10,6 @@ module FinchAPI
       #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [FinchAPI::SinglePage<FinchAPI::Models::Provider>]
-      #
       def list(params = {})
         @client.request(
           method: :get,
@@ -22,7 +21,6 @@ module FinchAPI
       end
 
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/finch-api/resources/request_forwarding.rb

@@ -30,7 +30,6 @@ module FinchAPI
       #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [FinchAPI::Models::RequestForwardingForwardResponse]
-      #
       def forward(params)
         parsed, options = FinchAPI::Models::RequestForwardingForwardParams.dump_request(params)
         @client.request(
@@ -43,7 +42,6 @@ module FinchAPI
       end
 
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/finch-api/resources/sandbox/company.rb

@@ -27,7 +27,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse]
-        #
         def update(params)
           parsed, options = FinchAPI::Models::Sandbox::CompanyUpdateParams.dump_request(params)
           @client.request(
@@ -40,7 +39,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/sandbox/connections/accounts.rb

@@ -21,7 +21,6 @@ module FinchAPI
           #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
           #
           # @return [FinchAPI::Models::Sandbox::Connections::AccountCreateResponse]
-          #
           def create(params)
             parsed, options = FinchAPI::Models::Sandbox::Connections::AccountCreateParams.dump_request(params)
             @client.request(
@@ -43,7 +42,6 @@ module FinchAPI
           #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
           #
           # @return [FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse]
-          #
           def update(params = {})
             parsed, options = FinchAPI::Models::Sandbox::Connections::AccountUpdateParams.dump_request(params)
             @client.request(
@@ -56,7 +54,6 @@ module FinchAPI
           end
 
           # @param client [FinchAPI::Client]
-          #
           def initialize(client:)
             @client = client
           end

data/lib/finch-api/resources/sandbox/connections.rb

@@ -24,7 +24,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Sandbox::ConnectionCreateResponse]
-        #
         def create(params)
           parsed, options = FinchAPI::Models::Sandbox::ConnectionCreateParams.dump_request(params)
           @client.request(
@@ -37,7 +36,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
           @accounts = FinchAPI::Resources::Sandbox::Connections::Accounts.new(client: client)

data/lib/finch-api/resources/sandbox/directory.rb

@@ -14,7 +14,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [Array<Object>]
-        #
         def create(params = {})
           parsed, options = FinchAPI::Models::Sandbox::DirectoryCreateParams.dump_request(params)
           @client.request(
@@ -27,7 +26,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/sandbox/employment.rb

@@ -53,7 +53,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Sandbox::EmploymentUpdateResponse]
-        #
         def update(individual_id, params = {})
           parsed, options = FinchAPI::Models::Sandbox::EmploymentUpdateParams.dump_request(params)
           @client.request(
@@ -66,7 +65,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/sandbox/individual.rb

@@ -42,7 +42,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Sandbox::IndividualUpdateResponse]
-        #
         def update(individual_id, params = {})
           parsed, options = FinchAPI::Models::Sandbox::IndividualUpdateParams.dump_request(params)
           @client.request(
@@ -55,7 +54,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/sandbox/jobs/configuration.rb

@@ -12,7 +12,6 @@ module FinchAPI
           #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
           #
           # @return [Array<FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration>]
-          #
           def retrieve(params = {})
             @client.request(
               method: :get,
@@ -33,7 +32,6 @@ module FinchAPI
           #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
           #
           # @return [FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]
-          #
           def update(params)
             parsed, options = FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params)
             @client.request(
@@ -46,7 +44,6 @@ module FinchAPI
           end
 
           # @param client [FinchAPI::Client]
-          #
           def initialize(client:)
             @client = client
           end

data/lib/finch-api/resources/sandbox/jobs.rb

@@ -16,7 +16,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Sandbox::JobCreateResponse]
-        #
         def create(params)
           parsed, options = FinchAPI::Models::Sandbox::JobCreateParams.dump_request(params)
           @client.request(
@@ -29,7 +28,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
           @configuration = FinchAPI::Resources::Sandbox::Jobs::Configuration.new(client: client)

data/lib/finch-api/resources/sandbox/payment.rb

@@ -17,7 +17,6 @@ module FinchAPI
         #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
         #
         # @return [FinchAPI::Models::Sandbox::PaymentCreateResponse]
-        #
         def create(params = {})
           parsed, options = FinchAPI::Models::Sandbox::PaymentCreateParams.dump_request(params)
           @client.request(
@@ -30,7 +29,6 @@ module FinchAPI
         end
 
         # @param client [FinchAPI::Client]
-        #
         def initialize(client:)
           @client = client
         end

data/lib/finch-api/resources/sandbox.rb

@@ -25,7 +25,6 @@ module FinchAPI
       attr_reader :jobs
 
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
         @connections = FinchAPI::Resources::Sandbox::Connections.new(client: client)

data/lib/finch-api/resources/webhooks.rb

@@ -4,7 +4,6 @@ module FinchAPI
   module Resources
     class Webhooks
       # @param client [FinchAPI::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/finch-api/responses_page.rb

@@ -2,70 +2,64 @@
 
 module FinchAPI
   # @example
-  # ```ruby
-  # if responses_page.has_next?
-  #   page = responses_page.next_page
-  # end
-  # ```
+  #   if responses_page.has_next?
+  #     responses_page = responses_page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # responses_page.auto_paging_each do |item|
-  # #   item ...
-  # end
-  # ```
+  #   responses_page.auto_paging_each do |individual|
+  #     puts(individual)
+  #   end
   #
   # @example
-  # ```ruby
-  # items = responses_page.to_enum.take(2)
+  #   individuals =
+  #     responses_page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # items => Array
-  # ```
+  #   individuals => Array
   class ResponsesPage
     include FinchAPI::BasePage
 
-    # @return [Array<Object>]
+    # @return [Array<Object>, nil]
     attr_accessor :responses
 
-    # rubocop:disable Lint/UnusedMethodArgument
-    # @private
+    # @api private
     #
     # @param client [FinchAPI::BaseClient]
     # @param req [Hash{Symbol=>Object}]
     # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    # @param unwrapped [Array<Object>]
-    #
-    def initialize(client:, req:, headers:, unwrapped:)
-      @client = client
-      @req = req
+    # @param page_data [Array<Object>]
+    def initialize(client:, req:, headers:, page_data:)
+      super
       model = req.fetch(:model)
 
-      case unwrapped
+      case page_data
       in {responses: Array | nil => responses}
-        @responses = responses&.map { model.coerce(_1) }
+        @responses = responses&.map { FinchAPI::Converter.coerce(model, _1) }
       else
       end
     end
-    # rubocop:enable Lint/UnusedMethodArgument
 
     # @return [Boolean]
-    #
     def next_page?
       false
     end
 
     # @raise [FinchAPI::HTTP::Error]
     # @return [FinchAPI::ResponsesPage]
-    #
     def next_page
-      raise NotImplementedError
+      RuntimeError.new("No more pages available.")
     end
 
     # @param blk [Proc]
-    #
     def auto_paging_each(&blk)
       unless block_given?
-        raise ArgumentError.new("A block must be given to #auto_paging_each")
+        raise ArgumentError.new("A block must be given to ##{__method__}")
       end
       page = self
       loop do
@@ -76,7 +70,6 @@ module FinchAPI
     end
 
     # @return [String]
-    #
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} responses=#{responses.inspect}>"
     end

data/lib/finch-api/single_page.rb

@@ -2,68 +2,61 @@
 
 module FinchAPI
   # @example
-  # ```ruby
-  # if single_page.has_next?
-  #   page = single_page.next_page
-  # end
-  # ```
+  #   if single_page.has_next?
+  #     single_page = single_page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # single_page.auto_paging_each do |item|
-  # #   item ...
-  # end
-  # ```
+  #   single_page.auto_paging_each do |payment|
+  #     puts(payment)
+  #   end
   #
   # @example
-  # ```ruby
-  # items = single_page.to_enum.take(2)
+  #   payments =
+  #     single_page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # items => Array
-  # ```
+  #   payments => Array
   class SinglePage < ::Array
     include FinchAPI::BasePage
 
-    # rubocop:disable Lint/UnusedMethodArgument
-    # @private
+    # @api private
     #
     # @param client [FinchAPI::BaseClient]
     # @param req [Hash{Symbol=>Object}]
     # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    # @param unwrapped [Array<Object>]
-    #
-    def initialize(client:, req:, headers:, unwrapped:)
-      @client = client
-      @req = req
+    # @param page_data [Array<Object>]
+    def initialize(client:, req:, headers:, page_data:)
+      super
       model = req.fetch(:model)
 
-      case unwrapped
+      case page_data
       in Array
-        super(unwrapped&.map { model.coerce(_1) })
+        replace(page_data.map { model.coerce(_1) })
       else
-        super([])
       end
     end
-    # rubocop:enable Lint/UnusedMethodArgument
 
     # @return [Boolean]
-    #
     def next_page?
       false
     end
 
     # @raise [FinchAPI::HTTP::Error]
     # @return [FinchAPI::SinglePage]
-    #
     def next_page
-      raise NotImplementedError
+      RuntimeError.new("No more pages available.")
     end
 
     # @param blk [Proc]
-    #
     def auto_paging_each(&blk)
       unless block_given?
-        raise ArgumentError.new("A block must be given to #auto_paging_each")
+        raise ArgumentError.new("A block must be given to ##{__method__}")
       end
       page = self
       loop do
@@ -74,7 +67,6 @@ module FinchAPI
     end
 
     # @return [String]
-    #
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)}>"
     end