finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.13

data/lib/finch_api/models/jobs/automated_list_response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Automated#list
+      class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
+        required :data, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Jobs::AutomatedAsyncJob] }
+
+        # @!attribute meta
+        #
+        #   @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta]
+        required :meta, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
+        #   @param meta [FinchAPI::Models::Jobs::AutomatedListResponse::Meta]
+
+        # @see FinchAPI::Models::Jobs::AutomatedListResponse#meta
+        class Meta < FinchAPI::Internal::Type::BaseModel
+          # @!attribute quotas
+          #   Information about remaining quotas for this connection. Only applicable for
+          #   customers opted in to use Finch's Data Sync Refresh endpoint
+          #   (`POST /jobs/automated`). Please contact a Finch representative for more
+          #   details.
+          #
+          #   @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, nil]
+          optional :quotas, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas }
+
+          # @!method initialize(quotas: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::Jobs::AutomatedListResponse::Meta} for more details.
+          #
+          #   @param quotas [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas] Information about remaining quotas for this connection. Only applicable for cust
+          #   ...
+
+          # @see FinchAPI::Models::Jobs::AutomatedListResponse::Meta#quotas
+          class Quotas < FinchAPI::Internal::Type::BaseModel
+            # @!attribute data_sync_all
+            #
+            #   @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, nil]
+            optional :data_sync_all, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll }
+
+            # @!method initialize(data_sync_all: nil)
+            #   Information about remaining quotas for this connection. Only applicable for
+            #   customers opted in to use Finch's Data Sync Refresh endpoint
+            #   (`POST /jobs/automated`). Please contact a Finch representative for more
+            #   details.
+            #
+            #   @param data_sync_all [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll]
+
+            # @see FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas#data_sync_all
+            class DataSyncAll < FinchAPI::Internal::Type::BaseModel
+              # @!attribute allowed_refreshes
+              #
+              #   @return [Integer, nil]
+              optional :allowed_refreshes, Integer
+
+              # @!attribute remaining_refreshes
+              #
+              #   @return [Integer, nil]
+              optional :remaining_refreshes, Integer
+
+              # @!method initialize(allowed_refreshes: nil, remaining_refreshes: nil)
+              #   @param allowed_refreshes [Integer]
+              #   @param remaining_refreshes [Integer]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/jobs/automated_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Automated#retrieve
+      class AutomatedRetrieveParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/finch_api/models/jobs/manual_async_job.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Manual#retrieve
+      class ManualAsyncJob < FinchAPI::Internal::Type::BaseModel
+        # @!attribute body
+        #   Specific information about the job, such as individual statuses for batch jobs.
+        #
+        #   @return [Array<Object>, nil]
+        required :body, FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown], nil?: true
+
+        # @!attribute job_id
+        #
+        #   @return [String]
+        required :job_id, String
+
+        # @!attribute status
+        #
+        #   @return [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status]
+        required :status, enum: -> { FinchAPI::Models::Jobs::ManualAsyncJob::Status }
+
+        # @!method initialize(body:, job_id:, status:)
+        #   @param body [Array<Object>, nil] Specific information about the job, such as individual statuses for batch jobs.
+        #
+        #   @param job_id [String]
+        #
+        #   @param status [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status]
+
+        # @see FinchAPI::Models::Jobs::ManualAsyncJob#status
+        module Status
+          extend FinchAPI::Internal::Type::Enum
+
+          PENDING = :pending
+          IN_PROGRESS = :in_progress
+          ERROR = :error
+          COMPLETE = :complete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/jobs/manual_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Manual#retrieve
+      class ManualRetrieveParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/finch_api/models/location.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Location < FinchAPI::Internal::Type::BaseModel
+      # @!attribute city
+      #   City, district, suburb, town, or village.
+      #
+      #   @return [String, nil]
+      required :city, String, nil?: true
+
+      # @!attribute country
+      #   The 2-letter ISO 3166 country code.
+      #
+      #   @return [String, nil]
+      required :country, String, nil?: true
+
+      # @!attribute line1
+      #   Street address or PO box.
+      #
+      #   @return [String, nil]
+      required :line1, String, nil?: true
+
+      # @!attribute line2
+      #   Apartment, suite, unit, or building.
+      #
+      #   @return [String, nil]
+      required :line2, String, nil?: true
+
+      # @!attribute postal_code
+      #   The postal code or zip code.
+      #
+      #   @return [String, nil]
+      required :postal_code, String, nil?: true
+
+      # @!attribute state
+      #   The state code.
+      #
+      #   @return [String, nil]
+      required :state, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute source_id
+      #
+      #   @return [String, nil]
+      optional :source_id, String, nil?: true
+
+      # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:, name: nil, source_id: nil)
+      #   @param city [String, nil] City, district, suburb, town, or village.
+      #
+      #   @param country [String, nil] The 2-letter ISO 3166 country code.
+      #
+      #   @param line1 [String, nil] Street address or PO box.
+      #
+      #   @param line2 [String, nil] Apartment, suite, unit, or building.
+      #
+      #   @param postal_code [String, nil] The postal code or zip code.
+      #
+      #   @param state [String, nil] The state code.
+      #
+      #   @param name [String, nil]
+      #
+      #   @param source_id [String, nil]
+    end
+  end
+end

data/lib/finch_api/models/money.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Money < FinchAPI::Internal::Type::BaseModel
+      # @!attribute amount
+      #   Amount for money object (in cents)
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute currency
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!method initialize(amount: nil, currency: nil)
+      #   @param amount [Integer, nil] Amount for money object (in cents)
+      #
+      #   @param currency [String]
+    end
+  end
+end

data/lib/finch_api/models/operation_support.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # - `supported`: This operation is supported by both the provider and Finch
+    # - `not_supported_by_finch`: This operation is not supported by Finch but
+    #   supported by the provider
+    # - `not_supported_by_provider`: This operation is not supported by the provider,
+    #   so Finch cannot support
+    # - `client_access_only`: This behavior is supported by the provider, but only
+    #   available to the client and not to Finch
+    module OperationSupport
+      extend FinchAPI::Internal::Type::Enum
+
+      SUPPORTED = :supported
+      NOT_SUPPORTED_BY_FINCH = :not_supported_by_finch
+      NOT_SUPPORTED_BY_PROVIDER = :not_supported_by_provider
+      CLIENT_ACCESS_ONLY = :client_access_only
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/finch_api/models/operation_support_matrix.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel
+      # @!attribute create
+      #   - `supported`: This operation is supported by both the provider and Finch
+      #   - `not_supported_by_finch`: This operation is not supported by Finch but
+      #     supported by the provider
+      #   - `not_supported_by_provider`: This operation is not supported by the provider,
+      #     so Finch cannot support
+      #   - `client_access_only`: This behavior is supported by the provider, but only
+      #     available to the client and not to Finch
+      #
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
+      optional :create, enum: -> { FinchAPI::Models::OperationSupport }
+
+      # @!attribute delete
+      #   - `supported`: This operation is supported by both the provider and Finch
+      #   - `not_supported_by_finch`: This operation is not supported by Finch but
+      #     supported by the provider
+      #   - `not_supported_by_provider`: This operation is not supported by the provider,
+      #     so Finch cannot support
+      #   - `client_access_only`: This behavior is supported by the provider, but only
+      #     available to the client and not to Finch
+      #
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
+      optional :delete, enum: -> { FinchAPI::Models::OperationSupport }
+
+      # @!attribute read
+      #   - `supported`: This operation is supported by both the provider and Finch
+      #   - `not_supported_by_finch`: This operation is not supported by Finch but
+      #     supported by the provider
+      #   - `not_supported_by_provider`: This operation is not supported by the provider,
+      #     so Finch cannot support
+      #   - `client_access_only`: This behavior is supported by the provider, but only
+      #     available to the client and not to Finch
+      #
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
+      optional :read, enum: -> { FinchAPI::Models::OperationSupport }
+
+      # @!attribute update
+      #   - `supported`: This operation is supported by both the provider and Finch
+      #   - `not_supported_by_finch`: This operation is not supported by Finch but
+      #     supported by the provider
+      #   - `not_supported_by_provider`: This operation is not supported by the provider,
+      #     so Finch cannot support
+      #   - `client_access_only`: This behavior is supported by the provider, but only
+      #     available to the client and not to Finch
+      #
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
+      optional :update, enum: -> { FinchAPI::Models::OperationSupport }
+
+      # @!method initialize(create: nil, delete: nil, read: nil, update: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::OperationSupportMatrix} for more details.
+      #
+      #   @param create [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ...
+      #
+      #   @param delete [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ...
+      #
+      #   @param read [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ...
+      #
+      #   @param update [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ...
+    end
+  end
+end

data/lib/finch_api/models/paging.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Paging < FinchAPI::Internal::Type::BaseModel
+      # @!attribute offset
+      #   The current start index of the returned list of elements
+      #
+      #   @return [Integer]
+      required :offset, Integer
+
+      # @!attribute count
+      #   The total number of elements for the entire query (not just the given page)
+      #
+      #   @return [Integer, nil]
+      optional :count, Integer
+
+      # @!method initialize(offset:, count: nil)
+      #   @param offset [Integer] The current start index of the returned list of elements
+      #
+      #   @param count [Integer] The total number of elements for the entire query (not just the given page)
+    end
+  end
+end

data/lib/finch_api/models/pay_statement_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [FinchAPI::Models::PayStatementEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::PayStatementEvent::Data }
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::PayStatementEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::PayStatementEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [FinchAPI::Models::PayStatementEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::PayStatementEvent::EventType]
+
+      class Data < FinchAPI::Internal::Type::BaseModel
+        # @!attribute individual_id
+        #   The ID of the individual associated with the pay statement.
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!attribute payment_id
+        #   The ID of the payment associated with the pay statement.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String
+
+        # @!method initialize(individual_id: nil, payment_id: nil)
+        #   @param individual_id [String] The ID of the individual associated with the pay statement.
+        #
+        #   @param payment_id [String] The ID of the payment associated with the pay statement.
+      end
+
+      module EventType
+        extend FinchAPI::Internal::Type::Enum
+
+        PAY_STATEMENT_CREATED = :"pay_statement.created"
+        PAY_STATEMENT_UPDATED = :"pay_statement.updated"
+        PAY_STATEMENT_DELETED = :"pay_statement.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/payment_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class PaymentEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [FinchAPI::Models::PaymentEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::PaymentEvent::Data }
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::PaymentEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::PaymentEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [FinchAPI::Models::PaymentEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::PaymentEvent::EventType]
+
+      class Data < FinchAPI::Internal::Type::BaseModel
+        # @!attribute pay_date
+        #   The date of the payment.
+        #
+        #   @return [String]
+        required :pay_date, String
+
+        # @!attribute payment_id
+        #   The ID of the payment.
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!method initialize(pay_date:, payment_id:)
+        #   @param pay_date [String] The date of the payment.
+        #
+        #   @param payment_id [String] The ID of the payment.
+      end
+
+      module EventType
+        extend FinchAPI::Internal::Type::Enum
+
+        PAYMENT_CREATED = :"payment.created"
+        PAYMENT_UPDATED = :"payment.updated"
+        PAYMENT_DELETED = :"payment.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/payroll/pay_group_list_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      # @see FinchAPI::Resources::Payroll::PayGroups#list
+      class PayGroupListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute individual_id
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!attribute pay_frequencies
+        #
+        #   @return [Array<String>, nil]
+        optional :pay_frequencies, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(individual_id: nil, pay_frequencies: nil, request_options: {})
+        #   @param individual_id [String]
+        #   @param pay_frequencies [Array<String>]
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/finch_api/models/payroll/pay_group_list_response.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      # @see FinchAPI::Resources::Payroll::PayGroups#list
+      class PayGroupListResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   Finch id (uuidv4) for the pay group
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute name
+        #   Name of the pay group
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute pay_frequencies
+        #   List of pay frequencies associated with this pay group
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>, nil]
+        optional :pay_frequencies,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency] }
+
+        # @!method initialize(id: nil, name: nil, pay_frequencies: nil)
+        #   @param id [String] Finch id (uuidv4) for the pay group
+        #
+        #   @param name [String] Name of the pay group
+        #
+        #   @param pay_frequencies [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>] List of pay frequencies associated with this pay group
+
+        module PayFrequency
+          extend FinchAPI::Internal::Type::Enum
+
+          ANNUALLY = :annually
+          SEMI_ANNUALLY = :semi_annually
+          QUARTERLY = :quarterly
+          MONTHLY = :monthly
+          SEMI_MONTHLY = :semi_monthly
+          BI_WEEKLY = :bi_weekly
+          WEEKLY = :weekly
+          DAILY = :daily
+          OTHER = :other
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      # @see FinchAPI::Resources::Payroll::PayGroups#retrieve
+      class PayGroupRetrieveParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      # @see FinchAPI::Resources::Payroll::PayGroups#retrieve
+      class PayGroupRetrieveResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   Finch id (uuidv4) for the pay group
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute individual_ids
+        #
+        #   @return [Array<String>]
+        required :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!attribute name
+        #   Name of the pay group
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute pay_frequencies
+        #   List of pay frequencies associated with this pay group
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>]
+        required :pay_frequencies,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency] }
+
+        # @!method initialize(id:, individual_ids:, name:, pay_frequencies:)
+        #   @param id [String] Finch id (uuidv4) for the pay group
+        #
+        #   @param individual_ids [Array<String>]
+        #
+        #   @param name [String] Name of the pay group
+        #
+        #   @param pay_frequencies [Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>] List of pay frequencies associated with this pay group
+
+        module PayFrequency
+          extend FinchAPI::Internal::Type::Enum
+
+          ANNUALLY = :annually
+          SEMI_ANNUALLY = :semi_annually
+          QUARTERLY = :quarterly
+          MONTHLY = :monthly
+          SEMI_MONTHLY = :semi_monthly
+          BI_WEEKLY = :bi_weekly
+          WEEKLY = :weekly
+          DAILY = :daily
+          OTHER = :other
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end