vitable-connect 0.5.0 → 1.0.0

data/lib/vitable_connect/models/employer.rb

@@ -1,155 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#list
-    class Employer < VitableConnect::Internal::Type::BaseModel
-      # @!attribute active
-      #   Whether the employer is currently active in the system
-      #
-      #   @return [Boolean]
-      required :active, VitableConnect::Internal::Type::Boolean
-
-      # @!attribute address
-      #   Nested address within EmployerSerializer.
-      #
-      #   @return [VitableConnect::Models::Employer::Address]
-      required :address, -> { VitableConnect::Employer::Address }
-
-      # @!attribute created_at
-      #   Timestamp when the employer was created
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute legal_name
-      #   Legal business name for compliance and tax purposes
-      #
-      #   @return [String]
-      required :legal_name, String
-
-      # @!attribute name
-      #   Display name of the employer
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute updated_at
-      #   Timestamp when the employer was last updated
-      #
-      #   @return [Time]
-      required :updated_at, Time
-
-      # @!attribute email
-      #   Email address for billing and communications
-      #
-      #   @return [String, nil]
-      optional :email, String, nil?: true
-
-      # @!attribute phone_number
-      #   Employer phone number (E.164 format recommended)
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, nil?: true
-
-      # @!attribute reference_id
-      #   Partner-assigned reference ID for the employer
-      #
-      #   @return [String, nil]
-      optional :reference_id, String, nil?: true
-
-      response_only do
-        # @!attribute id
-        #   Unique employer identifier with 'empr\_' prefix
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute ein
-        #   Employer Identification Number (masked in responses)
-        #
-        #   @return [String, nil]
-        required :ein, String, nil?: true
-
-        # @!attribute organization_id
-        #   ID of the parent organization (org\_\*)
-        #
-        #   @return [String, nil]
-        required :organization_id, String, nil?: true
-      end
-
-      # @!method initialize(id:, active:, address:, created_at:, ein:, legal_name:, name:, organization_id:, updated_at:, email: nil, phone_number: nil, reference_id: nil)
-      #   Serializer for Employer entity in public API responses.
-      #
-      #   @param id [String] Unique employer identifier with 'empr\_' prefix
-      #
-      #   @param active [Boolean] Whether the employer is currently active in the system
-      #
-      #   @param address [VitableConnect::Models::Employer::Address] Nested address within EmployerSerializer.
-      #
-      #   @param created_at [Time] Timestamp when the employer was created
-      #
-      #   @param ein [String, nil] Employer Identification Number (masked in responses)
-      #
-      #   @param legal_name [String] Legal business name for compliance and tax purposes
-      #
-      #   @param name [String] Display name of the employer
-      #
-      #   @param organization_id [String, nil] ID of the parent organization (org\_\*)
-      #
-      #   @param updated_at [Time] Timestamp when the employer was last updated
-      #
-      #   @param email [String, nil] Email address for billing and communications
-      #
-      #   @param phone_number [String, nil] Employer phone number (E.164 format recommended)
-      #
-      #   @param reference_id [String, nil] Partner-assigned reference ID for the employer
-
-      # @see VitableConnect::Models::Employer#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)
-        #   Nested address within EmployerSerializer.
-        #
-        #   @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/employer_create_params.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#create
-    class EmployerCreateParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute address
-      #   Employer address
-      #
-      #   @return [VitableConnect::Models::EmployerCreateParams::Address]
-      required :address, -> { VitableConnect::EmployerCreateParams::Address }
-
-      # @!attribute ein
-      #   Employer Identification Number (format: XX-XXXXXXX)
-      #
-      #   @return [String]
-      required :ein, String
-
-      # @!attribute email
-      #   Email address for billing and communications
-      #
-      #   @return [String]
-      required :email, String
-
-      # @!attribute legal_name
-      #   Legal business name
-      #
-      #   @return [String]
-      required :legal_name, String
-
-      # @!attribute name
-      #   Employer display name
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute phone_number
-      #   Employer phone number (10-digit US format, e.g. 5551234567)
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, nil?: true
-
-      # @!attribute reference_id
-      #   External reference ID for this employer
-      #
-      #   @return [String, nil]
-      optional :reference_id, String, nil?: true
-
-      # @!method initialize(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}]
-
-      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
-        #
-        #   @return [String]
-        required :state, String
-
-        # @!attribute zipcode
-        #   ZIP code
-        #
-        #   @return [String]
-        required :zipcode, String
-
-        # @!attribute address_line_2
-        #   Secondary street address
-        #
-        #   @return [String, nil]
-        optional :address_line_2, String, nil?: true
-
-        # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
-        #   Employer address
-        #
-        #   @param address_line_1 [String] Primary street address
-        #
-        #   @param city [String] City name
-        #
-        #   @param state [String] Two-letter state code
-        #
-        #   @param zipcode [String] ZIP code
-        #
-        #   @param address_line_2 [String, nil] Secondary street address
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/employer_list_employees_params.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#list_employees
-    class EmployerListEmployeesParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute employer_id
-      #   Unique employer identifier (empr\_\*)
-      #
-      #   @return [String]
-      required :employer_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(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}]
-    end
-  end
-end

data/lib/vitable_connect/models/employer_list_params.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#list
-    class EmployerListParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!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(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}]
-    end
-  end
-end

data/lib/vitable_connect/models/employer_response.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#create
-    class EmployerResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #   Serializer for Employer entity in public API responses.
-      #
-      #   @return [VitableConnect::Models::Employer]
-      required :data, -> { VitableConnect::Employer }
-
-      # @!method initialize(data:)
-      #   Response containing a single employer resource.
-      #
-      #   @param data [VitableConnect::Models::Employer] Serializer for Employer entity in public API responses.
-    end
-  end
-end

data/lib/vitable_connect/models/employer_retrieve_params.rb

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