increase 0.3.3 → 1.0.0

data/lib/increase/models/physical_card_list_params.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::PhysicalCards#list
+    class PhysicalCardListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute card_id
+      #   Filter Physical Cards to ones belonging to the specified Card.
+      #
+      #   @return [String, nil]
+      optional :card_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::PhysicalCardListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::PhysicalCardListParams::CreatedAt }
+
+      # @!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
+
+      # @!method initialize(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::PhysicalCardListParams} for more details.
+      #
+      #   @param card_id [String] Filter Physical Cards to ones belonging to the specified Card.
+      #
+      #   @param created_at [Increase::Models::PhysicalCardListParams::CreatedAt]
+      #
+      #   @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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      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::PhysicalCardListParams::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/physical_card_profile.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::PhysicalCardProfiles#create
+    class PhysicalCardProfile < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Card Profile identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute back_image_file_id
+      #   The identifier of the File containing the physical card's back image.
+      #
+      #   @return [String, nil]
+      required :back_image_file_id, String, nil?: true
+
+      # @!attribute carrier_image_file_id
+      #   The identifier of the File containing the physical card's carrier image.
+      #
+      #   @return [String, nil]
+      required :carrier_image_file_id, 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 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 creator
+      #   The creator of this Physical Card Profile.
+      #
+      #   @return [Symbol, Increase::Models::PhysicalCardProfile::Creator]
+      required :creator, enum: -> { Increase::PhysicalCardProfile::Creator }
+
+      # @!attribute description
+      #   A description you can use to identify the Physical Card Profile.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute front_image_file_id
+      #   The identifier of the File containing the physical card's front image.
+      #
+      #   @return [String, nil]
+      required :front_image_file_id, String, nil?: true
+
+      # @!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 is_default
+      #   Whether this Physical Card Profile is the default for all cards in its Increase
+      #   group.
+      #
+      #   @return [Boolean]
+      required :is_default, Increase::Internal::Type::Boolean
+
+      # @!attribute program_id
+      #   The identifier for the Program this Physical Card Profile belongs to.
+      #
+      #   @return [String]
+      required :program_id, String
+
+      # @!attribute status
+      #   The status of the Physical Card Profile.
+      #
+      #   @return [Symbol, Increase::Models::PhysicalCardProfile::Status]
+      required :status, enum: -> { Increase::PhysicalCardProfile::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `physical_card_profile`.
+      #
+      #   @return [Symbol, Increase::Models::PhysicalCardProfile::Type]
+      required :type, enum: -> { Increase::PhysicalCardProfile::Type }
+
+      # @!method initialize(id:, back_image_file_id:, carrier_image_file_id:, contact_phone:, created_at:, creator:, description:, front_image_file_id:, idempotency_key:, is_default:, program_id:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::PhysicalCardProfile} for more details.
+      #
+      #   This contains artwork and metadata relating to a Physical Card's appearance. For
+      #   more information, see our guide on
+      #   [physical card artwork](https://increase.com/documentation/card-art-physical-cards).
+      #
+      #   @param id [String] The Card Profile identifier.
+      #
+      #   @param back_image_file_id [String, nil] The identifier of the File containing the physical card's back image.
+      #
+      #   @param carrier_image_file_id [String, nil] The identifier of the File containing the physical card's carrier image.
+      #
+      #   @param contact_phone [String, nil] A phone number the user can contact to 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 creator [Symbol, Increase::Models::PhysicalCardProfile::Creator] The creator of this Physical Card Profile.
+      #
+      #   @param description [String] A description you can use to identify the Physical Card Profile.
+      #
+      #   @param front_image_file_id [String, nil] The identifier of the File containing the physical card's front image.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param is_default [Boolean] Whether this Physical Card Profile is the default for all cards in its Increase
+      #
+      #   @param program_id [String] The identifier for the Program this Physical Card Profile belongs to.
+      #
+      #   @param status [Symbol, Increase::Models::PhysicalCardProfile::Status] The status of the Physical Card Profile.
+      #
+      #   @param type [Symbol, Increase::Models::PhysicalCardProfile::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The creator of this Physical Card Profile.
+      #
+      # @see Increase::Models::PhysicalCardProfile#creator
+      module Creator
+        extend Increase::Internal::Type::Enum
+
+        # This Physical Card Profile was created by Increase.
+        INCREASE = :increase
+
+        # This Physical Card Profile was created by you.
+        USER = :user
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the Physical Card Profile.
+      #
+      # @see Increase::Models::PhysicalCardProfile#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The Card Profile has not yet been processed by Increase.
+        PENDING_CREATING = :pending_creating
+
+        # The card profile is awaiting review by Increase.
+        PENDING_REVIEWING = :pending_reviewing
+
+        # There is an issue with the Physical Card Profile preventing it from use.
+        REJECTED = :rejected
+
+        # The card profile is awaiting submission to the fulfillment provider.
+        PENDING_SUBMITTING = :pending_submitting
+
+        # The Physical Card Profile has been submitted to the fulfillment provider and is ready to use.
+        ACTIVE = :active
+
+        # The Physical Card Profile has been archived.
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `physical_card_profile`.
+      #
+      # @see Increase::Models::PhysicalCardProfile#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        PHYSICAL_CARD_PROFILE = :physical_card_profile
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/physical_card_profile_archive_params.rb

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::PhysicalCardProfiles#clone_
+    class PhysicalCardProfileCloneParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute carrier_image_file_id
+      #   The identifier of the File containing the physical card's carrier image.
+      #
+      #   @return [String, nil]
+      optional :carrier_image_file_id, 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 description
+      #   A description you can use to identify the Card Profile.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute front_image_file_id
+      #   The identifier of the File containing the physical card's front image.
+      #
+      #   @return [String, nil]
+      optional :front_image_file_id, String
+
+      # @!attribute front_text
+      #   Text printed on the front of the card. Reach out to
+      #   [support@increase.com](mailto:support@increase.com) for more information.
+      #
+      #   @return [Increase::Models::PhysicalCardProfileCloneParams::FrontText, nil]
+      optional :front_text, -> { Increase::PhysicalCardProfileCloneParams::FrontText }
+
+      # @!method initialize(carrier_image_file_id: nil, contact_phone: nil, description: nil, front_image_file_id: nil, front_text: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::PhysicalCardProfileCloneParams} for more details.
+      #
+      #   @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image.
+      #
+      #   @param contact_phone [String] A phone number the user can contact to receive support for their card.
+      #
+      #   @param description [String] A description you can use to identify the Card Profile.
+      #
+      #   @param front_image_file_id [String] The identifier of the File containing the physical card's front image.
+      #
+      #   @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] Text printed on the front of the card. Reach out to [support@increase.com](mailt
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class FrontText < Increase::Internal::Type::BaseModel
+        # @!attribute line1
+        #   The first line of text on the front of the card.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of text on the front of the card. Providing a second line moves
+        #   the first line slightly higher and prints the second line in the spot where the
+        #   first line would have otherwise been printed.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!method initialize(line1:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::PhysicalCardProfileCloneParams::FrontText} for more details.
+        #
+        #   Text printed on the front of the card. Reach out to
+        #   [support@increase.com](mailto:support@increase.com) for more information.
+        #
+        #   @param line1 [String] The first line of text on the front of the card.
+        #
+        #   @param line2 [String] The second line of text on the front of the card. Providing a second line moves
+      end
+    end
+  end
+end

data/lib/increase/models/physical_card_profile_create_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::PhysicalCardProfiles#create
+    class PhysicalCardProfileCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute carrier_image_file_id
+      #   The identifier of the File containing the physical card's carrier image.
+      #
+      #   @return [String]
+      required :carrier_image_file_id, String
+
+      # @!attribute contact_phone
+      #   A phone number the user can contact to receive support for their card.
+      #
+      #   @return [String]
+      required :contact_phone, String
+
+      # @!attribute description
+      #   A description you can use to identify the Card Profile.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute front_image_file_id
+      #   The identifier of the File containing the physical card's front image.
+      #
+      #   @return [String]
+      required :front_image_file_id, String
+
+      # @!attribute program_id
+      #   The identifier for the Program that this Physical Card Profile falls under.
+      #
+      #   @return [String]
+      required :program_id, String
+
+      # @!attribute front_text
+      #   Text printed on the front of the card. Reach out to
+      #   [support@increase.com](mailto:support@increase.com) for more information.
+      #
+      #   @return [Increase::Models::PhysicalCardProfileCreateParams::FrontText, nil]
+      optional :front_text, -> { Increase::PhysicalCardProfileCreateParams::FrontText }
+
+      # @!method initialize(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, front_text: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::PhysicalCardProfileCreateParams} for more details.
+      #
+      #   @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image.
+      #
+      #   @param contact_phone [String] A phone number the user can contact to receive support for their card.
+      #
+      #   @param description [String] A description you can use to identify the Card Profile.
+      #
+      #   @param front_image_file_id [String] The identifier of the File containing the physical card's front image.
+      #
+      #   @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
+      #
+      #   @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText] Text printed on the front of the card. Reach out to [support@increase.com](mailt
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class FrontText < Increase::Internal::Type::BaseModel
+        # @!attribute line1
+        #   The first line of text on the front of the card.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of text on the front of the card. Providing a second line moves
+        #   the first line slightly higher and prints the second line in the spot where the
+        #   first line would have otherwise been printed.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!method initialize(line1:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::PhysicalCardProfileCreateParams::FrontText} for more details.
+        #
+        #   Text printed on the front of the card. Reach out to
+        #   [support@increase.com](mailto:support@increase.com) for more information.
+        #
+        #   @param line1 [String] The first line of text on the front of the card.
+        #
+        #   @param line2 [String] The second line of text on the front of the card. Providing a second line moves
+      end
+    end
+  end
+end

data/lib/increase/models/physical_card_profile_list_params.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::PhysicalCardProfiles#list
+    class PhysicalCardProfileListParams < 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 status
+      #
+      #   @return [Increase::Models::PhysicalCardProfileListParams::Status, nil]
+      optional :status, -> { Increase::PhysicalCardProfileListParams::Status }
+
+      # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::PhysicalCardProfileListParams} 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 status [Increase::Models::PhysicalCardProfileListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Physical Card Profiles for those with the specified statuses. For GET
+        #   requests, this should be encoded as a comma-delimited string, such as
+        #   `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::PhysicalCardProfileListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::PhysicalCardProfileListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::PhysicalCardProfileListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::PhysicalCardProfileListParams::Status::In>] Filter Physical Card Profiles for those with the specified statuses. For GET req
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The Card Profile has not yet been processed by Increase.
+          PENDING_CREATING = :pending_creating
+
+          # The card profile is awaiting review by Increase.
+          PENDING_REVIEWING = :pending_reviewing
+
+          # There is an issue with the Physical Card Profile preventing it from use.
+          REJECTED = :rejected
+
+          # The card profile is awaiting submission to the fulfillment provider.
+          PENDING_SUBMITTING = :pending_submitting
+
+          # The Physical Card Profile has been submitted to the fulfillment provider and is ready to use.
+          ACTIVE = :active
+
+          # The Physical Card Profile has been archived.
+          ARCHIVED = :archived
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/physical_card_profile_retrieve_params.rb

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::PhysicalCards#update
+    class PhysicalCardUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute status
+      #   The status to update the Physical Card to.
+      #
+      #   @return [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
+      required :status, enum: -> { Increase::PhysicalCardUpdateParams::Status }
+
+      # @!method initialize(status:, request_options: {})
+      #   @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] The status to update the Physical Card to.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The status to update the Physical Card to.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The physical card is active.
+        ACTIVE = :active
+
+        # The physical card is temporarily disabled.
+        DISABLED = :disabled
+
+        # The physical card is permanently canceled.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end