gusto_embedded_client 0.2.5

data/lib/gusto_embedded/models/shared/unprocessable_entity_error_object.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
+  
+    # Unprocessable Entity
+    #   
+    # This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+    # 
+    class UnprocessableEntityErrorObject < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :errors, T.nilable(T::Array[::GustoEmbedded::Shared::EntityErrorObject]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('errors') } }
+
+
+      sig { params(errors: T.nilable(T::Array[::GustoEmbedded::Shared::EntityErrorObject])).void }
+      def initialize(errors: nil)
+        @errors = errors
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/unprocessed_termination_pay_period.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 an unprocessed termination pay period.
+    class UnprocessedTerminationPayPeriod < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The check date of the pay period.
+      field :check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('check_date') } }
+      # The debit date of the pay period.
+      field :debit_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('debit_date') } }
+      # The full name of the employee.
+      field :employee_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_name') } }
+      # A unique identifier of the employee.
+      field :employee_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+      # The end date of the pay period.
+      field :end_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('end_date') } }
+      # A unique identifier of the pay schedule to which the pay period belongs.
+      field :pay_schedule_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_schedule_uuid') } }
+      # The start date of the pay period.
+      field :start_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('start_date') } }
+
+
+      sig { params(check_date: T.nilable(::String), debit_date: T.nilable(::String), employee_name: T.nilable(::String), employee_uuid: T.nilable(::String), end_date: T.nilable(::String), pay_schedule_uuid: T.nilable(::String), start_date: T.nilable(::String)).void }
+      def initialize(check_date: nil, debit_date: nil, employee_name: nil, employee_uuid: nil, end_date: nil, pay_schedule_uuid: nil, start_date: nil)
+        @check_date = check_date
+        @debit_date = debit_date
+        @employee_name = employee_name
+        @employee_uuid = employee_uuid
+        @end_date = end_date
+        @pay_schedule_uuid = pay_schedule_uuid
+        @start_date = start_date
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # [for `tax_rate`] Describes the validation required for the tax rate
+    class Validation < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Describes the type of tax_rate validation rule
+      field :type, ::GustoEmbedded::Shared::TaxRequirementMetadataValidationType, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::TaxRequirementMetadataValidationType, false) } }
+      # [for `min_max`] The inclusive upper bound of the tax rate
+      field :max, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('max') } }
+      # [for `min_max`] The inclusive lower bound of the tax rate
+      field :min, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('min') } }
+      # [for `one_of`] The possible, unformatted tax rates for selection.
+      # - e.g. ["0.0", "0.001"] representing 0% and 0.1%
+      # 
+      field :rates, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('rates') } }
+
+
+      sig { params(type: ::GustoEmbedded::Shared::TaxRequirementMetadataValidationType, max: T.nilable(::String), min: T.nilable(::String), rates: T.nilable(T::Array[::String])).void }
+      def initialize(type: nil, max: nil, min: nil, rates: nil)
+        @type = type
+        @max = max
+        @min = min
+        @rates = rates
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # VerificationStatus - 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.
+    class VerificationStatus < T::Enum
+      enums do
+        AWAITING_DEPOSITS = new('awaiting_deposits')
+        READY_FOR_VERIFICATION = new('ready_for_verification')
+        VERIFIED = new('verified')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # VerificationType - 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.
+    class VerificationType < T::Enum
+      enums do
+        BANK_DEPOSITS = new('bank_deposits')
+        PLAID = new('plaid')
+        PLAID_EXTERNAL = new('plaid_external')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class VersionHeader < T::Enum
+      enums do
+        TWO_THOUSAND_AND_TWENTY_FOUR_04_01 = new('2024-04-01')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/veterans_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 VeteransDay < ::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/w4_data_type.rb

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # W4DataType - The version of w4 form.
+    class W4DataType < T::Enum
+      enums do
+        PRE_2020_W4 = new('pre_2020_w4')
+        REV_2020_W4 = new('rev_2020_w4')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # WageType - The contractor's wage type, either "Fixed" or "Hourly".
+    class WageType < T::Enum
+      enums do
+        FIXED = new('Fixed')
+        HOURLY = new('Hourly')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/webhook_subscription.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 representation of webhook subscription.
+    class WebhookSubscription < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the webhook subscription.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The status of the webhook subscription.
+      field :status, T.nilable(::GustoEmbedded::Shared::WebhookSubscriptionStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::WebhookSubscriptionStatus, true) } }
+      # Receive updates for these types.
+      field :subscription_types, T.nilable(T::Array[::GustoEmbedded::Shared::SubscriptionTypes]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('subscription_types') } }
+      # The webhook subscriber URL. Updates will be POSTed to this URL.
+      field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('url') } }
+
+
+      sig { params(uuid: ::String, status: T.nilable(::GustoEmbedded::Shared::WebhookSubscriptionStatus), subscription_types: T.nilable(T::Array[::GustoEmbedded::Shared::SubscriptionTypes]), url: T.nilable(::String)).void }
+      def initialize(uuid: nil, status: nil, subscription_types: nil, url: nil)
+        @uuid = uuid
+        @status = status
+        @subscription_types = subscription_types
+        @url = url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # WebhookSubscriptionStatus - The status of the webhook subscription.
+    class WebhookSubscriptionStatus < T::Enum
+      enums do
+        PENDING = new('pending')
+        VERIFIED = new('verified')
+        REMOVED = new('removed')
+        UNREACHABLE = new('unreachable')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Representation of a wire in request
+    class WireInRequest < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Notes for the wire in request
+      field :additional_notes, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('additional_notes') } }
+      # Amount sent through wire in
+      field :amount_sent, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('amount_sent') } }
+      # Name of the bank initiating the wire in
+      field :bank_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('bank_name') } }
+      # Date the wire in was sent
+      field :date_sent, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('date_sent') } }
+      # Name of bank receiving the wire in
+      field :origination_bank, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('origination_bank') } }
+      # Address of bank receiving the wire in
+      field :origination_bank_address, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('origination_bank_address') } }
+      # Type of payment for the wire in
+      field :payment_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_type') } }
+      # Unique identifier of the payment
+      field :payment_uuid, T.nilable(::GustoEmbedded::Shared::PaymentUuid), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_uuid'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PaymentUuid, true) } }
+      # Recipient bank account number
+      field :recipient_account_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_account_number') } }
+      # Address of the recipient of the wire in
+      field :recipient_address, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_address') } }
+      # Name of the recipient of the wire In
+      field :recipient_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_name') } }
+      # Recipient bank routing number
+      field :recipient_routing_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_routing_number') } }
+      # Requested amount for the payment
+      field :requested_amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('requested_amount') } }
+      # Status of the wire in
+      field :status, T.nilable(::GustoEmbedded::Shared::WireInRequestStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::WireInRequestStatus, true) } }
+      # Include in note with bank to track payment
+      field :unique_tracking_code, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('unique_tracking_code') } }
+      # Unique identifier of a wire in request
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Deadline to submit the wire in
+      field :wire_in_deadline, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('wire_in_deadline') } }
+
+
+      sig { params(additional_notes: T.nilable(::String), amount_sent: T.nilable(::String), bank_name: T.nilable(::String), date_sent: T.nilable(::String), origination_bank: T.nilable(::String), origination_bank_address: T.nilable(::String), payment_type: T.nilable(::String), payment_uuid: T.nilable(::GustoEmbedded::Shared::PaymentUuid), recipient_account_number: T.nilable(::String), recipient_address: T.nilable(::String), recipient_name: T.nilable(::String), recipient_routing_number: T.nilable(::String), requested_amount: T.nilable(::String), status: T.nilable(::GustoEmbedded::Shared::WireInRequestStatus), unique_tracking_code: T.nilable(::String), uuid: T.nilable(::String), wire_in_deadline: T.nilable(::String)).void }
+      def initialize(additional_notes: nil, amount_sent: nil, bank_name: nil, date_sent: nil, origination_bank: nil, origination_bank_address: nil, payment_type: nil, payment_uuid: nil, recipient_account_number: nil, recipient_address: nil, recipient_name: nil, recipient_routing_number: nil, requested_amount: nil, status: nil, unique_tracking_code: nil, uuid: nil, wire_in_deadline: nil)
+        @additional_notes = additional_notes
+        @amount_sent = amount_sent
+        @bank_name = bank_name
+        @date_sent = date_sent
+        @origination_bank = origination_bank
+        @origination_bank_address = origination_bank_address
+        @payment_type = payment_type
+        @payment_uuid = payment_uuid
+        @recipient_account_number = recipient_account_number
+        @recipient_address = recipient_address
+        @recipient_name = recipient_name
+        @recipient_routing_number = recipient_routing_number
+        @requested_amount = requested_amount
+        @status = status
+        @unique_tracking_code = unique_tracking_code
+        @uuid = uuid
+        @wire_in_deadline = wire_in_deadline
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # WireInRequestStatus - Status of the wire in
+    class WireInRequestStatus < T::Enum
+      enums do
+        AWAITING_FUNDS = new('awaiting_funds')
+        PENDING_REVIEW = new('pending_review')
+        APPROVED = new('approved')
+        RFI = new('rfi')
+        CANCELED = new('canceled')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/work_address.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
+  
+
+    class WorkAddress < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Reference to a company location
+      field :location_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('location_uuid') } }
+
+
+      sig { params(location_uuid: T.nilable(::String)).void }
+      def initialize(location_uuid: nil)
+        @location_uuid = location_uuid
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/ytd_benefit_amounts_from_different_company.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
+  
+    # Ytd Benefit Amounts From Different Company
+    class YtdBenefitAmountsFromDifferentCompany < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The benefit type supported by Gusto. See [Benefit Types](https://docs.gusto.com/embedded-payroll/reference/get-v1-benefits) for more information.
+      field :benefit_type, ::Integer, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('benefit_type') } }
+      # The unique identifier for this benefit amount record.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The year-to-date company contribution made outside the current company.
+      field :ytd_company_contribution_amount, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('ytd_company_contribution_amount') } }
+      # The year-to-date employee deduction made outside the current company.
+      field :ytd_employee_deduction_amount, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('ytd_employee_deduction_amount') } }
+
+
+      sig { params(benefit_type: ::Integer, uuid: ::String, ytd_company_contribution_amount: ::String, ytd_employee_deduction_amount: ::String).void }
+      def initialize(benefit_type: nil, uuid: nil, ytd_company_contribution_amount: nil, ytd_employee_deduction_amount: nil)
+        @benefit_type = benefit_type
+        @uuid = uuid
+        @ytd_company_contribution_amount = ytd_company_contribution_amount
+        @ytd_employee_deduction_amount = ytd_employee_deduction_amount
+      end
+    end
+  end
+end