lithic 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4

data/lib/lithic/models/auth_rules/v2_promote_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#promote
       class V2PromoteParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_promote_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#promote
       class V2PromoteResponse < Lithic::BaseModel
         # @!attribute token
         #   Auth Rule Token
@@ -96,6 +97,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::V2PromoteResponse#current_version
         class CurrentVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -122,6 +124,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2PromoteResponse::CurrentVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -135,6 +139,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AuthRules::V2PromoteResponse#draft_version
         class DraftVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -160,6 +165,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2PromoteResponse::DraftVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -174,6 +181,8 @@ module Lithic
         end
 
         # The state of the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2PromoteResponse#state
         module State
           extend Lithic::Enum
 
@@ -188,6 +197,8 @@ module Lithic
         end
 
         # The type of Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2PromoteResponse#type
         module Type
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/v2_report_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#report
       class V2ReportParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_report_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#report
       class V2ReportResponse < Lithic::BaseModel
         # @!attribute [r] report_token
         #

data/lib/lithic/models/auth_rules/v2_retrieve_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#retrieve
       class V2RetrieveParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_retrieve_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#retrieve
       class V2RetrieveResponse < Lithic::BaseModel
         # @!attribute token
         #   Auth Rule Token
@@ -98,6 +99,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::V2RetrieveResponse#current_version
         class CurrentVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -124,6 +126,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2RetrieveResponse::CurrentVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -137,6 +141,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AuthRules::V2RetrieveResponse#draft_version
         class DraftVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -163,6 +168,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2RetrieveResponse::DraftVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -177,6 +184,8 @@ module Lithic
         end
 
         # The state of the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2RetrieveResponse#state
         module State
           extend Lithic::Enum
 
@@ -191,6 +200,8 @@ module Lithic
         end
 
         # The type of Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2RetrieveResponse#type
         module Type
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/v2_update_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#update
       class V2UpdateParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_update_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#update
       class V2UpdateResponse < Lithic::BaseModel
         # @!attribute token
         #   Auth Rule Token
@@ -96,6 +97,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::V2UpdateResponse#current_version
         class CurrentVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -122,6 +124,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2UpdateResponse::CurrentVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -135,6 +139,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AuthRules::V2UpdateResponse#draft_version
         class DraftVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -160,6 +165,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2UpdateResponse::DraftVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -174,6 +181,8 @@ module Lithic
         end
 
         # The state of the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2UpdateResponse#state
         module State
           extend Lithic::Enum
 
@@ -188,6 +197,8 @@ module Lithic
         end
 
         # The type of Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2UpdateResponse#type
         module Type
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/velocity_limit_params.rb

@@ -50,6 +50,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::VelocityLimitParams#filters
         class Filters < Lithic::BaseModel
           # @!attribute exclude_countries
           #   ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
@@ -94,6 +95,8 @@ module Lithic
 
         # The size of the trailing window to calculate Spend Velocity over in seconds. The
         #   minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
+        #
+        # @see Lithic::Models::AuthRules::VelocityLimitParams#period
         module Period
           extend Lithic::Union
 
@@ -112,6 +115,7 @@ module Lithic
           #   def self.variants; end
         end
 
+        # @see Lithic::Models::AuthRules::VelocityLimitParams#scope
         module Scope
           extend Lithic::Enum
 

data/lib/lithic/models/auth_stream_enrollment_retrieve_secret_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AuthStreamEnrollment#retrieve_secret
     class AuthStreamEnrollmentRetrieveSecretParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_stream_enrollment_rotate_secret_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AuthStreamEnrollment#rotate_secret
     class AuthStreamEnrollmentRotateSecretParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_stream_secret.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AuthStreamEnrollment#retrieve_secret
     class AuthStreamSecret < Lithic::BaseModel
       # @!attribute [r] secret
       #   The shared HMAC ASA secret

data/lib/lithic/models/balance.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Balances#list
     class Balance < Lithic::BaseModel
       # @!attribute available_amount
       #   Funds available for spend in the currency's smallest unit (e.g., cents for USD)
@@ -100,6 +101,8 @@ module Lithic
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
       # Type of financial account.
+      #
+      # @see Lithic::Models::Balance#financial_account_type
       module FinancialAccountType
         extend Lithic::Enum
 

data/lib/lithic/models/balance_list_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Balances#list
     class BalanceListParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/book_transfer_create_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::BookTransfers#create
     class BookTransferCreateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/book_transfer_list_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::BookTransfers#list
     class BookTransferListParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/book_transfer_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::BookTransfers#create
     class BookTransferResponse < Lithic::BaseModel
       # @!attribute token
       #   Customer-provided token that will serve as an idempotency token. This token will
@@ -119,6 +120,8 @@ module Lithic
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
       # Category of the book transfer
+      #
+      # @see Lithic::Models::BookTransferResponse#category
       module Category
         extend Lithic::Enum
 
@@ -218,6 +221,8 @@ module Lithic
 
         # APPROVED financial events were successful while DECLINED financial events were
         #   declined by user, Lithic, or the network.
+        #
+        # @see Lithic::Models::BookTransferResponse::Event#result
         module Result
           extend Lithic::Enum
 
@@ -234,6 +239,8 @@ module Lithic
 
       # APPROVED transactions were successful while DECLINED transactions were declined
       #   by user, Lithic, or the network.
+      #
+      # @see Lithic::Models::BookTransferResponse#result
       module Result
         extend Lithic::Enum
 
@@ -249,6 +256,8 @@ module Lithic
 
       # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
       #   transfer was reversed \* `SETTLED` - The transfer is completed.
+      #
+      # @see Lithic::Models::BookTransferResponse#status
       module Status
         extend Lithic::Enum
 

data/lib/lithic/models/book_transfer_retrieve_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::BookTransfers#retrieve
     class BookTransferRetrieveParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/book_transfer_reverse_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::BookTransfers#reverse
     class BookTransferReverseParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#create
     class Card < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier.
@@ -302,6 +303,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::Card#funding
       class Funding < Lithic::BaseModel
         # @!attribute token
         #   A globally unique identifier for this FundingAccount.
@@ -390,6 +392,8 @@ module Lithic
         #   - `PENDING` - The funding account is still being verified e.g. bank
         #     micro-deposits verification.
         #   - `DELETED` - The founding account has been deleted.
+        #
+        # @see Lithic::Models::Card::Funding#state
         module State
           extend Lithic::Enum
 
@@ -408,6 +412,8 @@ module Lithic
         #
         #   - `DEPOSITORY_CHECKING` - Bank checking account.
         #   - `DEPOSITORY_SAVINGS` - Bank savings account.
+        #
+        # @see Lithic::Models::Card::Funding#type
         module Type
           extend Lithic::Enum
 
@@ -424,6 +430,8 @@ module Lithic
 
       # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
       #   attempts).
+      #
+      # @see Lithic::Models::Card#pin_status
       module PinStatus
         extend Lithic::Enum
 
@@ -459,6 +467,8 @@ module Lithic
       #
       #   In sandbox, the same daily batch fulfillment occurs, but no cards are actually
       #   manufactured.
+      #
+      # @see Lithic::Models::Card#state
       module State
         extend Lithic::Enum
 
@@ -491,6 +501,8 @@ module Lithic
       #     VIRTUAL instead.
       #   - `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please
       #     use VIRTUAL instead.
+      #
+      # @see Lithic::Models::Card#type
       module Type
         extend Lithic::Enum
 

data/lib/lithic/models/card_convert_physical_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#convert_physical
     class CardConvertPhysicalParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter
@@ -82,7 +83,7 @@ module Lithic
       module ShippingMethod
         extend Lithic::Enum
 
-        NUMBER_2_DAY = :"2-DAY"
+        SHIPPING_METHOD_2_DAY = :"2-DAY"
         EXPEDITED = :EXPEDITED
         EXPRESS = :EXPRESS
         PRIORITY = :PRIORITY

data/lib/lithic/models/card_create_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#create
     class CardCreateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter
@@ -334,7 +335,7 @@ module Lithic
       module ShippingMethod
         extend Lithic::Enum
 
-        NUMBER_2_DAY = :"2_DAY"
+        SHIPPING_METHOD_2_DAY = :"2_DAY"
         EXPEDITED = :EXPEDITED
         EXPRESS = :EXPRESS
         PRIORITY = :PRIORITY

data/lib/lithic/models/card_embed_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#embed
     class CardEmbedParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_list_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#list
     class CardListParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_program.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::CardPrograms#retrieve
     class CardProgram < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier.

data/lib/lithic/models/card_program_list_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::CardPrograms#list
     class CardProgramListParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_program_retrieve_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::CardPrograms#retrieve
     class CardProgramRetrieveParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_provision_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#provision
     class CardProvisionParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_provision_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#provision
     class CardProvisionResponse < Lithic::BaseModel
       # @!attribute [r] provisioning_payload
       #

data/lib/lithic/models/card_reissue_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#reissue
     class CardReissueParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter
@@ -86,7 +87,7 @@ module Lithic
       module ShippingMethod
         extend Lithic::Enum
 
-        NUMBER_2_DAY = :"2-DAY"
+        SHIPPING_METHOD_2_DAY = :"2-DAY"
         EXPEDITED = :EXPEDITED
         EXPRESS = :EXPRESS
         PRIORITY = :PRIORITY

data/lib/lithic/models/card_renew_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#renew
     class CardRenewParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter
@@ -117,7 +118,7 @@ module Lithic
       module ShippingMethod
         extend Lithic::Enum
 
-        NUMBER_2_DAY = :"2-DAY"
+        SHIPPING_METHOD_2_DAY = :"2-DAY"
         EXPEDITED = :EXPEDITED
         EXPRESS = :EXPRESS
         PRIORITY = :PRIORITY

data/lib/lithic/models/card_retrieve_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#retrieve
     class CardRetrieveParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_retrieve_spend_limits_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#retrieve_spend_limits
     class CardRetrieveSpendLimitsParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_search_by_pan_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#search_by_pan
     class CardSearchByPanParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/card_spend_limits.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#retrieve_spend_limits
     class CardSpendLimits < Lithic::BaseModel
       # @!attribute available_spend_limit
       #
@@ -35,6 +36,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::CardSpendLimits#available_spend_limit
       class AvailableSpendLimit < Lithic::BaseModel
         # @!attribute [r] annually
         #   The available spend limit (in cents) relative to the annual limit configured on
@@ -79,6 +81,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::CardSpendLimits#spend_limit
       class SpendLimit < Lithic::BaseModel
         # @!attribute [r] annually
         #   The configured annual spend limit (in cents) on the Card.
@@ -120,6 +123,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::CardSpendLimits#spend_velocity
       class SpendVelocity < Lithic::BaseModel
         # @!attribute [r] annually
         #   Current annual spend velocity (in cents) on the Card. Present if annual spend

data/lib/lithic/models/card_update_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Cards#update
     class CardUpdateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/cards/aggregate_balance_list_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module Cards
+      # @see Lithic::Resources::Cards::AggregateBalances#list
       class AggregateBalanceListParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/cards/aggregate_balance_list_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module Cards
+      # @see Lithic::Resources::Cards::AggregateBalances#list
       class AggregateBalanceListResponse < Lithic::BaseModel
         # @!attribute available_amount
         #   Funds available for spend in the currency's smallest unit (e.g., cents for USD)

data/lib/lithic/models/cards/balance_list_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module Cards
+      # @see Lithic::Resources::Cards::Balances#list
       class BalanceListParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter