terminal-shop 2.1.2 → 3.5.0

data/lib/terminal_shop/internal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Internal
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{TerminalShop::Internal}::OMIT>" }
+      end
+        .freeze
+  end
+end

data/lib/terminal_shop/models/address.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class AddressAPI < TerminalShop::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique object identifier. The format and length of IDs may change over time.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute city
+      #   City of the address.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country code of the address.
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute created
+      #   Date the address was created.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!attribute name
+      #   The recipient's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute street1
+      #   Street of the address.
+      #
+      #   @return [String]
+      required :street1, String
+
+      # @!attribute zip
+      #   Zip code of the address.
+      #
+      #   @return [String]
+      required :zip, String
+
+      # @!attribute phone
+      #   Phone number of the recipient.
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!attribute province
+      #   Province or state of the address.
+      #
+      #   @return [String, nil]
+      optional :province, String
+
+      # @!attribute street2
+      #   Apartment, suite, etc. of the address.
+      #
+      #   @return [String, nil]
+      optional :street2, String
+
+      # @!method initialize(id:, city:, country:, created:, name:, street1:, zip:, phone: nil, province: nil, street2: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::AddressAPI} for more details.
+      #
+      #   Physical address associated with a Terminal shop user.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param city [String] City of the address.
+      #
+      #   @param country [String] ISO 3166-1 alpha-2 country code of the address.
+      #
+      #   @param created [String] Date the address was created.
+      #
+      #   @param name [String] The recipient's name.
+      #
+      #   @param street1 [String] Street of the address.
+      #
+      #   @param zip [String] Zip code of the address.
+      #
+      #   @param phone [String] Phone number of the recipient.
+      #
+      #   @param province [String] Province or state of the address.
+      #
+      #   @param street2 [String] Apartment, suite, etc. of the address.
+    end
+  end
+end

data/lib/terminal_shop/models/address_create_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#create
+    class AddressCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute city
+      #   City of the address.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country code of the address.
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute name
+      #   The recipient's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute street1
+      #   Street of the address.
+      #
+      #   @return [String]
+      required :street1, String
+
+      # @!attribute zip
+      #   Zip code of the address.
+      #
+      #   @return [String]
+      required :zip, String
+
+      # @!attribute phone
+      #   Phone number of the recipient.
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!attribute province
+      #   Province or state of the address.
+      #
+      #   @return [String, nil]
+      optional :province, String
+
+      # @!attribute street2
+      #   Apartment, suite, etc. of the address.
+      #
+      #   @return [String, nil]
+      optional :street2, String
+
+      # @!method initialize(city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil, request_options: {})
+      #   @param city [String] City of the address.
+      #
+      #   @param country [String] ISO 3166-1 alpha-2 country code of the address.
+      #
+      #   @param name [String] The recipient's name.
+      #
+      #   @param street1 [String] Street of the address.
+      #
+      #   @param zip [String] Zip code of the address.
+      #
+      #   @param phone [String] Phone number of the recipient.
+      #
+      #   @param province [String] Province or state of the address.
+      #
+      #   @param street2 [String] Apartment, suite, etc. of the address.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/address_create_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#create
+    class AddressCreateResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   Shipping address ID.
+      #
+      #   @return [String]
+      required :data, String
+
+      # @!method initialize(data:)
+      #   @param data [String] Shipping address ID.
+    end
+  end
+end

data/lib/terminal_shop/models/address_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#delete
+    class AddressDeleteParams < 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/address_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#delete
+    class AddressDeleteResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!method initialize(data: :ok)
+      #   @param data [Symbol, :ok]
+    end
+  end
+end

data/lib/terminal_shop/models/address_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#get
+    class AddressGetParams < 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 → terminal_shop}/models/address_get_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class AddressGetResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Address#get
+    class AddressGetResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   Physical address associated with a Terminal shop user.
       #
       #   @return [TerminalShop::Models::AddressAPI]
       required :data, -> { TerminalShop::Models::AddressAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::AddressAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::AddressAPI] Physical address associated with a Terminal shop user.
     end
   end
 end

data/lib/terminal_shop/models/address_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#list
+    class AddressListParams < 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/address_list_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Address#list
+    class AddressListResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   Shipping addresses.
+      #
+      #   @return [Array<TerminalShop::Models::AddressAPI>]
+      required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::AddressAPI] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<TerminalShop::Models::AddressAPI>] Shipping addresses.
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 
 module TerminalShop
   module Models
-    class AppAPI < TerminalShop::BaseModel
+    class AppAPI < TerminalShop::Internal::Type::BaseModel
       # @!attribute id
       #   Unique object identifier. The format and length of IDs may change over time.
       #
@@ -27,17 +27,19 @@ module TerminalShop
       #   @return [String]
       required :secret, String
 
-      # @!parse
-      #   # A Terminal App used for configuring an OAuth 2.0 client.
-      #   #
-      #   # @param id [String]
-      #   # @param name [String]
-      #   # @param redirect_uri [String]
-      #   # @param secret [String]
-      #   #
-      #   def initialize(id:, name:, redirect_uri:, secret:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(id:, name:, redirect_uri:, secret:)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::AppAPI} for more details.
+      #
+      #   A Terminal App used for configuring an OAuth 2.0 client.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param name [String] Name of the app.
+      #
+      #   @param redirect_uri [String] Redirect URI of the app.
+      #
+      #   @param secret [String] OAuth 2.0 client secret of the app (obfuscated).
     end
   end
 end

data/lib/terminal_shop/models/app_create_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::App#create
+    class AppCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute redirect_uri
+      #
+      #   @return [String]
+      required :redirect_uri, String, api_name: :redirectURI
+
+      # @!method initialize(name:, redirect_uri:, request_options: {})
+      #   @param name [String]
+      #   @param redirect_uri [String]
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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

@@ -2,20 +2,18 @@
 
 module TerminalShop
   module Models
-    class AppCreateResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::App#create
+    class AppCreateResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #
       #   @return [TerminalShop::Models::AppCreateResponse::Data]
       required :data, -> { TerminalShop::Models::AppCreateResponse::Data }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::AppCreateResponse::Data]
-      #   #
-      #   def initialize(data:, **) = super
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::AppCreateResponse::Data]
 
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
-
-      class Data < TerminalShop::BaseModel
+      # @see TerminalShop::Models::AppCreateResponse#data
+      class Data < TerminalShop::Internal::Type::BaseModel
         # @!attribute id
         #   OAuth 2.0 client ID.
         #
@@ -28,13 +26,10 @@ module TerminalShop
         #   @return [String]
         required :secret, String
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param secret [String]
-        #   #
-        #   def initialize(id:, secret:, **) = super
-
-        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+        # @!method initialize(id:, secret:)
+        #   @param id [String] OAuth 2.0 client ID.
+        #
+        #   @param secret [String] OAuth 2.0 client secret.
       end
     end
   end

data/lib/terminal_shop/models/app_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::App#delete
+    class AppDeleteParams < 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/app_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::App#delete
+    class AppDeleteResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!method initialize(data: :ok)
+      #   @param data [Symbol, :ok]
+    end
+  end
+end

data/lib/terminal_shop/models/app_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::App#get
+    class AppGetParams < 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 → terminal_shop}/models/app_get_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class AppGetResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::App#get
+    class AppGetResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   A Terminal App used for configuring an OAuth 2.0 client.
       #
       #   @return [TerminalShop::Models::AppAPI]
       required :data, -> { TerminalShop::Models::AppAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::AppAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::AppAPI] A Terminal App used for configuring an OAuth 2.0 client.
     end
   end
 end

data/lib/terminal_shop/models/app_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::App#list
+    class AppListParams < 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/app_list_response.rb

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

data/lib/terminal_shop/models/card.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CardAPI < TerminalShop::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique object identifier. The format and length of IDs may change over time.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute brand
+      #   Brand of the card.
+      #
+      #   @return [String]
+      required :brand, String
+
+      # @!attribute created
+      #   Date the card was created.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!attribute expiration
+      #   Expiration of the card.
+      #
+      #   @return [TerminalShop::Models::CardAPI::Expiration]
+      required :expiration, -> { TerminalShop::Models::CardAPI::Expiration }
+
+      # @!attribute last4
+      #   Last four digits of the card.
+      #
+      #   @return [String]
+      required :last4, String
+
+      # @!method initialize(id:, brand:, created:, expiration:, last4:)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::CardAPI} for more details.
+      #
+      #   Credit card used for payments in the Terminal shop.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param brand [String] Brand of the card.
+      #
+      #   @param created [String] Date the card was created.
+      #
+      #   @param expiration [TerminalShop::Models::CardAPI::Expiration] Expiration of the card.
+      #
+      #   @param last4 [String] Last four digits of the card.
+
+      # @see TerminalShop::Models::CardAPI#expiration
+      class Expiration < TerminalShop::Internal::Type::BaseModel
+        # @!attribute month
+        #   Expiration month of the card.
+        #
+        #   @return [Integer]
+        required :month, Integer
+
+        # @!attribute year
+        #   Expiration year of the card.
+        #
+        #   @return [Integer]
+        required :year, Integer
+
+        # @!method initialize(month:, year:)
+        #   Expiration of the card.
+        #
+        #   @param month [Integer] Expiration month of the card.
+        #
+        #   @param year [Integer] Expiration year of the card.
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/card_collect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#collect
+    class CardCollectParams < 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/card_collect_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#collect
+    class CardCollectResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   URL for collecting card information.
+      #
+      #   @return [TerminalShop::Models::CardCollectResponse::Data]
+      required :data, -> { TerminalShop::Models::CardCollectResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::CardCollectResponse::Data] URL for collecting card information.
+
+      # @see TerminalShop::Models::CardCollectResponse#data
+      class Data < TerminalShop::Internal::Type::BaseModel
+        # @!attribute url
+        #   Temporary URL that allows a user to enter credit card details over https at
+        #   terminal.shop.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(url:)
+        #   Some parameter documentations has been truncated, see
+        #   {TerminalShop::Models::CardCollectResponse::Data} for more details.
+        #
+        #   URL for collecting card information.
+        #
+        #   @param url [String] Temporary URL that allows a user to enter credit card details over https at term
+        #   ...
+      end
+    end
+  end
+end