lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/card_provision_params.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardProvisionParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] certificate
+      #   Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
+      #     `activationData` in the response. Apple's public leaf certificate. Base64
+      #     encoded in PEM format with headers `(-----BEGIN CERTIFICATE-----)` and trailers
+      #     omitted. Provided by the device's wallet.
+      #
+      #   @return [String, nil]
+      optional :certificate, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :certificate
+
+      # @!attribute [r] client_device_id
+      #   Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
+      #     card is on the Visa network. Stable device identification set by the wallet
+      #     provider.
+      #
+      #   @return [String, nil]
+      optional :client_device_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :client_device_id
+
+      # @!attribute [r] client_wallet_account_id
+      #   Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
+      #     card is on the Visa network. Consumer ID that identifies the wallet account
+      #     holder entity.
+      #
+      #   @return [String, nil]
+      optional :client_wallet_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :client_wallet_account_id
+
+      # @!attribute [r] digital_wallet
+      #   Name of digital wallet provider.
+      #
+      #   @return [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet, nil]
+      optional :digital_wallet, enum: -> { Lithic::Models::CardProvisionParams::DigitalWallet }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
+      #   attr_writer :digital_wallet
+
+      # @!attribute [r] nonce
+      #   Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
+      #     `activationData` in the response. Base64 cryptographic nonce provided by the
+      #     device's wallet.
+      #
+      #   @return [String, nil]
+      optional :nonce, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :nonce
+
+      # @!attribute [r] nonce_signature
+      #   Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
+      #     `activationData` in the response. Base64 cryptographic nonce provided by the
+      #     device's wallet.
+      #
+      #   @return [String, nil]
+      optional :nonce_signature, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :nonce_signature
+
+      # @!parse
+      #   # @param certificate [String]
+      #   # @param client_device_id [String]
+      #   # @param client_wallet_account_id [String]
+      #   # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
+      #   # @param nonce [String]
+      #   # @param nonce_signature [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     certificate: nil,
+      #     client_device_id: nil,
+      #     client_wallet_account_id: nil,
+      #     digital_wallet: nil,
+      #     nonce: nil,
+      #     nonce_signature: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Name of digital wallet provider.
+      module DigitalWallet
+        extend Lithic::Enum
+
+        APPLE_PAY = :APPLE_PAY
+        GOOGLE_PAY = :GOOGLE_PAY
+        SAMSUNG_PAY = :SAMSUNG_PAY
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/card_provision_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardProvisionResponse < Lithic::BaseModel
+      # @!attribute [r] provisioning_payload
+      #
+      #   @return [String, nil]
+      optional :provisioning_payload, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :provisioning_payload
+
+      # @!parse
+      #   # @param provisioning_payload [String]
+      #   #
+      #   def initialize(provisioning_payload: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_reissue_params.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardReissueParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] carrier
+      #   If omitted, the previous carrier will be used.
+      #
+      #   @return [Lithic::Models::Carrier, nil]
+      optional :carrier, -> { Lithic::Models::Carrier }
+
+      # @!parse
+      #   # @return [Lithic::Models::Carrier]
+      #   attr_writer :carrier
+
+      # @!attribute [r] product_id
+      #   Specifies the configuration (e.g. physical card art) that the card should be
+      #     manufactured with, and only applies to cards of type `PHYSICAL`. This must be
+      #     configured with Lithic before use.
+      #
+      #   @return [String, nil]
+      optional :product_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :product_id
+
+      # @!attribute [r] shipping_address
+      #   If omitted, the previous shipping address will be used.
+      #
+      #   @return [Lithic::Models::ShippingAddress, nil]
+      optional :shipping_address, -> { Lithic::Models::ShippingAddress }
+
+      # @!parse
+      #   # @return [Lithic::Models::ShippingAddress]
+      #   attr_writer :shipping_address
+
+      # @!attribute [r] shipping_method
+      #   Shipping method for the card. Use of options besides `STANDARD` require
+      #     additional permissions.
+      #
+      #     - `STANDARD` - USPS regular mail or similar international option, with no
+      #       tracking
+      #     - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
+      #       with tracking
+      #     - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
+      #     - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
+      #     - `2_DAY` - FedEx 2-day shipping, with tracking
+      #     - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+      #       tracking
+      #
+      #   @return [Symbol, Lithic::Models::CardReissueParams::ShippingMethod, nil]
+      optional :shipping_method, enum: -> { Lithic::Models::CardReissueParams::ShippingMethod }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardReissueParams::ShippingMethod]
+      #   attr_writer :shipping_method
+
+      # @!parse
+      #   # @param carrier [Lithic::Models::Carrier]
+      #   # @param product_id [String]
+      #   # @param shipping_address [Lithic::Models::ShippingAddress]
+      #   # @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(carrier: nil, product_id: nil, shipping_address: nil, shipping_method: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Shipping method for the card. Use of options besides `STANDARD` require
+      #   additional permissions.
+      #
+      #   - `STANDARD` - USPS regular mail or similar international option, with no
+      #     tracking
+      #   - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
+      #     with tracking
+      #   - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
+      #   - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
+      #   - `2_DAY` - FedEx 2-day shipping, with tracking
+      #   - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+      #     tracking
+      module ShippingMethod
+        extend Lithic::Enum
+
+        NUMBER_2_DAY = :"2-DAY"
+        EXPEDITED = :EXPEDITED
+        EXPRESS = :EXPRESS
+        PRIORITY = :PRIORITY
+        STANDARD = :STANDARD
+        STANDARD_WITH_TRACKING = :STANDARD_WITH_TRACKING
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/card_renew_params.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardRenewParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute shipping_address
+      #   The shipping address this card will be sent to.
+      #
+      #   @return [Lithic::Models::ShippingAddress]
+      required :shipping_address, -> { Lithic::Models::ShippingAddress }
+
+      # @!attribute [r] carrier
+      #   If omitted, the previous carrier will be used.
+      #
+      #   @return [Lithic::Models::Carrier, nil]
+      optional :carrier, -> { Lithic::Models::Carrier }
+
+      # @!parse
+      #   # @return [Lithic::Models::Carrier]
+      #   attr_writer :carrier
+
+      # @!attribute [r] exp_month
+      #   Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
+      #     an expiration date six years in the future will be generated.
+      #
+      #   @return [String, nil]
+      optional :exp_month, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :exp_month
+
+      # @!attribute [r] exp_year
+      #   Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
+      #     provided, an expiration date six years in the future will be generated.
+      #
+      #   @return [String, nil]
+      optional :exp_year, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :exp_year
+
+      # @!attribute [r] product_id
+      #   Specifies the configuration (e.g. physical card art) that the card should be
+      #     manufactured with, and only applies to cards of type `PHYSICAL`. This must be
+      #     configured with Lithic before use.
+      #
+      #   @return [String, nil]
+      optional :product_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :product_id
+
+      # @!attribute [r] shipping_method
+      #   Shipping method for the card. Use of options besides `STANDARD` require
+      #     additional permissions.
+      #
+      #     - `STANDARD` - USPS regular mail or similar international option, with no
+      #       tracking
+      #     - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
+      #       with tracking
+      #     - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
+      #     - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
+      #     - `2_DAY` - FedEx 2-day shipping, with tracking
+      #     - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+      #       tracking
+      #
+      #   @return [Symbol, Lithic::Models::CardRenewParams::ShippingMethod, nil]
+      optional :shipping_method, enum: -> { Lithic::Models::CardRenewParams::ShippingMethod }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardRenewParams::ShippingMethod]
+      #   attr_writer :shipping_method
+
+      # @!parse
+      #   # @param shipping_address [Lithic::Models::ShippingAddress]
+      #   # @param carrier [Lithic::Models::Carrier]
+      #   # @param exp_month [String]
+      #   # @param exp_year [String]
+      #   # @param product_id [String]
+      #   # @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     shipping_address:,
+      #     carrier: nil,
+      #     exp_month: nil,
+      #     exp_year: nil,
+      #     product_id: nil,
+      #     shipping_method: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Shipping method for the card. Use of options besides `STANDARD` require
+      #   additional permissions.
+      #
+      #   - `STANDARD` - USPS regular mail or similar international option, with no
+      #     tracking
+      #   - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
+      #     with tracking
+      #   - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
+      #   - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
+      #   - `2_DAY` - FedEx 2-day shipping, with tracking
+      #   - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+      #     tracking
+      module ShippingMethod
+        extend Lithic::Enum
+
+        NUMBER_2_DAY = :"2-DAY"
+        EXPEDITED = :EXPEDITED
+        EXPRESS = :EXPRESS
+        PRIORITY = :PRIORITY
+        STANDARD = :STANDARD
+        STANDARD_WITH_TRACKING = :STANDARD_WITH_TRACKING
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/card_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardRetrieveParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_retrieve_spend_limits_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardRetrieveSpendLimitsParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_search_by_pan_params.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardSearchByPanParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute pan
+      #   The PAN for the card being retrieved.
+      #
+      #   @return [String]
+      required :pan, String
+
+      # @!parse
+      #   # @param pan [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(pan:, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_spend_limits.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardSpendLimits < Lithic::BaseModel
+      # @!attribute available_spend_limit
+      #
+      #   @return [Lithic::Models::CardSpendLimits::AvailableSpendLimit]
+      required :available_spend_limit, -> { Lithic::Models::CardSpendLimits::AvailableSpendLimit }
+
+      # @!attribute [r] spend_limit
+      #
+      #   @return [Lithic::Models::CardSpendLimits::SpendLimit, nil]
+      optional :spend_limit, -> { Lithic::Models::CardSpendLimits::SpendLimit }
+
+      # @!parse
+      #   # @return [Lithic::Models::CardSpendLimits::SpendLimit]
+      #   attr_writer :spend_limit
+
+      # @!attribute [r] spend_velocity
+      #
+      #   @return [Lithic::Models::CardSpendLimits::SpendVelocity, nil]
+      optional :spend_velocity, -> { Lithic::Models::CardSpendLimits::SpendVelocity }
+
+      # @!parse
+      #   # @return [Lithic::Models::CardSpendLimits::SpendVelocity]
+      #   attr_writer :spend_velocity
+
+      # @!parse
+      #   # @param available_spend_limit [Lithic::Models::CardSpendLimits::AvailableSpendLimit]
+      #   # @param spend_limit [Lithic::Models::CardSpendLimits::SpendLimit]
+      #   # @param spend_velocity [Lithic::Models::CardSpendLimits::SpendVelocity]
+      #   #
+      #   def initialize(available_spend_limit:, spend_limit: nil, spend_velocity: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      class AvailableSpendLimit < Lithic::BaseModel
+        # @!attribute [r] annually
+        #   The available spend limit (in cents) relative to the annual limit configured on
+        #     the Card (e.g. 100000 would be a $1,000 limit).
+        #
+        #   @return [Integer, nil]
+        optional :annually, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :annually
+
+        # @!attribute [r] forever
+        #   The available spend limit (in cents) relative to the forever limit configured on
+        #     the Card.
+        #
+        #   @return [Integer, nil]
+        optional :forever, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :forever
+
+        # @!attribute [r] monthly
+        #   The available spend limit (in cents) relative to the monthly limit configured on
+        #     the Card.
+        #
+        #   @return [Integer, nil]
+        optional :monthly, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :monthly
+
+        # @!parse
+        #   # @param annually [Integer]
+        #   # @param forever [Integer]
+        #   # @param monthly [Integer]
+        #   #
+        #   def initialize(annually: nil, forever: nil, monthly: nil, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+
+      class SpendLimit < Lithic::BaseModel
+        # @!attribute [r] annually
+        #   The configured annual spend limit (in cents) on the Card.
+        #
+        #   @return [Integer, nil]
+        optional :annually, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :annually
+
+        # @!attribute [r] forever
+        #   The configured forever spend limit (in cents) on the Card.
+        #
+        #   @return [Integer, nil]
+        optional :forever, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :forever
+
+        # @!attribute [r] monthly
+        #   The configured monthly spend limit (in cents) on the Card.
+        #
+        #   @return [Integer, nil]
+        optional :monthly, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :monthly
+
+        # @!parse
+        #   # @param annually [Integer]
+        #   # @param forever [Integer]
+        #   # @param monthly [Integer]
+        #   #
+        #   def initialize(annually: nil, forever: nil, monthly: nil, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+
+      class SpendVelocity < Lithic::BaseModel
+        # @!attribute [r] annually
+        #   Current annual spend velocity (in cents) on the Card. Present if annual spend
+        #     limit is set.
+        #
+        #   @return [Integer, nil]
+        optional :annually, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :annually
+
+        # @!attribute [r] forever
+        #   Current forever spend velocity (in cents) on the Card. Present if forever spend
+        #     limit is set.
+        #
+        #   @return [Integer, nil]
+        optional :forever, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :forever
+
+        # @!attribute [r] monthly
+        #   Current monthly spend velocity (in cents) on the Card. Present if monthly spend
+        #     limit is set.
+        #
+        #   @return [Integer, nil]
+        optional :monthly, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :monthly
+
+        # @!parse
+        #   # @param annually [Integer]
+        #   # @param forever [Integer]
+        #   # @param monthly [Integer]
+        #   #
+        #   def initialize(annually: nil, forever: nil, monthly: nil, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+    end
+  end
+end