increase 1.249.0 → 1.250.0

data/rbi/increase/models/entity_beneficial_owner.rbi

@@ -21,6 +21,12 @@ module Increase
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The idempotency key you chose for this object. This value is unique across
+      # Increase and is used to ensure that a request is only processed once. Learn more
+      # about [idempotency](https://increase.com/documentation/idempotency-keys).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :idempotency_key
+
       # Personal details for the beneficial owner.
       sig { returns(Increase::EntityBeneficialOwner::Individual) }
       attr_reader :individual
@@ -53,6 +59,7 @@ module Increase
           id: String,
           company_title: T.nilable(String),
           created_at: Time,
+          idempotency_key: T.nilable(String),
           individual: Increase::EntityBeneficialOwner::Individual::OrHash,
           prongs: T::Array[Increase::EntityBeneficialOwner::Prong::OrSymbol],
           type: Increase::EntityBeneficialOwner::Type::OrSymbol
@@ -66,6 +73,10 @@ module Increase
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
         # Beneficial Owner was created.
         created_at:,
+        # The idempotency key you chose for this object. This value is unique across
+        # Increase and is used to ensure that a request is only processed once. Learn more
+        # about [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key:,
         # Personal details for the beneficial owner.
         individual:,
         # Why this person is considered a beneficial owner of the entity.
@@ -82,6 +93,7 @@ module Increase
             id: String,
             company_title: T.nilable(String),
             created_at: Time,
+            idempotency_key: T.nilable(String),
             individual: Increase::EntityBeneficialOwner::Individual,
             prongs:
               T::Array[Increase::EntityBeneficialOwner::Prong::TaggedSymbol],

data/rbi/increase/models.rbi

@@ -71,6 +71,8 @@ module Increase
 
   BeneficialOwnerArchiveParams = Increase::Models::BeneficialOwnerArchiveParams
 
+  BeneficialOwnerCreateParams = Increase::Models::BeneficialOwnerCreateParams
+
   BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
 
   BeneficialOwnerRetrieveParams =

data/rbi/increase/resources/beneficial_owners.rbi

@@ -3,6 +3,32 @@
 module Increase
   module Resources
     class BeneficialOwners
+      # Create a beneficial owner
+      sig do
+        params(
+          entity_id: String,
+          individual: Increase::BeneficialOwnerCreateParams::Individual::OrHash,
+          prongs:
+            T::Array[Increase::BeneficialOwnerCreateParams::Prong::OrSymbol],
+          company_title: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityBeneficialOwner)
+      end
+      def create(
+        # The identifier of the Entity to associate with the new Beneficial Owner.
+        entity_id:,
+        # Personal details for the beneficial owner.
+        individual:,
+        # Why this person is considered a beneficial owner of the entity. At least one
+        # option is required, if a person is both a control person and owner, submit an
+        # array containing both.
+        prongs:,
+        # This person's role or title within the entity.
+        company_title: nil,
+        request_options: {}
+      )
+      end
+
       # Retrieve a Beneficial Owner
       sig do
         params(

data/sig/increase/models/beneficial_owner_create_params.rbs

@@ -0,0 +1,319 @@
+module Increase
+  module Models
+    type beneficial_owner_create_params =
+      {
+        entity_id: String,
+        individual: Increase::BeneficialOwnerCreateParams::Individual,
+        prongs: ::Array[Increase::Models::BeneficialOwnerCreateParams::prong],
+        company_title: String
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class BeneficialOwnerCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor entity_id: String
+
+      attr_accessor individual: Increase::BeneficialOwnerCreateParams::Individual
+
+      attr_accessor prongs: ::Array[Increase::Models::BeneficialOwnerCreateParams::prong]
+
+      attr_reader company_title: String?
+
+      def company_title=: (String) -> String
+
+      def initialize: (
+        entity_id: String,
+        individual: Increase::BeneficialOwnerCreateParams::Individual,
+        prongs: ::Array[Increase::Models::BeneficialOwnerCreateParams::prong],
+        ?company_title: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        entity_id: String,
+        individual: Increase::BeneficialOwnerCreateParams::Individual,
+        prongs: ::Array[Increase::Models::BeneficialOwnerCreateParams::prong],
+        company_title: String,
+        request_options: Increase::RequestOptions
+      }
+
+      type individual =
+        {
+          address: Increase::BeneficialOwnerCreateParams::Individual::Address,
+          date_of_birth: Date,
+          identification: Increase::BeneficialOwnerCreateParams::Individual::Identification,
+          name: String,
+          confirmed_no_us_tax_id: bool
+        }
+
+      class Individual < Increase::Internal::Type::BaseModel
+        attr_accessor address: Increase::BeneficialOwnerCreateParams::Individual::Address
+
+        attr_accessor date_of_birth: Date
+
+        attr_accessor identification: Increase::BeneficialOwnerCreateParams::Individual::Identification
+
+        attr_accessor name: String
+
+        attr_reader confirmed_no_us_tax_id: bool?
+
+        def confirmed_no_us_tax_id=: (bool) -> bool
+
+        def initialize: (
+          address: Increase::BeneficialOwnerCreateParams::Individual::Address,
+          date_of_birth: Date,
+          identification: Increase::BeneficialOwnerCreateParams::Individual::Identification,
+          name: String,
+          ?confirmed_no_us_tax_id: bool
+        ) -> void
+
+        def to_hash: -> {
+          address: Increase::BeneficialOwnerCreateParams::Individual::Address,
+          date_of_birth: Date,
+          identification: Increase::BeneficialOwnerCreateParams::Individual::Identification,
+          name: String,
+          confirmed_no_us_tax_id: bool
+        }
+
+        type address =
+          {
+            city: String,
+            country: String,
+            :line1 => String,
+            :line2 => String,
+            state: String,
+            zip: String
+          }
+
+        class Address < Increase::Internal::Type::BaseModel
+          attr_accessor city: String
+
+          attr_accessor country: String
+
+          attr_accessor line1: String
+
+          attr_reader line2: String?
+
+          def line2=: (String) -> String
+
+          attr_reader state: String?
+
+          def state=: (String) -> String
+
+          attr_reader zip: String?
+
+          def zip=: (String) -> String
+
+          def initialize: (
+            city: String,
+            country: String,
+            line1: String,
+            ?line2: String,
+            ?state: String,
+            ?zip: String
+          ) -> void
+
+          def to_hash: -> {
+            city: String,
+            country: String,
+            :line1 => String,
+            :line2 => String,
+            state: String,
+            zip: String
+          }
+        end
+
+        type identification =
+          {
+            method_: Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::method_,
+            number: String,
+            drivers_license: Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense,
+            other: Increase::BeneficialOwnerCreateParams::Individual::Identification::Other,
+            passport: Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport
+          }
+
+        class Identification < Increase::Internal::Type::BaseModel
+          attr_accessor method_: Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::method_
+
+          attr_accessor number: String
+
+          attr_reader drivers_license: Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense?
+
+          def drivers_license=: (
+            Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense
+          ) -> Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense
+
+          attr_reader other: Increase::BeneficialOwnerCreateParams::Individual::Identification::Other?
+
+          def other=: (
+            Increase::BeneficialOwnerCreateParams::Individual::Identification::Other
+          ) -> Increase::BeneficialOwnerCreateParams::Individual::Identification::Other
+
+          attr_reader passport: Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport?
+
+          def passport=: (
+            Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport
+          ) -> Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport
+
+          def initialize: (
+            method_: Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::method_,
+            number: String,
+            ?drivers_license: Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense,
+            ?other: Increase::BeneficialOwnerCreateParams::Individual::Identification::Other,
+            ?passport: Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport
+          ) -> void
+
+          def to_hash: -> {
+            method_: Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::method_,
+            number: String,
+            drivers_license: Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense,
+            other: Increase::BeneficialOwnerCreateParams::Individual::Identification::Other,
+            passport: Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport
+          }
+
+          type method_ =
+            :social_security_number
+            | :individual_taxpayer_identification_number
+            | :passport
+            | :drivers_license
+            | :other
+
+          module Method
+            extend Increase::Internal::Type::Enum
+
+            # A social security number.
+            SOCIAL_SECURITY_NUMBER: :social_security_number
+
+            # An individual taxpayer identification number (ITIN).
+            INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER: :individual_taxpayer_identification_number
+
+            # A passport number.
+            PASSPORT: :passport
+
+            # A driver's license number.
+            DRIVERS_LICENSE: :drivers_license
+
+            # Another identifying document.
+            OTHER: :other
+
+            def self?.values: -> ::Array[Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::method_]
+          end
+
+          type drivers_license =
+            {
+              expiration_date: Date,
+              file_id: String,
+              state: String,
+              back_file_id: String
+            }
+
+          class DriversLicense < Increase::Internal::Type::BaseModel
+            attr_accessor expiration_date: Date
+
+            attr_accessor file_id: String
+
+            attr_accessor state: String
+
+            attr_reader back_file_id: String?
+
+            def back_file_id=: (String) -> String
+
+            def initialize: (
+              expiration_date: Date,
+              file_id: String,
+              state: String,
+              ?back_file_id: String
+            ) -> void
+
+            def to_hash: -> {
+              expiration_date: Date,
+              file_id: String,
+              state: String,
+              back_file_id: String
+            }
+          end
+
+          type other =
+            {
+              country: String,
+              description: String,
+              file_id: String,
+              back_file_id: String,
+              expiration_date: Date
+            }
+
+          class Other < Increase::Internal::Type::BaseModel
+            attr_accessor country: String
+
+            attr_accessor description: String
+
+            attr_accessor file_id: String
+
+            attr_reader back_file_id: String?
+
+            def back_file_id=: (String) -> String
+
+            attr_reader expiration_date: Date?
+
+            def expiration_date=: (Date) -> Date
+
+            def initialize: (
+              country: String,
+              description: String,
+              file_id: String,
+              ?back_file_id: String,
+              ?expiration_date: Date
+            ) -> void
+
+            def to_hash: -> {
+              country: String,
+              description: String,
+              file_id: String,
+              back_file_id: String,
+              expiration_date: Date
+            }
+          end
+
+          type passport =
+            { country: String, expiration_date: Date, file_id: String }
+
+          class Passport < Increase::Internal::Type::BaseModel
+            attr_accessor country: String
+
+            attr_accessor expiration_date: Date
+
+            attr_accessor file_id: String
+
+            def initialize: (
+              country: String,
+              expiration_date: Date,
+              file_id: String
+            ) -> void
+
+            def to_hash: -> {
+              country: String,
+              expiration_date: Date,
+              file_id: String
+            }
+          end
+        end
+      end
+
+      type prong = :ownership | :control
+
+      module Prong
+        extend Increase::Internal::Type::Enum
+
+        # A person with 25% or greater direct or indirect ownership of the entity.
+        OWNERSHIP: :ownership
+
+        # A person who manages, directs, or has significant control of the entity.
+        CONTROL: :control
+
+        def self?.values: -> ::Array[Increase::Models::BeneficialOwnerCreateParams::prong]
+      end
+    end
+  end
+end

data/sig/increase/models/entity_beneficial_owner.rbs

@@ -5,6 +5,7 @@ module Increase
         id: String,
         company_title: String?,
         created_at: Time,
+        idempotency_key: String?,
         individual: Increase::EntityBeneficialOwner::Individual,
         prongs: ::Array[Increase::Models::EntityBeneficialOwner::prong],
         type: Increase::Models::EntityBeneficialOwner::type_
@@ -17,6 +18,8 @@ module Increase
 
       attr_accessor created_at: Time
 
+      attr_accessor idempotency_key: String?
+
       attr_accessor individual: Increase::EntityBeneficialOwner::Individual
 
       attr_accessor prongs: ::Array[Increase::Models::EntityBeneficialOwner::prong]
@@ -27,6 +30,7 @@ module Increase
         id: String,
         company_title: String?,
         created_at: Time,
+        idempotency_key: String?,
         individual: Increase::EntityBeneficialOwner::Individual,
         prongs: ::Array[Increase::Models::EntityBeneficialOwner::prong],
         type: Increase::Models::EntityBeneficialOwner::type_
@@ -36,6 +40,7 @@ module Increase
         id: String,
         company_title: String?,
         created_at: Time,
+        idempotency_key: String?,
         individual: Increase::EntityBeneficialOwner::Individual,
         prongs: ::Array[Increase::Models::EntityBeneficialOwner::prong],
         type: Increase::Models::EntityBeneficialOwner::type_

data/sig/increase/models.rbs

@@ -65,6 +65,8 @@ module Increase
 
   class BeneficialOwnerArchiveParams = Increase::Models::BeneficialOwnerArchiveParams
 
+  class BeneficialOwnerCreateParams = Increase::Models::BeneficialOwnerCreateParams
+
   class BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
 
   class BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams

data/sig/increase/resources/beneficial_owners.rbs

@@ -1,6 +1,14 @@
 module Increase
   module Resources
     class BeneficialOwners
+      def create: (
+        entity_id: String,
+        individual: Increase::BeneficialOwnerCreateParams::Individual,
+        prongs: ::Array[Increase::Models::BeneficialOwnerCreateParams::prong],
+        ?company_title: String,
+        ?request_options: Increase::request_opts
+      ) -> Increase::EntityBeneficialOwner
+
       def retrieve: (
         String entity_beneficial_owner_id,
         ?request_options: Increase::request_opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.249.0
+  version: 1.250.0
 platform: ruby
 authors:
 - Increase
@@ -117,6 +117,7 @@ files:
 - lib/increase/models/ach_transfer_retrieve_params.rb
 - lib/increase/models/balance_lookup.rb
 - lib/increase/models/beneficial_owner_archive_params.rb
+- lib/increase/models/beneficial_owner_create_params.rb
 - lib/increase/models/beneficial_owner_list_params.rb
 - lib/increase/models/beneficial_owner_retrieve_params.rb
 - lib/increase/models/beneficial_owner_update_params.rb
@@ -532,6 +533,7 @@ files:
 - rbi/increase/models/ach_transfer_retrieve_params.rbi
 - rbi/increase/models/balance_lookup.rbi
 - rbi/increase/models/beneficial_owner_archive_params.rbi
+- rbi/increase/models/beneficial_owner_create_params.rbi
 - rbi/increase/models/beneficial_owner_list_params.rbi
 - rbi/increase/models/beneficial_owner_retrieve_params.rbi
 - rbi/increase/models/beneficial_owner_update_params.rbi
@@ -946,6 +948,7 @@ files:
 - sig/increase/models/ach_transfer_retrieve_params.rbs
 - sig/increase/models/balance_lookup.rbs
 - sig/increase/models/beneficial_owner_archive_params.rbs
+- sig/increase/models/beneficial_owner_create_params.rbs
 - sig/increase/models/beneficial_owner_list_params.rbs
 - sig/increase/models/beneficial_owner_retrieve_params.rbs
 - sig/increase/models/beneficial_owner_update_params.rbs