vitable-connect 0.1.0

data/lib/vitable_connect/internal.rb

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,68 @@
+# 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::Type]
+        required :type, enum: -> { VitableConnect::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::Type] - `employer` - employer
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/auth_issue_access_token_response.rb

@@ -0,0 +1,70 @@
+# 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::Type]
+        required :type, enum: -> { VitableConnect::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::Type] - `employer` - employer
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/benefit_eligibility_policy.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    class BenefitEligibilityPolicy < VitableConnect::Internal::Type::BaseModel
+      # @!attribute active
+      #
+      #   @return [Boolean]
+      required :active, VitableConnect::Internal::Type::Boolean
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      response_only do
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute classification
+        #
+        #   @return [String]
+        required :classification, String
+
+        # @!attribute employer_id
+        #
+        #   @return [String]
+        required :employer_id, String
+
+        # @!attribute waiting_period
+        #
+        #   @return [String]
+        required :waiting_period, String
+      end
+
+      # @!method initialize(id:, active:, classification:, created_at:, employer_id:, updated_at:, waiting_period:)
+      #   @param id [String]
+      #   @param active [Boolean]
+      #   @param classification [String]
+      #   @param created_at [Time]
+      #   @param employer_id [String]
+      #   @param updated_at [Time]
+      #   @param waiting_period [String]
+    end
+  end
+end

data/lib/vitable_connect/models/benefit_eligibility_policy_response.rb

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

data/lib/vitable_connect/models/benefit_eligibility_policy_retrieve_params.rb

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

data/lib/vitable_connect/models/employee.rb

@@ -0,0 +1,244 @@
+# 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 email
+      #   Email address
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute enrollments
+      #   Benefit enrollments for this employee
+      #
+      #   @return [Array<VitableConnect::Models::Employee::Enrollment>]
+      required :enrollments,
+               -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Employee::Enrollment] }
+
+      # @!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 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, nil]
+      optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true
+
+      # @!attribute gender
+      #   Gender identity, if provided
+      #
+      #   @return [String, nil]
+      optional :gender, String, nil?: true
+
+      # @!attribute hire_date
+      #   Employee's hire date with the employer
+      #
+      #   @return [Date, nil]
+      optional :hire_date, Date, nil?: true
+
+      # @!attribute phone
+      #   Phone number (10-digit US domestic string)
+      #
+      #   @return [String, nil]
+      optional :phone, 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 member_id
+        #   Unique member identifier with 'mbr\_' prefix
+        #
+        #   @return [String]
+        required :member_id, String
+
+        # @!attribute status
+        #   Employee status (active or terminated)
+        #
+        #   @return [String]
+        required :status, String
+      end
+
+      # @!method initialize(id:, created_at:, date_of_birth:, email:, enrollments:, first_name:, last_name:, member_id:, status:, updated_at:, address: nil, employee_class: nil, gender: nil, hire_date: nil, phone: 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 created_at [Time] Timestamp when the employee was created
+      #
+      #   @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
+      #
+      #   @param email [String] Email address
+      #
+      #   @param enrollments [Array<VitableConnect::Models::Employee::Enrollment>] Benefit enrollments for this employee
+      #
+      #   @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 status [String] 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 employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
+      #
+      #   @param gender [String, nil] Gender identity, if provided
+      #
+      #   @param hire_date [Date, nil] Employee's hire date with the employer
+      #
+      #   @param phone [String, nil] Phone number (10-digit US domestic string)
+      #
+      #   @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
+
+      class Enrollment < VitableConnect::Internal::Type::BaseModel
+        # @!attribute status
+        #   - `pending` - Pending
+        #   - `enrolled` - Enrolled
+        #   - `waived` - Waived
+        #   - `inactive` - Inactive
+        #
+        #   @return [Symbol, VitableConnect::Models::EnrollmentStatus]
+        required :status, enum: -> { VitableConnect::EnrollmentStatus }
+
+        # @!attribute answered_at
+        #   Timestamp when the enrollment decision was made
+        #
+        #   @return [Time, nil]
+        optional :answered_at, Time, nil?: true
+
+        response_only do
+          # @!attribute id
+          #   Unique enrollment identifier with 'enrl\_' prefix
+          #
+          #   @return [String]
+          required :id, String
+        end
+
+        # @!method initialize(id:, status:, answered_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {VitableConnect::Models::Employee::Enrollment} for more details.
+        #
+        #   @param id [String] Unique enrollment identifier with 'enrl\_' prefix
+        #
+        #   @param status [Symbol, VitableConnect::Models::EnrollmentStatus] - `pending` - Pending
+        #
+        #   @param answered_at [Time, nil] Timestamp when the enrollment decision was made
+      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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,38 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,18 @@
+# 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