terminal-shop 2.1.3 → 3.6.0

data/lib/terminal_shop/models/token_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#get
+    class TokenGetParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/token_get_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#get
+    class TokenGetResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   A personal access token used to access the Terminal API. If you leak this,
+      #   expect large sums of coffee to be ordered on your credit card.
+      #
+      #   @return [TerminalShop::Models::TokenAPI]
+      required :data, -> { TerminalShop::Models::TokenAPI }
+
+      # @!method initialize(data:)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::TokenGetResponse} for more details.
+      #
+      #   @param data [TerminalShop::Models::TokenAPI] A personal access token used to access the Terminal API. If you leak this, expec
+      #   ...
+    end
+  end
+end

data/lib/terminal_shop/models/token_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#list
+    class TokenListParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/token_list_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#list
+    class TokenListResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   List of personal access tokens.
+      #
+      #   @return [Array<TerminalShop::Models::TokenAPI>]
+      required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::TokenAPI] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<TerminalShop::Models::TokenAPI>] List of personal access tokens.
+    end
+  end
+end

data/lib/terminal_shop/models/view_init_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::View#init
+    class ViewInitParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/view_init_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::View#init
+    class ViewInitResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   Initial app data.
+      #
+      #   @return [TerminalShop::Models::ViewInitResponse::Data]
+      required :data, -> { TerminalShop::Models::ViewInitResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::ViewInitResponse::Data] Initial app data.
+
+      # @see TerminalShop::Models::ViewInitResponse#data
+      class Data < TerminalShop::Internal::Type::BaseModel
+        # @!attribute addresses
+        #
+        #   @return [Array<TerminalShop::Models::AddressAPI>]
+        required :addresses, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::AddressAPI] }
+
+        # @!attribute apps
+        #
+        #   @return [Array<TerminalShop::Models::AppAPI>]
+        required :apps, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::AppAPI] }
+
+        # @!attribute cards
+        #
+        #   @return [Array<TerminalShop::Models::CardAPI>]
+        required :cards, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::CardAPI] }
+
+        # @!attribute cart
+        #   The current Terminal shop user's cart.
+        #
+        #   @return [TerminalShop::Models::CartAPI]
+        required :cart, -> { TerminalShop::Models::CartAPI }
+
+        # @!attribute orders
+        #
+        #   @return [Array<TerminalShop::Models::OrderAPI>]
+        required :orders, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::OrderAPI] }
+
+        # @!attribute products
+        #
+        #   @return [Array<TerminalShop::Models::ProductAPI>]
+        required :products, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::ProductAPI] }
+
+        # @!attribute profile
+        #   A Terminal shop user's profile. (We have users, btw.)
+        #
+        #   @return [TerminalShop::Models::ProfileAPI]
+        required :profile, -> { TerminalShop::Models::ProfileAPI }
+
+        # @!attribute region
+        #   A Terminal shop user's region.
+        #
+        #   @return [Symbol, TerminalShop::Models::Region]
+        required :region, enum: -> { TerminalShop::Models::Region }
+
+        # @!attribute subscriptions
+        #
+        #   @return [Array<TerminalShop::Models::SubscriptionAPI>]
+        required :subscriptions,
+                 -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::SubscriptionAPI] }
+
+        # @!attribute tokens
+        #
+        #   @return [Array<TerminalShop::Models::TokenAPI>]
+        required :tokens, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::TokenAPI] }
+
+        # @!method initialize(addresses:, apps:, cards:, cart:, orders:, products:, profile:, region:, subscriptions:, tokens:)
+        #   Initial app data.
+        #
+        #   @param addresses [Array<TerminalShop::Models::AddressAPI>]
+        #
+        #   @param apps [Array<TerminalShop::Models::AppAPI>]
+        #
+        #   @param cards [Array<TerminalShop::Models::CardAPI>]
+        #
+        #   @param cart [TerminalShop::Models::CartAPI] The current Terminal shop user's cart.
+        #
+        #   @param orders [Array<TerminalShop::Models::OrderAPI>]
+        #
+        #   @param products [Array<TerminalShop::Models::ProductAPI>]
+        #
+        #   @param profile [TerminalShop::Models::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
+        #
+        #   @param region [Symbol, TerminalShop::Models::Region] A Terminal shop user's region.
+        #
+        #   @param subscriptions [Array<TerminalShop::Models::SubscriptionAPI>]
+        #
+        #   @param tokens [Array<TerminalShop::Models::TokenAPI>]
+      end
+    end
+  end
+end

data/lib/terminal_shop/models.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  AddressAPI = TerminalShop::Models::AddressAPI
+
+  AddressCreateParams = TerminalShop::Models::AddressCreateParams
+
+  AddressDeleteParams = TerminalShop::Models::AddressDeleteParams
+
+  AddressGetParams = TerminalShop::Models::AddressGetParams
+
+  AddressListParams = TerminalShop::Models::AddressListParams
+
+  AppAPI = TerminalShop::Models::AppAPI
+
+  AppCreateParams = TerminalShop::Models::AppCreateParams
+
+  AppDeleteParams = TerminalShop::Models::AppDeleteParams
+
+  AppGetParams = TerminalShop::Models::AppGetParams
+
+  AppListParams = TerminalShop::Models::AppListParams
+
+  CardAPI = TerminalShop::Models::CardAPI
+
+  CardCollectParams = TerminalShop::Models::CardCollectParams
+
+  CardCreateParams = TerminalShop::Models::CardCreateParams
+
+  CardDeleteParams = TerminalShop::Models::CardDeleteParams
+
+  CardGetParams = TerminalShop::Models::CardGetParams
+
+  CardListParams = TerminalShop::Models::CardListParams
+
+  CartAPI = TerminalShop::Models::CartAPI
+
+  CartClearParams = TerminalShop::Models::CartClearParams
+
+  CartConvertParams = TerminalShop::Models::CartConvertParams
+
+  CartGetParams = TerminalShop::Models::CartGetParams
+
+  CartSetAddressParams = TerminalShop::Models::CartSetAddressParams
+
+  CartSetCardParams = TerminalShop::Models::CartSetCardParams
+
+  CartSetItemParams = TerminalShop::Models::CartSetItemParams
+
+  EmailCreateParams = TerminalShop::Models::EmailCreateParams
+
+  OrderAPI = TerminalShop::Models::OrderAPI
+
+  OrderCreateParams = TerminalShop::Models::OrderCreateParams
+
+  OrderGetParams = TerminalShop::Models::OrderGetParams
+
+  OrderListParams = TerminalShop::Models::OrderListParams
+
+  ProductAPI = TerminalShop::Models::ProductAPI
+
+  ProductGetParams = TerminalShop::Models::ProductGetParams
+
+  ProductListParams = TerminalShop::Models::ProductListParams
+
+  ProductVariant = TerminalShop::Models::ProductVariant
+
+  ProfileAPI = TerminalShop::Models::ProfileAPI
+
+  ProfileMeParams = TerminalShop::Models::ProfileMeParams
+
+  ProfileUpdateParams = TerminalShop::Models::ProfileUpdateParams
+
+  Region = TerminalShop::Models::Region
+
+  SubscriptionAPI = TerminalShop::Models::SubscriptionAPI
+
+  SubscriptionCreateParams = TerminalShop::Models::SubscriptionCreateParams
+
+  SubscriptionDeleteParams = TerminalShop::Models::SubscriptionDeleteParams
+
+  SubscriptionGetParams = TerminalShop::Models::SubscriptionGetParams
+
+  SubscriptionListParams = TerminalShop::Models::SubscriptionListParams
+
+  SubscriptionUpdateParams = TerminalShop::Models::SubscriptionUpdateParams
+
+  TokenAPI = TerminalShop::Models::TokenAPI
+
+  TokenCreateParams = TerminalShop::Models::TokenCreateParams
+
+  TokenDeleteParams = TerminalShop::Models::TokenDeleteParams
+
+  TokenGetParams = TerminalShop::Models::TokenGetParams
+
+  TokenListParams = TerminalShop::Models::TokenListParams
+
+  ViewInitParams = TerminalShop::Models::ViewInitParams
+end

data/lib/{terminal-shop → terminal_shop}/request_options.rb

@@ -2,11 +2,11 @@
 
 module TerminalShop
   # Specify HTTP behaviour to use for a specific request. These options supplement
-  #   or override those provided at the client level.
+  # or override those provided at the client level.
   #
-  #   When making a request, you can pass an actual {RequestOptions} instance, or
-  #   simply pass a Hash with symbol keys matching the attributes on this class.
-  class RequestOptions < TerminalShop::BaseModel
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < TerminalShop::Internal::Type::BaseModel
     # @api private
     #
     # @param opts [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
@@ -27,31 +27,31 @@ module TerminalShop
 
     # @!attribute idempotency_key
     #   Idempotency key to send with request and all associated retries. Will only be
-    #     sent for write requests.
+    #   sent for write requests.
     #
     #   @return [String, nil]
     optional :idempotency_key, String
 
     # @!attribute extra_query
     #   Extra query params to send with the request. These are `.merge`’d into any
-    #     `query` given at the client level.
+    #   `query` given at the client level.
     #
     #   @return [Hash{String=>Array<String>, String, nil}, nil]
-    optional :extra_query, TerminalShop::HashOf[TerminalShop::ArrayOf[String]]
+    optional :extra_query, TerminalShop::Internal::Type::HashOf[TerminalShop::Internal::Type::ArrayOf[String]]
 
     # @!attribute extra_headers
     #   Extra headers to send with the request. These are `.merged`’d into any
-    #     `extra_headers` given at the client level.
+    #   `extra_headers` given at the client level.
     #
     #   @return [Hash{String=>String, nil}, nil]
-    optional :extra_headers, TerminalShop::HashOf[String, nil?: true]
+    optional :extra_headers, TerminalShop::Internal::Type::HashOf[String, nil?: true]
 
     # @!attribute extra_body
     #   Extra data to send with the request. These are deep merged into any data
-    #     generated as part of the normal request.
+    #   generated as part of the normal request.
     #
     #   @return [Object, nil]
-    optional :extra_body, TerminalShop::HashOf[TerminalShop::Unknown]
+    optional :extra_body, TerminalShop::Internal::Type::HashOf[TerminalShop::Internal::Type::Unknown]
 
     # @!attribute max_retries
     #   Maximum number of retries to attempt after a failed initial request.
@@ -65,11 +65,9 @@ module TerminalShop
     #   @return [Float, nil]
     optional :timeout, Float
 
-    # @!parse
-    #   # Returns a new instance of RequestOptions.
-    #   #
-    #   # @param values [Hash{Symbol=>Object}]
-    #   #
-    #   def initialize(values = {}) = super
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
   end
 end

data/lib/{terminal-shop → terminal_shop}/resources/address.rb

@@ -5,27 +5,29 @@ module TerminalShop
     class Address
       # Create and add a shipping address to the current user.
       #
-      # @param params [TerminalShop::Models::AddressCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil, request_options: {})
       #
-      #   @option params [String] :city City of the address.
+      # @param city [String] City of the address.
       #
-      #   @option params [String] :country ISO 3166-1 alpha-2 country code of the address.
+      # @param country [String] ISO 3166-1 alpha-2 country code of the address.
       #
-      #   @option params [String] :name The recipient's name.
+      # @param name [String] The recipient's name.
       #
-      #   @option params [String] :street1 Street of the address.
+      # @param street1 [String] Street of the address.
       #
-      #   @option params [String] :zip Zip code of the address.
+      # @param zip [String] Zip code of the address.
       #
-      #   @option params [String] :phone Phone number of the recipient.
+      # @param phone [String] Phone number of the recipient.
       #
-      #   @option params [String] :province Province or state of the address.
+      # @param province [String] Province or state of the address.
       #
-      #   @option params [String] :street2 Apartment, suite, etc. of the address.
+      # @param street2 [String] Apartment, suite, etc. of the address.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AddressCreateResponse]
+      #
+      # @see TerminalShop::Models::AddressCreateParams
       def create(params)
         parsed, options = TerminalShop::Models::AddressCreateParams.dump_request(params)
         @client.request(
@@ -39,11 +41,13 @@ module TerminalShop
 
       # Get the shipping addresses associated with the current user.
       #
-      # @param params [TerminalShop::Models::AddressListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AddressListResponse]
+      #
+      # @see TerminalShop::Models::AddressListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -55,13 +59,15 @@ module TerminalShop
 
       # Delete a shipping address from the current user.
       #
-      # @param id [String] ID of the shipping address to delete.
+      # @overload delete(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::AddressDeleteParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the shipping address to delete.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AddressDeleteResponse]
+      #
+      # @see TerminalShop::Models::AddressDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -73,13 +79,15 @@ module TerminalShop
 
       # Get the shipping address with the given ID.
       #
-      # @param id [String] ID of the shipping address to get.
+      # @overload get(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::AddressGetParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the shipping address to get.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AddressGetResponse]
+      #
+      # @see TerminalShop::Models::AddressGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -89,6 +97,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/{terminal-shop → terminal_shop}/resources/app.rb

@@ -5,15 +5,15 @@ module TerminalShop
     class App
       # Create an app.
       #
-      # @param params [TerminalShop::Models::AppCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(name:, redirect_uri:, request_options: {})
       #
-      #   @option params [String] :name
-      #
-      #   @option params [String] :redirect_uri
-      #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param name [String]
+      # @param redirect_uri [String]
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AppCreateResponse]
+      #
+      # @see TerminalShop::Models::AppCreateParams
       def create(params)
         parsed, options = TerminalShop::Models::AppCreateParams.dump_request(params)
         @client.request(
@@ -27,11 +27,13 @@ module TerminalShop
 
       # List the current user's registered apps.
       #
-      # @param params [TerminalShop::Models::AppListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AppListResponse]
+      #
+      # @see TerminalShop::Models::AppListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -43,13 +45,15 @@ module TerminalShop
 
       # Delete the app with the given ID.
       #
-      # @param id [String] ID of the app to delete.
+      # @overload delete(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::AppDeleteParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the app to delete.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AppDeleteResponse]
+      #
+      # @see TerminalShop::Models::AppDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -61,13 +65,15 @@ module TerminalShop
 
       # Get the app with the given ID.
       #
-      # @param id [String] ID of the app to get.
+      # @overload get(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::AppGetParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the app to get.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::AppGetResponse]
+      #
+      # @see TerminalShop::Models::AppGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -77,6 +83,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/{terminal-shop → terminal_shop}/resources/card.rb

@@ -3,16 +3,21 @@
 module TerminalShop
   module Resources
     class Card
+      # Some parameter documentations has been truncated, see
+      # {TerminalShop::Models::CardCreateParams} for more details.
+      #
       # Attach a credit card (tokenized via Stripe) to the current user.
       #
-      # @param params [TerminalShop::Models::CardCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(token:, request_options: {})
       #
-      #   @option params [String] :token Stripe card token. Learn how to
-      #     [create one here](https://docs.stripe.com/api/tokens/create_card).
+      # @param token [String] Stripe card token. Learn how to [create one here](https://docs.stripe.com/api/to
+      # ...
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CardCreateResponse]
+      #
+      # @see TerminalShop::Models::CardCreateParams
       def create(params)
         parsed, options = TerminalShop::Models::CardCreateParams.dump_request(params)
         @client.request(
@@ -26,11 +31,13 @@ module TerminalShop
 
       # List the credit cards associated with the current user.
       #
-      # @param params [TerminalShop::Models::CardListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CardListResponse]
+      #
+      # @see TerminalShop::Models::CardListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -42,13 +49,15 @@ module TerminalShop
 
       # Delete a credit card associated with the current user.
       #
-      # @param id [String] ID of the card to delete.
+      # @overload delete(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::CardDeleteParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the card to delete.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CardDeleteResponse]
+      #
+      # @see TerminalShop::Models::CardDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -59,13 +68,15 @@ module TerminalShop
       end
 
       # Create a temporary URL for collecting credit card information for the current
-      #   user.
+      # user.
       #
-      # @param params [TerminalShop::Models::CardCollectParams, Hash{Symbol=>Object}] .
+      # @overload collect(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CardCollectResponse]
+      #
+      # @see TerminalShop::Models::CardCollectParams
       def collect(params = {})
         @client.request(
           method: :post,
@@ -77,13 +88,15 @@ module TerminalShop
 
       # Get a credit card by ID associated with the current user.
       #
-      # @param id [String] ID of the card to get.
+      # @overload get(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::CardGetParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the card to get.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CardGetResponse]
+      #
+      # @see TerminalShop::Models::CardGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -93,6 +106,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client