finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.13

data/lib/finch_api/models/sandbox/individual_update_params.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Individual#update
+      class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute dob
+        #
+        #   @return [String, nil]
+        optional :dob, String, nil?: true
+
+        # @!attribute emails
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
+        optional :emails,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateParams::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::IndividualUpdateParams::Ethnicity, nil]
+        optional :ethnicity, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::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::IndividualUpdateParams::Gender, nil]
+        optional :gender, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::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::IndividualUpdateParams::PhoneNumber, nil>, nil]
+        optional :phone_numbers,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateParams::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
+
+        # @!method initialize(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, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Sandbox::IndividualUpdateParams} for more details.
+        #
+        #   @param dob [String, nil]
+        #
+        #   @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
+        #
+        #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
+        #   ...
+        #
+        #   @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+        #
+        #   @param first_name [String, nil] The legal first name of the individual.
+        #
+        #   @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
+        #
+        #   @param last_name [String, nil] The legal last name of the individual.
+        #
+        #   @param middle_name [String, nil] The legal middle name of the individual.
+        #
+        #   @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
+        #
+        #   @param preferred_name [String, nil] The preferred name of the individual.
+        #
+        #   @param residence [FinchAPI::Models::Location, nil]
+        #
+        #   @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
+        #   ...
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        class Email < FinchAPI::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [String, nil]
+          optional :data, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil]
+          optional :type, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type }, nil?: true
+
+          # @!method initialize(data: nil, type: nil)
+          #   @param data [String]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil]
+
+          # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::Email#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            WORK = :work
+            PERSONAL = :personal
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The EEOC-defined ethnicity of the individual.
+        module Ethnicity
+          extend FinchAPI::Internal::Type::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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The gender of the individual.
+        module Gender
+          extend FinchAPI::Internal::Type::Enum
+
+          FEMALE = :female
+          MALE = :male
+          OTHER = :other
+          DECLINE_TO_SPECIFY = :decline_to_specify
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class PhoneNumber < FinchAPI::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [String, nil]
+          optional :data, String, nil?: true
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
+          optional :type,
+                   enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type },
+                   nil?: true
+
+          # @!method initialize(data: nil, type: nil)
+          #   @param data [String, nil]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
+
+          # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            WORK = :work
+            PERSONAL = :personal
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/individual_update_response.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Individual#update
+      class IndividualUpdateResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute dob
+        #
+        #   @return [String, nil]
+        optional :dob, String, nil?: true
+
+        # @!attribute emails
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email>, nil]
+        optional :emails,
+                 -> { FinchAPI::Internal::Type::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::Internal::Type::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
+
+        # @!method 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)
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Sandbox::IndividualUpdateResponse} for more details.
+        #
+        #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @param dob [String, nil]
+        #
+        #   @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email>, nil]
+        #
+        #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
+        #   ...
+        #
+        #   @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+        #
+        #   @param first_name [String, nil] The legal first name of the individual.
+        #
+        #   @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender, nil] The gender of the individual.
+        #
+        #   @param last_name [String, nil] The legal last name of the individual.
+        #
+        #   @param middle_name [String, nil] The legal middle name of the individual.
+        #
+        #   @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, nil>, nil]
+        #
+        #   @param preferred_name [String, nil] The preferred name of the individual.
+        #
+        #   @param residence [FinchAPI::Models::Location, nil]
+        #
+        #   @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
+        #   ...
+
+        class Email < FinchAPI::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [String, nil]
+          optional :data, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type, nil]
+          optional :type, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type }, nil?: true
+
+          # @!method initialize(data: nil, type: nil)
+          #   @param data [String]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type, nil]
+
+          # @see FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            WORK = :work
+            PERSONAL = :personal
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The EEOC-defined ethnicity of the individual.
+        #
+        # @see FinchAPI::Models::Sandbox::IndividualUpdateResponse#ethnicity
+        module Ethnicity
+          extend FinchAPI::Internal::Type::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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The gender of the individual.
+        #
+        # @see FinchAPI::Models::Sandbox::IndividualUpdateResponse#gender
+        module Gender
+          extend FinchAPI::Internal::Type::Enum
+
+          FEMALE = :female
+          MALE = :male
+          OTHER = :other
+          DECLINE_TO_SPECIFY = :decline_to_specify
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class PhoneNumber < FinchAPI::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [String, nil]
+          optional :data, String, nil?: true
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type, nil]
+          optional :type,
+                   enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type },
+                   nil?: true
+
+          # @!method initialize(data: nil, type: nil)
+          #   @param data [String, nil]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type, nil]
+
+          # @see FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            WORK = :work
+            PERSONAL = :personal
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/job_create_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Jobs#create
+      class JobCreateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::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 }
+
+        # @!method initialize(type:, request_options: {})
+        #   @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The type of job to start. Currently the only supported type is `data_sync_all`
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          DATA_SYNC_ALL = :data_sync_all
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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
+      # @see FinchAPI::Resources::Sandbox::Jobs#create
+      class JobCreateResponse < FinchAPI::Internal::Type::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
+
+        # @!method initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:)
+        #   @param allowed_refreshes [Integer] The number of allowed refreshes per hour (per hour, fixed window)
+        #
+        #   @param job_id [String] The id of the job that has been created.
+        #
+        #   @param job_url [String] The url that can be used to retrieve the job status
+        #
+        #   @param remaining_refreshes [Integer] The number of remaining refreshes available (per hour, fixed window)
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/jobs/configuration_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        # @see FinchAPI::Resources::Sandbox::Jobs::Configuration#retrieve
+        class ConfigurationRetrieveParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb

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

data/lib/finch_api/models/sandbox/jobs/configuration_update_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        # @see FinchAPI::Resources::Sandbox::Jobs::Configuration#update
+        class ConfigurationUpdateParams < FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Jobs
+        # @see FinchAPI::Resources::Sandbox::Jobs::Configuration#update
+        class SandboxJobConfiguration < FinchAPI::Internal::Type::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 }
+
+          # @!method initialize(completion_status:, type:)
+          #   @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
+
+          # @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#completion_status
+          module CompletionStatus
+            extend FinchAPI::Internal::Type::Enum
+
+            COMPLETE = :complete
+            REAUTH_ERROR = :reauth_error
+            PERMISSIONS_ERROR = :permissions_error
+            ERROR = :error
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            DATA_SYNC_ALL = :data_sync_all
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end