increase 0.3.2 → 1.0.0

data/lib/increase/models/declined_transaction_list_params.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DeclinedTransactions#list
+    class DeclinedTransactionListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Declined Transactions to ones belonging to the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute category
+      #
+      #   @return [Increase::Models::DeclinedTransactionListParams::Category, nil]
+      optional :category, -> { Increase::DeclinedTransactionListParams::Category }
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::DeclinedTransactionListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::DeclinedTransactionListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, 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 route_id
+      #   Filter Declined Transactions to those belonging to the specified route.
+      #
+      #   @return [String, nil]
+      optional :route_id, String
+
+      # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::DeclinedTransactionListParams} for more details.
+      #
+      #   @param account_id [String] Filter Declined Transactions to ones belonging to the specified Account.
+      #
+      #   @param category [Increase::Models::DeclinedTransactionListParams::Category]
+      #
+      #   @param created_at [Increase::Models::DeclinedTransactionListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param route_id [String] Filter Declined Transactions to those belonging to the specified route.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Category < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Return results whose value is in the provided list. For GET requests, this
+        #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::DeclinedTransactionListParams::Category::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::DeclinedTransactionListParams::Category::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::DeclinedTransactionListParams::Category} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::DeclinedTransactionListParams::Category::In>] Return results whose value is in the provided list. For GET requests, this shoul
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # ACH Decline: details will be under the `ach_decline` object.
+          ACH_DECLINE = :ach_decline
+
+          # Card Decline: details will be under the `card_decline` object.
+          CARD_DECLINE = :card_decline
+
+          # Check Decline: details will be under the `check_decline` object.
+          CHECK_DECLINE = :check_decline
+
+          # Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.
+          INBOUND_REAL_TIME_PAYMENTS_TRANSFER_DECLINE = :inbound_real_time_payments_transfer_decline
+
+          # Wire Decline: details will be under the `wire_decline` object.
+          WIRE_DECLINE = :wire_decline
+
+          # Check Deposit Rejection: details will be under the `check_deposit_rejection` object.
+          CHECK_DEPOSIT_REJECTION = :check_deposit_rejection
+
+          # The Declined Transaction was made for an undocumented or deprecated reason.
+          OTHER = :other
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::DeclinedTransactionListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+    end
+  end
+end

data/lib/increase/models/declined_transaction_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DeclinedTransactions#retrieve
+    class DeclinedTransactionRetrieveParams < 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/digital_card_profile.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalCardProfiles#create
+    class DigitalCardProfile < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Card Profile identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute app_icon_file_id
+      #   The identifier of the File containing the card's icon image.
+      #
+      #   @return [String]
+      required :app_icon_file_id, String
+
+      # @!attribute background_image_file_id
+      #   The identifier of the File containing the card's front image.
+      #
+      #   @return [String]
+      required :background_image_file_id, String
+
+      # @!attribute card_description
+      #   A user-facing description for the card itself.
+      #
+      #   @return [String]
+      required :card_description, String
+
+      # @!attribute contact_email
+      #   An email address the user can contact to receive support for their card.
+      #
+      #   @return [String, nil]
+      required :contact_email, String, nil?: true
+
+      # @!attribute contact_phone
+      #   A phone number the user can contact to receive support for their card.
+      #
+      #   @return [String, nil]
+      required :contact_phone, String, nil?: true
+
+      # @!attribute contact_website
+      #   A website the user can visit to view and receive support for their card.
+      #
+      #   @return [String, nil]
+      required :contact_website, String, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the Card Dispute was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   A description you can use to identify the Card Profile.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!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 issuer_name
+      #   A user-facing description for whoever is issuing the card.
+      #
+      #   @return [String]
+      required :issuer_name, String
+
+      # @!attribute status
+      #   The status of the Card Profile.
+      #
+      #   @return [Symbol, Increase::Models::DigitalCardProfile::Status]
+      required :status, enum: -> { Increase::DigitalCardProfile::Status }
+
+      # @!attribute text_color
+      #   The Card's text color, specified as an RGB triple.
+      #
+      #   @return [Increase::Models::DigitalCardProfile::TextColor]
+      required :text_color, -> { Increase::DigitalCardProfile::TextColor }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `digital_card_profile`.
+      #
+      #   @return [Symbol, Increase::Models::DigitalCardProfile::Type]
+      required :type, enum: -> { Increase::DigitalCardProfile::Type }
+
+      # @!method initialize(id:, app_icon_file_id:, background_image_file_id:, card_description:, contact_email:, contact_phone:, contact_website:, created_at:, description:, idempotency_key:, issuer_name:, status:, text_color:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::DigitalCardProfile} for more details.
+      #
+      #   This contains artwork and metadata relating to a Card's appearance in digital
+      #   wallet apps like Apple Pay and Google Pay. For more information, see our guide
+      #   on [digital card artwork](https://increase.com/documentation/card-art).
+      #
+      #   @param id [String] The Card Profile identifier.
+      #
+      #   @param app_icon_file_id [String] The identifier of the File containing the card's icon image.
+      #
+      #   @param background_image_file_id [String] The identifier of the File containing the card's front image.
+      #
+      #   @param card_description [String] A user-facing description for the card itself.
+      #
+      #   @param contact_email [String, nil] An email address the user can contact to receive support for their card.
+      #
+      #   @param contact_phone [String, nil] A phone number the user can contact to receive support for their card.
+      #
+      #   @param contact_website [String, nil] A website the user can visit to view and receive support for their card.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param description [String] A description you can use to identify the Card Profile.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param issuer_name [String] A user-facing description for whoever is issuing the card.
+      #
+      #   @param status [Symbol, Increase::Models::DigitalCardProfile::Status] The status of the Card Profile.
+      #
+      #   @param text_color [Increase::Models::DigitalCardProfile::TextColor] The Card's text color, specified as an RGB triple.
+      #
+      #   @param type [Symbol, Increase::Models::DigitalCardProfile::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The status of the Card Profile.
+      #
+      # @see Increase::Models::DigitalCardProfile#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The Card Profile is awaiting review from Increase and/or processing by card networks.
+        PENDING = :pending
+
+        # There is an issue with the Card Profile preventing it from use.
+        REJECTED = :rejected
+
+        # The Card Profile can be assigned to Cards.
+        ACTIVE = :active
+
+        # The Card Profile is no longer in use.
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Increase::Models::DigitalCardProfile#text_color
+      class TextColor < Increase::Internal::Type::BaseModel
+        # @!attribute blue
+        #   The value of the blue channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :blue, Integer
+
+        # @!attribute green
+        #   The value of the green channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :green, Integer
+
+        # @!attribute red
+        #   The value of the red channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :red, Integer
+
+        # @!method initialize(blue:, green:, red:)
+        #   The Card's text color, specified as an RGB triple.
+        #
+        #   @param blue [Integer] The value of the blue channel in the RGB color.
+        #
+        #   @param green [Integer] The value of the green channel in the RGB color.
+        #
+        #   @param red [Integer] The value of the red channel in the RGB color.
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `digital_card_profile`.
+      #
+      # @see Increase::Models::DigitalCardProfile#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        DIGITAL_CARD_PROFILE = :digital_card_profile
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/digital_card_profile_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalCardProfiles#archive
+    class DigitalCardProfileArchiveParams < 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/digital_card_profile_clone_params.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalCardProfiles#clone_
+    class DigitalCardProfileCloneParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute app_icon_file_id
+      #   The identifier of the File containing the card's icon image.
+      #
+      #   @return [String, nil]
+      optional :app_icon_file_id, String
+
+      # @!attribute background_image_file_id
+      #   The identifier of the File containing the card's front image.
+      #
+      #   @return [String, nil]
+      optional :background_image_file_id, String
+
+      # @!attribute card_description
+      #   A user-facing description for the card itself.
+      #
+      #   @return [String, nil]
+      optional :card_description, String
+
+      # @!attribute contact_email
+      #   An email address the user can contact to receive support for their card.
+      #
+      #   @return [String, nil]
+      optional :contact_email, String
+
+      # @!attribute contact_phone
+      #   A phone number the user can contact to receive support for their card.
+      #
+      #   @return [String, nil]
+      optional :contact_phone, String
+
+      # @!attribute contact_website
+      #   A website the user can visit to view and receive support for their card.
+      #
+      #   @return [String, nil]
+      optional :contact_website, String
+
+      # @!attribute description
+      #   A description you can use to identify the Card Profile.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute issuer_name
+      #   A user-facing description for whoever is issuing the card.
+      #
+      #   @return [String, nil]
+      optional :issuer_name, String
+
+      # @!attribute text_color
+      #   The Card's text color, specified as an RGB triple. The default is white.
+      #
+      #   @return [Increase::Models::DigitalCardProfileCloneParams::TextColor, nil]
+      optional :text_color, -> { Increase::DigitalCardProfileCloneParams::TextColor }
+
+      # @!method initialize(app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_phone: nil, contact_website: nil, description: nil, issuer_name: nil, text_color: nil, request_options: {})
+      #   @param app_icon_file_id [String] The identifier of the File containing the card's icon image.
+      #
+      #   @param background_image_file_id [String] The identifier of the File containing the card's front image.
+      #
+      #   @param card_description [String] A user-facing description for the card itself.
+      #
+      #   @param contact_email [String] An email address the user can contact to receive support for their card.
+      #
+      #   @param contact_phone [String] A phone number the user can contact to receive support for their card.
+      #
+      #   @param contact_website [String] A website the user can visit to view and receive support for their card.
+      #
+      #   @param description [String] A description you can use to identify the Card Profile.
+      #
+      #   @param issuer_name [String] A user-facing description for whoever is issuing the card.
+      #
+      #   @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] The Card's text color, specified as an RGB triple. The default is white.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class TextColor < Increase::Internal::Type::BaseModel
+        # @!attribute blue
+        #   The value of the blue channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :blue, Integer
+
+        # @!attribute green
+        #   The value of the green channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :green, Integer
+
+        # @!attribute red
+        #   The value of the red channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :red, Integer
+
+        # @!method initialize(blue:, green:, red:)
+        #   The Card's text color, specified as an RGB triple. The default is white.
+        #
+        #   @param blue [Integer] The value of the blue channel in the RGB color.
+        #
+        #   @param green [Integer] The value of the green channel in the RGB color.
+        #
+        #   @param red [Integer] The value of the red channel in the RGB color.
+      end
+    end
+  end
+end

data/lib/increase/models/digital_card_profile_create_params.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalCardProfiles#create
+    class DigitalCardProfileCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute app_icon_file_id
+      #   The identifier of the File containing the card's icon image.
+      #
+      #   @return [String]
+      required :app_icon_file_id, String
+
+      # @!attribute background_image_file_id
+      #   The identifier of the File containing the card's front image.
+      #
+      #   @return [String]
+      required :background_image_file_id, String
+
+      # @!attribute card_description
+      #   A user-facing description for the card itself.
+      #
+      #   @return [String]
+      required :card_description, String
+
+      # @!attribute description
+      #   A description you can use to identify the Card Profile.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute issuer_name
+      #   A user-facing description for whoever is issuing the card.
+      #
+      #   @return [String]
+      required :issuer_name, String
+
+      # @!attribute contact_email
+      #   An email address the user can contact to receive support for their card.
+      #
+      #   @return [String, nil]
+      optional :contact_email, String
+
+      # @!attribute contact_phone
+      #   A phone number the user can contact to receive support for their card.
+      #
+      #   @return [String, nil]
+      optional :contact_phone, String
+
+      # @!attribute contact_website
+      #   A website the user can visit to view and receive support for their card.
+      #
+      #   @return [String, nil]
+      optional :contact_website, String
+
+      # @!attribute text_color
+      #   The Card's text color, specified as an RGB triple. The default is white.
+      #
+      #   @return [Increase::Models::DigitalCardProfileCreateParams::TextColor, nil]
+      optional :text_color, -> { Increase::DigitalCardProfileCreateParams::TextColor }
+
+      # @!method initialize(app_icon_file_id:, background_image_file_id:, card_description:, description:, issuer_name:, contact_email: nil, contact_phone: nil, contact_website: nil, text_color: nil, request_options: {})
+      #   @param app_icon_file_id [String] The identifier of the File containing the card's icon image.
+      #
+      #   @param background_image_file_id [String] The identifier of the File containing the card's front image.
+      #
+      #   @param card_description [String] A user-facing description for the card itself.
+      #
+      #   @param description [String] A description you can use to identify the Card Profile.
+      #
+      #   @param issuer_name [String] A user-facing description for whoever is issuing the card.
+      #
+      #   @param contact_email [String] An email address the user can contact to receive support for their card.
+      #
+      #   @param contact_phone [String] A phone number the user can contact to receive support for their card.
+      #
+      #   @param contact_website [String] A website the user can visit to view and receive support for their card.
+      #
+      #   @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] The Card's text color, specified as an RGB triple. The default is white.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class TextColor < Increase::Internal::Type::BaseModel
+        # @!attribute blue
+        #   The value of the blue channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :blue, Integer
+
+        # @!attribute green
+        #   The value of the green channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :green, Integer
+
+        # @!attribute red
+        #   The value of the red channel in the RGB color.
+        #
+        #   @return [Integer]
+        required :red, Integer
+
+        # @!method initialize(blue:, green:, red:)
+        #   The Card's text color, specified as an RGB triple. The default is white.
+        #
+        #   @param blue [Integer] The value of the blue channel in the RGB color.
+        #
+        #   @param green [Integer] The value of the green channel in the RGB color.
+        #
+        #   @param red [Integer] The value of the red channel in the RGB color.
+      end
+    end
+  end
+end