increase 0.3.3 → 1.0.0

data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundWireDrawdownRequests#create
+      class InboundWireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute amount
+        #   The amount being requested in cents.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute beneficiary_account_number
+        #   The drawdown request's beneficiary's account number.
+        #
+        #   @return [String]
+        required :beneficiary_account_number, String
+
+        # @!attribute beneficiary_routing_number
+        #   The drawdown request's beneficiary's routing number.
+        #
+        #   @return [String]
+        required :beneficiary_routing_number, String
+
+        # @!attribute currency
+        #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+        #   requested. Will always be "USD".
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute message_to_recipient
+        #   A message from the drawdown request's originator.
+        #
+        #   @return [String]
+        required :message_to_recipient, String
+
+        # @!attribute originator_account_number
+        #   The drawdown request's originator's account number.
+        #
+        #   @return [String]
+        required :originator_account_number, String
+
+        # @!attribute originator_routing_number
+        #   The drawdown request's originator's routing number.
+        #
+        #   @return [String]
+        required :originator_routing_number, String
+
+        # @!attribute recipient_account_number_id
+        #   The Account Number to which the recipient of this request is being requested to
+        #   send funds from.
+        #
+        #   @return [String]
+        required :recipient_account_number_id, String
+
+        # @!attribute beneficiary_address_line1
+        #   Line 1 of the drawdown request's beneficiary's address.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_address_line1, String
+
+        # @!attribute beneficiary_address_line2
+        #   Line 2 of the drawdown request's beneficiary's address.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_address_line2, String
+
+        # @!attribute beneficiary_address_line3
+        #   Line 3 of the drawdown request's beneficiary's address.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_address_line3, String
+
+        # @!attribute beneficiary_name
+        #   The drawdown request's beneficiary's name.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_name, String
+
+        # @!attribute originator_address_line1
+        #   Line 1 of the drawdown request's originator's address.
+        #
+        #   @return [String, nil]
+        optional :originator_address_line1, String
+
+        # @!attribute originator_address_line2
+        #   Line 2 of the drawdown request's originator's address.
+        #
+        #   @return [String, nil]
+        optional :originator_address_line2, String
+
+        # @!attribute originator_address_line3
+        #   Line 3 of the drawdown request's originator's address.
+        #
+        #   @return [String, nil]
+        optional :originator_address_line3, String
+
+        # @!attribute originator_name
+        #   The drawdown request's originator's name.
+        #
+        #   @return [String, nil]
+        optional :originator_name, String
+
+        # @!attribute originator_to_beneficiary_information_line1
+        #   Line 1 of the information conveyed from the originator of the message to the
+        #   beneficiary.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line1, String
+
+        # @!attribute originator_to_beneficiary_information_line2
+        #   Line 2 of the information conveyed from the originator of the message to the
+        #   beneficiary.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line2, String
+
+        # @!attribute originator_to_beneficiary_information_line3
+        #   Line 3 of the information conveyed from the originator of the message to the
+        #   beneficiary.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line3, String
+
+        # @!attribute originator_to_beneficiary_information_line4
+        #   Line 4 of the information conveyed from the originator of the message to the
+        #   beneficiary.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line4, String
+
+        # @!method initialize(amount:, beneficiary_account_number:, beneficiary_routing_number:, currency:, message_to_recipient:, originator_account_number:, originator_routing_number:, recipient_account_number_id:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundWireDrawdownRequestCreateParams} for more
+        #   details.
+        #
+        #   @param amount [Integer] The amount being requested in cents.
+        #
+        #   @param beneficiary_account_number [String] The drawdown request's beneficiary's account number.
+        #
+        #   @param beneficiary_routing_number [String] The drawdown request's beneficiary's routing number.
+        #
+        #   @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+        #
+        #   @param message_to_recipient [String] A message from the drawdown request's originator.
+        #
+        #   @param originator_account_number [String] The drawdown request's originator's account number.
+        #
+        #   @param originator_routing_number [String] The drawdown request's originator's routing number.
+        #
+        #   @param recipient_account_number_id [String] The Account Number to which the recipient of this request is being requested to
+        #
+        #   @param beneficiary_address_line1 [String] Line 1 of the drawdown request's beneficiary's address.
+        #
+        #   @param beneficiary_address_line2 [String] Line 2 of the drawdown request's beneficiary's address.
+        #
+        #   @param beneficiary_address_line3 [String] Line 3 of the drawdown request's beneficiary's address.
+        #
+        #   @param beneficiary_name [String] The drawdown request's beneficiary's name.
+        #
+        #   @param originator_address_line1 [String] Line 1 of the drawdown request's originator's address.
+        #
+        #   @param originator_address_line2 [String] Line 2 of the drawdown request's originator's address.
+        #
+        #   @param originator_address_line3 [String] Line 3 of the drawdown request's originator's address.
+        #
+        #   @param originator_name [String] The drawdown request's originator's name.
+        #
+        #   @param originator_to_beneficiary_information_line1 [String] Line 1 of the information conveyed from the originator of the message to the ben
+        #
+        #   @param originator_to_beneficiary_information_line2 [String] Line 2 of the information conveyed from the originator of the message to the ben
+        #
+        #   @param originator_to_beneficiary_information_line3 [String] Line 3 of the information conveyed from the originator of the message to the ben
+        #
+        #   @param originator_to_beneficiary_information_line4 [String] Line 4 of the information conveyed from the originator of the message to the ben
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundWireTransfers#create
+      class InboundWireTransferCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_number_id
+        #   The identifier of the Account Number the inbound Wire Transfer is for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute amount
+        #   The transfer amount in cents. Must be positive.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute beneficiary_address_line1
+        #   The sending bank will set beneficiary_address_line1 in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_address_line1, String
+
+        # @!attribute beneficiary_address_line2
+        #   The sending bank will set beneficiary_address_line2 in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_address_line2, String
+
+        # @!attribute beneficiary_address_line3
+        #   The sending bank will set beneficiary_address_line3 in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_address_line3, String
+
+        # @!attribute beneficiary_name
+        #   The sending bank will set beneficiary_name in production. You can simulate any
+        #   value here.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_name, String
+
+        # @!attribute beneficiary_reference
+        #   The sending bank will set beneficiary_reference in production. You can simulate
+        #   any value here.
+        #
+        #   @return [String, nil]
+        optional :beneficiary_reference, String
+
+        # @!attribute originator_address_line1
+        #   The sending bank will set originator_address_line1 in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_address_line1, String
+
+        # @!attribute originator_address_line2
+        #   The sending bank will set originator_address_line2 in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_address_line2, String
+
+        # @!attribute originator_address_line3
+        #   The sending bank will set originator_address_line3 in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_address_line3, String
+
+        # @!attribute originator_name
+        #   The sending bank will set originator_name in production. You can simulate any
+        #   value here.
+        #
+        #   @return [String, nil]
+        optional :originator_name, String
+
+        # @!attribute originator_routing_number
+        #   The sending bank will set originator_routing_number in production. You can
+        #   simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_routing_number, String
+
+        # @!attribute originator_to_beneficiary_information_line1
+        #   The sending bank will set originator_to_beneficiary_information_line1 in
+        #   production. You can simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line1, String
+
+        # @!attribute originator_to_beneficiary_information_line2
+        #   The sending bank will set originator_to_beneficiary_information_line2 in
+        #   production. You can simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line2, String
+
+        # @!attribute originator_to_beneficiary_information_line3
+        #   The sending bank will set originator_to_beneficiary_information_line3 in
+        #   production. You can simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line3, String
+
+        # @!attribute originator_to_beneficiary_information_line4
+        #   The sending bank will set originator_to_beneficiary_information_line4 in
+        #   production. You can simulate any value here.
+        #
+        #   @return [String, nil]
+        optional :originator_to_beneficiary_information_line4, String
+
+        # @!attribute sender_reference
+        #   The sending bank will set sender_reference in production. You can simulate any
+        #   value here.
+        #
+        #   @return [String, nil]
+        optional :sender_reference, String
+
+        # @!method initialize(account_number_id:, amount:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, beneficiary_reference: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_routing_number: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, sender_reference: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundWireTransferCreateParams} for more
+        #   details.
+        #
+        #   @param account_number_id [String] The identifier of the Account Number the inbound Wire Transfer is for.
+        #
+        #   @param amount [Integer] The transfer amount in cents. Must be positive.
+        #
+        #   @param beneficiary_address_line1 [String] The sending bank will set beneficiary_address_line1 in production. You can simul
+        #
+        #   @param beneficiary_address_line2 [String] The sending bank will set beneficiary_address_line2 in production. You can simul
+        #
+        #   @param beneficiary_address_line3 [String] The sending bank will set beneficiary_address_line3 in production. You can simul
+        #
+        #   @param beneficiary_name [String] The sending bank will set beneficiary_name in production. You can simulate any v
+        #
+        #   @param beneficiary_reference [String] The sending bank will set beneficiary_reference in production. You can simulate
+        #
+        #   @param originator_address_line1 [String] The sending bank will set originator_address_line1 in production. You can simula
+        #
+        #   @param originator_address_line2 [String] The sending bank will set originator_address_line2 in production. You can simula
+        #
+        #   @param originator_address_line3 [String] The sending bank will set originator_address_line3 in production. You can simula
+        #
+        #   @param originator_name [String] The sending bank will set originator_name in production. You can simulate any va
+        #
+        #   @param originator_routing_number [String] The sending bank will set originator_routing_number in production. You can simul
+        #
+        #   @param originator_to_beneficiary_information_line1 [String] The sending bank will set originator_to_beneficiary_information_line1 in product
+        #
+        #   @param originator_to_beneficiary_information_line2 [String] The sending bank will set originator_to_beneficiary_information_line2 in product
+        #
+        #   @param originator_to_beneficiary_information_line3 [String] The sending bank will set originator_to_beneficiary_information_line3 in product
+        #
+        #   @param originator_to_beneficiary_information_line4 [String] The sending bank will set originator_to_beneficiary_information_line4 in product
+        #
+        #   @param sender_reference [String] The sending bank will set sender_reference in production. You can simulate any v
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/interest_payment_create_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InterestPayments#create
+      class InterestPaymentCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The identifier of the Account the Interest Payment should be paid to is for.
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!attribute amount
+        #   The interest amount in cents. Must be positive.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute accrued_on_account_id
+        #   The identifier of the Account the Interest accrued on. Defaults to `account_id`.
+        #
+        #   @return [String, nil]
+        optional :accrued_on_account_id, String
+
+        # @!attribute period_end
+        #   The end of the interest period. If not provided, defaults to the current time.
+        #
+        #   @return [Time, nil]
+        optional :period_end, Time
+
+        # @!attribute period_start
+        #   The start of the interest period. If not provided, defaults to the current time.
+        #
+        #   @return [Time, nil]
+        optional :period_start, Time
+
+        # @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InterestPaymentCreateParams} for more details.
+        #
+        #   @param account_id [String] The identifier of the Account the Interest Payment should be paid to is for.
+        #
+        #   @param amount [Integer] The interest amount in cents. Must be positive.
+        #
+        #   @param accrued_on_account_id [String] The identifier of the Account the Interest accrued on. Defaults to `account_id`.
+        #
+        #   @param period_end [Time] The end of the interest period. If not provided, defaults to the current time.
+        #
+        #   @param period_start [Time] The start of the interest period. If not provided, defaults to the current time.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::PhysicalCards#advance_shipment
+      class PhysicalCardAdvanceShipmentParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute shipment_status
+        #   The shipment status to move the Physical Card to.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus]
+        required :shipment_status,
+                 enum: -> { Increase::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus }
+
+        # @!method initialize(shipment_status:, request_options: {})
+        #   @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] The shipment status to move the Physical Card to.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # The shipment status to move the Physical Card to.
+        module ShipmentStatus
+          extend Increase::Internal::Type::Enum
+
+          # The physical card has not yet been shipped.
+          PENDING = :pending
+
+          # The physical card shipment was canceled prior to submission.
+          CANCELED = :canceled
+
+          # The physical card shipment has been submitted to the card fulfillment provider.
+          SUBMITTED = :submitted
+
+          # The physical card shipment has been acknowledged by the card fulfillment provider and will be processed in their next batch.
+          ACKNOWLEDGED = :acknowledged
+
+          # The physical card shipment was rejected by the card printer due to an error.
+          REJECTED = :rejected
+
+          # The physical card has been shipped.
+          SHIPPED = :shipped
+
+          # The physical card shipment was returned to the sender and destroyed by the production facility.
+          RETURNED = :returned
+
+          # The physical card shipment requires attention from Increase before progressing.
+          REQUIRES_ATTENTION = :requires_attention
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/physical_card_tracking_updates_params.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::PhysicalCards#tracking_updates
+      class PhysicalCardTrackingUpdatesParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute category
+        #   The type of tracking event.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::PhysicalCardTrackingUpdatesParams::Category]
+        required :category, enum: -> { Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category }
+
+        # @!attribute carrier_estimated_delivery_at
+        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
+        #   carrier expects the card to be delivered.
+        #
+        #   @return [Time, nil]
+        optional :carrier_estimated_delivery_at, Time
+
+        # @!attribute city
+        #   The city where the event took place.
+        #
+        #   @return [String, nil]
+        optional :city, String
+
+        # @!attribute postal_code
+        #   The postal code where the event took place.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String
+
+        # @!attribute state
+        #   The state where the event took place.
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!method initialize(category:, carrier_estimated_delivery_at: nil, city: nil, postal_code: nil, state: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::PhysicalCardTrackingUpdatesParams} for more
+        #   details.
+        #
+        #   @param category [Symbol, Increase::Models::Simulations::PhysicalCardTrackingUpdatesParams::Category] The type of tracking event.
+        #
+        #   @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
+        #
+        #   @param city [String] The city where the event took place.
+        #
+        #   @param postal_code [String] The postal code where the event took place.
+        #
+        #   @param state [String] The state where the event took place.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # The type of tracking event.
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          # The physical card is in transit.
+          IN_TRANSIT = :in_transit
+
+          # The physical card has been processed for delivery.
+          PROCESSED_FOR_DELIVERY = :processed_for_delivery
+
+          # The physical card has been delivered.
+          DELIVERED = :delivered
+
+          # Delivery failed and the physical card was returned to sender.
+          RETURNED_TO_SENDER = :returned_to_sender
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/program_create_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::Programs#create
+      class ProgramCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #   The name of the program being added.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute reserve_account_id
+        #   The identifier of the Account the Program should be added to is for.
+        #
+        #   @return [String, nil]
+        optional :reserve_account_id, String
+
+        # @!method initialize(name:, reserve_account_id: nil, request_options: {})
+        #   @param name [String] The name of the program being added.
+        #
+        #   @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end