fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/reports/client.rb

@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "types/reports_create_request_columns_item"
+require_relative "types/reports_create_request_groupings_item"
+require_relative "types/reports_create_request_file_type"
+require_relative "types/reports_create_request_payment_method"
+require_relative "types/reports_create_request_employment_type"
+require_relative "types/reports_create_request_employment_status"
+require_relative "../types/create_report"
+require_relative "../types/report"
+require_relative "../types/report_template"
+require "async"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class ReportsClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::ReportsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Create a custom report for a company. This endpoint initiates creating a custom
+#  report with custom columns, groupings, and filters. The `request_uuid` in the
+#  response can then be used to poll for the status and report URL upon completion
+#  using the report GET endpoint.
+#  scope: `company_reports:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param columns [Array<Gusto::Reports::ReportsCreateRequestColumnsItem>] Columns to include in the report
+    # @param groupings [Array<Gusto::Reports::ReportsCreateRequestGroupingsItem>] How to group the report
+    # @param custom_name [String] The title of the report
+    # @param file_type [Gusto::Reports::ReportsCreateRequestFileType] The type of file to generate
+    # @param with_totals [Boolean] Whether to include subtotals and grand totals in the report
+    # @param start_date [String] Start date of data to filter by
+    # @param end_date [String] End date of data to filter by
+    # @param dismissed_start_date [String] Dismissed start date of employees to filter by
+    # @param dismissed_end_date [String] Dismissed end date of employees to filter by
+    # @param payment_method [Gusto::Reports::ReportsCreateRequestPaymentMethod] Payment method to filter by
+    # @param employment_type [Gusto::Reports::ReportsCreateRequestEmploymentType] Employee employment type to filter by
+    # @param employment_status [Gusto::Reports::ReportsCreateRequestEmploymentStatus] Employee employment status to filter by
+    # @param employee_uuids [Array<String>] Employees to filter by
+    # @param department_uuids [Array<String>] Departments to filter by
+    # @param work_address_uuids [Array<String>] Work addresses to filter by
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::CreateReport]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.reports.create(
+#    company_uuid: "company_uuid",
+#    columns: [BANK_ACCOUNT_ACCOUNT_NUMBER],
+#    groupings: [PAYROLL],
+#    file_type: CSV
+#  )
+    def create(company_uuid:, columns:, groupings:, custom_name: nil, file_type:, with_totals: nil, start_date: nil, end_date: nil, dismissed_start_date: nil, dismissed_end_date: nil, payment_method: nil, employment_type: nil, employment_status: nil, employee_uuids: nil, department_uuids: nil, work_address_uuids: nil, request_options: nil)
+      response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), columns: columns, groupings: groupings, custom_name: custom_name, file_type: file_type, with_totals: with_totals, start_date: start_date, end_date: end_date, dismissed_start_date: dismissed_start_date, dismissed_end_date: dismissed_end_date, payment_method: payment_method, employment_type: employment_type, employment_status: employment_status, employee_uuids: employee_uuids, department_uuids: department_uuids, work_address_uuids: work_address_uuids }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/reports"
+end
+      Gusto::CreateReport.from_json(json_object: response.body)
+    end
+# Get a company's report given the `request_uuid`. The response will include the
+#  report request's status and, if complete, the report URL.
+#  scope: `company_reports:read`
+    #
+    # @param report_uuid [String] The UUID of the report request
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Report]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.reports.get(report_uuid: "report_uuid")
+    def get(report_uuid:, request_options: nil)
+      response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/reports/#{report_uuid}"
+end
+      Gusto::Report.from_json(json_object: response.body)
+    end
+# Get a company's report template. The only supported report type is
+#  `payroll_journal`. The resulting columns and groupings from this endpoint can be
+#  used as a guidance to create the report using the POST create report endpoint.
+#  scope: `company_reports:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param report_type [String] The report type
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::ReportTemplate]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.reports.get_template(company_uuid: "company_uuid", report_type: "report_type")
+    def get_template(company_uuid:, report_type:, request_options: nil)
+      response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/report_templates/#{report_type}"
+end
+      Gusto::ReportTemplate.from_json(json_object: response.body)
+    end
+  end
+  class AsyncReportsClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncReportsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Create a custom report for a company. This endpoint initiates creating a custom
+#  report with custom columns, groupings, and filters. The `request_uuid` in the
+#  response can then be used to poll for the status and report URL upon completion
+#  using the report GET endpoint.
+#  scope: `company_reports:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param columns [Array<Gusto::Reports::ReportsCreateRequestColumnsItem>] Columns to include in the report
+    # @param groupings [Array<Gusto::Reports::ReportsCreateRequestGroupingsItem>] How to group the report
+    # @param custom_name [String] The title of the report
+    # @param file_type [Gusto::Reports::ReportsCreateRequestFileType] The type of file to generate
+    # @param with_totals [Boolean] Whether to include subtotals and grand totals in the report
+    # @param start_date [String] Start date of data to filter by
+    # @param end_date [String] End date of data to filter by
+    # @param dismissed_start_date [String] Dismissed start date of employees to filter by
+    # @param dismissed_end_date [String] Dismissed end date of employees to filter by
+    # @param payment_method [Gusto::Reports::ReportsCreateRequestPaymentMethod] Payment method to filter by
+    # @param employment_type [Gusto::Reports::ReportsCreateRequestEmploymentType] Employee employment type to filter by
+    # @param employment_status [Gusto::Reports::ReportsCreateRequestEmploymentStatus] Employee employment status to filter by
+    # @param employee_uuids [Array<String>] Employees to filter by
+    # @param department_uuids [Array<String>] Departments to filter by
+    # @param work_address_uuids [Array<String>] Work addresses to filter by
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::CreateReport]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.reports.create(
+#    company_uuid: "company_uuid",
+#    columns: [BANK_ACCOUNT_ACCOUNT_NUMBER],
+#    groupings: [PAYROLL],
+#    file_type: CSV
+#  )
+    def create(company_uuid:, columns:, groupings:, custom_name: nil, file_type:, with_totals: nil, start_date: nil, end_date: nil, dismissed_start_date: nil, dismissed_end_date: nil, payment_method: nil, employment_type: nil, employment_status: nil, employee_uuids: nil, department_uuids: nil, work_address_uuids: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), columns: columns, groupings: groupings, custom_name: custom_name, file_type: file_type, with_totals: with_totals, start_date: start_date, end_date: end_date, dismissed_start_date: dismissed_start_date, dismissed_end_date: dismissed_end_date, payment_method: payment_method, employment_type: employment_type, employment_status: employment_status, employee_uuids: employee_uuids, department_uuids: department_uuids, work_address_uuids: work_address_uuids }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/reports"
+end
+        Gusto::CreateReport.from_json(json_object: response.body)
+      end
+    end
+# Get a company's report given the `request_uuid`. The response will include the
+#  report request's status and, if complete, the report URL.
+#  scope: `company_reports:read`
+    #
+    # @param report_uuid [String] The UUID of the report request
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Report]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.reports.get(report_uuid: "report_uuid")
+    def get(report_uuid:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/reports/#{report_uuid}"
+end
+        Gusto::Report.from_json(json_object: response.body)
+      end
+    end
+# Get a company's report template. The only supported report type is
+#  `payroll_journal`. The resulting columns and groupings from this endpoint can be
+#  used as a guidance to create the report using the POST create report endpoint.
+#  scope: `company_reports:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param report_type [String] The report type
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::ReportTemplate]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.reports.get_template(company_uuid: "company_uuid", report_type: "report_type")
+    def get_template(company_uuid:, report_type:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/report_templates/#{report_type}"
+end
+        Gusto::ReportTemplate.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/fern_gusto/reports/types/reports_create_request_columns_item.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Reports
+    class ReportsCreateRequestColumnsItem
+
+      BANK_ACCOUNT_ACCOUNT_NUMBER = "bank_account_account_number"
+      BANK_ACCOUNT_ROUTING_NUMBER = "bank_account_routing_number"
+      BANK_ACCOUNT_TYPE = "bank_account_type"
+      BANK_ACCOUNT = "bank_account"
+      BONUS = "bonus"
+      CASH_TIPS = "cash_tips"
+      CHECK_AMOUNT = "check_amount"
+      CHECK_DATE = "check_date"
+      COMMISSION = "commission"
+      DATE_OF_BIRTH = "date_of_birth"
+      DOUBLE_OVERTIME_EARNINGS = "double_overtime_earnings"
+      DOUBLE_OVERTIME_HOURS = "double_overtime_hours"
+      DOUBLE_OVERTIME_RATE = "double_overtime_rate"
+      EMPLOYEE_ADDITIONAL_TAXES = "employee_additional_taxes"
+      EMPLOYEE_BENEFIT_CONTRIBUTIONS = "employee_benefit_contributions"
+      EMPLOYEE_COMPENSATION_TIME_PERIOD = "employee_compensation_time_period"
+      EMPLOYEE_COMPENSATION = "employee_compensation"
+      EMPLOYEE_DEDUCTIONS = "employee_deductions"
+      EMPLOYEE_DEPARTMENT = "employee_department"
+      EMPLOYEE_EMAIL = "employee_email"
+      EMPLOYEE_FEDERAL_INCOME_TAX = "employee_federal_income_tax"
+      EMPLOYEE_FIRST_NAME = "employee_first_name"
+      EMPLOYEE_LAST_NAME = "employee_last_name"
+      EMPLOYEE_MIDDLE_INITIAL = "employee_middle_initial"
+      EMPLOYEE_MEDICARE_ADDITIONAL_TAX = "employee_medicare_additional_tax"
+      EMPLOYEE_MEDICARE_TAX = "employee_medicare_tax"
+      EMPLOYEE_PHONE_NUMBER = "employee_phone_number"
+      EMPLOYEE_SOCIAL_SECURITY_TAX = "employee_social_security_tax"
+      EMPLOYEE_TAXES = "employee_taxes"
+      EMPLOYEE_WORK_EMAIL = "employee_work_email"
+      EMPLOYER_ADDITIONAL_TAXES = "employer_additional_taxes"
+      EMPLOYER_BENEFIT_CONTRIBUTIONS = "employer_benefit_contributions"
+      EMPLOYER_COST = "employer_cost"
+      EMPLOYER_FUTA_TAX = "employer_futa_tax"
+      EMPLOYER_MEDICARE_TAX = "employer_medicare_tax"
+      EMPLOYER_SOCIAL_SECURITY_TAX = "employer_social_security_tax"
+      EMPLOYER_SUTA_TAX = "employer_suta_tax"
+      EMPLOYER_TAXES = "employer_taxes"
+      EMPLOYMENT_TYPE = "employment_type"
+      EMPLOYMENT = "employment"
+      END_DATE = "end_date"
+      GARNISHMENTS = "garnishments"
+      GROSS_EARNINGS = "gross_earnings"
+      HOLIDAY_EARNINGS = "holiday_earnings"
+      HOLIDAY_HOURS = "holiday_hours"
+      HOME_ADDRESS_CITY = "home_address_city"
+      HOME_ADDRESS_STATE = "home_address_state"
+      HOME_ADDRESS_STREET = "home_address_street"
+      HOME_ADDRESS_ZIP = "home_address_zip"
+      HOME_ADDRESS = "home_address"
+      JOB_TITLE = "job_title"
+      NET_PAY = "net_pay"
+      ONE_TIME_REIMBURSEMENTS = "one_time_reimbursements"
+      OVERTIME_EARNINGS = "overtime_earnings"
+      OVERTIME_HOURS = "overtime_hours"
+      OVERTIME_RATE = "overtime_rate"
+      PAID_TIME_OFF_EARNINGS = "paid_time_off_earnings"
+      PAID_TIME_OFF_HOURS = "paid_time_off_hours"
+      PAID_TIME_OFF_RATE = "paid_time_off_rate"
+      PAY_PERIOD_END = "pay_period_end"
+      PAY_PERIOD_START = "pay_period_start"
+      PAYCHECK_TIPS = "paycheck_tips"
+      PAYMENT_METHOD = "payment_method"
+      PAYROLL_TYPE = "payroll_type"
+      PREFERRED_FIRST_NAME = "preferred_first_name"
+      RECURRING_REIMBURSEMENTS = "recurring_reimbursements"
+      REGULAR_EARNINGS = "regular_earnings"
+      REGULAR_HOURS = "regular_hours"
+      REGULAR_RATE = "regular_rate"
+      REIMBURSEMENTS = "reimbursements"
+      RISK_CLASS_CODE = "risk_class_code"
+      SICK_RATE = "sick_rate"
+      SICK_TIME_OFF_EARNINGS = "sick_time_off_earnings"
+      SICK_TIME_OFF_HOURS = "sick_time_off_hours"
+      START_DATE = "start_date"
+      TOTAL_EMPLOYER_BENEFIT_CONTRIBUTIONS = "total_employer_benefit_contributions"
+      TOTAL_TIME_OFF_EARNINGS = "total_time_off_earnings"
+      TOTAL_TIME_OFF_HOURS = "total_time_off_hours"
+      WORK_ADDRESS_CITY = "work_address_city"
+      WORK_ADDRESS_STREET = "work_address_street"
+      WORK_ADDRESS_ZIP = "work_address_zip"
+
+    end
+  end
+end

data/lib/fern_gusto/reports/types/reports_create_request_employment_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Reports
+# Employee employment status to filter by
+    class ReportsCreateRequestEmploymentStatus
+
+      ACTIVE_FULL_TIME = "active_full_time"
+      ACTIVE_PART_TIME = "active_part_time"
+      ACTIVE_PART_TIME_ELIGIBLE = "active_part_time_eligible"
+      ACTIVE_VARIABLE = "active_variable"
+      ACTIVE_SEASONAL = "active_seasonal"
+      ACTIVE = "active"
+      DISMISSED = "dismissed"
+
+    end
+  end
+end

data/lib/fern_gusto/reports/types/reports_create_request_employment_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Reports
+# Employee employment type to filter by
+    class ReportsCreateRequestEmploymentType
+
+      EXEMPT = "exempt"
+      SALARIED_NONEXEMPT = "salaried_nonexempt"
+      NONEXEMPT = "nonexempt"
+      COMMISSION_ONLY_EXEMPT = "commission_only_exempt"
+      COMMISSION_ONLY_NONEXEMPT = "commission_only_nonexempt"
+
+    end
+  end
+end

data/lib/fern_gusto/reports/types/reports_create_request_file_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Reports
+# The type of file to generate
+    class ReportsCreateRequestFileType
+
+      CSV = "csv"
+      JSON_ = "json"
+
+    end
+  end
+end

data/lib/fern_gusto/reports/types/reports_create_request_groupings_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Reports
+    class ReportsCreateRequestGroupingsItem
+
+      PAYROLL = "payroll"
+      EMPLOYEE = "employee"
+      WORK_ADDRESS = "work_address"
+      WORK_ADDRESS_STATE = "work_address_state"
+
+    end
+  end
+end

data/lib/fern_gusto/reports/types/reports_create_request_payment_method.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Reports
+# Payment method to filter by
+    class ReportsCreateRequestPaymentMethod
+
+      CHECK = "check"
+      DIRECT_DEPOSIT = "direct_deposit"
+
+    end
+  end
+end

data/lib/fern_gusto/signatories/types/signatory.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+require_relative "signatory_identity_verification_status"
+require_relative "signatory_home_address"
+require "ostruct"
+require "json"
+
+module Gusto
+  module Signatories
+# The representation of a company's signatory
+    class Signatory
+    # @return [String] 
+      attr_reader :uuid
+    # @return [String] 
+      attr_reader :first_name
+    # @return [String] 
+      attr_reader :last_name
+    # @return [String] 
+      attr_reader :title
+    # @return [String] 
+      attr_reader :phone
+    # @return [String] 
+      attr_reader :email
+    # @return [String] 
+      attr_reader :birthday
+    # @return [Boolean] Whether or not the signatory is also the payroll admin of the company.
+      attr_reader :is_admin
+    # @return [Boolean] Indicates whether the signatory has an SSN in Gusto.
+      attr_reader :has_ssn
+    # @return [String] The current version of the signatory. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information
+#  on how to use this field.
+      attr_reader :version
+    # @return [Gusto::Signatories::SignatoryIdentityVerificationStatus] |            |
+#  |
+#  | ---------- |
+#  --------------------------------------------------------------------------------
+#  |
+#  | **Status** | **Description**
+#  |
+#  | Pass       | Signatory can sign all forms
+#  |
+#  | Fail       | Signatory cannot sign forms
+#  |
+#  | Skipped    | Signatory cannot sign Form 8655 until the form is manually
+#  uploaded as wet-signed |
+#  | null       | Identity verification process has not been completed
+#  |
+      attr_reader :identity_verification_status
+    # @return [Gusto::Signatories::SignatoryHomeAddress] 
+      attr_reader :home_address
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param uuid [String] 
+      # @param first_name [String] 
+      # @param last_name [String] 
+      # @param title [String] 
+      # @param phone [String] 
+      # @param email [String] 
+      # @param birthday [String] 
+      # @param is_admin [Boolean] Whether or not the signatory is also the payroll admin of the company.
+      # @param has_ssn [Boolean] Indicates whether the signatory has an SSN in Gusto.
+      # @param version [String] The current version of the signatory. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information
+#  on how to use this field.
+      # @param identity_verification_status [Gusto::Signatories::SignatoryIdentityVerificationStatus] |            |
+#  |
+#  | ---------- |
+#  --------------------------------------------------------------------------------
+#  |
+#  | **Status** | **Description**
+#  |
+#  | Pass       | Signatory can sign all forms
+#  |
+#  | Fail       | Signatory cannot sign forms
+#  |
+#  | Skipped    | Signatory cannot sign Form 8655 until the form is manually
+#  uploaded as wet-signed |
+#  | null       | Identity verification process has not been completed
+#  |
+      # @param home_address [Gusto::Signatories::SignatoryHomeAddress] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Signatories::Signatory]
+      def initialize(uuid:, first_name: OMIT, last_name: OMIT, title: OMIT, phone: OMIT, email: OMIT, birthday: OMIT, is_admin: OMIT, has_ssn: OMIT, version: OMIT, identity_verification_status: OMIT, home_address: OMIT, additional_properties: nil)
+        @uuid = uuid
+        @first_name = first_name if first_name != OMIT
+        @last_name = last_name if last_name != OMIT
+        @title = title if title != OMIT
+        @phone = phone if phone != OMIT
+        @email = email if email != OMIT
+        @birthday = birthday if birthday != OMIT
+        @is_admin = is_admin if is_admin != OMIT
+        @has_ssn = has_ssn if has_ssn != OMIT
+        @version = version if version != OMIT
+        @identity_verification_status = identity_verification_status if identity_verification_status != OMIT
+        @home_address = home_address if home_address != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "uuid": uuid, "first_name": first_name, "last_name": last_name, "title": title, "phone": phone, "email": email, "birthday": birthday, "is_admin": is_admin, "has_ssn": has_ssn, "version": version, "identity_verification_status": identity_verification_status, "home_address": home_address }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of Signatory
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Signatories::Signatory]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        uuid = parsed_json["uuid"]
+        first_name = parsed_json["first_name"]
+        last_name = parsed_json["last_name"]
+        title = parsed_json["title"]
+        phone = parsed_json["phone"]
+        email = parsed_json["email"]
+        birthday = parsed_json["birthday"]
+        is_admin = parsed_json["is_admin"]
+        has_ssn = parsed_json["has_ssn"]
+        version = parsed_json["version"]
+        identity_verification_status = parsed_json["identity_verification_status"]
+        unless parsed_json["home_address"].nil?
+          home_address = parsed_json["home_address"].to_json
+          home_address = Gusto::Signatories::SignatoryHomeAddress.from_json(json_object: home_address)
+        else
+          home_address = nil
+        end
+        new(
+          uuid: uuid,
+          first_name: first_name,
+          last_name: last_name,
+          title: title,
+          phone: phone,
+          email: email,
+          birthday: birthday,
+          is_admin: is_admin,
+          has_ssn: has_ssn,
+          version: version,
+          identity_verification_status: identity_verification_status,
+          home_address: home_address,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of Signatory to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+      #
+      # @param obj [Object] 
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.uuid.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
+        obj.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
+        obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
+        obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.phone&.is_a?(String) != false || raise("Passed value for field obj.phone is not the expected type, validation failed.")
+        obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+        obj.birthday&.is_a?(String) != false || raise("Passed value for field obj.birthday is not the expected type, validation failed.")
+        obj.is_admin&.is_a?(Boolean) != false || raise("Passed value for field obj.is_admin is not the expected type, validation failed.")
+        obj.has_ssn&.is_a?(Boolean) != false || raise("Passed value for field obj.has_ssn is not the expected type, validation failed.")
+        obj.version&.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
+        obj.identity_verification_status&.is_a?(Gusto::Signatories::SignatoryIdentityVerificationStatus) != false || raise("Passed value for field obj.identity_verification_status is not the expected type, validation failed.")
+        obj.home_address.nil? || Gusto::Signatories::SignatoryHomeAddress.validate_raw(obj: obj.home_address)
+      end
+    end
+  end
+end