gusto_embedded_client 0.2.5

data/lib/gusto_embedded/models/shared/benefit_type_requirements_catch_up_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsCatchUpDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_company_contribution_annual_maximum_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsCompanyContributionAnnualMaximumDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_contribution.rb

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # An object representing the type and value of the company contribution.
+    class BenefitTypeRequirementsContribution < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :choices, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('choices') } }
+
+      field :default_value, T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsDefaultValue), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('default_value') } }
+
+      field :editable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('editable') } }
+
+      field :required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required') } }
+
+
+      sig { params(choices: T.nilable(T::Array[::String]), default_value: T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsDefaultValue), editable: T.nilable(T::Boolean), required: T.nilable(T::Boolean)).void }
+      def initialize(choices: nil, default_value: nil, editable: nil, required: nil)
+        @choices = choices
+        @default_value = default_value
+        @editable = editable
+        @required = required
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_coverage_amount_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsCoverageAmountDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_coverage_salary_multiplier_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsCoverageSalaryMultiplierDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_deduct_as_percentage_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsDeductAsPercentageDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_type_requirements_limit_option_default_value.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitTypeRequirementsLimitOptionDefaultValue < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::String)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefits.rb

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class Benefits < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :company_contribution, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution') } }
+
+      field :employee_deduction, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
+
+      field :imputed, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('imputed') } }
+
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(company_contribution: T.nilable(::Float), employee_deduction: T.nilable(::Float), imputed: T.nilable(T::Boolean), name: T.nilable(::String)).void }
+      def initialize(company_contribution: nil, employee_deduction: nil, imputed: nil, name: nil)
+        @company_contribution = company_contribution
+        @employee_deduction = employee_deduction
+        @imputed = imputed
+        @name = name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/catch_up.rb

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Whether the employee should use a benefit’s 'catch up' rate. Only Roth 401k and 401k benefits use this value for employees over 50.
+    class CatchUp < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :choices, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('choices') } }
+
+      field :default_value, T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsCatchUpDefaultValue), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('default_value') } }
+
+      field :editable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('editable') } }
+
+      field :required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required') } }
+
+
+      sig { params(choices: T.nilable(T::Array[::String]), default_value: T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsCatchUpDefaultValue), editable: T.nilable(T::Boolean), required: T.nilable(T::Boolean)).void }
+      def initialize(choices: nil, default_value: nil, editable: nil, required: nil)
+        @choices = choices
+        @default_value = default_value
+        @editable = editable
+        @required = required
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/category.rb

@@ -0,0 +1,19 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Category - The category of the company attachment
+    class Category < T::Enum
+      enums do
+        GEP_NOTICE = new('gep_notice')
+        COMPLIANCE = new('compliance')
+        OTHER = new('other')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/child_support_data.rb

@@ -0,0 +1,24 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Child Support agency data
+    class ChildSupportData < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # State child support agencies
+      field :agencies, T.nilable(T::Array[::GustoEmbedded::Shared::Agencies]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('agencies') } }
+
+
+      sig { params(agencies: T.nilable(T::Array[::GustoEmbedded::Shared::Agencies])).void }
+      def initialize(agencies: nil)
+        @agencies = agencies
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/columbus_day.rb

@@ -0,0 +1,30 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class ColumbusDay < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('date') } }
+
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+      field :selected, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('selected') } }
+
+
+      sig { params(date: T.nilable(::String), name: T.nilable(::String), selected: T.nilable(T::Boolean)).void }
+      def initialize(date: nil, name: nil, selected: nil)
+        @date = date
+        @name = name
+        @selected = selected
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/company.rb

@@ -0,0 +1,75 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of a company in Gusto.
+    class Company < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # A unique identifier of the company in Gusto.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The status of the company in Gusto. "Approved" companies are approved to run payroll from a risk and compliance perspective. However, an approved company may still need to resolve other [payroll blockers](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers) to be able to run payroll. "Not Approved" companies may not yet run payroll with Gusto and may need to complete onboarding or contact support. "Suspended" companies may not run payroll with Gusto. In order to unsuspend their account, the company must contact support.
+      field :company_status, T.nilable(::GustoEmbedded::Shared::CompanyStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::CompanyStatus, true) } }
+      # The available company-wide compensation rates for the company.
+      field :compensations, T.nilable(::GustoEmbedded::Shared::Compensations), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('compensations') } }
+      # Whether the company only supports contractors.
+      field :contractor_only, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_only') } }
+      # The Federal Employer Identification Number of the company.
+      field :ein, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('ein') } }
+      # The tax payer type of the company.
+      field :entity_type, T.nilable(::GustoEmbedded::Shared::EntityType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('entity_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::EntityType, true) } }
+      # Company's default funding type
+      field :funding_type, T.nilable(::GustoEmbedded::Shared::FundingType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('funding_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::FundingType, true) } }
+      # Whether the company is fully managed by a partner via the API
+      field :is_partner_managed, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('is_partner_managed') } }
+      # Whether or not the company is suspended in Gusto. Suspended companies may not run payroll.
+      field :is_suspended, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('is_suspended') } }
+      # Company's first invoiceable event date
+      field :join_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('join_date') } }
+      # The locations of the company.
+      field :locations, T.nilable(T::Array[::GustoEmbedded::Shared::CompanyAddress]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('locations') } }
+      # The name of the company.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # The pay schedule assignment type.
+      field :pay_schedule_type, T.nilable(::GustoEmbedded::Shared::PayScheduleType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_schedule_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PayScheduleType, true) } }
+      # The primary payroll admin of the company.
+      field :primary_payroll_admin, T.nilable(::GustoEmbedded::Shared::PrimaryPayrollAdmin), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('primary_payroll_admin') } }
+      # The primary signatory of the company.
+      field :primary_signatory, T.nilable(::GustoEmbedded::Shared::PrimarySignatory), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('primary_signatory') } }
+      # The slug of the name of the company.
+      field :slug, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('slug') } }
+      # The Gusto product tier of the company (not applicable to Embedded partner managed companies).
+      field :tier, T.nilable(::GustoEmbedded::Shared::Tier), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('tier'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::Tier, true) } }
+      # The trade name of the company.
+      field :trade_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('trade_name') } }
+
+
+      sig { params(uuid: ::String, company_status: T.nilable(::GustoEmbedded::Shared::CompanyStatus), compensations: T.nilable(::GustoEmbedded::Shared::Compensations), contractor_only: T.nilable(T::Boolean), ein: T.nilable(::String), entity_type: T.nilable(::GustoEmbedded::Shared::EntityType), funding_type: T.nilable(::GustoEmbedded::Shared::FundingType), is_partner_managed: T.nilable(T::Boolean), is_suspended: T.nilable(T::Boolean), join_date: T.nilable(::String), locations: T.nilable(T::Array[::GustoEmbedded::Shared::CompanyAddress]), name: T.nilable(::String), pay_schedule_type: T.nilable(::GustoEmbedded::Shared::PayScheduleType), primary_payroll_admin: T.nilable(::GustoEmbedded::Shared::PrimaryPayrollAdmin), primary_signatory: T.nilable(::GustoEmbedded::Shared::PrimarySignatory), slug: T.nilable(::String), tier: T.nilable(::GustoEmbedded::Shared::Tier), trade_name: T.nilable(::String)).void }
+      def initialize(uuid: nil, company_status: nil, compensations: nil, contractor_only: nil, ein: nil, entity_type: nil, funding_type: nil, is_partner_managed: nil, is_suspended: nil, join_date: nil, locations: nil, name: nil, pay_schedule_type: nil, primary_payroll_admin: nil, primary_signatory: nil, slug: nil, tier: nil, trade_name: nil)
+        @uuid = uuid
+        @company_status = company_status
+        @compensations = compensations
+        @contractor_only = contractor_only
+        @ein = ein
+        @entity_type = entity_type
+        @funding_type = funding_type
+        @is_partner_managed = is_partner_managed
+        @is_suspended = is_suspended
+        @join_date = join_date
+        @locations = locations
+        @name = name
+        @pay_schedule_type = pay_schedule_type
+        @primary_payroll_admin = primary_payroll_admin
+        @primary_signatory = primary_signatory
+        @slug = slug
+        @tier = tier
+        @trade_name = trade_name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/company_address.rb

@@ -0,0 +1,42 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of a company's address in Gusto.
+    class CompanyAddress < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+
+      field :city, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('city') } }
+
+      field :country, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('country') } }
+
+      field :state, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('state') } }
+
+      field :street_1, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('street_1') } }
+
+      field :street_2, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('street_2') } }
+
+      field :zip, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('zip') } }
+
+
+      sig { params(active: T.nilable(T::Boolean), city: T.nilable(::String), country: T.nilable(::String), state: T.nilable(::String), street_1: T.nilable(::String), street_2: T.nilable(::String), zip: T.nilable(::String)).void }
+      def initialize(active: nil, city: nil, country: nil, state: nil, street_1: nil, street_2: nil, zip: nil)
+        @active = active
+        @city = city
+        @country = country
+        @state = state
+        @street_1 = street_1
+        @street_2 = street_2
+        @zip = zip
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/company_attachment.rb

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The company attachment
+    class CompanyAttachment < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The category of the company attachment
+      field :category, T.nilable(::GustoEmbedded::Shared::Category), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('category'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::Category, true) } }
+      # name of the file uploaded
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # The ISO 8601 timestamp of when an attachment was uploaded
+      field :upload_time, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('upload_time') } }
+      # UUID of the company attachment
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+
+
+      sig { params(category: T.nilable(::GustoEmbedded::Shared::Category), name: T.nilable(::String), upload_time: T.nilable(::String), uuid: T.nilable(::String)).void }
+      def initialize(category: nil, name: nil, upload_time: nil, uuid: nil)
+        @category = category
+        @name = name
+        @upload_time = upload_time
+        @uuid = uuid
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/company_bank_account.rb

@@ -0,0 +1,61 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The company bank account
+    class CompanyBankAccount < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # UUID of the bank account
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Bank account type
+      field :account_type, T.nilable(::GustoEmbedded::Shared::AccountType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('account_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::AccountType, true) } }
+      # The balance fetch date associated with the last_cached_balance. Only applies when verification type is Plaid.
+      field :balance_fetched_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('balance_fetched_date') } }
+      # UUID of the company
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # Masked bank account number
+      field :hidden_account_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('hidden_account_number') } }
+      # The last fetch balance for the bank account. Please be aware that this amount does not reflect the most up-to-date balance and only applies when the verification type is Plaid.
+      field :last_cached_balance, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('last_cached_balance') } }
+      # Name of bank account
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # The Plaid connection status of the bank account. Only applies when verification type is Plaid.
+      field :plaid_status, T.nilable(::GustoEmbedded::Shared::PlaidStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('plaid_status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PlaidStatus, true) } }
+      # The bank account's routing number
+      field :routing_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('routing_number') } }
+      # The verification status of the bank account.
+      # 
+      # 'awaiting_deposits' means the bank account is just created and money is being transferred.
+      # 'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint.
+      # 'verified' means the bank account is verified.
+      field :verification_status, T.nilable(::GustoEmbedded::Shared::VerificationStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('verification_status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::VerificationStatus, true) } }
+      # The verification type of the bank account.
+      # 
+      # 'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits.
+      # 'plaid' means the bank account is connected through Plaid.
+      field :verification_type, T.nilable(::GustoEmbedded::Shared::VerificationType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('verification_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::VerificationType, true) } }
+
+
+      sig { params(uuid: ::String, account_type: T.nilable(::GustoEmbedded::Shared::AccountType), balance_fetched_date: T.nilable(::String), company_uuid: T.nilable(::String), hidden_account_number: T.nilable(::String), last_cached_balance: T.nilable(::String), name: T.nilable(::String), plaid_status: T.nilable(::GustoEmbedded::Shared::PlaidStatus), routing_number: T.nilable(::String), verification_status: T.nilable(::GustoEmbedded::Shared::VerificationStatus), verification_type: T.nilable(::GustoEmbedded::Shared::VerificationType)).void }
+      def initialize(uuid: nil, account_type: nil, balance_fetched_date: nil, company_uuid: nil, hidden_account_number: nil, last_cached_balance: nil, name: nil, plaid_status: nil, routing_number: nil, verification_status: nil, verification_type: nil)
+        @uuid = uuid
+        @account_type = account_type
+        @balance_fetched_date = balance_fetched_date
+        @company_uuid = company_uuid
+        @hidden_account_number = hidden_account_number
+        @last_cached_balance = last_cached_balance
+        @name = name
+        @plaid_status = plaid_status
+        @routing_number = routing_number
+        @verification_status = verification_status
+        @verification_type = verification_type
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/company_benefit.rb

@@ -0,0 +1,54 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of a company benefit.
+    class CompanyBenefit < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the company benefit.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating.
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+      # The type of the benefit to which the company benefit belongs.
+      field :benefit_type, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('benefit_type') } }
+      # The UUID of the company.
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # Whether this company benefit can be deleted. Deletable will be set to true if the benefit has not been used in payroll, has no employee benefits associated, and the benefit is not owned by Gusto or a Partner
+      field :deletable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deletable') } }
+      # The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+      # The number of employees enrolled in the benefit, only returned when enrollment_count query param is set to true.
+      field :enrollment_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('enrollment_count') } }
+      # Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to third party sick pay benefits.
+      field :responsible_for_employee_w2, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('responsible_for_employee_w2') } }
+      # Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits.
+      field :responsible_for_employer_taxes, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('responsible_for_employer_taxes') } }
+      # Whether employee deductions and company contributions can be set as percentages of payroll for an individual employee. This is determined by the type of benefit and is not configurable by the company.
+      field :supports_percentage_amounts, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('supports_percentage_amounts') } }
+      # The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field.
+      field :version, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('version') } }
+
+
+      sig { params(uuid: ::String, active: T.nilable(T::Boolean), benefit_type: T.nilable(::Integer), company_uuid: T.nilable(::String), deletable: T.nilable(T::Boolean), description: T.nilable(::String), enrollment_count: T.nilable(::Integer), responsible_for_employee_w2: T.nilable(T::Boolean), responsible_for_employer_taxes: T.nilable(T::Boolean), supports_percentage_amounts: T.nilable(T::Boolean), version: T.nilable(::String)).void }
+      def initialize(uuid: nil, active: nil, benefit_type: nil, company_uuid: nil, deletable: nil, description: nil, enrollment_count: nil, responsible_for_employee_w2: nil, responsible_for_employer_taxes: nil, supports_percentage_amounts: nil, version: nil)
+        @uuid = uuid
+        @active = active
+        @benefit_type = benefit_type
+        @company_uuid = company_uuid
+        @deletable = deletable
+        @description = description
+        @enrollment_count = enrollment_count
+        @responsible_for_employee_w2 = responsible_for_employee_w2
+        @responsible_for_employer_taxes = responsible_for_employer_taxes
+        @supports_percentage_amounts = supports_percentage_amounts
+        @version = version
+      end
+    end
+  end
+end