terminal-shop 2.1.3 → 3.5.0

data/lib/terminal_shop/models/order.rb

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class OrderAPI < 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 amount
+      #   The subtotal and shipping amounts of the order.
+      #
+      #   @return [TerminalShop::Models::OrderAPI::Amount]
+      required :amount, -> { TerminalShop::Models::OrderAPI::Amount }
+
+      # @!attribute created
+      #   Date the order was created.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!attribute items
+      #   Items in the order.
+      #
+      #   @return [Array<TerminalShop::Models::OrderAPI::Item>]
+      required :items, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::OrderAPI::Item] }
+
+      # @!attribute shipping
+      #   Shipping address of the order.
+      #
+      #   @return [TerminalShop::Models::OrderAPI::Shipping]
+      required :shipping, -> { TerminalShop::Models::OrderAPI::Shipping }
+
+      # @!attribute tracking
+      #   Tracking information of the order.
+      #
+      #   @return [TerminalShop::Models::OrderAPI::Tracking]
+      required :tracking, -> { TerminalShop::Models::OrderAPI::Tracking }
+
+      # @!attribute index
+      #   Zero-based index of the order for this user only.
+      #
+      #   @return [Integer, nil]
+      optional :index, Integer
+
+      # @!method initialize(id:, amount:, created:, items:, shipping:, tracking:, index: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::OrderAPI} for more details.
+      #
+      #   An order from the Terminal shop.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param amount [TerminalShop::Models::OrderAPI::Amount] The subtotal and shipping amounts of the order.
+      #
+      #   @param created [String] Date the order was created.
+      #
+      #   @param items [Array<TerminalShop::Models::OrderAPI::Item>] Items in the order.
+      #
+      #   @param shipping [TerminalShop::Models::OrderAPI::Shipping] Shipping address of the order.
+      #
+      #   @param tracking [TerminalShop::Models::OrderAPI::Tracking] Tracking information of the order.
+      #
+      #   @param index [Integer] Zero-based index of the order for this user only.
+
+      # @see TerminalShop::Models::OrderAPI#amount
+      class Amount < TerminalShop::Internal::Type::BaseModel
+        # @!attribute shipping
+        #   Shipping amount of the order, in cents (USD).
+        #
+        #   @return [Integer]
+        required :shipping, Integer
+
+        # @!attribute subtotal
+        #   Subtotal amount of the order, in cents (USD).
+        #
+        #   @return [Integer]
+        required :subtotal, Integer
+
+        # @!method initialize(shipping:, subtotal:)
+        #   The subtotal and shipping amounts of the order.
+        #
+        #   @param shipping [Integer] Shipping amount of the order, in cents (USD).
+        #
+        #   @param subtotal [Integer] Subtotal amount of the order, 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 amount
+        #   Amount of the item in the order, in cents (USD).
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute quantity
+        #   Quantity of the item in the order.
+        #
+        #   @return [Integer]
+        required :quantity, Integer
+
+        # @!attribute description
+        #   Description of the item in the order.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute product_variant_id
+        #   ID of the product variant of the item in the order.
+        #
+        #   @return [String, nil]
+        optional :product_variant_id, String, api_name: :productVariantID
+
+        # @!method initialize(id:, amount:, quantity:, description: nil, product_variant_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {TerminalShop::Models::OrderAPI::Item} for more details.
+        #
+        #   @param id [String] Unique object identifier. ...
+        #
+        #   @param amount [Integer] Amount of the item in the order, in cents (USD).
+        #
+        #   @param quantity [Integer] Quantity of the item in the order.
+        #
+        #   @param description [String] Description of the item in the order.
+        #
+        #   @param product_variant_id [String] ID of the product variant of the item in the order.
+      end
+
+      # @see TerminalShop::Models::OrderAPI#shipping
+      class Shipping < TerminalShop::Internal::Type::BaseModel
+        # @!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)
+        #   Shipping address of the order.
+        #
+        #   @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.
+      end
+
+      # @see TerminalShop::Models::OrderAPI#tracking
+      class Tracking < TerminalShop::Internal::Type::BaseModel
+        # @!attribute number
+        #   Tracking number of the order.
+        #
+        #   @return [String, nil]
+        optional :number, String
+
+        # @!attribute service
+        #   Shipping service of the order.
+        #
+        #   @return [String, nil]
+        optional :service, String
+
+        # @!attribute status
+        #   Current tracking status of the shipment.
+        #
+        #   @return [Symbol, TerminalShop::Models::OrderAPI::Tracking::Status, nil]
+        optional :status, enum: -> { TerminalShop::Models::OrderAPI::Tracking::Status }
+
+        # @!attribute status_details
+        #   Additional details about the tracking status.
+        #
+        #   @return [String, nil]
+        optional :status_details, String, api_name: :statusDetails
+
+        # @!attribute status_updated_at
+        #   When the tracking status was last updated.
+        #
+        #   @return [String, nil]
+        optional :status_updated_at, String, api_name: :statusUpdatedAt
+
+        # @!attribute url
+        #   Tracking URL of the order.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(number: nil, service: nil, status: nil, status_details: nil, status_updated_at: nil, url: nil)
+        #   Tracking information of the order.
+        #
+        #   @param number [String] Tracking number of the order.
+        #
+        #   @param service [String] Shipping service of the order.
+        #
+        #   @param status [Symbol, TerminalShop::Models::OrderAPI::Tracking::Status] Current tracking status of the shipment.
+        #
+        #   @param status_details [String] Additional details about the tracking status.
+        #
+        #   @param status_updated_at [String] When the tracking status was last updated.
+        #
+        #   @param url [String] Tracking URL of the order.
+
+        # Current tracking status of the shipment.
+        #
+        # @see TerminalShop::Models::OrderAPI::Tracking#status
+        module Status
+          extend TerminalShop::Internal::Type::Enum
+
+          PRE_TRANSIT = :PRE_TRANSIT
+          TRANSIT = :TRANSIT
+          DELIVERED = :DELIVERED
+          RETURNED = :RETURNED
+          FAILURE = :FAILURE
+          UNKNOWN = :UNKNOWN
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/order_create_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Order#create
+    class OrderCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute address_id
+      #   Shipping address ID.
+      #
+      #   @return [String]
+      required :address_id, String, api_name: :addressID
+
+      # @!attribute card_id
+      #   Card ID.
+      #
+      #   @return [String]
+      required :card_id, String, api_name: :cardID
+
+      # @!attribute variants
+      #   Product variants to include in the order, along with their quantities.
+      #
+      #   @return [Hash{Symbol=>Integer}]
+      required :variants, TerminalShop::Internal::Type::HashOf[Integer]
+
+      # @!method initialize(address_id:, card_id:, variants:, request_options: {})
+      #   @param address_id [String] Shipping address ID.
+      #
+      #   @param card_id [String] Card ID.
+      #
+      #   @param variants [Hash{Symbol=>Integer}] Product variants to include in the order, along with their quantities.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/order_create_response.rb

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

data/lib/terminal_shop/models/order_get_params.rb

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

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class OrderGetResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Order#get
+    class OrderGetResponse < 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/order_list_params.rb

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

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

data/lib/terminal_shop/models/product.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class ProductAPI < 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 description
+      #   Description of the product.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute name
+      #   Name of the product.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute variants
+      #   List of variants of the product.
+      #
+      #   @return [Array<TerminalShop::Models::ProductVariant>]
+      required :variants, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::ProductVariant] }
+
+      # @!attribute order
+      #   Order of the product used when displaying a sorted list of products.
+      #
+      #   @return [Integer, nil]
+      optional :order, Integer
+
+      # @!attribute subscription
+      #   Whether the product must be or can be subscribed to.
+      #
+      #   @return [Symbol, TerminalShop::Models::ProductAPI::Subscription, nil]
+      optional :subscription, enum: -> { TerminalShop::Models::ProductAPI::Subscription }
+
+      # @!attribute tags
+      #   Tags for the product.
+      #
+      #   @return [TerminalShop::Models::ProductAPI::Tags, nil]
+      optional :tags, -> { TerminalShop::Models::ProductAPI::Tags }
+
+      # @!method initialize(id:, description:, name:, variants:, order: nil, subscription: nil, tags: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::ProductAPI} for more details.
+      #
+      #   Product sold in the Terminal shop.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param description [String] Description of the product.
+      #
+      #   @param name [String] Name of the product.
+      #
+      #   @param variants [Array<TerminalShop::Models::ProductVariant>] List of variants of the product.
+      #
+      #   @param order [Integer] Order of the product used when displaying a sorted list of products.
+      #
+      #   @param subscription [Symbol, TerminalShop::Models::ProductAPI::Subscription] Whether the product must be or can be subscribed to.
+      #
+      #   @param tags [TerminalShop::Models::ProductAPI::Tags] Tags for the product.
+
+      # Whether the product must be or can be subscribed to.
+      #
+      # @see TerminalShop::Models::ProductAPI#subscription
+      module Subscription
+        extend TerminalShop::Internal::Type::Enum
+
+        ALLOWED = :allowed
+        REQUIRED = :required
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see TerminalShop::Models::ProductAPI#tags
+      class Tags < TerminalShop::Internal::Type::BaseModel
+        # @!attribute app
+        #
+        #   @return [String, nil]
+        optional :app, String
+
+        # @!attribute color
+        #
+        #   @return [String, nil]
+        optional :color, String
+
+        # @!attribute featured
+        #
+        #   @return [Boolean, nil]
+        optional :featured, TerminalShop::Internal::Type::Boolean
+
+        # @!attribute market_eu
+        #
+        #   @return [Boolean, nil]
+        optional :market_eu, TerminalShop::Internal::Type::Boolean
+
+        # @!attribute market_global
+        #
+        #   @return [Boolean, nil]
+        optional :market_global, TerminalShop::Internal::Type::Boolean
+
+        # @!attribute market_na
+        #
+        #   @return [Boolean, nil]
+        optional :market_na, TerminalShop::Internal::Type::Boolean
+
+        # @!method initialize(app: nil, color: nil, featured: nil, market_eu: nil, market_global: nil, market_na: nil)
+        #   Tags for the product.
+        #
+        #   @param app [String]
+        #   @param color [String]
+        #   @param featured [Boolean]
+        #   @param market_eu [Boolean]
+        #   @param market_global [Boolean]
+        #   @param market_na [Boolean]
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/product_get_params.rb

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

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

data/lib/terminal_shop/models/product_list_params.rb

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

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

data/lib/terminal_shop/models/product_variant.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class ProductVariant < 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 name
+      #   Name of the product variant.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute price
+      #   Price of the product variant in cents (USD).
+      #
+      #   @return [Integer]
+      required :price, Integer
+
+      # @!attribute description
+      #   Description of the product variant.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute tags
+      #   Tags for the product variant.
+      #
+      #   @return [TerminalShop::Models::ProductVariant::Tags, nil]
+      optional :tags, -> { TerminalShop::Models::ProductVariant::Tags }
+
+      # @!method initialize(id:, name:, price:, description: nil, tags: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::ProductVariant} for more details.
+      #
+      #   Variant of a product in the Terminal shop.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param name [String] Name of the product variant.
+      #
+      #   @param price [Integer] Price of the product variant in cents (USD).
+      #
+      #   @param description [String] Description of the product variant.
+      #
+      #   @param tags [TerminalShop::Models::ProductVariant::Tags] Tags for the product variant.
+
+      # @see TerminalShop::Models::ProductVariant#tags
+      class Tags < TerminalShop::Internal::Type::BaseModel
+        # @!attribute app
+        #
+        #   @return [String, nil]
+        optional :app, String
+
+        # @!attribute market_eu
+        #
+        #   @return [Boolean, nil]
+        optional :market_eu, TerminalShop::Internal::Type::Boolean
+
+        # @!attribute market_global
+        #
+        #   @return [Boolean, nil]
+        optional :market_global, TerminalShop::Internal::Type::Boolean
+
+        # @!attribute market_na
+        #
+        #   @return [Boolean, nil]
+        optional :market_na, TerminalShop::Internal::Type::Boolean
+
+        # @!method initialize(app: nil, market_eu: nil, market_global: nil, market_na: nil)
+        #   Tags for the product variant.
+        #
+        #   @param app [String]
+        #   @param market_eu [Boolean]
+        #   @param market_global [Boolean]
+        #   @param market_na [Boolean]
+      end
+    end
+  end
+end