vitable-connect 0.6.0 → 1.0.0

data/lib/vitable_connect/internal.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Internal
-    extend VitableConnect::Internal::Util::SorbetRuntimeSupport
-
-    OMIT =
-      Object.new.tap do
-        _1.define_singleton_method(:inspect) { "#<#{VitableConnect::Internal}::OMIT>" }
-      end
-        .freeze
-
-    define_sorbet_constant!(:AnyHash) do
-      T.type_alias { T::Hash[Symbol, T.anything] }
-    end
-    define_sorbet_constant!(:FileInput) do
-      T.type_alias { T.any(Pathname, StringIO, IO, String, VitableConnect::FilePart) }
-    end
-  end
-end

data/lib/vitable_connect/models/auth_issue_access_token_params.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Auth#issue_access_token
-    class AuthIssueAccessTokenParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute grant_type
-      #   - `client_credentials` - client_credentials
-      #
-      #   @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType]
-      required :grant_type, enum: -> { VitableConnect::AuthIssueAccessTokenParams::GrantType }
-
-      # @!attribute bound_entity
-      #   Optional entity to bind the token to for scoped access
-      #
-      #   @return [VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity, nil]
-      optional :bound_entity, -> { VitableConnect::AuthIssueAccessTokenParams::BoundEntity }, nil?: true
-
-      # @!method initialize(grant_type:, bound_entity: nil, request_options: {})
-      #   @param grant_type [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType] - `client_credentials` - client_credentials
-      #
-      #   @param bound_entity [VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity, nil] Optional entity to bind the token to for scoped access
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-
-      # - `client_credentials` - client_credentials
-      module GrantType
-        extend VitableConnect::Internal::Type::Enum
-
-        CLIENT_CREDENTIALS = :client_credentials
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      class BoundEntity < VitableConnect::Internal::Type::BaseModel
-        # @!attribute id
-        #   Prefixed entity ID to bind the token to (empr*\* for employer, empl*\* for
-        #   employee)
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute type
-        #   - `employer` - employer
-        #   - `employee` - employee
-        #
-        #   @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity::Type]
-        required :type, enum: -> { VitableConnect::AuthIssueAccessTokenParams::BoundEntity::Type }
-
-        # @!method initialize(id:, type:)
-        #   Some parameter documentations has been truncated, see
-        #   {VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity} for more
-        #   details.
-        #
-        #   Optional entity to bind the token to for scoped access
-        #
-        #   @param id [String] Prefixed entity ID to bind the token to (empr*\* for employer, empl*\* for
-        #   employe
-        #
-        #   @param type [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity::Type] - `employer` - employer
-
-        # - `employer` - employer
-        # - `employee` - employee
-        #
-        # @see VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity#type
-        module Type
-          extend VitableConnect::Internal::Type::Enum
-
-          EMPLOYER = :employer
-          EMPLOYEE = :employee
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/auth_issue_access_token_response.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Auth#issue_access_token
-    class AuthIssueAccessTokenResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute access_token
-      #   The issued access token (vit*at*\*)
-      #
-      #   @return [String]
-      required :access_token, String
-
-      # @!attribute expires_in
-      #   Token lifetime in seconds
-      #
-      #   @return [Integer]
-      required :expires_in, Integer
-
-      # @!attribute token_type
-      #   Token type, always 'Bearer'
-      #
-      #   @return [String]
-      required :token_type, String
-
-      # @!attribute bound_entity
-      #   Entity the token is bound to, if any
-      #
-      #   @return [VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity, nil]
-      optional :bound_entity,
-               -> { VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity },
-               nil?: true
-
-      # @!method initialize(access_token:, expires_in:, token_type:, bound_entity: nil)
-      #   @param access_token [String] The issued access token (vit*at*\*)
-      #
-      #   @param expires_in [Integer] Token lifetime in seconds
-      #
-      #   @param token_type [String] Token type, always 'Bearer'
-      #
-      #   @param bound_entity [VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity, nil] Entity the token is bound to, if any
-
-      # @see VitableConnect::Models::AuthIssueAccessTokenResponse#bound_entity
-      class BoundEntity < VitableConnect::Internal::Type::BaseModel
-        # @!attribute id
-        #   Prefixed entity ID the token is bound to (empr*\* or empl*\*)
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute type
-        #   - `employer` - employer
-        #   - `employee` - employee
-        #
-        #   @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type]
-        required :type, enum: -> { VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type }
-
-        # @!method initialize(id:, type:)
-        #   Some parameter documentations has been truncated, see
-        #   {VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity} for more
-        #   details.
-        #
-        #   Entity the token is bound to, if any
-        #
-        #   @param id [String] Prefixed entity ID the token is bound to (empr*\* or empl*\*)
-        #
-        #   @param type [Symbol, VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type] - `employer` - employer
-
-        # - `employer` - employer
-        # - `employee` - employee
-        #
-        # @see VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity#type
-        module Type
-          extend VitableConnect::Internal::Type::Enum
-
-          EMPLOYER = :employer
-          EMPLOYEE = :employee
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/employee.rb

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

data/lib/vitable_connect/models/employee_class.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # - `Full Time` - Full Time
-    # - `Part Time` - Part Time
-    # - `Temporary` - Temporary
-    # - `Intern` - Intern
-    # - `Seasonal` - Seasonal
-    # - `Individual Contractor` - Individual Contractor
-    module EmployeeClass
-      extend VitableConnect::Internal::Type::Enum
-
-      FULL_TIME = :"Full Time"
-      PART_TIME = :"Part Time"
-      TEMPORARY = :Temporary
-      INTERN = :Intern
-      SEASONAL = :Seasonal
-      INDIVIDUAL_CONTRACTOR = :"Individual Contractor"
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/vitable_connect/models/employee_list_enrollments_params.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employees#list_enrollments
-    class EmployeeListEnrollmentsParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute employee_id
-      #   Unique employee identifier (empl\_\*)
-      #
-      #   @return [String]
-      required :employee_id, String
-
-      # @!attribute limit
-      #   Items per page (default: 20, max: 100)
-      #
-      #   @return [Integer, nil]
-      optional :limit, Integer
-
-      # @!attribute page
-      #   Page number (default: 1)
-      #
-      #   @return [Integer, nil]
-      optional :page, Integer
-
-      # @!method initialize(employee_id:, limit: nil, page: nil, request_options: {})
-      #   @param employee_id [String] Unique employee identifier (empl\_\*)
-      #
-      #   @param limit [Integer] Items per page (default: 20, max: 100)
-      #
-      #   @param page [Integer] Page number (default: 1)
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/employee_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employees#retrieve
-    class EmployeeRetrieveParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute employee_id
-      #   Unique employee identifier (empl\_\*)
-      #
-      #   @return [String]
-      required :employee_id, String
-
-      # @!method initialize(employee_id:, request_options: {})
-      #   @param employee_id [String] Unique employee identifier (empl\_\*)
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/employee_retrieve_response.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employees#retrieve
-    class EmployeeRetrieveResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [VitableConnect::Models::Employee]
-      required :data, -> { VitableConnect::Employee }
-
-      # @!method initialize(data:)
-      #   Response containing a single employee resource.
-      #
-      #   @param data [VitableConnect::Models::Employee]
-    end
-  end
-end