lithic 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0c8b5a7989afe426d0115b72d6ee6c435145d02a01ab917685c1d4c15a9e6f8
-  data.tar.gz: 4e4838fa8d84c45c7ddb8a09afdd077369fd8017235332377bb865593034e876
+  metadata.gz: 18e62e72ed7b543b02b1b27f8b6fa01e5d103ade169f16821584c7f25bf795c4
+  data.tar.gz: '059128319fd80fce301facf7fe31a78bb1e7dc285bcf087cbbb865699fa5d799'
 SHA512:
-  metadata.gz: 964dd7be6e3ef70cd7b5ef9fd4ff9d78e1bb23409c3cacfe5aab146f01e9d40d4171d5c137091cba4f576c59a145fbfc2eaaf325eae7b104cced1e380e517511
-  data.tar.gz: 4e51bab703b5f119a678dc27b8a6a5bfcf32e6e15ffe9c6415e209826a5efcd09e9e753b2d8c9981ae5d49b994e5b140433bdb02ed347cf91110ad0848437c23
+  metadata.gz: 59726459104a1e320267baff1fbc631a240c873933213fb240cd3a3f952a36e50b105298890e508bbd3dc38ee004c87f2f3e5c908a717dafdd7d3b31f4986362
+  data.tar.gz: b4e731358d20edad987d145a1fff6f2adc6416fa7fbf0384ff3296e72eb511a30cde488f9451d137547b075dcad602c40540d247bddcd2fee325bf37e6a37a50

data/README.md

@@ -13,7 +13,7 @@ The underlying REST API documentation can be found on [docs.lithic.com](https://
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
 ```ruby
-gem "lithic", "~> 0.1.0.pre.alpha.1"
+gem "lithic", "~> 0.1.0.pre.alpha.3"
 ```
 
 To fetch an initial copy of the gem:
@@ -64,7 +64,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 ```ruby
 begin
   card = lithic.cards.create(type: "an_incorrect_type")
-rescue Lithic::Error => e
+rescue Lithic::Errors::APIError => e
   puts(e.status) # 400
 end
 ```
@@ -80,7 +80,7 @@ Error codes are as followed:
 | HTTP 409         | `ConflictError`            |
 | HTTP 422         | `UnprocessableEntityError` |
 | HTTP 429         | `RateLimitError`           |
-| HTTP >=500       | `InternalServerError`      |
+| HTTP >= 500      | `InternalServerError`      |
 | Other HTTP error | `APIStatusError`           |
 | Timeout          | `APITimeoutError`          |
 | Network error    | `APIConnectionError`       |
@@ -134,7 +134,7 @@ Due to limitations with the Sorbet type system, where a method otherwise can tak
 Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
 
 ```ruby
-model = CardCreateParams.new(type: "SINGLE_USE")
+model = Lithic::Models::CardCreateParams.new(type: "SINGLE_USE")
 
 lithic.cards.create(**model)
 ```

data/lib/lithic/client.rb

@@ -100,11 +100,13 @@ module Lithic
 
     # Status of api
     #
-    # @param params [Lithic::Models::ClientAPIStatusParams, Hash{Symbol=>Object}] .
+    # @overload api_status(request_options: {})
     #
-    #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+    # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
     #
     # @return [Lithic::Models::APIStatus]
+    #
+    # @see Lithic::Models::ClientAPIStatusParams
     def api_status(params = {})
       request(
         method: :get,
@@ -123,6 +125,8 @@ module Lithic
 
     # Creates and returns a new client for interacting with the API.
     #
+    # @param api_key [String, nil] Defaults to `ENV["LITHIC_API_KEY"]`
+    #
     # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
     #
     #   Each environment maps to a different base URL:
@@ -132,8 +136,6 @@ module Lithic
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
     #
-    # @param api_key [String, nil] Defaults to `ENV["LITHIC_API_KEY"]`
-    #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
     # @param timeout [Float]
@@ -142,9 +144,9 @@ module Lithic
     #
     # @param max_retry_delay [Float]
     def initialize(
+      api_key: ENV["LITHIC_API_KEY"],
       environment: nil,
       base_url: nil,
-      api_key: ENV["LITHIC_API_KEY"],
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
@@ -162,7 +164,7 @@ module Lithic
       end
 
       if api_key.nil?
-        raise ArgumentError.new("api_key is required")
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"LITHIC_API_KEY\"")
       end
 
       headers = {

data/lib/lithic/errors.rb

@@ -1,183 +1,220 @@
 # frozen_string_literal: true
 
 module Lithic
-  class Error < StandardError
-    # @!parse
-    #   # @return [StandardError, nil]
-    #   attr_accessor :cause
-  end
+  module Errors
+    class Error < StandardError
+      # @!parse
+      #   # @return [StandardError, nil]
+      #   attr_accessor :cause
+    end
 
-  class ConversionError < Lithic::Error
-  end
+    class ConversionError < Lithic::Errors::Error
+    end
 
-  class APIError < Lithic::Error
-    # @return [URI::Generic]
-    attr_accessor :url
-
-    # @return [Integer, nil]
-    attr_accessor :status
-
-    # @return [Object, nil]
-    attr_accessor :body
-
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer, nil]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
-      @url = url
-      @status = status
-      @body = body
-      @request = request
-      @response = response
-      super(message)
+    class APIError < Lithic::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
     end
-  end
 
-  class APIConnectionError < Lithic::APIError
-    # @!parse
-    #   # @return [nil]
-    #   attr_accessor :status
-
-    # @!parse
-    #   # @return [nil]
-    #   attr_accessor :body
-
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [nil]
-    # @param body [nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(
-      url:,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: "Connection error."
-    )
-      super
+    class APIConnectionError < Lithic::Errors::APIError
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :status
+
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
     end
-  end
 
-  class APITimeoutError < Lithic::APIConnectionError
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [nil]
-    # @param body [nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(
-      url:,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: "Request timed out."
-    )
-      super
+    class APITimeoutError < Lithic::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
     end
-  end
 
-  class APIStatusError < Lithic::APIError
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    #
-    # @return [Lithic::APIStatusError]
-    def self.for(url:, status:, body:, request:, response:, message: nil)
-      kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
-
-      case status
-      in 400
-        Lithic::BadRequestError.new(**kwargs)
-      in 401
-        Lithic::AuthenticationError.new(**kwargs)
-      in 403
-        Lithic::PermissionDeniedError.new(**kwargs)
-      in 404
-        Lithic::NotFoundError.new(**kwargs)
-      in 409
-        Lithic::ConflictError.new(**kwargs)
-      in 422
-        Lithic::UnprocessableEntityError.new(**kwargs)
-      in 429
-        Lithic::RateLimitError.new(**kwargs)
-      in (500..)
-        Lithic::InternalServerError.new(**kwargs)
-      else
-        Lithic::APIStatusError.new(**kwargs)
+    class APIStatusError < Lithic::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [Lithic::Errors::APIStatusError]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          Lithic::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Lithic::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Lithic::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Lithic::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Lithic::Errors::ConflictError.new(**kwargs)
+        in 422
+          Lithic::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Lithic::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Lithic::Errors::InternalServerError.new(**kwargs)
+        else
+          Lithic::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
       end
     end
 
-    # @!parse
-    #   # @return [Integer]
-    #   attr_accessor :status
-
-    # @api private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    def initialize(url:, status:, body:, request:, response:, message: nil)
-      message ||= {url: url.to_s, status: status, body: body}
-      super(
-        url: url,
-        status: status,
-        body: body,
-        request: request,
-        response: response,
-        message: message&.to_s
-      )
+    class BadRequestError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 400
     end
-  end
 
-  class BadRequestError < Lithic::APIStatusError
-    HTTP_STATUS = 400
-  end
+    class AuthenticationError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
 
-  class AuthenticationError < Lithic::APIStatusError
-    HTTP_STATUS = 401
-  end
+    class PermissionDeniedError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
 
-  class PermissionDeniedError < Lithic::APIStatusError
-    HTTP_STATUS = 403
-  end
+    class NotFoundError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
 
-  class NotFoundError < Lithic::APIStatusError
-    HTTP_STATUS = 404
-  end
+    class ConflictError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
 
-  class ConflictError < Lithic::APIStatusError
-    HTTP_STATUS = 409
-  end
+    class UnprocessableEntityError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
 
-  class UnprocessableEntityError < Lithic::APIStatusError
-    HTTP_STATUS = 422
-  end
+    class RateLimitError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
 
-  class RateLimitError < Lithic::APIStatusError
-    HTTP_STATUS = 429
+    class InternalServerError < Lithic::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
   end
 
-  class InternalServerError < Lithic::APIStatusError
-    HTTP_STATUS = (500..)
-  end
+  Error = Lithic::Errors::Error
+
+  ConversionError = Lithic::Errors::ConversionError
+
+  APIError = Lithic::Errors::APIError
+
+  APIStatusError = Lithic::Errors::APIStatusError
+
+  APIConnectionError = Lithic::Errors::APIConnectionError
+
+  APITimeoutError = Lithic::Errors::APITimeoutError
+
+  BadRequestError = Lithic::Errors::BadRequestError
+
+  AuthenticationError = Lithic::Errors::AuthenticationError
+
+  PermissionDeniedError = Lithic::Errors::PermissionDeniedError
+
+  NotFoundError = Lithic::Errors::NotFoundError
+
+  ConflictError = Lithic::Errors::ConflictError
+
+  UnprocessableEntityError = Lithic::Errors::UnprocessableEntityError
+
+  RateLimitError = Lithic::Errors::RateLimitError
+
+  InternalServerError = Lithic::Errors::InternalServerError
 end

data/lib/lithic/models/account.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Accounts#retrieve
     class Account < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier for the account. This is the same as the
@@ -111,6 +112,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::Account#spend_limit
       class SpendLimit < Lithic::BaseModel
         # @!attribute daily
         #   Daily spend limit (in cents).
@@ -157,6 +159,8 @@ module Lithic
       #     risk/compliance reasons. Please contact
       #     [support@lithic.com](mailto:support@lithic.com) if you believe this was in
       #     error.
+      #
+      # @see Lithic::Models::Account#state
       module State
         extend Lithic::Enum
 
@@ -171,6 +175,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::Account#account_holder
       class AccountHolder < Lithic::BaseModel
         # @!attribute token
         #   Globally unique identifier for the account holder.
@@ -210,6 +215,8 @@ module Lithic
       end
 
       # @deprecated
+      #
+      # @see Lithic::Models::Account#verification_address
       class VerificationAddress < Lithic::BaseModel
         # @!attribute address1
         #   Valid deliverable address (no PO boxes).

data/lib/lithic/models/account_holder.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#retrieve
     class AccountHolder < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier for the account holder.
@@ -415,6 +416,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::AccountHolder#business_entity
       class BusinessEntity < Lithic::BaseModel
         # @!attribute address
         #   Business's physical address - PO boxes, UPS drops, and FedEx drops are not
@@ -495,6 +497,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::AccountHolder#control_person
       class ControlPerson < Lithic::BaseModel
         # @!attribute address
         #   Individual's current address
@@ -560,6 +563,8 @@ module Lithic
       end
 
       # The type of KYC exemption for a KYC-Exempt Account Holder.
+      #
+      # @see Lithic::Models::AccountHolder#exemption_type
       module ExemptionType
         extend Lithic::Enum
 
@@ -573,6 +578,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::AccountHolder#individual
       class Individual < Lithic::BaseModel
         # @!attribute address
         #   Individual's current address
@@ -640,6 +646,8 @@ module Lithic
       #   Note:
       #
       #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+      #
+      # @see Lithic::Models::AccountHolder#status
       module Status
         extend Lithic::Enum
 
@@ -682,6 +690,8 @@ module Lithic
       #   attribute will be present. If the type is "BUSINESS" then the "business_entity",
       #   "control_person", "beneficial_owner_individuals", "beneficial_owner_entities",
       #   "nature_of_business", and "website_url" attributes will be present.
+      #
+      # @see Lithic::Models::AccountHolder#user_type
       module UserType
         extend Lithic::Enum
 
@@ -695,6 +705,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::AccountHolder#verification_application
       class VerificationApplication < Lithic::BaseModel
         # @!attribute [r] created
         #   Timestamp of when the application was created.
@@ -758,6 +769,8 @@ module Lithic
         #   Note:
         #
         #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+        #
+        # @see Lithic::Models::AccountHolder::VerificationApplication#status
         module Status
           extend Lithic::Enum
 

data/lib/lithic/models/account_holder_create_params.rb

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

data/lib/lithic/models/account_holder_create_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#create
     class AccountHolderCreateResponse < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier for the account holder.
@@ -93,6 +94,8 @@ module Lithic
       #   Note:
       #
       #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+      #
+      # @see Lithic::Models::AccountHolderCreateResponse#status
       module Status
         extend Lithic::Enum
 

data/lib/lithic/models/account_holder_list_documents_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#list_documents
     class AccountHolderListDocumentsParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_holder_list_documents_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#list_documents
     class AccountHolderListDocumentsResponse < Lithic::BaseModel
       # @!attribute [r] data
       #

data/lib/lithic/models/account_holder_list_params.rb

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

data/lib/lithic/models/account_holder_retrieve_document_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#retrieve_document
     class AccountHolderRetrieveDocumentParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_holder_retrieve_params.rb

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

data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#simulate_enrollment_document_review
     class AccountHolderSimulateEnrollmentDocumentReviewParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter