finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/models/sandbox/individual_update_response.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class IndividualUpdateResponse < FinchAPI::BaseModel
+        # @!attribute [r] id
+        #   A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :id
+
+        # @!attribute dob
+        #
+        #   @return [String, nil]
+        optional :dob, String, nil?: true
+
+        # @!attribute emails
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email>, nil]
+        optional :emails,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email] },
+                 nil?: true
+
+        # @!attribute encrypted_ssn
+        #   Social Security Number of the individual in **encrypted** format. This field is
+        #     only available with the `ssn` scope enabled and the
+        #     `options: { include: ['ssn'] }` param set in the body.
+        #
+        #   @return [String, nil]
+        optional :encrypted_ssn, String, nil?: true
+
+        # @!attribute ethnicity
+        #   The EEOC-defined ethnicity of the individual.
+        #
+        #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity, nil]
+        optional :ethnicity,
+                 enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity },
+                 nil?: true
+
+        # @!attribute first_name
+        #   The legal first name of the individual.
+        #
+        #   @return [String, nil]
+        optional :first_name, String, nil?: true
+
+        # @!attribute gender
+        #   The gender of the individual.
+        #
+        #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender, nil]
+        optional :gender, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender }, nil?: true
+
+        # @!attribute last_name
+        #   The legal last name of the individual.
+        #
+        #   @return [String, nil]
+        optional :last_name, String, nil?: true
+
+        # @!attribute middle_name
+        #   The legal middle name of the individual.
+        #
+        #   @return [String, nil]
+        optional :middle_name, String, nil?: true
+
+        # @!attribute phone_numbers
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, nil>, nil]
+        optional :phone_numbers,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, nil?: true] },
+                 nil?: true
+
+        # @!attribute preferred_name
+        #   The preferred name of the individual.
+        #
+        #   @return [String, nil]
+        optional :preferred_name, String, nil?: true
+
+        # @!attribute residence
+        #
+        #   @return [FinchAPI::Models::Location, nil]
+        optional :residence, -> { FinchAPI::Models::Location }, nil?: true
+
+        # @!attribute ssn
+        #   Social Security Number of the individual. This field is only available with the
+        #     `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+        #     body.
+        #     [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
+        #
+        #   @return [String, nil]
+        optional :ssn, String, nil?: true
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param dob [String, nil]
+        #   # @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email>, nil]
+        #   # @param encrypted_ssn [String, nil]
+        #   # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity, nil]
+        #   # @param first_name [String, nil]
+        #   # @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender, nil]
+        #   # @param last_name [String, nil]
+        #   # @param middle_name [String, nil]
+        #   # @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, nil>, nil]
+        #   # @param preferred_name [String, nil]
+        #   # @param residence [FinchAPI::Models::Location, nil]
+        #   # @param ssn [String, nil]
+        #   #
+        #   def initialize(
+        #     id: nil,
+        #     dob: nil,
+        #     emails: nil,
+        #     encrypted_ssn: nil,
+        #     ethnicity: nil,
+        #     first_name: nil,
+        #     gender: nil,
+        #     last_name: nil,
+        #     middle_name: nil,
+        #     phone_numbers: nil,
+        #     preferred_name: nil,
+        #     residence: nil,
+        #     ssn: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Email < FinchAPI::BaseModel
+          # @!attribute [r] data
+          #
+          #   @return [String, nil]
+          optional :data, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :data
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type, nil]
+          optional :type, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type }, nil?: true
+
+          # @!parse
+          #   # @param data [String]
+          #   # @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type, nil]
+          #   #
+          #   def initialize(data: nil, type: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :work
+          #   # ...
+          # in :personal
+          #   # ...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            WORK = :work
+            PERSONAL = :personal
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # The EEOC-defined ethnicity of the individual.
+        #
+        # @example
+        # ```ruby
+        # case ethnicity
+        # in :asian
+        #   # ...
+        # in :white
+        #   # ...
+        # in :black_or_african_american
+        #   # ...
+        # in :native_hawaiian_or_pacific_islander
+        #   # ...
+        # in :american_indian_or_alaska_native
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class Ethnicity < FinchAPI::Enum
+          ASIAN = :asian
+          WHITE = :white
+          BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american
+          NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander
+          AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native
+          HISPANIC_OR_LATINO = :hispanic_or_latino
+          TWO_OR_MORE_RACES = :two_or_more_races
+          DECLINE_TO_SPECIFY = :decline_to_specify
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # The gender of the individual.
+        #
+        # @example
+        # ```ruby
+        # case gender
+        # in :female
+        #   # ...
+        # in :male
+        #   # ...
+        # in :other
+        #   # ...
+        # in :decline_to_specify
+        #   # ...
+        # end
+        # ```
+        class Gender < FinchAPI::Enum
+          FEMALE = :female
+          MALE = :male
+          OTHER = :other
+          DECLINE_TO_SPECIFY = :decline_to_specify
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        class PhoneNumber < FinchAPI::BaseModel
+          # @!attribute [r] data
+          #
+          #   @return [String, nil]
+          optional :data, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :data
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type, nil]
+          optional :type,
+                   enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type },
+                   nil?: true
+
+          # @!parse
+          #   # @param data [String]
+          #   # @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type, nil]
+          #   #
+          #   def initialize(data: nil, type: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :work
+          #   # ...
+          # in :personal
+          #   # ...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            WORK = :work
+            PERSONAL = :personal
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/job_create_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class JobCreateParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute type
+        #   The type of job to start. Currently the only supported type is `data_sync_all`
+        #
+        #   @return [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type]
+        required :type, enum: -> { FinchAPI::Models::Sandbox::JobCreateParams::Type }
+
+        # @!parse
+        #   # @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(type:, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # The type of job to start. Currently the only supported type is `data_sync_all`
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :data_sync_all
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          DATA_SYNC_ALL = :data_sync_all
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/job_create_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class JobCreateResponse < FinchAPI::BaseModel
+        # @!attribute allowed_refreshes
+        #   The number of allowed refreshes per hour (per hour, fixed window)
+        #
+        #   @return [Integer]
+        required :allowed_refreshes, Integer
+
+        # @!attribute job_id
+        #   The id of the job that has been created.
+        #
+        #   @return [String]
+        required :job_id, String
+
+        # @!attribute job_url
+        #   The url that can be used to retrieve the job status
+        #
+        #   @return [String]
+        required :job_url, String
+
+        # @!attribute remaining_refreshes
+        #   The number of remaining refreshes available (per hour, fixed window)
+        #
+        #   @return [Integer]
+        required :remaining_refreshes, Integer
+
+        # @!parse
+        #   # @param allowed_refreshes [Integer]
+        #   # @param job_id [String]
+        #   # @param job_url [String]
+        #   # @param remaining_refreshes [Integer]
+        #   #
+        #   def initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        class ConfigurationRetrieveParams < FinchAPI::BaseModel
+          # @!parse
+          #   extend FinchAPI::RequestParameters::Converter
+          include FinchAPI::RequestParameters
+
+          # @!parse
+          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(request_options: {}, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        ConfigurationRetrieveResponse = FinchAPI::ArrayOf[-> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration }]
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/jobs/configuration_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        class ConfigurationUpdateParams < FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration
+          # @!parse
+          #   extend FinchAPI::RequestParameters::Converter
+          include FinchAPI::RequestParameters
+
+          # @!parse
+          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(request_options: {}, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        class SandboxJobConfiguration < FinchAPI::BaseModel
+          # @!attribute completion_status
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          required :completion_status,
+                   enum: -> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
+          required :type, enum: -> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type }
+
+          # @!parse
+          #   # @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          #   # @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
+          #   #
+          #   def initialize(completion_status:, type:, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case completion_status
+          # in :complete
+          #   # ...
+          # in :reauth_error
+          #   # ...
+          # in :permissions_error
+          #   # ...
+          # in :error
+          #   # ...
+          # end
+          # ```
+          class CompletionStatus < FinchAPI::Enum
+            COMPLETE = :complete
+            REAUTH_ERROR = :reauth_error
+            PERMISSIONS_ERROR = :permissions_error
+            ERROR = :error
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :data_sync_all
+          #   # ...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            DATA_SYNC_ALL = :data_sync_all
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end