vitable-connect 0.6.0 → 1.0.0

data/lib/vitable_connect/models/employer_retrieve_hris_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#retrieve_hris
-    class EmployerRetrieveHRISParams < 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

data/lib/vitable_connect/models/employer_retrieve_hris_response.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#retrieve_hris
-    class EmployerRetrieveHRISResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute hris
-      #   HRIS connection details, or null when the employer has no integration.
-      #
-      #   @return [VitableConnect::Models::EmployerRetrieveHRISResponse::HRIS, nil]
-      required :hris, -> { VitableConnect::Models::EmployerRetrieveHRISResponse::HRIS }, nil?: true
-
-      # @!method initialize(hris:)
-      #   @param hris [VitableConnect::Models::EmployerRetrieveHRISResponse::HRIS, nil] HRIS connection details, or null when the employer has no integration.
-
-      # @see VitableConnect::Models::EmployerRetrieveHRISResponse#hris
-      class HRIS < VitableConnect::Internal::Type::BaseModel
-        # @!attribute last_sync_on
-        #   When the last sync completed, or null when none has.
-        #
-        #   @return [Time, nil]
-        required :last_sync_on, Time, nil?: true
-
-        # @!attribute provider
-        #   HRIS/payroll provider the employer is connected to (e.g. `Paychex`).
-        #
-        #   @return [String]
-        required :provider, String
-
-        # @!attribute status
-        #   Connection status reported by the integration.
-        #
-        #   @return [String]
-        required :status, String
-
-        # @!attribute synced_row_count
-        #   Rows in the latest completed sync, or null when none has.
-        #
-        #   @return [Integer, nil]
-        required :synced_row_count, Integer, nil?: true
-
-        # @!method initialize(last_sync_on:, provider:, status:, synced_row_count:)
-        #   HRIS connection details, or null when the employer has no integration.
-        #
-        #   @param last_sync_on [Time, nil] When the last sync completed, or null when none has.
-        #
-        #   @param provider [String] HRIS/payroll provider the employer is connected to (e.g. `Paychex`).
-        #
-        #   @param status [String] Connection status reported by the integration.
-        #
-        #   @param synced_row_count [Integer, nil] Rows in the latest completed sync, or null when none has.
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/employer_retrieve_invoice_pdf_params.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#retrieve_invoice_pdf
-    class EmployerRetrieveInvoicePdfParams < 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 invoice_id
-      #   External Chargebee invoice id (not a prefixed UUID).
-      #
-      #   @return [String]
-      required :invoice_id, String
-
-      # @!method initialize(employer_id:, invoice_id:, request_options: {})
-      #   @param employer_id [String] Unique employer identifier (empr\_\*)
-      #
-      #   @param invoice_id [String] External Chargebee invoice id (not a prefixed UUID).
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/employer_retrieve_invoice_pdf_response.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#retrieve_invoice_pdf
-    class EmployerRetrieveInvoicePdfResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute download_url
-      #   Time-limited Chargebee PDF download link for the invoice.
-      #
-      #   @return [String]
-      required :download_url, String
-
-      # @!method initialize(download_url:)
-      #   @param download_url [String] Time-limited Chargebee PDF download link for the invoice.
-    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

data/lib/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#retrieve_payroll_access_setup
-    class EmployerRetrievePayrollAccessSetupParams < 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

data/lib/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#retrieve_payroll_access_setup
-    class EmployerRetrievePayrollAccessSetupResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse::Data]
-      required :data, -> { VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse::Data }
-
-      # @!method initialize(data:)
-      #   Response containing a single payroll access setup status resource.
-      #
-      #   @param data [VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse::Data]
-
-      # @see VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse#data
-      class Data < VitableConnect::Internal::Type::BaseModel
-        # @!attribute completed
-        #
-        #   @return [Boolean]
-        required :completed, VitableConnect::Internal::Type::Boolean
-
-        # @!attribute submitted_at
-        #
-        #   @return [Time, nil]
-        required :submitted_at, Time, nil?: true
-
-        # @!method initialize(completed:, submitted_at:)
-        #   @param completed [Boolean]
-        #   @param submitted_at [Time, nil]
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/employer_submit_census_sync_params.rb

@@ -1,375 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#submit_census_sync
-    class EmployerSubmitCensusSyncParams < 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 employees
-      #
-      #   @return [Array<VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee>]
-      required :employees,
-               -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::EmployerSubmitCensusSyncParams::Employee] }
-
-      # @!method initialize(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}]
-
-      class Employee < VitableConnect::Internal::Type::BaseModel
-        # @!attribute date_of_birth
-        #
-        #   @return [Date]
-        required :date_of_birth, Date
-
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute first_name
-        #
-        #   @return [String]
-        required :first_name, String
-
-        # @!attribute last_name
-        #
-        #   @return [String]
-        required :last_name, String
-
-        # @!attribute address
-        #
-        #   @return [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
-        optional :address,
-                 -> {
-                   VitableConnect::EmployerSubmitCensusSyncParams::Employee::Address
-                 },
-                 nil?: true
-
-        # @!attribute compensation_type
-        #   - `Salary` - Salary
-        #   - `Hourly` - Hourly
-        #
-        #   @return [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil]
-        optional :compensation_type,
-                 enum: -> { VitableConnect::EmployerSubmitCensusSyncParams::Employee::CompensationType },
-                 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 phone
-        #   Phone number
-        #
-        #   @return [String, nil]
-        optional :phone, String, nil?: true
-
-        # @!attribute reference_id
-        #
-        #   @return [String, nil]
-        optional :reference_id, String, nil?: true
-
-        # @!attribute start_date
-        #
-        #   @return [Date, nil]
-        optional :start_date, Date, nil?: true
-
-        # @!method initialize(date_of_birth:, email:, first_name:, last_name:, address: nil, compensation_type: nil, employee_class: nil, phone: nil, reference_id: nil, start_date: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee} for more
-        #   details.
-        #
-        #   @param date_of_birth [Date]
-        #
-        #   @param email [String]
-        #
-        #   @param first_name [String]
-        #
-        #   @param last_name [String]
-        #
-        #   @param address [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
-        #
-        #   @param compensation_type [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil] - `Salary` - Salary
-        #
-        #   @param employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
-        #
-        #   @param phone [String, nil] Phone number
-        #
-        #   @param reference_id [String, nil]
-        #
-        #   @param start_date [Date, nil]
-
-        # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee#address
-        class Address < VitableConnect::Internal::Type::BaseModel
-          # @!attribute address_line_1
-          #
-          #   @return [String]
-          required :address_line_1, String
-
-          # @!attribute city
-          #
-          #   @return [String]
-          required :city, String
-
-          # @!attribute state
-          #   - `AL` - AL
-          #   - `AK` - AK
-          #   - `AZ` - AZ
-          #   - `AR` - AR
-          #   - `CA` - CA
-          #   - `CO` - CO
-          #   - `CT` - CT
-          #   - `DC` - DC
-          #   - `DE` - DE
-          #   - `FL` - FL
-          #   - `GA` - GA
-          #   - `HI` - HI
-          #   - `ID` - ID
-          #   - `IL` - IL
-          #   - `IN` - IN
-          #   - `IA` - IA
-          #   - `KS` - KS
-          #   - `KY` - KY
-          #   - `LA` - LA
-          #   - `ME` - ME
-          #   - `MD` - MD
-          #   - `MA` - MA
-          #   - `MI` - MI
-          #   - `MN` - MN
-          #   - `MS` - MS
-          #   - `MO` - MO
-          #   - `MT` - MT
-          #   - `NE` - NE
-          #   - `NV` - NV
-          #   - `NH` - NH
-          #   - `NJ` - NJ
-          #   - `NM` - NM
-          #   - `NY` - NY
-          #   - `NC` - NC
-          #   - `ND` - ND
-          #   - `OH` - OH
-          #   - `OK` - OK
-          #   - `OR` - OR
-          #   - `PA` - PA
-          #   - `RI` - RI
-          #   - `SC` - SC
-          #   - `SD` - SD
-          #   - `TN` - TN
-          #   - `TX` - TX
-          #   - `UT` - UT
-          #   - `VT` - VT
-          #   - `VA` - VA
-          #   - `WA` - WA
-          #   - `WI` - WI
-          #   - `WV` - WV
-          #   - `WY` - WY
-          #   - `PR` - PR
-          #   - `GU` - GU
-          #   - `AS` - AS
-          #   - `VI` - VI
-          #   - `MP` - MP
-          #   - `MH` - MH
-          #   - `PW` - PW
-          #   - `FM` - FM
-          #   - `AE` - AE
-          #   - `AA` - AA
-          #   - `AP` - AP
-          #
-          #   @return [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address::State]
-          required :state, enum: -> { VitableConnect::EmployerSubmitCensusSyncParams::Employee::Address::State }
-
-          # @!attribute zipcode
-          #
-          #   @return [String]
-          required :zipcode, String
-
-          # @!attribute address_line_2
-          #
-          #   @return [String, nil]
-          optional :address_line_2, String, nil?: true
-
-          # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address} for
-          #   more details.
-          #
-          #   @param address_line_1 [String]
-          #
-          #   @param city [String]
-          #
-          #   @param state [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address::State] - `AL` - AL
-          #
-          #   @param zipcode [String]
-          #
-          #   @param address_line_2 [String, nil]
-
-          # - `AL` - AL
-          # - `AK` - AK
-          # - `AZ` - AZ
-          # - `AR` - AR
-          # - `CA` - CA
-          # - `CO` - CO
-          # - `CT` - CT
-          # - `DC` - DC
-          # - `DE` - DE
-          # - `FL` - FL
-          # - `GA` - GA
-          # - `HI` - HI
-          # - `ID` - ID
-          # - `IL` - IL
-          # - `IN` - IN
-          # - `IA` - IA
-          # - `KS` - KS
-          # - `KY` - KY
-          # - `LA` - LA
-          # - `ME` - ME
-          # - `MD` - MD
-          # - `MA` - MA
-          # - `MI` - MI
-          # - `MN` - MN
-          # - `MS` - MS
-          # - `MO` - MO
-          # - `MT` - MT
-          # - `NE` - NE
-          # - `NV` - NV
-          # - `NH` - NH
-          # - `NJ` - NJ
-          # - `NM` - NM
-          # - `NY` - NY
-          # - `NC` - NC
-          # - `ND` - ND
-          # - `OH` - OH
-          # - `OK` - OK
-          # - `OR` - OR
-          # - `PA` - PA
-          # - `RI` - RI
-          # - `SC` - SC
-          # - `SD` - SD
-          # - `TN` - TN
-          # - `TX` - TX
-          # - `UT` - UT
-          # - `VT` - VT
-          # - `VA` - VA
-          # - `WA` - WA
-          # - `WI` - WI
-          # - `WV` - WV
-          # - `WY` - WY
-          # - `PR` - PR
-          # - `GU` - GU
-          # - `AS` - AS
-          # - `VI` - VI
-          # - `MP` - MP
-          # - `MH` - MH
-          # - `PW` - PW
-          # - `FM` - FM
-          # - `AE` - AE
-          # - `AA` - AA
-          # - `AP` - AP
-          #
-          # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address#state
-          module State
-            extend VitableConnect::Internal::Type::Enum
-
-            AL = :AL
-            AK = :AK
-            AZ = :AZ
-            AR = :AR
-            CA = :CA
-            CO = :CO
-            CT = :CT
-            DC = :DC
-            DE = :DE
-            FL = :FL
-            GA = :GA
-            HI = :HI
-            ID = :ID
-            IL = :IL
-            IN = :IN
-            IA = :IA
-            KS = :KS
-            KY = :KY
-            LA = :LA
-            ME = :ME
-            MD = :MD
-            MA = :MA
-            MI = :MI
-            MN = :MN
-            MS = :MS
-            MO = :MO
-            MT = :MT
-            NE = :NE
-            NV = :NV
-            NH = :NH
-            NJ = :NJ
-            NM = :NM
-            NY = :NY
-            NC = :NC
-            ND = :ND
-            OH = :OH
-            OK = :OK
-            OR = :OR
-            PA = :PA
-            RI = :RI
-            SC = :SC
-            SD = :SD
-            TN = :TN
-            TX = :TX
-            UT = :UT
-            VT = :VT
-            VA = :VA
-            WA = :WA
-            WI = :WI
-            WV = :WV
-            WY = :WY
-            PR = :PR
-            GU = :GU
-            AS = :AS
-            VI = :VI
-            MP = :MP
-            MH = :MH
-            PW = :PW
-            FM = :FM
-            AE = :AE
-            AA = :AA
-            AP = :AP
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        # - `Salary` - Salary
-        # - `Hourly` - Hourly
-        #
-        # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee#compensation_type
-        module CompensationType
-          extend VitableConnect::Internal::Type::Enum
-
-          SALARY = :Salary
-          HOURLY = :Hourly
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/employer_submit_census_sync_response.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#submit_census_sync
-    class EmployerSubmitCensusSyncResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [VitableConnect::Models::EmployerSubmitCensusSyncResponse::Data]
-      required :data, -> { VitableConnect::Models::EmployerSubmitCensusSyncResponse::Data }
-
-      # @!method initialize(data:)
-      #   Response containing a single census sync detail resource.
-      #
-      #   @param data [VitableConnect::Models::EmployerSubmitCensusSyncResponse::Data]
-
-      # @see VitableConnect::Models::EmployerSubmitCensusSyncResponse#data
-      class Data < VitableConnect::Internal::Type::BaseModel
-        # @!attribute accepted_at
-        #
-        #   @return [Time]
-        required :accepted_at, Time
-
-        # @!attribute employer_id
-        #
-        #   @return [String]
-        required :employer_id, String
-
-        # @!method initialize(accepted_at:, employer_id:)
-        #   @param accepted_at [Time]
-        #   @param employer_id [String]
-      end
-    end
-  end
-end