increase 0.3.3 → 1.0.0

data/lib/increase/models/bookkeeping_entry_set_create_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingEntrySets#create
+    class BookkeepingEntrySetCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute entries
+      #   The bookkeeping entries.
+      #
+      #   @return [Array<Increase::Models::BookkeepingEntrySetCreateParams::Entry>]
+      required :entries,
+               -> { Increase::Internal::Type::ArrayOf[Increase::BookkeepingEntrySetCreateParams::Entry] }
+
+      # @!attribute date
+      #   The date of the transaction. Optional if `transaction_id` is provided, in which
+      #   case we use the `date` of that transaction. Required otherwise.
+      #
+      #   @return [Time, nil]
+      optional :date, Time
+
+      # @!attribute transaction_id
+      #   The identifier of the Transaction related to this entry set, if any.
+      #
+      #   @return [String, nil]
+      optional :transaction_id, String
+
+      # @!method initialize(entries:, date: nil, transaction_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BookkeepingEntrySetCreateParams} for more details.
+      #
+      #   @param entries [Array<Increase::Models::BookkeepingEntrySetCreateParams::Entry>] The bookkeeping entries.
+      #
+      #   @param date [Time] The date of the transaction. Optional if `transaction_id` is provided, in which
+      #
+      #   @param transaction_id [String] The identifier of the Transaction related to this entry set, if any.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Entry < Increase::Internal::Type::BaseModel
+        # @!attribute account_id
+        #   The identifier for the Bookkeeping Account impacted by this entry.
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!attribute amount
+        #   The entry amount in the minor unit of the account currency. For dollars, for
+        #   example, this is cents. Debit entries have positive amounts; credit entries have
+        #   negative amounts.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!method initialize(account_id:, amount:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::BookkeepingEntrySetCreateParams::Entry} for more details.
+        #
+        #   @param account_id [String] The identifier for the Bookkeeping Account impacted by this entry.
+        #
+        #   @param amount [Integer] The entry amount in the minor unit of the account currency. For dollars, for exa
+      end
+    end
+  end
+end

data/lib/increase/models/bookkeeping_entry_set_list_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingEntrySets#list
+    class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute idempotency_key
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that 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).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute transaction_id
+      #   Filter to the Bookkeeping Entry Set that maps to this Transaction.
+      #
+      #   @return [String, nil]
+      optional :transaction_id, String
+
+      # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BookkeepingEntrySetListParams} for more details.
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param transaction_id [String] Filter to the Bookkeeping Entry Set that maps to this Transaction.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb

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

data/lib/increase/models/card.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Cards#create
+    class Card < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The card identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The identifier for the account this card belongs to.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute billing_address
+      #   The Card's billing address.
+      #
+      #   @return [Increase::Models::Card::BillingAddress]
+      required :billing_address, -> { Increase::Card::BillingAddress }
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the Card was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The card's description for display purposes.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute digital_wallet
+      #   The contact information used in the two-factor steps for digital wallet card
+      #   creation. At least one field must be present to complete the digital wallet
+      #   steps.
+      #
+      #   @return [Increase::Models::Card::DigitalWallet, nil]
+      required :digital_wallet, -> { Increase::Card::DigitalWallet }, nil?: true
+
+      # @!attribute entity_id
+      #   The identifier for the entity associated with this card.
+      #
+      #   @return [String, nil]
+      required :entity_id, String, nil?: true
+
+      # @!attribute expiration_month
+      #   The month the card expires in M format (e.g., August is 8).
+      #
+      #   @return [Integer]
+      required :expiration_month, Integer
+
+      # @!attribute expiration_year
+      #   The year the card expires in YYYY format (e.g., 2025).
+      #
+      #   @return [Integer]
+      required :expiration_year, Integer
+
+      # @!attribute idempotency_key
+      #   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).
+      #
+      #   @return [String, nil]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute last4
+      #   The last 4 digits of the Card's Primary Account Number.
+      #
+      #   @return [String]
+      required :last4, String
+
+      # @!attribute status
+      #   This indicates if payments can be made with the card.
+      #
+      #   @return [Symbol, Increase::Models::Card::Status]
+      required :status, enum: -> { Increase::Card::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `card`.
+      #
+      #   @return [Symbol, Increase::Models::Card::Type]
+      required :type, enum: -> { Increase::Card::Type }
+
+      # @!method initialize(id:, account_id:, billing_address:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
+      #   Some parameter documentations has been truncated, see {Increase::Models::Card}
+      #   for more details.
+      #
+      #   Cards are commercial credit cards. They'll immediately work for online purchases
+      #   after you create them. All cards maintain a credit limit of 100% of the
+      #   Account’s available balance at the time of transaction. Funds are deducted from
+      #   the Account upon transaction settlement.
+      #
+      #   @param id [String] The card identifier.
+      #
+      #   @param account_id [String] The identifier for the account this card belongs to.
+      #
+      #   @param billing_address [Increase::Models::Card::BillingAddress] The Card's billing address.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param description [String, nil] The card's description for display purposes.
+      #
+      #   @param digital_wallet [Increase::Models::Card::DigitalWallet, nil] The contact information used in the two-factor steps for digital wallet card cre
+      #
+      #   @param entity_id [String, nil] The identifier for the entity associated with this card.
+      #
+      #   @param expiration_month [Integer] The month the card expires in M format (e.g., August is 8).
+      #
+      #   @param expiration_year [Integer] The year the card expires in YYYY format (e.g., 2025).
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param last4 [String] The last 4 digits of the Card's Primary Account Number.
+      #
+      #   @param status [Symbol, Increase::Models::Card::Status] This indicates if payments can be made with the card.
+      #
+      #   @param type [Symbol, Increase::Models::Card::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::Card#billing_address
+      class BillingAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the billing address.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute line1
+        #   The first line of the billing address.
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #   The second line of the billing address.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the billing address.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute state
+        #   The US state of the billing address.
+        #
+        #   @return [String, nil]
+        required :state, String, nil?: true
+
+        # @!method initialize(city:, line1:, line2:, postal_code:, state:)
+        #   The Card's billing address.
+        #
+        #   @param city [String, nil] The city of the billing address.
+        #
+        #   @param line1 [String, nil] The first line of the billing address.
+        #
+        #   @param line2 [String, nil] The second line of the billing address.
+        #
+        #   @param postal_code [String, nil] The postal code of the billing address.
+        #
+        #   @param state [String, nil] The US state of the billing address.
+      end
+
+      # @see Increase::Models::Card#digital_wallet
+      class DigitalWallet < Increase::Internal::Type::BaseModel
+        # @!attribute digital_card_profile_id
+        #   The digital card profile assigned to this digital card. Card profiles may also
+        #   be assigned at the program level.
+        #
+        #   @return [String, nil]
+        required :digital_card_profile_id, String, nil?: true
+
+        # @!attribute email
+        #   An email address that can be used to verify the cardholder via one-time passcode
+        #   over email.
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute phone
+        #   A phone number that can be used to verify the cardholder via one-time passcode
+        #   over SMS.
+        #
+        #   @return [String, nil]
+        required :phone, String, nil?: true
+
+        # @!method initialize(digital_card_profile_id:, email:, phone:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Card::DigitalWallet} for more details.
+        #
+        #   The contact information used in the two-factor steps for digital wallet card
+        #   creation. At least one field must be present to complete the digital wallet
+        #   steps.
+        #
+        #   @param digital_card_profile_id [String, nil] The digital card profile assigned to this digital card. Card profiles may also b
+        #
+        #   @param email [String, nil] An email address that can be used to verify the cardholder via one-time passcode
+        #
+        #   @param phone [String, nil] A phone number that can be used to verify the cardholder via one-time passcode o
+      end
+
+      # This indicates if payments can be made with the card.
+      #
+      # @see Increase::Models::Card#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The card is active.
+        ACTIVE = :active
+
+        # The card is temporarily disabled.
+        DISABLED = :disabled
+
+        # The card is permanently canceled.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card`.
+      #
+      # @see Increase::Models::Card#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD = :card
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/card_create_params.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Cards#create
+    class CardCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The Account the card should belong to.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute billing_address
+      #   The card's billing address.
+      #
+      #   @return [Increase::Models::CardCreateParams::BillingAddress, nil]
+      optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }
+
+      # @!attribute description
+      #   The description you choose to give the card.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute digital_wallet
+      #   The contact information used in the two-factor steps for digital wallet card
+      #   creation. To add the card to a digital wallet, you may supply an email or phone
+      #   number with this request. Otherwise, subscribe and then action a Real Time
+      #   Decision with the category `digital_wallet_token_requested` or
+      #   `digital_wallet_authentication_requested`.
+      #
+      #   @return [Increase::Models::CardCreateParams::DigitalWallet, nil]
+      optional :digital_wallet, -> { Increase::CardCreateParams::DigitalWallet }
+
+      # @!attribute entity_id
+      #   The Entity the card belongs to. You only need to supply this in rare situations
+      #   when the card is not for the Account holder.
+      #
+      #   @return [String, nil]
+      optional :entity_id, String
+
+      # @!method initialize(account_id:, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardCreateParams} for more details.
+      #
+      #   @param account_id [String] The Account the card should belong to.
+      #
+      #   @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
+      #
+      #   @param description [String] The description you choose to give the card.
+      #
+      #   @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre
+      #
+      #   @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class BillingAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the billing address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute line1
+        #   The first line of the billing address.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute postal_code
+        #   The postal code of the billing address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute state
+        #   The US state of the billing address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute line2
+        #   The second line of the billing address.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!method initialize(city:, line1:, postal_code:, state:, line2: nil)
+        #   The card's billing address.
+        #
+        #   @param city [String] The city of the billing address.
+        #
+        #   @param line1 [String] The first line of the billing address.
+        #
+        #   @param postal_code [String] The postal code of the billing address.
+        #
+        #   @param state [String] The US state of the billing address.
+        #
+        #   @param line2 [String] The second line of the billing address.
+      end
+
+      class DigitalWallet < Increase::Internal::Type::BaseModel
+        # @!attribute digital_card_profile_id
+        #   The digital card profile assigned to this digital card.
+        #
+        #   @return [String, nil]
+        optional :digital_card_profile_id, String
+
+        # @!attribute email
+        #   An email address that can be used to contact and verify the cardholder via
+        #   one-time passcode over email.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute phone
+        #   A phone number that can be used to contact and verify the cardholder via
+        #   one-time passcode over SMS.
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CardCreateParams::DigitalWallet} for more details.
+        #
+        #   The contact information used in the two-factor steps for digital wallet card
+        #   creation. To add the card to a digital wallet, you may supply an email or phone
+        #   number with this request. Otherwise, subscribe and then action a Real Time
+        #   Decision with the category `digital_wallet_token_requested` or
+        #   `digital_wallet_authentication_requested`.
+        #
+        #   @param digital_card_profile_id [String] The digital card profile assigned to this digital card.
+        #
+        #   @param email [String] An email address that can be used to contact and verify the cardholder via one-t
+        #
+        #   @param phone [String] A phone number that can be used to contact and verify the cardholder via one-tim
+      end
+    end
+  end
+end

data/lib/increase/models/card_details.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Cards#details
+    class CardDetails < Increase::Internal::Type::BaseModel
+      # @!attribute card_id
+      #   The identifier for the Card for which sensitive details have been returned.
+      #
+      #   @return [String]
+      required :card_id, String
+
+      # @!attribute expiration_month
+      #   The month the card expires in M format (e.g., August is 8).
+      #
+      #   @return [Integer]
+      required :expiration_month, Integer
+
+      # @!attribute expiration_year
+      #   The year the card expires in YYYY format (e.g., 2025).
+      #
+      #   @return [Integer]
+      required :expiration_year, Integer
+
+      # @!attribute primary_account_number
+      #   The card number.
+      #
+      #   @return [String]
+      required :primary_account_number, String
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `card_details`.
+      #
+      #   @return [Symbol, Increase::Models::CardDetails::Type]
+      required :type, enum: -> { Increase::CardDetails::Type }
+
+      # @!attribute verification_code
+      #   The three-digit verification code for the card. It's also known as the Card
+      #   Verification Code (CVC), the Card Verification Value (CVV), or the Card
+      #   Identification (CID).
+      #
+      #   @return [String]
+      required :verification_code, String
+
+      # @!method initialize(card_id:, expiration_month:, expiration_year:, primary_account_number:, type:, verification_code:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardDetails} for more details.
+      #
+      #   An object containing the sensitive details (card number, cvc, etc) for a Card.
+      #
+      #   @param card_id [String] The identifier for the Card for which sensitive details have been returned.
+      #
+      #   @param expiration_month [Integer] The month the card expires in M format (e.g., August is 8).
+      #
+      #   @param expiration_year [Integer] The year the card expires in YYYY format (e.g., 2025).
+      #
+      #   @param primary_account_number [String] The card number.
+      #
+      #   @param type [Symbol, Increase::Models::CardDetails::Type] A constant representing the object's type. For this resource it will always be `
+      #
+      #   @param verification_code [String] The three-digit verification code for the card. It's also known as the Card Veri
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card_details`.
+      #
+      # @see Increase::Models::CardDetails#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD_DETAILS = :card_details
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/card_details_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Cards#details
+    class CardDetailsParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end