terminal-shop 0.1.0.pre.alpha.5

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

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # order_api => {
+    #   id: String,
+    #   amount: TerminalShop::Models::OrderAPI::Amount,
+    #   items: -> { TerminalShop::ArrayOf[TerminalShop::Models::OrderAPI::Item] === _1 },
+    #   shipping: TerminalShop::Models::OrderAPI::Shipping,
+    #   tracking: TerminalShop::Models::OrderAPI::Tracking
+    # }
+    # ```
+    class OrderAPI < TerminalShop::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 items
+      #   Items in the order.
+      #
+      #   @return [Array<TerminalShop::Models::OrderAPI::Item>]
+      required :items, -> { TerminalShop::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 [r] index
+      #   Zero-based index of the order for this user only.
+      #
+      #   @return [Integer, nil]
+      optional :index, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :index
+
+      # @!parse
+      #   # An order from the Terminal shop.
+      #   #
+      #   # @param id [String]
+      #   # @param amount [TerminalShop::Models::OrderAPI::Amount]
+      #   # @param items [Array<TerminalShop::Models::OrderAPI::Item>]
+      #   # @param shipping [TerminalShop::Models::OrderAPI::Shipping]
+      #   # @param tracking [TerminalShop::Models::OrderAPI::Tracking]
+      #   # @param index [Integer]
+      #   #
+      #   def initialize(id:, amount:, items:, shipping:, tracking:, index: nil, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+
+      # @example
+      # ```ruby
+      # amount => {
+      #   shipping: Integer,
+      #   subtotal: Integer
+      # }
+      # ```
+      class Amount < TerminalShop::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
+
+        # @!parse
+        #   # The subtotal and shipping amounts of the order.
+        #   #
+        #   # @param shipping [Integer]
+        #   # @param subtotal [Integer]
+        #   #
+        #   def initialize(shipping:, subtotal:, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+
+      # @example
+      # ```ruby
+      # item => {
+      #   id: String,
+      #   amount: Integer,
+      #   quantity: Integer,
+      #   description: String,
+      #   product_variant_id: String
+      # }
+      # ```
+      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 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 [r] description
+        #   Description of the item in the order.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :description
+
+        # @!attribute [r] 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
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :product_variant_id
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param amount [Integer]
+        #   # @param quantity [Integer]
+        #   # @param description [String]
+        #   # @param product_variant_id [String]
+        #   #
+        #   def initialize(id:, amount:, quantity:, description: nil, product_variant_id: nil, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+
+      # @example
+      # ```ruby
+      # shipping => {
+      #   city: String,
+      #   country: String,
+      #   name: String,
+      #   street1: String,
+      #   zip: String,
+      #   **_
+      # }
+      # ```
+      class Shipping < TerminalShop::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 [r] phone
+        #   Phone number of the recipient.
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :phone
+
+        # @!attribute [r] province
+        #   Province or state of the address.
+        #
+        #   @return [String, nil]
+        optional :province, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :province
+
+        # @!attribute [r] street2
+        #   Apartment, suite, etc. of the address.
+        #
+        #   @return [String, nil]
+        optional :street2, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :street2
+
+        # @!parse
+        #   # Shipping address of the order.
+        #   #
+        #   # @param city [String]
+        #   # @param country [String]
+        #   # @param name [String]
+        #   # @param street1 [String]
+        #   # @param zip [String]
+        #   # @param phone [String]
+        #   # @param province [String]
+        #   # @param street2 [String]
+        #   #
+        #   def initialize(city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+
+      # @example
+      # ```ruby
+      # tracking => {
+      #   number: String,
+      #   service: String,
+      #   url: String
+      # }
+      # ```
+      class Tracking < TerminalShop::BaseModel
+        # @!attribute [r] number
+        #   Tracking number of the order.
+        #
+        #   @return [String, nil]
+        optional :number, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :number
+
+        # @!attribute [r] service
+        #   Shipping service of the order.
+        #
+        #   @return [String, nil]
+        optional :service, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :service
+
+        # @!attribute [r] url
+        #   Tracking URL of the order.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :url
+
+        # @!parse
+        #   # Tracking information of the order.
+        #   #
+        #   # @param number [String]
+        #   # @param service [String]
+        #   # @param url [String]
+        #   #
+        #   def initialize(number: nil, service: nil, url: nil, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # order_get_response => {
+    #   data: TerminalShop::Models::OrderAPI
+    # }
+    # ```
+    class OrderGetResponse < 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/order_list_params.rb

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # order_list_response => {
+    #   data: -> { TerminalShop::ArrayOf[TerminalShop::Models::OrderAPI] === _1 }
+    # }
+    # ```
+    class OrderListResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   List of orders.
+      #
+      #   @return [Array<TerminalShop::Models::OrderAPI>]
+      required :data, -> { TerminalShop::ArrayOf[TerminalShop::Models::OrderAPI] }
+
+      # @!parse
+      #   # @param data [Array<TerminalShop::Models::OrderAPI>]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # product_api => {
+    #   id: String,
+    #   description: String,
+    #   filters: -> { TerminalShop::ArrayOf[enum: TerminalShop::Models::ProductAPI::Filter] === _1 },
+    #   name: String,
+    #   variants: -> { TerminalShop::ArrayOf[TerminalShop::Models::ProductVariant] === _1 },
+    #   **_
+    # }
+    # ```
+    class ProductAPI < TerminalShop::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 filters
+      #
+      #   @return [Array<Symbol, TerminalShop::Models::ProductAPI::Filter>]
+      required :filters, -> { TerminalShop::ArrayOf[enum: TerminalShop::Models::ProductAPI::Filter] }
+
+      # @!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::ArrayOf[TerminalShop::Models::ProductVariant] }
+
+      # @!attribute [r] order
+      #   Order of the product used when displaying a sorted list of products.
+      #
+      #   @return [Integer, nil]
+      optional :order, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :order
+
+      # @!attribute [r] 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 }
+
+      # @!parse
+      #   # @return [Symbol, TerminalShop::Models::ProductAPI::Subscription]
+      #   attr_writer :subscription
+
+      # @!attribute [r] tags
+      #   Tags for the product.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :tags, TerminalShop::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :tags
+
+      # @!parse
+      #   # Product sold in the Terminal shop.
+      #   #
+      #   # @param id [String]
+      #   # @param description [String]
+      #   # @param filters [Array<Symbol, TerminalShop::Models::ProductAPI::Filter>]
+      #   # @param name [String]
+      #   # @param variants [Array<TerminalShop::Models::ProductVariant>]
+      #   # @param order [Integer]
+      #   # @param subscription [Symbol, TerminalShop::Models::ProductAPI::Subscription]
+      #   # @param tags [Hash{Symbol=>String}]
+      #   #
+      #   def initialize(id:, description:, filters:, name:, variants:, order: nil, subscription: nil, tags: nil, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+
+      # @abstract
+      #
+      # @example
+      # ```ruby
+      # case filter
+      # in :eu
+      #   # ...
+      # in :na
+      #   # ...
+      # end
+      # ```
+      class Filter < TerminalShop::Enum
+        EU = :eu
+        NA = :na
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # Whether the product must be or can be subscribed to.
+      #
+      # @example
+      # ```ruby
+      # case subscription
+      # in :allowed
+      #   # ...
+      # in :required
+      #   # ...
+      # end
+      # ```
+      class Subscription < TerminalShop::Enum
+        ALLOWED = :allowed
+        REQUIRED = :required
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # product_list_response => {
+    #   data: -> { TerminalShop::ArrayOf[TerminalShop::Models::ProductAPI] === _1 }
+    # }
+    # ```
+    class ProductListResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   A list of products.
+      #
+      #   @return [Array<TerminalShop::Models::ProductAPI>]
+      required :data, -> { TerminalShop::ArrayOf[TerminalShop::Models::ProductAPI] }
+
+      # @!parse
+      #   # @param data [Array<TerminalShop::Models::ProductAPI>]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # product_variant => {
+    #   id: String,
+    #   name: String,
+    #   price: Integer
+    # }
+    # ```
+    class ProductVariant < TerminalShop::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
+
+      # @!parse
+      #   # Variant of a product in the Terminal shop.
+      #   #
+      #   # @param id [String]
+      #   # @param name [String]
+      #   # @param price [Integer]
+      #   #
+      #   def initialize(id:, name:, price:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @example
+    # ```ruby
+    # profile_api => {
+    #   user: TerminalShop::Models::ProfileAPI::User
+    # }
+    # ```
+    class ProfileAPI < TerminalShop::BaseModel
+      # @!attribute user
+      #   A Terminal shop user. (We have users, btw.)
+      #
+      #   @return [TerminalShop::Models::ProfileAPI::User]
+      required :user, -> { TerminalShop::Models::ProfileAPI::User }
+
+      # @!parse
+      #   # A Terminal shop user's profile. (We have users, btw.)
+      #   #
+      #   # @param user [TerminalShop::Models::ProfileAPI::User]
+      #   #
+      #   def initialize(user:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+
+      # @example
+      # ```ruby
+      # user => {
+      #   id: String,
+      #   email: String,
+      #   fingerprint: String,
+      #   name: String,
+      #   stripe_customer_id: String
+      # }
+      # ```
+      class User < TerminalShop::BaseModel
+        # @!attribute id
+        #   Unique object identifier. The format and length of IDs may change over time.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   Email address of the user.
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute fingerprint
+        #   The user's fingerprint, derived from their public SSH key.
+        #
+        #   @return [String, nil]
+        required :fingerprint, String, nil?: true
+
+        # @!attribute name
+        #   Name of the user.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute stripe_customer_id
+        #   Stripe customer ID of the user.
+        #
+        #   @return [String]
+        required :stripe_customer_id, String, api_name: :stripeCustomerID
+
+        # @!parse
+        #   # A Terminal shop user. (We have users, btw.)
+        #   #
+        #   # @param id [String]
+        #   # @param email [String, nil]
+        #   # @param fingerprint [String, nil]
+        #   # @param name [String, nil]
+        #   # @param stripe_customer_id [String]
+        #   #
+        #   def initialize(id:, email:, fingerprint:, name:, stripe_customer_id:, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+    end
+  end
+end