vitable-connect 0.6.0 → 1.0.0

data/rbi/vitable_connect/models/auth_issue_access_token_response.rbi

@@ -1,174 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class AuthIssueAccessTokenResponse < VitableConnect::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            VitableConnect::Models::AuthIssueAccessTokenResponse,
-            VitableConnect::Internal::AnyHash
-          )
-        end
-
-      # The issued access token (vit*at*\*)
-      sig { returns(String) }
-      attr_accessor :access_token
-
-      # Token lifetime in seconds
-      sig { returns(Integer) }
-      attr_accessor :expires_in
-
-      # Token type, always 'Bearer'
-      sig { returns(String) }
-      attr_accessor :token_type
-
-      # Entity the token is bound to, if any
-      sig do
-        returns(
-          T.nilable(
-            VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity
-          )
-        )
-      end
-      attr_reader :bound_entity
-
-      sig do
-        params(
-          bound_entity:
-            T.nilable(
-              VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::OrHash
-            )
-        ).void
-      end
-      attr_writer :bound_entity
-
-      sig do
-        params(
-          access_token: String,
-          expires_in: Integer,
-          token_type: String,
-          bound_entity:
-            T.nilable(
-              VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::OrHash
-            )
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The issued access token (vit*at*\*)
-        access_token:,
-        # Token lifetime in seconds
-        expires_in:,
-        # Token type, always 'Bearer'
-        token_type:,
-        # Entity the token is bound to, if any
-        bound_entity: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            access_token: String,
-            expires_in: Integer,
-            token_type: String,
-            bound_entity:
-              T.nilable(
-                VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity
-              )
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class BoundEntity < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # Prefixed entity ID the token is bound to (empr*\* or empl*\*)
-        sig { returns(String) }
-        attr_accessor :id
-
-        # - `employer` - employer
-        # - `employee` - employee
-        sig do
-          returns(
-            VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type::TaggedSymbol
-          )
-        end
-        attr_accessor :type
-
-        # Entity the token is bound to, if any
-        sig do
-          params(
-            id: String,
-            type:
-              VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Prefixed entity ID the token is bound to (empr*\* or empl*\*)
-          id:,
-          # - `employer` - employer
-          # - `employee` - employee
-          type:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              type:
-                VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # - `employer` - employer
-        # - `employee` - employee
-        module Type
-          extend VitableConnect::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          EMPLOYER =
-            T.let(
-              :employer,
-              VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type::TaggedSymbol
-            )
-          EMPLOYEE =
-            T.let(
-              :employee,
-              VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/vitable_connect/models/employee.rbi

@@ -1,551 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class Employee < VitableConnect::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(VitableConnect::Employee, VitableConnect::Internal::AnyHash)
-        end
-
-      # Timestamp when the employee was created
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # Date of birth (YYYY-MM-DD)
-      sig { returns(Date) }
-      attr_accessor :date_of_birth
-
-      # Payroll deductions from the most recent statement period. Replaced when a new
-      # statement is generated.
-      sig { returns(T::Array[VitableConnect::Employee::Deduction]) }
-      attr_accessor :deductions
-
-      # Email address
-      sig { returns(String) }
-      attr_accessor :email
-
-      # - `Full Time` - Full Time
-      # - `Part Time` - Part Time
-      # - `Temporary` - Temporary
-      # - `Intern` - Intern
-      # - `Seasonal` - Seasonal
-      # - `Individual Contractor` - Individual Contractor
-      sig { returns(VitableConnect::EmployeeClass::TaggedSymbol) }
-      attr_accessor :employee_class
-
-      # Employee's legal first name
-      sig { returns(String) }
-      attr_accessor :first_name
-
-      # Employee's legal last name
-      sig { returns(String) }
-      attr_accessor :last_name
-
-      # Timestamp when the employee was last updated
-      sig { returns(Time) }
-      attr_accessor :updated_at
-
-      # Employee's residential address
-      sig { returns(T.nilable(VitableConnect::Employee::Address)) }
-      attr_reader :address
-
-      sig do
-        params(
-          address: T.nilable(VitableConnect::Employee::Address::OrHash)
-        ).void
-      end
-      attr_writer :address
-
-      # Name of the employer this employment is with
-      sig { returns(T.nilable(String)) }
-      attr_accessor :employer_name
-
-      # Gender identity, if provided
-      sig { returns(T.nilable(String)) }
-      attr_accessor :gender
-
-      # Partner-assigned reference ID for the employee
-      sig { returns(T.nilable(String)) }
-      attr_accessor :reference_id
-
-      # Name suffix (e.g., Jr., Sr., III)
-      sig { returns(T.nilable(String)) }
-      attr_accessor :suffix
-
-      # Employee's termination date, if terminated
-      sig { returns(T.nilable(Date)) }
-      attr_accessor :termination_date
-
-      # Unique employee identifier with 'empl\_' prefix
-      sig { returns(String) }
-      attr_accessor :id
-
-      # Date the employee's current classification took effect
-      sig { returns(Date) }
-      attr_accessor :classification_effective_date
-
-      # - `Salary` - Salary
-      # - `Hourly` - Hourly
-      sig do
-        returns(
-          T.nilable(VitableConnect::Employee::CompensationType::TaggedSymbol)
-        )
-      end
-      attr_accessor :compensation_type
-
-      # Date the employee's current compensation type took effect
-      sig { returns(Date) }
-      attr_accessor :compensation_type_effective_date
-
-      # Unique identifier of the employer this employment is with (empr\_\*)
-      sig { returns(String) }
-      attr_accessor :employer_id
-
-      # Unique member identifier with 'mbr\_' prefix
-      sig { returns(String) }
-      attr_accessor :member_id
-
-      # Phone number (10-digit US domestic string)
-      sig { returns(T.nilable(String)) }
-      attr_accessor :phone
-
-      # Employee's start date with the employer
-      sig { returns(Date) }
-      attr_accessor :start_date
-
-      # Employee status (active or terminated)
-      sig { returns(VitableConnect::Employee::Status::TaggedSymbol) }
-      attr_accessor :status
-
-      sig do
-        params(
-          id: String,
-          classification_effective_date: Date,
-          compensation_type:
-            T.nilable(VitableConnect::Employee::CompensationType::OrSymbol),
-          compensation_type_effective_date: Date,
-          created_at: Time,
-          date_of_birth: Date,
-          deductions: T::Array[VitableConnect::Employee::Deduction::OrHash],
-          email: String,
-          employee_class: VitableConnect::EmployeeClass::OrSymbol,
-          employer_id: String,
-          first_name: String,
-          last_name: String,
-          member_id: String,
-          phone: T.nilable(String),
-          start_date: Date,
-          status: VitableConnect::Employee::Status::OrSymbol,
-          updated_at: Time,
-          address: T.nilable(VitableConnect::Employee::Address::OrHash),
-          employer_name: T.nilable(String),
-          gender: T.nilable(String),
-          reference_id: T.nilable(String),
-          suffix: T.nilable(String),
-          termination_date: T.nilable(Date)
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Unique employee identifier with 'empl\_' prefix
-        id:,
-        # Date the employee's current classification took effect
-        classification_effective_date:,
-        # - `Salary` - Salary
-        # - `Hourly` - Hourly
-        compensation_type:,
-        # Date the employee's current compensation type took effect
-        compensation_type_effective_date:,
-        # Timestamp when the employee was created
-        created_at:,
-        # Date of birth (YYYY-MM-DD)
-        date_of_birth:,
-        # Payroll deductions from the most recent statement period. Replaced when a new
-        # statement is generated.
-        deductions:,
-        # Email address
-        email:,
-        # - `Full Time` - Full Time
-        # - `Part Time` - Part Time
-        # - `Temporary` - Temporary
-        # - `Intern` - Intern
-        # - `Seasonal` - Seasonal
-        # - `Individual Contractor` - Individual Contractor
-        employee_class:,
-        # Unique identifier of the employer this employment is with (empr\_\*)
-        employer_id:,
-        # Employee's legal first name
-        first_name:,
-        # Employee's legal last name
-        last_name:,
-        # Unique member identifier with 'mbr\_' prefix
-        member_id:,
-        # Phone number (10-digit US domestic string)
-        phone:,
-        # Employee's start date with the employer
-        start_date:,
-        # Employee status (active or terminated)
-        status:,
-        # Timestamp when the employee was last updated
-        updated_at:,
-        # Employee's residential address
-        address: nil,
-        # Name of the employer this employment is with
-        employer_name: nil,
-        # Gender identity, if provided
-        gender: nil,
-        # Partner-assigned reference ID for the employee
-        reference_id: nil,
-        # Name suffix (e.g., Jr., Sr., III)
-        suffix: nil,
-        # Employee's termination date, if terminated
-        termination_date: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            classification_effective_date: Date,
-            compensation_type:
-              T.nilable(
-                VitableConnect::Employee::CompensationType::TaggedSymbol
-              ),
-            compensation_type_effective_date: Date,
-            created_at: Time,
-            date_of_birth: Date,
-            deductions: T::Array[VitableConnect::Employee::Deduction],
-            email: String,
-            employee_class: VitableConnect::EmployeeClass::TaggedSymbol,
-            employer_id: String,
-            first_name: String,
-            last_name: String,
-            member_id: String,
-            phone: T.nilable(String),
-            start_date: Date,
-            status: VitableConnect::Employee::Status::TaggedSymbol,
-            updated_at: Time,
-            address: T.nilable(VitableConnect::Employee::Address),
-            employer_name: T.nilable(String),
-            gender: T.nilable(String),
-            reference_id: T.nilable(String),
-            suffix: T.nilable(String),
-            termination_date: T.nilable(Date)
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # - `Salary` - Salary
-      # - `Hourly` - Hourly
-      module CompensationType
-        extend VitableConnect::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, VitableConnect::Employee::CompensationType)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        SALARY =
-          T.let(
-            :Salary,
-            VitableConnect::Employee::CompensationType::TaggedSymbol
-          )
-        HOURLY =
-          T.let(
-            :Hourly,
-            VitableConnect::Employee::CompensationType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[VitableConnect::Employee::CompensationType::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class Deduction < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Employee::Deduction,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # Name of the benefit plan
-        sig { returns(String) }
-        attr_accessor :benefit_name
-
-        # Employee deduction amount in cents
-        sig { returns(Integer) }
-        attr_accessor :deduction_amount_in_cents
-
-        # Deduction category (reserved for future use)
-        sig { returns(T.nilable(String)) }
-        attr_accessor :deduction_category
-
-        # - `weekly` - Weekly
-        # - `bi_weekly` - Bi Weekly
-        # - `semi_monthly` - Semi Monthly
-        # - `monthly` - Monthly
-        sig do
-          returns(VitableConnect::Employee::Deduction::Frequency::TaggedSymbol)
-        end
-        attr_accessor :frequency
-
-        # Period end date (YYYY-MM-DD)
-        sig { returns(Date) }
-        attr_accessor :period_end_date
-
-        # Period start date (YYYY-MM-DD)
-        sig { returns(Date) }
-        attr_accessor :period_start_date
-
-        # - `Unknown` - Unknown
-        # - `Pre-tax` - Pre Tax
-        # - `Post-tax` - Post Tax
-        sig do
-          returns(
-            VitableConnect::Employee::Deduction::TaxClassification::TaggedSymbol
-          )
-        end
-        attr_accessor :tax_classification
-
-        sig do
-          params(
-            benefit_name: String,
-            deduction_amount_in_cents: Integer,
-            deduction_category: T.nilable(String),
-            frequency: VitableConnect::Employee::Deduction::Frequency::OrSymbol,
-            period_end_date: Date,
-            period_start_date: Date,
-            tax_classification:
-              VitableConnect::Employee::Deduction::TaxClassification::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Name of the benefit plan
-          benefit_name:,
-          # Employee deduction amount in cents
-          deduction_amount_in_cents:,
-          # Deduction category (reserved for future use)
-          deduction_category:,
-          # - `weekly` - Weekly
-          # - `bi_weekly` - Bi Weekly
-          # - `semi_monthly` - Semi Monthly
-          # - `monthly` - Monthly
-          frequency:,
-          # Period end date (YYYY-MM-DD)
-          period_end_date:,
-          # Period start date (YYYY-MM-DD)
-          period_start_date:,
-          # - `Unknown` - Unknown
-          # - `Pre-tax` - Pre Tax
-          # - `Post-tax` - Post Tax
-          tax_classification:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              benefit_name: String,
-              deduction_amount_in_cents: Integer,
-              deduction_category: T.nilable(String),
-              frequency:
-                VitableConnect::Employee::Deduction::Frequency::TaggedSymbol,
-              period_end_date: Date,
-              period_start_date: Date,
-              tax_classification:
-                VitableConnect::Employee::Deduction::TaxClassification::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # - `weekly` - Weekly
-        # - `bi_weekly` - Bi Weekly
-        # - `semi_monthly` - Semi Monthly
-        # - `monthly` - Monthly
-        module Frequency
-          extend VitableConnect::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, VitableConnect::Employee::Deduction::Frequency)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          WEEKLY =
-            T.let(
-              :weekly,
-              VitableConnect::Employee::Deduction::Frequency::TaggedSymbol
-            )
-          BI_WEEKLY =
-            T.let(
-              :bi_weekly,
-              VitableConnect::Employee::Deduction::Frequency::TaggedSymbol
-            )
-          SEMI_MONTHLY =
-            T.let(
-              :semi_monthly,
-              VitableConnect::Employee::Deduction::Frequency::TaggedSymbol
-            )
-          MONTHLY =
-            T.let(
-              :monthly,
-              VitableConnect::Employee::Deduction::Frequency::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                VitableConnect::Employee::Deduction::Frequency::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # - `Unknown` - Unknown
-        # - `Pre-tax` - Pre Tax
-        # - `Post-tax` - Post Tax
-        module TaxClassification
-          extend VitableConnect::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                VitableConnect::Employee::Deduction::TaxClassification
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          UNKNOWN =
-            T.let(
-              :Unknown,
-              VitableConnect::Employee::Deduction::TaxClassification::TaggedSymbol
-            )
-          PRE_TAX =
-            T.let(
-              :"Pre-tax",
-              VitableConnect::Employee::Deduction::TaxClassification::TaggedSymbol
-            )
-          POST_TAX =
-            T.let(
-              :"Post-tax",
-              VitableConnect::Employee::Deduction::TaxClassification::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                VitableConnect::Employee::Deduction::TaxClassification::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      # Employee status (active or terminated)
-      module Status
-        extend VitableConnect::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, VitableConnect::Employee::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ACTIVE = T.let(:active, VitableConnect::Employee::Status::TaggedSymbol)
-        TERMINATED =
-          T.let(:terminated, VitableConnect::Employee::Status::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[VitableConnect::Employee::Status::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class Address < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Employee::Address,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # Primary street address
-        sig { returns(String) }
-        attr_accessor :address_line_1
-
-        # City name
-        sig { returns(String) }
-        attr_accessor :city
-
-        # Two-letter state code (e.g., CA, NY)
-        sig { returns(String) }
-        attr_accessor :state
-
-        # ZIP code (5 or 9 digit)
-        sig { returns(String) }
-        attr_accessor :zipcode
-
-        # Secondary street address (apt, suite, etc.)
-        sig { returns(T.nilable(String)) }
-        attr_accessor :address_line_2
-
-        # Employee's residential address
-        sig do
-          params(
-            address_line_1: String,
-            city: String,
-            state: String,
-            zipcode: String,
-            address_line_2: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Primary street address
-          address_line_1:,
-          # City name
-          city:,
-          # Two-letter state code (e.g., CA, NY)
-          state:,
-          # ZIP code (5 or 9 digit)
-          zipcode:,
-          # Secondary street address (apt, suite, etc.)
-          address_line_2: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              address_line_1: String,
-              city: String,
-              state: String,
-              zipcode: String,
-              address_line_2: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end