terminal-shop 2.1.2 → 3.5.0

data/lib/terminal_shop/models/card_create_params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#create
+    class CardCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute token
+      #   Stripe card token. Learn how to
+      #   [create one here](https://docs.stripe.com/api/tokens/create_card).
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!method initialize(token:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::CardCreateParams} for more details.
+      #
+      #   @param token [String] Stripe card token. Learn how to [create one here](https://docs.stripe.com/api/to
+      #   ...
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/card_create_response.rb

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

data/lib/terminal_shop/models/card_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#delete
+    class CardDeleteParams < 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_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#delete
+    class CardDeleteResponse < 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/card_get_params.rb

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

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class CardGetResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Card#get
+    class CardGetResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   Credit card used for payments in the Terminal shop.
       #
       #   @return [TerminalShop::Models::CardAPI]
       required :data, -> { TerminalShop::Models::CardAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::CardAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::CardAPI] Credit card used for payments in the Terminal shop.
     end
   end
 end

data/lib/terminal_shop/models/card_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#list
+    class CardListParams < 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_list_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Card#list
+    class CardListResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   List of cards associated with the user.
+      #
+      #   @return [Array<TerminalShop::Models::CardAPI>]
+      required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::CardAPI] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<TerminalShop::Models::CardAPI>] List of cards associated with the user.
+    end
+  end
+end

data/lib/terminal_shop/models/cart.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartAPI < TerminalShop::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The subtotal and shipping amounts for the current user's cart.
+      #
+      #   @return [TerminalShop::Models::CartAPI::Amount]
+      required :amount, -> { TerminalShop::Models::CartAPI::Amount }
+
+      # @!attribute items
+      #   An array of items in the current user's cart.
+      #
+      #   @return [Array<TerminalShop::Models::CartAPI::Item>]
+      required :items, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::CartAPI::Item] }
+
+      # @!attribute subtotal
+      #   The subtotal of all items in the current user's cart, in cents (USD).
+      #
+      #   @return [Integer]
+      required :subtotal, Integer
+
+      # @!attribute address_id
+      #   ID of the shipping address selected on the current user's cart.
+      #
+      #   @return [String, nil]
+      optional :address_id, String, api_name: :addressID
+
+      # @!attribute card_id
+      #   ID of the card selected on the current user's cart.
+      #
+      #   @return [String, nil]
+      optional :card_id, String, api_name: :cardID
+
+      # @!attribute shipping
+      #   Shipping information for the current user's cart.
+      #
+      #   @return [TerminalShop::Models::CartAPI::Shipping, nil]
+      optional :shipping, -> { TerminalShop::Models::CartAPI::Shipping }
+
+      # @!method initialize(amount:, items:, subtotal:, address_id: nil, card_id: nil, shipping: nil)
+      #   The current Terminal shop user's cart.
+      #
+      #   @param amount [TerminalShop::Models::CartAPI::Amount] The subtotal and shipping amounts for the current user's cart.
+      #
+      #   @param items [Array<TerminalShop::Models::CartAPI::Item>] An array of items in the current user's cart.
+      #
+      #   @param subtotal [Integer] The subtotal of all items in the current user's cart, in cents (USD).
+      #
+      #   @param address_id [String] ID of the shipping address selected on the current user's cart.
+      #
+      #   @param card_id [String] ID of the card selected on the current user's cart.
+      #
+      #   @param shipping [TerminalShop::Models::CartAPI::Shipping] Shipping information for the current user's cart.
+
+      # @see TerminalShop::Models::CartAPI#amount
+      class Amount < TerminalShop::Internal::Type::BaseModel
+        # @!attribute subtotal
+        #   Subtotal of the current user's cart, in cents (USD).
+        #
+        #   @return [Integer]
+        required :subtotal, Integer
+
+        # @!attribute shipping
+        #   Shipping amount of the current user's cart, in cents (USD).
+        #
+        #   @return [Integer, nil]
+        optional :shipping, Integer
+
+        # @!attribute total
+        #   Total amount after any discounts, in cents (USD).
+        #
+        #   @return [Integer, nil]
+        optional :total, Integer
+
+        # @!method initialize(subtotal:, shipping: nil, total: nil)
+        #   The subtotal and shipping amounts for the current user's cart.
+        #
+        #   @param subtotal [Integer] Subtotal of the current user's cart, in cents (USD).
+        #
+        #   @param shipping [Integer] Shipping amount of the current user's cart, in cents (USD).
+        #
+        #   @param total [Integer] Total amount after any discounts, in cents (USD).
+      end
+
+      class Item < 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 product_variant_id
+        #   ID of the product variant for this item in the current user's cart.
+        #
+        #   @return [String]
+        required :product_variant_id, String, api_name: :productVariantID
+
+        # @!attribute quantity
+        #   Quantity of the item in the current user's cart.
+        #
+        #   @return [Integer]
+        required :quantity, Integer
+
+        # @!attribute subtotal
+        #   Subtotal of the item in the current user's cart, in cents (USD).
+        #
+        #   @return [Integer]
+        required :subtotal, Integer
+
+        # @!method initialize(id:, product_variant_id:, quantity:, subtotal:)
+        #   Some parameter documentations has been truncated, see
+        #   {TerminalShop::Models::CartAPI::Item} for more details.
+        #
+        #   An item in the current Terminal shop user's cart.
+        #
+        #   @param id [String] Unique object identifier. ...
+        #
+        #   @param product_variant_id [String] ID of the product variant for this item in the current user's cart.
+        #
+        #   @param quantity [Integer] Quantity of the item in the current user's cart.
+        #
+        #   @param subtotal [Integer] Subtotal of the item in the current user's cart, in cents (USD).
+      end
+
+      # @see TerminalShop::Models::CartAPI#shipping
+      class Shipping < TerminalShop::Internal::Type::BaseModel
+        # @!attribute service
+        #   Shipping service name.
+        #
+        #   @return [String, nil]
+        optional :service, String
+
+        # @!attribute timeframe
+        #   Shipping timeframe provided by the shipping carrier.
+        #
+        #   @return [String, nil]
+        optional :timeframe, String
+
+        # @!method initialize(service: nil, timeframe: nil)
+        #   Shipping information for the current user's cart.
+        #
+        #   @param service [String] Shipping service name.
+        #
+        #   @param timeframe [String] Shipping timeframe provided by the shipping carrier.
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/cart_clear_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#clear
+    class CartClearParams < 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/cart_clear_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#clear
+    class CartClearResponse < 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/cart_convert_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#convert
+    class CartConvertParams < 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/cart_convert_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class CartConvertResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Cart#convert
+    class CartConvertResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   An order from the Terminal shop.
       #
       #   @return [TerminalShop::Models::OrderAPI]
       required :data, -> { TerminalShop::Models::OrderAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::OrderAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::OrderAPI] An order from the Terminal shop.
     end
   end
 end

data/lib/terminal_shop/models/cart_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#get
+    class CartGetParams < 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/cart_get_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class CartGetResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Cart#get
+    class CartGetResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   The current Terminal shop user's cart.
       #
       #   @return [TerminalShop::Models::CartAPI]
       required :data, -> { TerminalShop::Models::CartAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::CartAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::CartAPI] The current Terminal shop user's cart.
     end
   end
 end

data/lib/terminal_shop/models/cart_set_address_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#set_address
+    class CartSetAddressParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute address_id
+      #   ID of the shipping address to set for the current user's cart.
+      #
+      #   @return [String]
+      required :address_id, String, api_name: :addressID
+
+      # @!method initialize(address_id:, request_options: {})
+      #   @param address_id [String] ID of the shipping address to set for the current user's cart.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/cart_set_address_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#set_address
+    class CartSetAddressResponse < 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/cart_set_card_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#set_card
+    class CartSetCardParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute card_id
+      #   ID of the credit card to set for the current user's cart.
+      #
+      #   @return [String]
+      required :card_id, String, api_name: :cardID
+
+      # @!method initialize(card_id:, request_options: {})
+      #   @param card_id [String] ID of the credit card to set for the current user's cart.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/cart_set_card_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#set_card
+    class CartSetCardResponse < 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/cart_set_item_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Cart#set_item
+    class CartSetItemParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute product_variant_id
+      #   ID of the product variant to add to the cart.
+      #
+      #   @return [String]
+      required :product_variant_id, String, api_name: :productVariantID
+
+      # @!attribute quantity
+      #   Quantity of the item to add to the cart.
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!method initialize(product_variant_id:, quantity:, request_options: {})
+      #   @param product_variant_id [String] ID of the product variant to add to the cart.
+      #
+      #   @param quantity [Integer] Quantity of the item to add to the cart.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class CartSetItemResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Cart#set_item
+    class CartSetItemResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   The current Terminal shop user's cart.
       #
       #   @return [TerminalShop::Models::CartAPI]
       required :data, -> { TerminalShop::Models::CartAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::CartAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::CartAPI] The current Terminal shop user's cart.
     end
   end
 end

data/lib/terminal_shop/models/email_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Email#create
+    class EmailCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   Email address to subscribe to Terminal updates with.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!method initialize(email:, request_options: {})
+      #   @param email [String] Email address to subscribe to Terminal updates with.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/email_create_response.rb

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