vitable-connect 0.6.0 → 1.0.0

data/rbi/vitable_connect/models/webhook_event_retrieve_response.rbi

@@ -1,34 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class WebhookEventRetrieveResponse < VitableConnect::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            VitableConnect::Models::WebhookEventRetrieveResponse,
-            VitableConnect::Internal::AnyHash
-          )
-        end
-
-      sig { returns(VitableConnect::WebhookEvent) }
-      attr_reader :data
-
-      sig { params(data: VitableConnect::WebhookEvent::OrHash).void }
-      attr_writer :data
-
-      # Response containing a single webhook event resource.
-      sig do
-        params(data: VitableConnect::WebhookEvent::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(data:)
-      end
-
-      sig { override.returns({ data: VitableConnect::WebhookEvent }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/vitable_connect/models.rbi

@@ -1,134 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  AuthIssueAccessTokenParams =
-    VitableConnect::Models::AuthIssueAccessTokenParams
-
-  Employee = VitableConnect::Models::Employee
-
-  EmployeeClass = VitableConnect::Models::EmployeeClass
-
-  EmployeeListEnrollmentsParams =
-    VitableConnect::Models::EmployeeListEnrollmentsParams
-
-  EmployeeRetrieveParams = VitableConnect::Models::EmployeeRetrieveParams
-
-  EmployeeUpdateParams = VitableConnect::Models::EmployeeUpdateParams
-
-  Employer = VitableConnect::Models::Employer
-
-  EmployerCreateParams = VitableConnect::Models::EmployerCreateParams
-
-  EmployerEnsurePayrollIntegrationEmailParams =
-    VitableConnect::Models::EmployerEnsurePayrollIntegrationEmailParams
-
-  EmployerListBenefitPlanYearEnrollmentsParams =
-    VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsParams
-
-  EmployerListBenefitPlanYearsParams =
-    VitableConnect::Models::EmployerListBenefitPlanYearsParams
-
-  EmployerListEmployeesParams =
-    VitableConnect::Models::EmployerListEmployeesParams
-
-  EmployerListHRISProvidersParams =
-    VitableConnect::Models::EmployerListHRISProvidersParams
-
-  EmployerListInvoicesParams =
-    VitableConnect::Models::EmployerListInvoicesParams
-
-  EmployerListParams = VitableConnect::Models::EmployerListParams
-
-  EmployerListPayrollDeductionStatementsParams =
-    VitableConnect::Models::EmployerListPayrollDeductionStatementsParams
-
-  EmployerResponse = VitableConnect::Models::EmployerResponse
-
-  EmployerRetrieveBenefitPlanYearParams =
-    VitableConnect::Models::EmployerRetrieveBenefitPlanYearParams
-
-  EmployerRetrieveHRISParams =
-    VitableConnect::Models::EmployerRetrieveHRISParams
-
-  EmployerRetrieveInvoicePdfParams =
-    VitableConnect::Models::EmployerRetrieveInvoicePdfParams
-
-  EmployerRetrieveParams = VitableConnect::Models::EmployerRetrieveParams
-
-  EmployerRetrievePayrollAccessSetupParams =
-    VitableConnect::Models::EmployerRetrievePayrollAccessSetupParams
-
-  EmployerSubmitCensusSyncParams =
-    VitableConnect::Models::EmployerSubmitCensusSyncParams
-
-  EmployerSubmitPayrollAccessSetupParams =
-    VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams
-
-  EmployerUpdateParams = VitableConnect::Models::EmployerUpdateParams
-
-  EmployerUpdateSettingsParams =
-    VitableConnect::Models::EmployerUpdateSettingsParams
-
-  Enrollment = VitableConnect::Models::Enrollment
-
-  EnrollmentReissueParams = VitableConnect::Models::EnrollmentReissueParams
-
-  EnrollmentRetrieveParams = VitableConnect::Models::EnrollmentRetrieveParams
-
-  EnrollmentStatus = VitableConnect::Models::EnrollmentStatus
-
-  EnrollmentTerminateParams = VitableConnect::Models::EnrollmentTerminateParams
-
-  Group = VitableConnect::Models::Group
-
-  GroupCreateParams = VitableConnect::Models::GroupCreateParams
-
-  GroupListParams = VitableConnect::Models::GroupListParams
-
-  GroupResponse = VitableConnect::Models::GroupResponse
-
-  GroupRetrieveParams = VitableConnect::Models::GroupRetrieveParams
-
-  Groups = VitableConnect::Models::Groups
-
-  GroupUpdateParams = VitableConnect::Models::GroupUpdateParams
-
-  MemberListDependentsParams =
-    VitableConnect::Models::MemberListDependentsParams
-
-  MemberListEmploymentsParams =
-    VitableConnect::Models::MemberListEmploymentsParams
-
-  MemberListEnrollmentsParams =
-    VitableConnect::Models::MemberListEnrollmentsParams
-
-  MemberListIDCardsParams = VitableConnect::Models::MemberListIDCardsParams
-
-  MemberListParams = VitableConnect::Models::MemberListParams
-
-  MemberListQualifyingLifeEventsParams =
-    VitableConnect::Models::MemberListQualifyingLifeEventsParams
-
-  MemberRetrieveHouseholdParams =
-    VitableConnect::Models::MemberRetrieveHouseholdParams
-
-  MemberRetrieveParams = VitableConnect::Models::MemberRetrieveParams
-
-  OrganizationCreateParams = VitableConnect::Models::OrganizationCreateParams
-
-  OrganizationListParams = VitableConnect::Models::OrganizationListParams
-
-  Pagination = VitableConnect::Models::Pagination
-
-  PlanListParams = VitableConnect::Models::PlanListParams
-
-  WebhookEvent = VitableConnect::Models::WebhookEvent
-
-  WebhookEventListDeliveriesParams =
-    VitableConnect::Models::WebhookEventListDeliveriesParams
-
-  WebhookEventListParams = VitableConnect::Models::WebhookEventListParams
-
-  WebhookEventRetrieveParams =
-    VitableConnect::Models::WebhookEventRetrieveParams
-end

data/rbi/vitable_connect/request_options.rbi

@@ -1,61 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  # Specify HTTP behaviour to use for a specific request. These options supplement
-  # or override those provided at the client level.
-  #
-  # When making a request, you can pass an actual {RequestOptions} instance, or
-  # simply pass a Hash with symbol keys matching the attributes on this class.
-  class RequestOptions < VitableConnect::Internal::Type::BaseModel
-    OrHash =
-      T.type_alias do
-        T.any(VitableConnect::RequestOptions, VitableConnect::Internal::AnyHash)
-      end
-
-    # @api private
-    sig { params(opts: VitableConnect::RequestOptions::OrHash).void }
-    def self.validate!(opts)
-    end
-
-    # Idempotency key to send with request and all associated retries. Will only be
-    # sent for write requests.
-    sig { returns(T.nilable(String)) }
-    attr_accessor :idempotency_key
-
-    # Extra query params to send with the request. These are `.merge`’d into any
-    # `query` given at the client level.
-    sig do
-      returns(
-        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
-      )
-    end
-    attr_accessor :extra_query
-
-    # Extra headers to send with the request. These are `.merged`’d into any
-    # `extra_headers` given at the client level.
-    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
-    attr_accessor :extra_headers
-
-    # Extra data to send with the request. These are deep merged into any data
-    # generated as part of the normal request.
-    sig { returns(T.nilable(T.anything)) }
-    attr_accessor :extra_body
-
-    # Maximum number of retries to attempt after a failed initial request.
-    sig { returns(T.nilable(Integer)) }
-    attr_accessor :max_retries
-
-    # Request timeout in seconds.
-    sig { returns(T.nilable(Float)) }
-    attr_accessor :timeout
-
-    # Returns a new instance of RequestOptions.
-    sig do
-      params(values: VitableConnect::Internal::AnyHash).returns(
-        T.attached_class
-      )
-    end
-    def self.new(values = {})
-    end
-  end
-end

data/rbi/vitable_connect/resources/auth.rbi

@@ -1,36 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    # Issue short-lived access tokens for scoped API access
-    class Auth
-      # Issues a short-lived access token from the authenticated API key. Access tokens
-      # can optionally be bound to a specific employer or employee for scoped access.
-      # Tokens expire after 15 minutes.
-      sig do
-        params(
-          grant_type:
-            VitableConnect::AuthIssueAccessTokenParams::GrantType::OrSymbol,
-          bound_entity:
-            T.nilable(
-              VitableConnect::AuthIssueAccessTokenParams::BoundEntity::OrHash
-            ),
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::AuthIssueAccessTokenResponse)
-      end
-      def issue_access_token(
-        # - `client_credentials` - client_credentials
-        grant_type:,
-        # Optional entity to bind the token to for scoped access
-        bound_entity: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/employees.rbi

@@ -1,110 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Employees
-      # Retrieves detailed information for a specific employee by ID. Returns employee
-      # details including personal information, employment status, classification and
-      # compensation-type effective dates, compensation type, and payroll deductions
-      # from the most recent statement period. Deductions reflect a snapshot of the
-      # current period and are replaced when a new statement is generated.
-      sig do
-        params(
-          employee_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::EmployeeRetrieveResponse)
-      end
-      def retrieve(
-        # Unique employee identifier (empl\_\*)
-        employee_id,
-        request_options: {}
-      )
-      end
-
-      # Updates employee personal, contact, address, and employment fields. This
-      # endpoint currently supports email, phone, gender, address, employee_class,
-      # start_date, and compensation_type. effective_date is required and applies to
-      # employee_class and compensation_type when those fields are included in the
-      # request.
-      sig do
-        params(
-          employee_id: String,
-          effective_date: Date,
-          address:
-            T.nilable(VitableConnect::EmployeeUpdateParams::Address::OrHash),
-          compensation_type:
-            T.nilable(
-              VitableConnect::EmployeeUpdateParams::CompensationType::OrSymbol
-            ),
-          email: T.nilable(String),
-          employee_class: T.nilable(VitableConnect::EmployeeClass::OrSymbol),
-          gender:
-            T.nilable(VitableConnect::EmployeeUpdateParams::Gender::OrSymbol),
-          phone: T.nilable(String),
-          start_date: T.nilable(Date),
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::EmployeeUpdateResponse)
-      end
-      def update(
-        # Unique employee identifier (empl\_\*)
-        employee_id,
-        # Past or present date applied to each tracked employment field included in this
-        # request
-        effective_date:,
-        # Employee's residential address
-        address: nil,
-        # - `Salary` - Salary
-        # - `Hourly` - Hourly
-        compensation_type: nil,
-        # Email address
-        email: nil,
-        # - `Full Time` - Full Time
-        # - `Part Time` - Part Time
-        # - `Temporary` - Temporary
-        # - `Intern` - Intern
-        # - `Seasonal` - Seasonal
-        # - `Individual Contractor` - Individual Contractor
-        employee_class: nil,
-        # - `Male` - Male
-        # - `Female` - Female
-        # - `Transgender` - Transgender
-        # - `Non-binary` - Non-binary
-        # - `Prefer not to respond` - Prefer not to respond
-        gender: nil,
-        # Phone number
-        phone: nil,
-        # Employment start date
-        start_date: nil,
-        request_options: {}
-      )
-      end
-
-      # Retrieves a paginated list of benefit enrollments for an employee.
-      sig do
-        params(
-          employee_id: String,
-          limit: Integer,
-          page: Integer,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[VitableConnect::Enrollment]
-        )
-      end
-      def list_enrollments(
-        # Unique employee identifier (empl\_\*)
-        employee_id,
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end