terminal-shop 0.1.0.pre.alpha.5

data/lib/terminal-shop/models/cart.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # cart_api => {
+    #   amount: TerminalShop::Models::CartAPI::Amount,
+    #   items: -> { TerminalShop::ArrayOf[TerminalShop::Models::CartAPI::Item] === _1 },
+    #   subtotal: Integer,
+    #   address_id: String,
+    #   card_id: String
+    # }
+    # ```
+    class CartAPI < TerminalShop::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::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 [r] address_id
+      #   ID of the shipping address selected on the current user's cart.
+      #
+      #   @return [String, nil]
+      optional :address_id, String, api_name: :addressID
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :address_id
+
+      # @!attribute [r] card_id
+      #   ID of the card selected on the current user's cart.
+      #
+      #   @return [String, nil]
+      optional :card_id, String, api_name: :cardID
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :card_id
+
+      # @!attribute [r] shipping
+      #   Shipping information for the current user's cart.
+      #
+      #   @return [TerminalShop::Models::CartAPI::Shipping, nil]
+      optional :shipping, -> { TerminalShop::Models::CartAPI::Shipping }
+
+      # @!parse
+      #   # @return [TerminalShop::Models::CartAPI::Shipping]
+      #   attr_writer :shipping
+
+      # @!parse
+      #   # The current Terminal shop user's cart.
+      #   #
+      #   # @param amount [TerminalShop::Models::CartAPI::Amount]
+      #   # @param items [Array<TerminalShop::Models::CartAPI::Item>]
+      #   # @param subtotal [Integer]
+      #   # @param address_id [String]
+      #   # @param card_id [String]
+      #   # @param shipping [TerminalShop::Models::CartAPI::Shipping]
+      #   #
+      #   def initialize(amount:, items:, subtotal:, address_id: nil, card_id: nil, shipping: nil, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+
+      # @example
+      # ```ruby
+      # amount => {
+      #   subtotal: Integer,
+      #   shipping: Integer
+      # }
+      # ```
+      class Amount < TerminalShop::BaseModel
+        # @!attribute subtotal
+        #   Subtotal of the current user's cart, in cents (USD).
+        #
+        #   @return [Integer]
+        required :subtotal, Integer
+
+        # @!attribute [r] shipping
+        #   Shipping amount of the current user's cart, in cents (USD).
+        #
+        #   @return [Integer, nil]
+        optional :shipping, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :shipping
+
+        # @!parse
+        #   # The subtotal and shipping amounts for the current user's cart.
+        #   #
+        #   # @param subtotal [Integer]
+        #   # @param shipping [Integer]
+        #   #
+        #   def initialize(subtotal:, shipping: nil, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+
+      # @example
+      # ```ruby
+      # item => {
+      #   id: String,
+      #   product_variant_id: String,
+      #   quantity: Integer,
+      #   subtotal: Integer
+      # }
+      # ```
+      class Item < TerminalShop::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
+
+        # @!parse
+        #   # An item in the current Terminal shop user's cart.
+        #   #
+        #   # @param id [String]
+        #   # @param product_variant_id [String]
+        #   # @param quantity [Integer]
+        #   # @param subtotal [Integer]
+        #   #
+        #   def initialize(id:, product_variant_id:, quantity:, subtotal:, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+
+      # @example
+      # ```ruby
+      # shipping => {
+      #   service: String,
+      #   timeframe: String
+      # }
+      # ```
+      class Shipping < TerminalShop::BaseModel
+        # @!attribute [r] service
+        #   Shipping service name.
+        #
+        #   @return [String, nil]
+        optional :service, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :service
+
+        # @!attribute [r] timeframe
+        #   Shipping timeframe provided by the shipping carrier.
+        #
+        #   @return [String, nil]
+        optional :timeframe, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :timeframe
+
+        # @!parse
+        #   # Shipping information for the current user's cart.
+        #   #
+        #   # @param service [String]
+        #   # @param timeframe [String]
+        #   #
+        #   def initialize(service: nil, timeframe: nil, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/terminal-shop/models/cart_convert_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartConvertParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!parse
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_convert_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # cart_convert_response => {
+    #   data: TerminalShop::Models::OrderAPI
+    # }
+    # ```
+    class CartConvertResponse < TerminalShop::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
+    end
+  end
+end

data/lib/terminal-shop/models/cart_get_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartGetParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!parse
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_get_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # cart_get_response => {
+    #   data: TerminalShop::Models::CartAPI
+    # }
+    # ```
+    class CartGetResponse < TerminalShop::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
+    end
+  end
+end

data/lib/terminal-shop/models/cart_set_address_params.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartSetAddressParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::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
+
+      # @!parse
+      #   # @param address_id [String]
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(address_id:, request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_set_address_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # cart_set_address_response => {
+    #   data: :ok
+    # }
+    # ```
+    class CartSetAddressResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!parse
+      #   # @param data [Symbol, :ok]
+      #   #
+      #   def initialize(data: :ok, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_set_card_params.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartSetCardParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::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
+
+      # @!parse
+      #   # @param card_id [String]
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(card_id:, request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_set_card_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # cart_set_card_response => {
+    #   data: :ok
+    # }
+    # ```
+    class CartSetCardResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!parse
+      #   # @param data [Symbol, :ok]
+      #   #
+      #   def initialize(data: :ok, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_set_item_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartSetItemParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::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
+
+      # @!parse
+      #   # @param product_variant_id [String]
+      #   # @param quantity [Integer]
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(product_variant_id:, quantity:, request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_set_item_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # cart_set_item_response => {
+    #   data: TerminalShop::Models::CartAPI
+    # }
+    # ```
+    class CartSetItemResponse < TerminalShop::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
+    end
+  end
+end

data/lib/terminal-shop/models/email_create_params.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class EmailCreateParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!attribute email
+      #   Email address to subscribe to Terminal updates with.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!parse
+      #   # @param email [String]
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(email:, request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/email_create_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # email_create_response => {
+    #   data: :ok
+    # }
+    # ```
+    class EmailCreateResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!parse
+      #   # @param data [Symbol, :ok]
+      #   #
+      #   def initialize(data: :ok, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end