terminal-shop 1.6.0 → 1.8.0

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class OrderAPI < TerminalShop::BaseModel
+      # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       def id
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def id=(_)
       end
 
+      # The subtotal and shipping amounts of the order.
       sig { returns(TerminalShop::Models::OrderAPI::Amount) }
       def amount
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def amount=(_)
       end
 
+      # Items in the order.
       sig { returns(T::Array[TerminalShop::Models::OrderAPI::Item]) }
       def items
       end
@@ -30,6 +33,7 @@ module TerminalShop
       def items=(_)
       end
 
+      # Shipping address of the order.
       sig { returns(TerminalShop::Models::OrderAPI::Shipping) }
       def shipping
       end
@@ -38,6 +42,7 @@ module TerminalShop
       def shipping=(_)
       end
 
+      # Tracking information of the order.
       sig { returns(TerminalShop::Models::OrderAPI::Tracking) }
       def tracking
       end
@@ -46,6 +51,7 @@ module TerminalShop
       def tracking=(_)
       end
 
+      # Zero-based index of the order for this user only.
       sig { returns(T.nilable(Integer)) }
       def index
       end
@@ -54,6 +60,7 @@ module TerminalShop
       def index=(_)
       end
 
+      # An order from the Terminal shop.
       sig do
         params(
           id: String,
@@ -85,6 +92,7 @@ module TerminalShop
       end
 
       class Amount < TerminalShop::BaseModel
+        # Shipping amount of the order, in cents (USD).
         sig { returns(Integer) }
         def shipping
         end
@@ -93,6 +101,7 @@ module TerminalShop
         def shipping=(_)
         end
 
+        # Subtotal amount of the order, in cents (USD).
         sig { returns(Integer) }
         def subtotal
         end
@@ -101,6 +110,7 @@ module TerminalShop
         def subtotal=(_)
         end
 
+        # The subtotal and shipping amounts of the order.
         sig { params(shipping: Integer, subtotal: Integer).returns(T.attached_class) }
         def self.new(shipping:, subtotal:)
         end
@@ -111,6 +121,7 @@ module TerminalShop
       end
 
       class Item < TerminalShop::BaseModel
+        # Unique object identifier. The format and length of IDs may change over time.
         sig { returns(String) }
         def id
         end
@@ -119,6 +130,7 @@ module TerminalShop
         def id=(_)
         end
 
+        # Amount of the item in the order, in cents (USD).
         sig { returns(Integer) }
         def amount
         end
@@ -127,6 +139,7 @@ module TerminalShop
         def amount=(_)
         end
 
+        # Quantity of the item in the order.
         sig { returns(Integer) }
         def quantity
         end
@@ -135,6 +148,7 @@ module TerminalShop
         def quantity=(_)
         end
 
+        # Description of the item in the order.
         sig { returns(T.nilable(String)) }
         def description
         end
@@ -143,6 +157,7 @@ module TerminalShop
         def description=(_)
         end
 
+        # ID of the product variant of the item in the order.
         sig { returns(T.nilable(String)) }
         def product_variant_id
         end
@@ -179,6 +194,7 @@ module TerminalShop
       end
 
       class Shipping < TerminalShop::BaseModel
+        # City of the address.
         sig { returns(String) }
         def city
         end
@@ -187,6 +203,7 @@ module TerminalShop
         def city=(_)
         end
 
+        # ISO 3166-1 alpha-2 country code of the address.
         sig { returns(String) }
         def country
         end
@@ -195,6 +212,7 @@ module TerminalShop
         def country=(_)
         end
 
+        # The recipient's name.
         sig { returns(String) }
         def name
         end
@@ -203,6 +221,7 @@ module TerminalShop
         def name=(_)
         end
 
+        # Street of the address.
         sig { returns(String) }
         def street1
         end
@@ -211,6 +230,7 @@ module TerminalShop
         def street1=(_)
         end
 
+        # Zip code of the address.
         sig { returns(String) }
         def zip
         end
@@ -219,6 +239,7 @@ module TerminalShop
         def zip=(_)
         end
 
+        # Phone number of the recipient.
         sig { returns(T.nilable(String)) }
         def phone
         end
@@ -227,6 +248,7 @@ module TerminalShop
         def phone=(_)
         end
 
+        # Province or state of the address.
         sig { returns(T.nilable(String)) }
         def province
         end
@@ -235,6 +257,7 @@ module TerminalShop
         def province=(_)
         end
 
+        # Apartment, suite, etc. of the address.
         sig { returns(T.nilable(String)) }
         def street2
         end
@@ -243,6 +266,7 @@ module TerminalShop
         def street2=(_)
         end
 
+        # Shipping address of the order.
         sig do
           params(
             city: String,
@@ -279,6 +303,7 @@ module TerminalShop
       end
 
       class Tracking < TerminalShop::BaseModel
+        # Tracking number of the order.
         sig { returns(T.nilable(String)) }
         def number
         end
@@ -287,6 +312,7 @@ module TerminalShop
         def number=(_)
         end
 
+        # Shipping service of the order.
         sig { returns(T.nilable(String)) }
         def service
         end
@@ -295,6 +321,7 @@ module TerminalShop
         def service=(_)
         end
 
+        # Tracking URL of the order.
         sig { returns(T.nilable(String)) }
         def url
         end
@@ -303,6 +330,7 @@ module TerminalShop
         def url=(_)
         end
 
+        # Tracking information of the order.
         sig { params(number: String, service: String, url: String).returns(T.attached_class) }
         def self.new(number: nil, service: nil, url: nil)
         end

data/rbi/lib/terminal-shop/models/order_create_params.rbi

@@ -6,6 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # Shipping address ID.
       sig { returns(String) }
       def address_id
       end
@@ -14,6 +15,7 @@ module TerminalShop
       def address_id=(_)
       end
 
+      # Card ID.
       sig { returns(String) }
       def card_id
       end
@@ -22,6 +24,7 @@ module TerminalShop
       def card_id=(_)
       end
 
+      # Product variants to include in the order, along with their quantities.
       sig { returns(T::Hash[Symbol, Integer]) }
       def variants
       end

data/rbi/lib/terminal-shop/models/order_create_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class OrderCreateResponse < TerminalShop::BaseModel
+      # Order ID.
       sig { returns(String) }
       def data
       end

data/rbi/lib/terminal-shop/models/order_get_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class OrderGetResponse < TerminalShop::BaseModel
+      # An order from the Terminal shop.
       sig { returns(TerminalShop::Models::OrderAPI) }
       def data
       end

data/rbi/lib/terminal-shop/models/order_list_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class OrderListResponse < TerminalShop::BaseModel
+      # List of orders.
       sig { returns(T::Array[TerminalShop::Models::OrderAPI]) }
       def data
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProductAPI < TerminalShop::BaseModel
+      # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       def id
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def id=(_)
       end
 
+      # Description of the product.
       sig { returns(String) }
       def description
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def description=(_)
       end
 
+      # Name of the product.
       sig { returns(String) }
       def name
       end
@@ -27,6 +30,7 @@ module TerminalShop
       def name=(_)
       end
 
+      # List of variants of the product.
       sig { returns(T::Array[TerminalShop::Models::ProductVariant]) }
       def variants
       end
@@ -38,6 +42,7 @@ module TerminalShop
       def variants=(_)
       end
 
+      # Order of the product used when displaying a sorted list of products.
       sig { returns(T.nilable(Integer)) }
       def order
       end
@@ -46,6 +51,7 @@ module TerminalShop
       def order=(_)
       end
 
+      # Whether the product must be or can be subscribed to.
       sig { returns(T.nilable(Symbol)) }
       def subscription
       end
@@ -54,6 +60,7 @@ module TerminalShop
       def subscription=(_)
       end
 
+      # Tags for the product.
       sig { returns(T.nilable(TerminalShop::Models::ProductAPI::Tags)) }
       def tags
       end
@@ -62,6 +69,7 @@ module TerminalShop
       def tags=(_)
       end
 
+      # Product sold in the Terminal shop.
       sig do
         params(
           id: String,
@@ -94,17 +102,14 @@ module TerminalShop
       def to_hash
       end
 
+      # Whether the product must be or can be subscribed to.
       class Subscription < TerminalShop::Enum
         abstract!
 
+        Value = type_template(:out) { {fixed: Symbol} }
+
         ALLOWED = :allowed
         REQUIRED = :required
-
-        class << self
-          sig { override.returns(T::Array[Symbol]) }
-          def values
-          end
-        end
       end
 
       class Tags < TerminalShop::BaseModel
@@ -148,6 +153,7 @@ module TerminalShop
         def market_na=(_)
         end
 
+        # Tags for the product.
         sig do
           params(
             app: String,

data/rbi/lib/terminal-shop/models/product_get_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProductGetResponse < TerminalShop::BaseModel
+      # Product sold in the Terminal shop.
       sig { returns(TerminalShop::Models::ProductAPI) }
       def data
       end

data/rbi/lib/terminal-shop/models/product_list_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProductListResponse < TerminalShop::BaseModel
+      # A list of products.
       sig { returns(T::Array[TerminalShop::Models::ProductAPI]) }
       def data
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProductVariant < TerminalShop::BaseModel
+      # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       def id
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def id=(_)
       end
 
+      # Name of the product variant.
       sig { returns(String) }
       def name
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def name=(_)
       end
 
+      # Price of the product variant in cents (USD).
       sig { returns(Integer) }
       def price
       end
@@ -27,6 +30,7 @@ module TerminalShop
       def price=(_)
       end
 
+      # Variant of a product in the Terminal shop.
       sig { params(id: String, name: String, price: Integer).returns(T.attached_class) }
       def self.new(id:, name:, price:)
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProfileAPI < TerminalShop::BaseModel
+      # A Terminal shop user. (We have users, btw.)
       sig { returns(TerminalShop::Models::ProfileAPI::User) }
       def user
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def user=(_)
       end
 
+      # A Terminal shop user's profile. (We have users, btw.)
       sig { params(user: TerminalShop::Models::ProfileAPI::User).returns(T.attached_class) }
       def self.new(user:)
       end
@@ -20,6 +22,7 @@ module TerminalShop
       end
 
       class User < TerminalShop::BaseModel
+        # Unique object identifier. The format and length of IDs may change over time.
         sig { returns(String) }
         def id
         end
@@ -28,6 +31,7 @@ module TerminalShop
         def id=(_)
         end
 
+        # Email address of the user.
         sig { returns(T.nilable(String)) }
         def email
         end
@@ -36,6 +40,7 @@ module TerminalShop
         def email=(_)
         end
 
+        # The user's fingerprint, derived from their public SSH key.
         sig { returns(T.nilable(String)) }
         def fingerprint
         end
@@ -44,6 +49,7 @@ module TerminalShop
         def fingerprint=(_)
         end
 
+        # Name of the user.
         sig { returns(T.nilable(String)) }
         def name
         end
@@ -52,6 +58,7 @@ module TerminalShop
         def name=(_)
         end
 
+        # Stripe customer ID of the user.
         sig { returns(String) }
         def stripe_customer_id
         end
@@ -60,6 +67,7 @@ module TerminalShop
         def stripe_customer_id=(_)
         end
 
+        # A Terminal shop user. (We have users, btw.)
         sig do
           params(
             id: String,

data/rbi/lib/terminal-shop/models/profile_me_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProfileMeResponse < TerminalShop::BaseModel
+      # A Terminal shop user's profile. (We have users, btw.)
       sig { returns(TerminalShop::Models::ProfileAPI) }
       def data
       end

data/rbi/lib/terminal-shop/models/profile_update_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class ProfileUpdateResponse < TerminalShop::BaseModel
+      # A Terminal shop user's profile. (We have users, btw.)
       sig { returns(TerminalShop::Models::ProfileAPI) }
       def data
       end

data/rbi/lib/terminal-shop/models/region.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module TerminalShop
+  module Models
+    # A Terminal shop user's region.
+    class Region < TerminalShop::Enum
+      abstract!
+
+      Value = type_template(:out) { {fixed: Symbol} }
+
+      EU = :eu
+      NA = :na
+    end
+  end
+end

data/rbi/lib/terminal-shop/models/subscription.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class SubscriptionAPI < TerminalShop::BaseModel
+      # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       def id
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def id=(_)
       end
 
+      # ID of the shipping address used for the subscription.
       sig { returns(String) }
       def address_id
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def address_id=(_)
       end
 
+      # ID of the card used for the subscription.
       sig { returns(String) }
       def card_id
       end
@@ -27,6 +30,7 @@ module TerminalShop
       def card_id=(_)
       end
 
+      # ID of the product variant being subscribed to.
       sig { returns(String) }
       def product_variant_id
       end
@@ -35,6 +39,7 @@ module TerminalShop
       def product_variant_id=(_)
       end
 
+      # Quantity of the subscription.
       sig { returns(Integer) }
       def quantity
       end
@@ -43,6 +48,7 @@ module TerminalShop
       def quantity=(_)
       end
 
+      # Next shipment and billing date for the subscription.
       sig { returns(T.nilable(String)) }
       def next_
       end
@@ -51,6 +57,7 @@ module TerminalShop
       def next_=(_)
       end
 
+      # Schedule of the subscription.
       sig do
         returns(
           T.nilable(
@@ -81,6 +88,7 @@ module TerminalShop
       def schedule=(_)
       end
 
+      # Subscription to a Terminal shop product.
       sig do
         params(
           id: String,
@@ -119,9 +127,19 @@ module TerminalShop
       def to_hash
       end
 
+      # Schedule of the subscription.
       class Schedule < TerminalShop::Union
         abstract!
 
+        Variants = type_template(:out) do
+          {
+            fixed: T.any(
+              TerminalShop::Models::SubscriptionAPI::Schedule::Fixed,
+              TerminalShop::Models::SubscriptionAPI::Schedule::Weekly
+            )
+          }
+        end
+
         class Fixed < TerminalShop::BaseModel
           sig { returns(Symbol) }
           def type
@@ -165,17 +183,6 @@ module TerminalShop
           def to_hash
           end
         end
-
-        class << self
-          sig do
-            override
-              .returns(
-                [[NilClass, TerminalShop::Models::SubscriptionAPI::Schedule::Fixed], [NilClass, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly]]
-              )
-          end
-          private def variants
-          end
-        end
       end
     end
   end

data/rbi/lib/terminal-shop/models/subscription_get_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class SubscriptionGetResponse < TerminalShop::BaseModel
+      # Subscription to a Terminal shop product.
       sig { returns(TerminalShop::Models::SubscriptionAPI) }
       def data
       end

data/rbi/lib/terminal-shop/models/subscription_list_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class SubscriptionListResponse < TerminalShop::BaseModel
+      # List of subscriptions.
       sig { returns(T::Array[TerminalShop::Models::SubscriptionAPI]) }
       def data
       end

data/rbi/lib/terminal-shop/models/token.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class TokenAPI < TerminalShop::BaseModel
+      # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       def id
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def id=(_)
       end
 
+      # Personal access token (obfuscated).
       sig { returns(String) }
       def token
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def token=(_)
       end
 
+      # The created time for the token.
       sig { returns(String) }
       def created
       end
@@ -27,6 +30,8 @@ module TerminalShop
       def created=(_)
       end
 
+      # A personal access token used to access the Terminal API. If you leak this,
+      #   expect large sums of coffee to be ordered on your credit card.
       sig { params(id: String, token: String, created: String).returns(T.attached_class) }
       def self.new(id:, token:, created:)
       end

data/rbi/lib/terminal-shop/models/token_create_response.rbi

@@ -23,6 +23,7 @@ module TerminalShop
       end
 
       class Data < TerminalShop::BaseModel
+        # Personal token ID.
         sig { returns(String) }
         def id
         end
@@ -31,6 +32,8 @@ module TerminalShop
         def id=(_)
         end
 
+        # Personal access token. Include this in the Authorization header
+        #   (`Bearer <token>`) when accessing the Terminal API.
         sig { returns(String) }
         def token
         end

data/rbi/lib/terminal-shop/models/token_get_response.rbi

@@ -3,6 +3,8 @@
 module TerminalShop
   module Models
     class TokenGetResponse < TerminalShop::BaseModel
+      # A personal access token used to access the Terminal API. If you leak this,
+      #   expect large sums of coffee to be ordered on your credit card.
       sig { returns(TerminalShop::Models::TokenAPI) }
       def data
       end

data/rbi/lib/terminal-shop/models/token_list_response.rbi

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class TokenListResponse < TerminalShop::BaseModel
+      # List of personal access tokens.
       sig { returns(T::Array[TerminalShop::Models::TokenAPI]) }
       def data
       end