vitable-connect 0.5.0 → 1.0.0

data/lib/vitable_connect/models.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  [
-    VitableConnect::Internal::Type::BaseModel,
-    *VitableConnect::Internal::Type::BaseModel.subclasses
-  ].each do |cls|
-    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, VitableConnect::Internal::AnyHash) } }
-  end
-
-  VitableConnect::Internal::Util.walk_namespaces(VitableConnect::Models).each do |mod|
-    case mod
-    in VitableConnect::Internal::Type::Enum | VitableConnect::Internal::Type::Union
-      mod.constants.each do |name|
-        case mod.const_get(name)
-        in true | false
-          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
-          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
-        in Integer
-          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
-          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
-        in Float
-          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
-          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
-        in Symbol
-          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
-          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
-        else
-        end
-      end
-    else
-    end
-  end
-
-  VitableConnect::Internal::Util.walk_namespaces(VitableConnect::Models)
-                                .lazy
-                                .grep(VitableConnect::Internal::Type::Union)
-                                .each do |mod|
-    const = :Variants
-    next if mod.sorbet_constant_defined?(const)
-
-    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
-  end
-
-  AuthIssueAccessTokenParams = VitableConnect::Models::AuthIssueAccessTokenParams
-
-  Employee = VitableConnect::Models::Employee
-
-  EmployeeClass = VitableConnect::Models::EmployeeClass
-
-  EmployeeListEnrollmentsParams = VitableConnect::Models::EmployeeListEnrollmentsParams
-
-  EmployeeRetrieveParams = VitableConnect::Models::EmployeeRetrieveParams
-
-  Employer = VitableConnect::Models::Employer
-
-  EmployerCreateParams = VitableConnect::Models::EmployerCreateParams
-
-  EmployerListEmployeesParams = VitableConnect::Models::EmployerListEmployeesParams
-
-  EmployerListParams = VitableConnect::Models::EmployerListParams
-
-  EmployerResponse = VitableConnect::Models::EmployerResponse
-
-  EmployerRetrieveParams = VitableConnect::Models::EmployerRetrieveParams
-
-  EmployerSubmitCensusSyncParams = VitableConnect::Models::EmployerSubmitCensusSyncParams
-
-  EmployerUpdateSettingsParams = VitableConnect::Models::EmployerUpdateSettingsParams
-
-  Enrollment = VitableConnect::Models::Enrollment
-
-  EnrollmentRetrieveParams = VitableConnect::Models::EnrollmentRetrieveParams
-
-  EnrollmentStatus = VitableConnect::Models::EnrollmentStatus
-
-  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
-
-  Pagination = VitableConnect::Models::Pagination
-
-  PlanListParams = VitableConnect::Models::PlanListParams
-
-  Type = VitableConnect::Models::Type
-
-  WebhookEvent = VitableConnect::Models::WebhookEvent
-
-  WebhookEventListDeliveriesParams = VitableConnect::Models::WebhookEventListDeliveriesParams
-
-  WebhookEventListParams = VitableConnect::Models::WebhookEventListParams
-
-  WebhookEventRetrieveParams = VitableConnect::Models::WebhookEventRetrieveParams
-end

data/lib/vitable_connect/request_options.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-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
-    # @api private
-    #
-    # @param opts [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    #
-    # @raise [ArgumentError]
-    def self.validate!(opts)
-      case opts
-      in VitableConnect::RequestOptions | Hash
-        opts.to_h.each_key do |k|
-          unless fields.include?(k)
-            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
-          end
-        end
-      else
-        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
-      end
-    end
-
-    # @!attribute idempotency_key
-    #   Idempotency key to send with request and all associated retries. Will only be
-    #   sent for write requests.
-    #
-    #   @return [String, nil]
-    optional :idempotency_key, String
-
-    # @!attribute extra_query
-    #   Extra query params to send with the request. These are `.merge`’d into any
-    #   `query` given at the client level.
-    #
-    #   @return [Hash{String=>Array<String>, String, nil}, nil]
-    optional :extra_query,
-             VitableConnect::Internal::Type::HashOf[VitableConnect::Internal::Type::ArrayOf[String]]
-
-    # @!attribute extra_headers
-    #   Extra headers to send with the request. These are `.merged`’d into any
-    #   `extra_headers` given at the client level.
-    #
-    #   @return [Hash{String=>String, nil}, nil]
-    optional :extra_headers, VitableConnect::Internal::Type::HashOf[String, nil?: true]
-
-    # @!attribute extra_body
-    #   Extra data to send with the request. These are deep merged into any data
-    #   generated as part of the normal request.
-    #
-    #   @return [Object, nil]
-    optional :extra_body, VitableConnect::Internal::Type::HashOf[VitableConnect::Internal::Type::Unknown]
-
-    # @!attribute max_retries
-    #   Maximum number of retries to attempt after a failed initial request.
-    #
-    #   @return [Integer, nil]
-    optional :max_retries, Integer
-
-    # @!attribute timeout
-    #   Request timeout in seconds.
-    #
-    #   @return [Float, nil]
-    optional :timeout, Float
-
-    # @!method initialize(values = {})
-    #   Returns a new instance of RequestOptions.
-    #
-    #   @param values [Hash{Symbol=>Object}]
-
-    define_sorbet_constant!(:OrHash) do
-      T.type_alias { T.any(VitableConnect::RequestOptions, VitableConnect::Internal::AnyHash) }
-    end
-  end
-end

data/lib/vitable_connect/resources/auth.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-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.
-      #
-      # @overload issue_access_token(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}, nil]
-      #
-      # @return [VitableConnect::Models::AuthIssueAccessTokenResponse]
-      #
-      # @see VitableConnect::Models::AuthIssueAccessTokenParams
-      def issue_access_token(params)
-        parsed, options = VitableConnect::AuthIssueAccessTokenParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "v1/auth/access-tokens",
-          body: parsed,
-          model: VitableConnect::Models::AuthIssueAccessTokenResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [VitableConnect::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/vitable_connect/resources/benefit_eligibility_policies.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Resources
-    class BenefitEligibilityPolicies
-      # @api private
-      #
-      # @param client [VitableConnect::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/vitable_connect/resources/employees.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Resources
-    class Employees
-      # Retrieves detailed information for a specific employee by ID. Returns employee
-      # details including personal information, employment status, 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.
-      #
-      # @overload retrieve(employee_id, request_options: {})
-      #
-      # @param employee_id [String] Unique employee identifier (empl\_\*)
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::EmployeeRetrieveResponse]
-      #
-      # @see VitableConnect::Models::EmployeeRetrieveParams
-      def retrieve(employee_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["v1/employees/%1$s", employee_id],
-          model: VitableConnect::Models::EmployeeRetrieveResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Retrieves a paginated list of benefit enrollments for an employee.
-      #
-      # @overload list_enrollments(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}, nil]
-      #
-      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Enrollment>]
-      #
-      # @see VitableConnect::Models::EmployeeListEnrollmentsParams
-      def list_enrollments(employee_id, params = {})
-        parsed, options = VitableConnect::EmployeeListEnrollmentsParams.dump_request(params)
-        query = VitableConnect::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: ["v1/employees/%1$s/enrollments", employee_id],
-          query: query,
-          page: VitableConnect::Internal::PageNumberPage,
-          model: VitableConnect::Enrollment,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [VitableConnect::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/vitable_connect/resources/employers.rb

@@ -1,184 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Resources
-    class Employers
-      # Creates a new employer for the authenticated organization. Requires employer
-      # name, legal name, EIN, email, and address information. Returns the created
-      # employer with its assigned ID.
-      #
-      # @overload create(address:, ein:, email:, legal_name:, name:, phone_number: nil, reference_id: nil, request_options: {})
-      #
-      # @param address [VitableConnect::Models::EmployerCreateParams::Address] Employer address
-      #
-      # @param ein [String] Employer Identification Number (format: XX-XXXXXXX)
-      #
-      # @param email [String] Email address for billing and communications
-      #
-      # @param legal_name [String] Legal business name
-      #
-      # @param name [String] Employer display name
-      #
-      # @param phone_number [String, nil] Employer phone number (10-digit US format, e.g. 5551234567)
-      #
-      # @param reference_id [String, nil] External reference ID for this employer
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::EmployerResponse]
-      #
-      # @see VitableConnect::Models::EmployerCreateParams
-      def create(params)
-        parsed, options = VitableConnect::EmployerCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "v1/employers",
-          body: parsed,
-          model: VitableConnect::EmployerResponse,
-          options: options
-        )
-      end
-
-      # Retrieves detailed information for a specific employer by ID. The employer must
-      # belong to the authenticated organization.
-      #
-      # @overload retrieve(employer_id, request_options: {})
-      #
-      # @param employer_id [String] Unique employer identifier (empr\_\*)
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::EmployerResponse]
-      #
-      # @see VitableConnect::Models::EmployerRetrieveParams
-      def retrieve(employer_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["v1/employers/%1$s", employer_id],
-          model: VitableConnect::EmployerResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Retrieves a paginated list of all employers belonging to the authenticated
-      # organization. Results are sorted by creation date (newest first) and paginated
-      # using page and limit parameters.
-      #
-      # @overload list(limit: nil, page: nil, request_options: {})
-      #
-      # @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}, nil]
-      #
-      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Employer>]
-      #
-      # @see VitableConnect::Models::EmployerListParams
-      def list(params = {})
-        parsed, options = VitableConnect::EmployerListParams.dump_request(params)
-        query = VitableConnect::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "v1/employers",
-          query: query,
-          page: VitableConnect::Internal::PageNumberPage,
-          model: VitableConnect::Employer,
-          options: options
-        )
-      end
-
-      # Retrieves a paginated list of all employees for a specific employer. Results are
-      # paginated using page and limit parameters. Each employee includes payroll
-      # deductions from the most recent statement period. When a new deduction statement
-      # is generated, previous period deductions are replaced.
-      #
-      # @overload list_employees(employer_id, limit: nil, page: nil, request_options: {})
-      #
-      # @param employer_id [String] Unique employer identifier (empr\_\*)
-      #
-      # @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}, nil]
-      #
-      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Employee>]
-      #
-      # @see VitableConnect::Models::EmployerListEmployeesParams
-      def list_employees(employer_id, params = {})
-        parsed, options = VitableConnect::EmployerListEmployeesParams.dump_request(params)
-        query = VitableConnect::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: ["v1/employers/%1$s/employees", employer_id],
-          query: query,
-          page: VitableConnect::Internal::PageNumberPage,
-          model: VitableConnect::Employee,
-          options: options
-        )
-      end
-
-      # Submits a census sync payload for the specified employer. The employees in the
-      # payload will be queued for processing. Returns an accepted response with the
-      # timestamp of acceptance.
-      #
-      # @overload submit_census_sync(employer_id, employees:, request_options: {})
-      #
-      # @param employer_id [String] Unique employer identifier (empr\_\*)
-      #
-      # @param employees [Array<VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee>]
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::EmployerSubmitCensusSyncResponse]
-      #
-      # @see VitableConnect::Models::EmployerSubmitCensusSyncParams
-      def submit_census_sync(employer_id, params)
-        parsed, options = VitableConnect::EmployerSubmitCensusSyncParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: ["v1/employers/%1$s/census-sync", employer_id],
-          body: parsed,
-          model: VitableConnect::Models::EmployerSubmitCensusSyncResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {VitableConnect::Models::EmployerUpdateSettingsParams} for more details.
-      #
-      # Updates configuration settings for a specific employer. The employer must belong
-      # to the authenticated organization.
-      #
-      # @overload update_settings(employer_id, pay_frequency:, request_options: {})
-      #
-      # @param employer_id [String] Unique employer identifier (empr\_\*)
-      #
-      # @param pay_frequency [Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency] - `weekly` - weekly
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::EmployerUpdateSettingsResponse]
-      #
-      # @see VitableConnect::Models::EmployerUpdateSettingsParams
-      def update_settings(employer_id, params)
-        parsed, options = VitableConnect::EmployerUpdateSettingsParams.dump_request(params)
-        @client.request(
-          method: :put,
-          path: ["v1/employers/%1$s/settings", employer_id],
-          body: parsed,
-          model: VitableConnect::Models::EmployerUpdateSettingsResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [VitableConnect::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/vitable_connect/resources/enrollments.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Resources
-    # Manage benefit enrollments and elections for employees
-    class Enrollments
-      # Retrieves detailed information for a specific enrollment by ID.
-      #
-      # @overload retrieve(enrollment_id, request_options: {})
-      #
-      # @param enrollment_id [String] Unique enrollment identifier (enrl\_\*)
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::EnrollmentRetrieveResponse]
-      #
-      # @see VitableConnect::Models::EnrollmentRetrieveParams
-      def retrieve(enrollment_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["v1/enrollments/%1$s", enrollment_id],
-          model: VitableConnect::Models::EnrollmentRetrieveResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [VitableConnect::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/vitable_connect/resources/groups/members/sync.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Resources
-    class Groups
-      class Members
-        class Sync
-          # Retrieves a previously-submitted group member sync request by its `grpmsr_` ID.
-          # Returns the acceptance timestamp, completion timestamp (if processing has
-          # finished), and the per-member `results` once available. While processing is in
-          # flight, `completed_at` and `results` are `null`.
-          #
-          # @overload retrieve(request_id, group_id:, request_options: {})
-          #
-          # @param request_id [String]
-          #
-          # @param group_id [String] Unique group identifier (grp\_\*)
-          #
-          # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [VitableConnect::Models::Groups::Members::SyncRetrieveResponse]
-          #
-          # @see VitableConnect::Models::Groups::Members::SyncRetrieveParams
-          def retrieve(request_id, params)
-            parsed, options = VitableConnect::Groups::Members::SyncRetrieveParams.dump_request(params)
-            group_id =
-              parsed.delete(:group_id) do
-                raise ArgumentError.new("missing required path argument #{_1}")
-              end
-            @client.request(
-              method: :get,
-              path: ["v1/groups/%1$s/members/sync/%2$s", group_id, request_id],
-              model: VitableConnect::Models::Groups::Members::SyncRetrieveResponse,
-              options: options
-            )
-          end
-
-          # Submits a member sync payload for the specified group. Members in the payload
-          # will be queued for processing asynchronously. Returns HTTP 202 with the batch ID
-          # and acceptance timestamp.
-          #
-          # @overload submit(group_id, members:, request_options: {})
-          #
-          # @param group_id [String] Unique group identifier (grp\_\*)
-          #
-          # @param members [Array<VitableConnect::Models::Groups::Members::SyncSubmitParams::Member>]
-          #
-          # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [VitableConnect::Models::Groups::Members::SyncSubmitResponse]
-          #
-          # @see VitableConnect::Models::Groups::Members::SyncSubmitParams
-          def submit(group_id, params)
-            parsed, options = VitableConnect::Groups::Members::SyncSubmitParams.dump_request(params)
-            @client.request(
-              method: :post,
-              path: ["v1/groups/%1$s/members/sync", group_id],
-              body: parsed,
-              model: VitableConnect::Models::Groups::Members::SyncSubmitResponse,
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [VitableConnect::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/resources/groups/members.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Resources
-    class Groups
-      class Members
-        # @return [VitableConnect::Resources::Groups::Members::Sync]
-        attr_reader :sync
-
-        # @api private
-        #
-        # @param client [VitableConnect::Client]
-        def initialize(client:)
-          @client = client
-          @sync = VitableConnect::Resources::Groups::Members::Sync.new(client: client)
-        end
-      end
-    end
-  end
-end