finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/models/operation_support_matrix.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class OperationSupportMatrix < FinchAPI::BaseModel
+      # @!attribute [r] 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 }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::OperationSupport]
+      #   attr_writer :create
+
+      # @!attribute [r] 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 }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::OperationSupport]
+      #   attr_writer :delete
+
+      # @!attribute [r] 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 }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::OperationSupport]
+      #   attr_writer :read
+
+      # @!attribute [r] 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 }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::OperationSupport]
+      #   attr_writer :update
+
+      # @!parse
+      #   # @param create [Symbol, FinchAPI::Models::OperationSupport]
+      #   # @param delete [Symbol, FinchAPI::Models::OperationSupport]
+      #   # @param read [Symbol, FinchAPI::Models::OperationSupport]
+      #   # @param update [Symbol, FinchAPI::Models::OperationSupport]
+      #   #
+      #   def initialize(create: nil, delete: nil, read: nil, update: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

data/lib/finch-api/models/paging.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Paging < FinchAPI::BaseModel
+      # @!attribute [r] count
+      #   The total number of elements for the entire query (not just the given page)
+      #
+      #   @return [Integer, nil]
+      optional :count, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :count
+
+      # @!attribute [r] offset
+      #   The current start index of the returned list of elements
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :offset
+
+      # @!parse
+      #   # @param count [Integer]
+      #   # @param offset [Integer]
+      #   #
+      #   def initialize(count: nil, offset: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

data/lib/finch-api/models/pay_statement_event.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute [r] data
+      #
+      #   @return [FinchAPI::Models::PayStatementEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::PayStatementEvent::Data }
+
+      # @!parse
+      #   # @return [FinchAPI::Models::PayStatementEvent::Data]
+      #   attr_writer :data
+
+      # @!attribute [r] event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::PayStatementEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::PayStatementEvent::EventType }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::PayStatementEvent::EventType]
+      #   attr_writer :event_type
+
+      # @!parse
+      #   # @param data [FinchAPI::Models::PayStatementEvent::Data]
+      #   # @param event_type [Symbol, FinchAPI::Models::PayStatementEvent::EventType]
+      #   #
+      #   def initialize(data: nil, event_type: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      class Data < FinchAPI::BaseModel
+        # @!attribute [r] individual_id
+        #   The ID of the individual associated with the pay statement.
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :individual_id
+
+        # @!attribute [r] payment_id
+        #   The ID of the payment associated with the pay statement.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :payment_id
+
+        # @!parse
+        #   # @param individual_id [String]
+        #   # @param payment_id [String]
+        #   #
+        #   def initialize(individual_id: nil, payment_id: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+
+      # @abstract
+      #
+      # @example
+      # ```ruby
+      # case event_type
+      # in :"pay_statement.created"
+      #   # ...
+      # in :"pay_statement.updated"
+      #   # ...
+      # in :"pay_statement.deleted"
+      #   # ...
+      # end
+      # ```
+      class EventType < FinchAPI::Enum
+        PAY_STATEMENT_CREATED = :"pay_statement.created"
+        PAY_STATEMENT_UPDATED = :"pay_statement.updated"
+        PAY_STATEMENT_DELETED = :"pay_statement.deleted"
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/finch-api/models/payment_event.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class PaymentEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute [r] data
+      #
+      #   @return [FinchAPI::Models::PaymentEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::PaymentEvent::Data }
+
+      # @!parse
+      #   # @return [FinchAPI::Models::PaymentEvent::Data]
+      #   attr_writer :data
+
+      # @!attribute [r] event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::PaymentEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::PaymentEvent::EventType }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::PaymentEvent::EventType]
+      #   attr_writer :event_type
+
+      # @!parse
+      #   # @param data [FinchAPI::Models::PaymentEvent::Data]
+      #   # @param event_type [Symbol, FinchAPI::Models::PaymentEvent::EventType]
+      #   #
+      #   def initialize(data: nil, event_type: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      class Data < FinchAPI::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
+
+        # @!parse
+        #   # @param pay_date [String]
+        #   # @param payment_id [String]
+        #   #
+        #   def initialize(pay_date:, payment_id:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+
+      # @abstract
+      #
+      # @example
+      # ```ruby
+      # case event_type
+      # in :"payment.created"
+      #   # ...
+      # in :"payment.updated"
+      #   # ...
+      # in :"payment.deleted"
+      #   # ...
+      # end
+      # ```
+      class EventType < FinchAPI::Enum
+        PAYMENT_CREATED = :"payment.created"
+        PAYMENT_UPDATED = :"payment.updated"
+        PAYMENT_DELETED = :"payment.deleted"
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/finch-api/models/payroll/pay_group_list_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      class PayGroupListParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute [r] individual_id
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :individual_id
+
+        # @!attribute [r] pay_frequencies
+        #
+        #   @return [Array<String>, nil]
+        optional :pay_frequencies, FinchAPI::ArrayOf[String]
+
+        # @!parse
+        #   # @return [Array<String>]
+        #   attr_writer :pay_frequencies
+
+        # @!parse
+        #   # @param individual_id [String]
+        #   # @param pay_frequencies [Array<String>]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(individual_id: nil, pay_frequencies: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/payroll/pay_group_list_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      class PayGroupListResponse < FinchAPI::BaseModel
+        # @!attribute [r] id
+        #   Finch id (uuidv4) for the pay group
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :id
+
+        # @!attribute [r] name
+        #   Name of the pay group
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :name
+
+        # @!attribute [r] pay_frequencies
+        #   List of pay frequencies associated with this pay group
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>, nil]
+        optional :pay_frequencies,
+                 -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency] }
+
+        # @!parse
+        #   # @return [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>]
+        #   attr_writer :pay_frequencies
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param name [String]
+        #   # @param pay_frequencies [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>]
+        #   #
+        #   def initialize(id: nil, name: nil, pay_frequencies: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case pay_frequency
+        # in :annually
+        #   # ...
+        # in :semi_annually
+        #   # ...
+        # in :quarterly
+        #   # ...
+        # in :monthly
+        #   # ...
+        # in :semi_monthly
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class PayFrequency < FinchAPI::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
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/payroll/pay_group_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      class PayGroupRetrieveParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!parse
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Payroll
+      class PayGroupRetrieveResponse < FinchAPI::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::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::ArrayOf[enum: FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency] }
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param individual_ids [Array<String>]
+        #   # @param name [String]
+        #   # @param pay_frequencies [Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>]
+        #   #
+        #   def initialize(id:, individual_ids:, name:, pay_frequencies:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case pay_frequency
+        # in :annually
+        #   # ...
+        # in :semi_annually
+        #   # ...
+        # in :quarterly
+        #   # ...
+        # in :monthly
+        #   # ...
+        # in :semi_monthly
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class PayFrequency < FinchAPI::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
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end