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

data/lib/lithic/resources/credit_products/prime_rates.rb

@@ -6,22 +6,21 @@ module Lithic
       class PrimeRates
         # Post Credit Product Prime Rate
         #
-        # @param credit_product_token [String] Globally unique identifier for credit products.
+        # @overload create(credit_product_token, effective_date:, rate:, request_options: {})
         #
-        # @param params [Lithic::Models::CreditProducts::PrimeRateCreateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Date] :effective_date Date the rate goes into effect
-        #
-        #   @option params [String] :rate The rate in decimal format
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param credit_product_token [String]
+        # @param effective_date [Date]
+        # @param rate [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::CreditProducts::PrimeRateCreateParams
         def create(credit_product_token, params)
           parsed, options = Lithic::Models::CreditProducts::PrimeRateCreateParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["v1/credit_products/%0s/prime_rates", credit_product_token],
+            path: ["v1/credit_products/%1$s/prime_rates", credit_product_token],
             body: parsed,
             model: NilClass,
             options: options
@@ -30,28 +29,29 @@ module Lithic
 
         # Get Credit Product Prime Rates
         #
-        # @param credit_product_token [String] Globally unique identifier for credit products.
-        #
-        # @param params [Lithic::Models::CreditProducts::PrimeRateRetrieveParams, Hash{Symbol=>Object}] .
+        # @overload retrieve(credit_product_token, ending_before: nil, starting_after: nil, request_options: {})
         #
-        #   @option params [Date] :ending_before The effective date that the prime rates ends before
-        #
-        #   @option params [Date] :starting_after The effective date that the prime rate starts after
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param credit_product_token [String]
+        # @param ending_before [Date]
+        # @param starting_after [Date]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::CreditProducts::PrimeRateRetrieveResponse]
+        #
+        # @see Lithic::Models::CreditProducts::PrimeRateRetrieveParams
         def retrieve(credit_product_token, params = {})
           parsed, options = Lithic::Models::CreditProducts::PrimeRateRetrieveParams.dump_request(params)
           @client.request(
             method: :get,
-            path: ["v1/credit_products/%0s/prime_rates", credit_product_token],
+            path: ["v1/credit_products/%1$s/prime_rates", credit_product_token],
             query: parsed,
             model: Lithic::Models::CreditProducts::PrimeRateRetrieveResponse,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/credit_products.rb

@@ -9,6 +9,8 @@ module Lithic
       # @return [Lithic::Resources::CreditProducts::PrimeRates]
       attr_reader :prime_rates
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/digital_card_art.rb

@@ -5,20 +5,18 @@ module Lithic
     class DigitalCardArt
       # Get digital card art by token.
       #
-      # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet
-      #   after tokenization. This artwork must be approved by Mastercard and configured
-      #   by Lithic to use. See
-      #   [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
+      # @overload retrieve(digital_card_art_token, request_options: {})
       #
-      # @param params [Lithic::Models::DigitalCardArtRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param digital_card_art_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DigitalCardArtAPI]
+      #
+      # @see Lithic::Models::DigitalCardArtRetrieveParams
       def retrieve(digital_card_art_token, params = {})
         @client.request(
           method: :get,
-          path: ["v1/digital_card_art/%0s", digital_card_art_token],
+          path: ["v1/digital_card_art/%1$s", digital_card_art_token],
           model: Lithic::Models::DigitalCardArtAPI,
           options: params[:request_options]
         )
@@ -26,19 +24,16 @@ module Lithic
 
       # List digital card art.
       #
-      # @param params [Lithic::Models::DigitalCardArtListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :ending_before A cursor representing an item's token before which a page of results should end.
-      #     Used to retrieve the previous page of results before this item.
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
+      # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      #   @option params [String] :starting_after A cursor representing an item's token after which a page of results should
-      #     begin. Used to retrieve the next page of results after this item.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::DigitalCardArtAPI>]
+      #
+      # @see Lithic::Models::DigitalCardArtListParams
       def list(params = {})
         parsed, options = Lithic::Models::DigitalCardArtListParams.dump_request(params)
         @client.request(
@@ -51,6 +46,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/disputes.rb

@@ -5,21 +5,18 @@ module Lithic
     class Disputes
       # Initiate a dispute.
       #
-      # @param params [Lithic::Models::DisputeCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
       #
-      #   @option params [Integer] :amount Amount to dispute
-      #
-      #   @option params [Symbol, Lithic::Models::DisputeCreateParams::Reason] :reason Reason for dispute
-      #
-      #   @option params [String] :transaction_token Transaction to dispute
-      #
-      #   @option params [Time] :customer_filed_date Date the customer filed the dispute
-      #
-      #   @option params [String] :customer_note Customer description of dispute
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason]
+      # @param transaction_token [String]
+      # @param customer_filed_date [Time]
+      # @param customer_note [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeCreateParams
       def create(params)
         parsed, options = Lithic::Models::DisputeCreateParams.dump_request(params)
         @client.request(
@@ -33,17 +30,18 @@ module Lithic
 
       # Get dispute.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(dispute_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeRetrieveParams
       def retrieve(dispute_token, params = {})
         @client.request(
           method: :get,
-          path: ["v1/disputes/%0s", dispute_token],
+          path: ["v1/disputes/%1$s", dispute_token],
           model: Lithic::Models::Dispute,
           options: params[:request_options]
         )
@@ -51,26 +49,23 @@ module Lithic
 
       # Update dispute. Can only be modified if status is `NEW`.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount Amount to dispute
-      #
-      #   @option params [Time] :customer_filed_date Date the customer filed the dispute
-      #
-      #   @option params [String] :customer_note Customer description of dispute
+      # @overload update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::DisputeUpdateParams::Reason] :reason Reason for dispute
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param amount [Integer]
+      # @param customer_filed_date [Time]
+      # @param customer_note [String]
+      # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeUpdateParams
       def update(dispute_token, params = {})
         parsed, options = Lithic::Models::DisputeUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["v1/disputes/%0s", dispute_token],
+          path: ["v1/disputes/%1$s", dispute_token],
           body: parsed,
           model: Lithic::Models::Dispute,
           options: options
@@ -79,29 +74,20 @@ module Lithic
 
       # List disputes.
       #
-      # @param params [Lithic::Models::DisputeListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Time] :begin_ Date string in RFC 3339 format. Only entries created after the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @option params [String] :ending_before A cursor representing an item's token before which a page of results should end.
-      #     Used to retrieve the previous page of results before this item.
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
+      # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {})
       #
-      #   @option params [String] :starting_after A cursor representing an item's token after which a page of results should
-      #     begin. Used to retrieve the next page of results after this item.
-      #
-      #   @option params [Symbol, Lithic::Models::DisputeListParams::Status] :status List disputes of a specific status.
-      #
-      #   @option params [Array<String>] :transaction_tokens Transaction tokens to filter by.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param begin_ [Time]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param status [Symbol, Lithic::Models::DisputeListParams::Status]
+      # @param transaction_tokens [Array<String>]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::Dispute>]
+      #
+      # @see Lithic::Models::DisputeListParams
       def list(params = {})
         parsed, options = Lithic::Models::DisputeListParams.dump_request(params)
         @client.request(
@@ -116,17 +102,18 @@ module Lithic
 
       # Withdraw dispute.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(dispute_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeDeleteParams
       def delete(dispute_token, params = {})
         @client.request(
           method: :delete,
-          path: ["v1/disputes/%0s", dispute_token],
+          path: ["v1/disputes/%1$s", dispute_token],
           model: Lithic::Models::Dispute,
           options: params[:request_options]
         )
@@ -135,15 +122,15 @@ module Lithic
       # Soft delete evidence for a dispute. Evidence will not be reviewed or submitted
       #   by Lithic after it is withdrawn.
       #
-      # @param evidence_token [String]
-      #
-      # @param params [Lithic::Models::DisputeDeleteEvidenceParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :dispute_token
+      # @overload delete_evidence(evidence_token, dispute_token:, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param evidence_token [String]
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
+      #
+      # @see Lithic::Models::DisputeDeleteEvidenceParams
       def delete_evidence(evidence_token, params)
         parsed, options = Lithic::Models::DisputeDeleteEvidenceParams.dump_request(params)
         dispute_token =
@@ -152,7 +139,7 @@ module Lithic
           end
         @client.request(
           method: :delete,
-          path: ["v1/disputes/%0s/evidences/%1s", dispute_token, evidence_token],
+          path: ["v1/disputes/%1$s/evidences/%2$s", dispute_token, evidence_token],
           model: Lithic::Models::DisputeEvidence,
           options: options
         )
@@ -164,20 +151,20 @@ module Lithic
       #   Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be
       #   less than 5 GiB.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeInitiateEvidenceUploadParams, Hash{Symbol=>Object}] .
+      # @overload initiate_evidence_upload(dispute_token, filename: nil, request_options: {})
       #
-      #   @option params [String] :filename Filename of the evidence.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param filename [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
+      #
+      # @see Lithic::Models::DisputeInitiateEvidenceUploadParams
       def initiate_evidence_upload(dispute_token, params = {})
         parsed, options = Lithic::Models::DisputeInitiateEvidenceUploadParams.dump_request(params)
         @client.request(
           method: :post,
-          path: ["v1/disputes/%0s/evidences", dispute_token],
+          path: ["v1/disputes/%1$s/evidences", dispute_token],
           body: parsed,
           model: Lithic::Models::DisputeEvidence,
           options: options
@@ -186,32 +173,24 @@ module Lithic
 
       # List evidence metadata for a dispute.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeListEvidencesParams, Hash{Symbol=>Object}] .
+      # @overload list_evidences(dispute_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      #   @option params [Time] :begin_ Date string in RFC 3339 format. Only entries created after the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @option params [String] :ending_before A cursor representing an item's token before which a page of results should end.
-      #     Used to retrieve the previous page of results before this item.
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
-      #
-      #   @option params [String] :starting_after A cursor representing an item's token after which a page of results should
-      #     begin. Used to retrieve the next page of results after this item.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param begin_ [Time]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::DisputeEvidence>]
+      #
+      # @see Lithic::Models::DisputeListEvidencesParams
       def list_evidences(dispute_token, params = {})
         parsed, options = Lithic::Models::DisputeListEvidencesParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["v1/disputes/%0s/evidences", dispute_token],
+          path: ["v1/disputes/%1$s/evidences", dispute_token],
           query: parsed,
           page: Lithic::CursorPage,
           model: Lithic::Models::DisputeEvidence,
@@ -221,15 +200,15 @@ module Lithic
 
       # Get a dispute's evidence metadata.
       #
-      # @param evidence_token [String]
-      #
-      # @param params [Lithic::Models::DisputeRetrieveEvidenceParams, Hash{Symbol=>Object}] .
+      # @overload retrieve_evidence(evidence_token, dispute_token:, request_options: {})
       #
-      #   @option params [String] :dispute_token
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param evidence_token [String]
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
+      #
+      # @see Lithic::Models::DisputeRetrieveEvidenceParams
       def retrieve_evidence(evidence_token, params)
         parsed, options = Lithic::Models::DisputeRetrieveEvidenceParams.dump_request(params)
         dispute_token =
@@ -238,12 +217,14 @@ module Lithic
           end
         @client.request(
           method: :get,
-          path: ["v1/disputes/%0s/evidences/%1s", dispute_token, evidence_token],
+          path: ["v1/disputes/%1$s/evidences/%2$s", dispute_token, evidence_token],
           model: Lithic::Models::DisputeEvidence,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client