terminal-shop 1.7.0 → 1.8.0

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class AddressAPI < 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
 
+      # City of the address.
       sig { returns(String) }
       def city
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def city=(_)
       end
 
+      # ISO 3166-1 alpha-2 country code of the address.
       sig { returns(String) }
       def country
       end
@@ -27,6 +30,7 @@ module TerminalShop
       def country=(_)
       end
 
+      # The recipient's name.
       sig { returns(String) }
       def name
       end
@@ -35,6 +39,7 @@ module TerminalShop
       def name=(_)
       end
 
+      # Street of the address.
       sig { returns(String) }
       def street1
       end
@@ -43,6 +48,7 @@ module TerminalShop
       def street1=(_)
       end
 
+      # Zip code of the address.
       sig { returns(String) }
       def zip
       end
@@ -51,6 +57,7 @@ module TerminalShop
       def zip=(_)
       end
 
+      # Phone number of the recipient.
       sig { returns(T.nilable(String)) }
       def phone
       end
@@ -59,6 +66,7 @@ module TerminalShop
       def phone=(_)
       end
 
+      # Province or state of the address.
       sig { returns(T.nilable(String)) }
       def province
       end
@@ -67,6 +75,7 @@ module TerminalShop
       def province=(_)
       end
 
+      # Apartment, suite, etc. of the address.
       sig { returns(T.nilable(String)) }
       def street2
       end
@@ -75,6 +84,7 @@ module TerminalShop
       def street2=(_)
       end
 
+      # Physical address associated with a Terminal shop user.
       sig do
         params(
           id: String,

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

@@ -6,6 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # City of the address.
       sig { returns(String) }
       def city
       end
@@ -14,6 +15,7 @@ module TerminalShop
       def city=(_)
       end
 
+      # ISO 3166-1 alpha-2 country code of the address.
       sig { returns(String) }
       def country
       end
@@ -22,6 +24,7 @@ module TerminalShop
       def country=(_)
       end
 
+      # The recipient's name.
       sig { returns(String) }
       def name
       end
@@ -30,6 +33,7 @@ module TerminalShop
       def name=(_)
       end
 
+      # Street of the address.
       sig { returns(String) }
       def street1
       end
@@ -38,6 +42,7 @@ module TerminalShop
       def street1=(_)
       end
 
+      # Zip code of the address.
       sig { returns(String) }
       def zip
       end
@@ -46,6 +51,7 @@ module TerminalShop
       def zip=(_)
       end
 
+      # Phone number of the recipient.
       sig { returns(T.nilable(String)) }
       def phone
       end
@@ -54,6 +60,7 @@ module TerminalShop
       def phone=(_)
       end
 
+      # Province or state of the address.
       sig { returns(T.nilable(String)) }
       def province
       end
@@ -62,6 +69,7 @@ module TerminalShop
       def province=(_)
       end
 
+      # Apartment, suite, etc. of the address.
       sig { returns(T.nilable(String)) }
       def street2
       end

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

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

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class AddressGetResponse < TerminalShop::BaseModel
+      # Physical address associated with a Terminal shop user.
       sig { returns(TerminalShop::Models::AddressAPI) }
       def data
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class AddressListResponse < TerminalShop::BaseModel
+      # Shipping addresses.
       sig { returns(T::Array[TerminalShop::Models::AddressAPI]) }
       def data
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class AppAPI < 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 app.
       sig { returns(String) }
       def name
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def name=(_)
       end
 
+      # Redirect URI of the app.
       sig { returns(String) }
       def redirect_uri
       end
@@ -27,6 +30,7 @@ module TerminalShop
       def redirect_uri=(_)
       end
 
+      # OAuth 2.0 client secret of the app (obfuscated).
       sig { returns(String) }
       def secret
       end
@@ -35,6 +39,7 @@ module TerminalShop
       def secret=(_)
       end
 
+      # A Terminal App used for configuring an OAuth 2.0 client.
       sig { params(id: String, name: String, redirect_uri: String, secret: String).returns(T.attached_class) }
       def self.new(id:, name:, redirect_uri:, secret:)
       end

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

@@ -23,6 +23,7 @@ module TerminalShop
       end
 
       class Data < TerminalShop::BaseModel
+        # OAuth 2.0 client ID.
         sig { returns(String) }
         def id
         end
@@ -31,6 +32,7 @@ module TerminalShop
         def id=(_)
         end
 
+        # OAuth 2.0 client secret.
         sig { returns(String) }
         def secret
         end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class AppGetResponse < TerminalShop::BaseModel
+      # A Terminal App used for configuring an OAuth 2.0 client.
       sig { returns(TerminalShop::Models::AppAPI) }
       def data
       end

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

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

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CardAPI < 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
 
+      # Brand of the card.
       sig { returns(String) }
       def brand
       end
@@ -19,6 +21,7 @@ module TerminalShop
       def brand=(_)
       end
 
+      # Expiration of the card.
       sig { returns(TerminalShop::Models::CardAPI::Expiration) }
       def expiration
       end
@@ -27,6 +30,7 @@ module TerminalShop
       def expiration=(_)
       end
 
+      # Last four digits of the card.
       sig { returns(String) }
       def last4
       end
@@ -35,6 +39,7 @@ module TerminalShop
       def last4=(_)
       end
 
+      # Credit card used for payments in the Terminal shop.
       sig do
         params(id: String, brand: String, expiration: TerminalShop::Models::CardAPI::Expiration, last4: String)
           .returns(T.attached_class)
@@ -50,6 +55,7 @@ module TerminalShop
       end
 
       class Expiration < TerminalShop::BaseModel
+        # Expiration month of the card.
         sig { returns(Integer) }
         def month
         end
@@ -58,6 +64,7 @@ module TerminalShop
         def month=(_)
         end
 
+        # Expiration year of the card.
         sig { returns(Integer) }
         def year
         end
@@ -66,6 +73,7 @@ module TerminalShop
         def year=(_)
         end
 
+        # Expiration of the card.
         sig { params(month: Integer, year: Integer).returns(T.attached_class) }
         def self.new(month:, year:)
         end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CardCollectResponse < TerminalShop::BaseModel
+      # URL for collecting card information.
       sig { returns(TerminalShop::Models::CardCollectResponse::Data) }
       def data
       end
@@ -23,6 +24,8 @@ module TerminalShop
       end
 
       class Data < TerminalShop::BaseModel
+        # Temporary URL that allows a user to enter credit card details over https at
+        #   terminal.shop.
         sig { returns(String) }
         def url
         end
@@ -31,6 +34,7 @@ module TerminalShop
         def url=(_)
         end
 
+        # URL for collecting card information.
         sig { params(url: String).returns(T.attached_class) }
         def self.new(url:)
         end

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

@@ -6,6 +6,8 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # Stripe card token. Learn how to
+      #   [create one here](https://docs.stripe.com/api/tokens/create_card).
       sig { returns(String) }
       def token
       end

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

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

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CardGetResponse < TerminalShop::BaseModel
+      # Credit card used for payments in the Terminal shop.
       sig { returns(TerminalShop::Models::CardAPI) }
       def data
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CardListResponse < TerminalShop::BaseModel
+      # List of cards associated with the user.
       sig { returns(T::Array[TerminalShop::Models::CardAPI]) }
       def data
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CartAPI < TerminalShop::BaseModel
+      # The subtotal and shipping amounts for the current user's cart.
       sig { returns(TerminalShop::Models::CartAPI::Amount) }
       def amount
       end
@@ -11,6 +12,7 @@ module TerminalShop
       def amount=(_)
       end
 
+      # An array of items in the current user's cart.
       sig { returns(T::Array[TerminalShop::Models::CartAPI::Item]) }
       def items
       end
@@ -22,6 +24,7 @@ module TerminalShop
       def items=(_)
       end
 
+      # The subtotal of all items in the current user's cart, in cents (USD).
       sig { returns(Integer) }
       def subtotal
       end
@@ -30,6 +33,7 @@ module TerminalShop
       def subtotal=(_)
       end
 
+      # ID of the shipping address selected on the current user's cart.
       sig { returns(T.nilable(String)) }
       def address_id
       end
@@ -38,6 +42,7 @@ module TerminalShop
       def address_id=(_)
       end
 
+      # ID of the card selected on the current user's cart.
       sig { returns(T.nilable(String)) }
       def card_id
       end
@@ -46,6 +51,7 @@ module TerminalShop
       def card_id=(_)
       end
 
+      # Shipping information for the current user's cart.
       sig { returns(T.nilable(TerminalShop::Models::CartAPI::Shipping)) }
       def shipping
       end
@@ -54,6 +60,7 @@ module TerminalShop
       def shipping=(_)
       end
 
+      # The current Terminal shop user's cart.
       sig do
         params(
           amount: TerminalShop::Models::CartAPI::Amount,
@@ -85,6 +92,7 @@ module TerminalShop
       end
 
       class Amount < TerminalShop::BaseModel
+        # Subtotal of the current user's cart, in cents (USD).
         sig { returns(Integer) }
         def subtotal
         end
@@ -93,6 +101,7 @@ module TerminalShop
         def subtotal=(_)
         end
 
+        # Shipping amount of the current user's cart, in cents (USD).
         sig { returns(T.nilable(Integer)) }
         def shipping
         end
@@ -101,6 +110,7 @@ module TerminalShop
         def shipping=(_)
         end
 
+        # Total amount after any discounts, in cents (USD).
         sig { returns(T.nilable(Integer)) }
         def total
         end
@@ -109,6 +119,7 @@ module TerminalShop
         def total=(_)
         end
 
+        # The subtotal and shipping amounts for the current user's cart.
         sig { params(subtotal: Integer, shipping: Integer, total: Integer).returns(T.attached_class) }
         def self.new(subtotal:, shipping: nil, total: nil)
         end
@@ -119,6 +130,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
@@ -127,6 +139,7 @@ module TerminalShop
         def id=(_)
         end
 
+        # ID of the product variant for this item in the current user's cart.
         sig { returns(String) }
         def product_variant_id
         end
@@ -135,6 +148,7 @@ module TerminalShop
         def product_variant_id=(_)
         end
 
+        # Quantity of the item in the current user's cart.
         sig { returns(Integer) }
         def quantity
         end
@@ -143,6 +157,7 @@ module TerminalShop
         def quantity=(_)
         end
 
+        # Subtotal of the item in the current user's cart, in cents (USD).
         sig { returns(Integer) }
         def subtotal
         end
@@ -151,6 +166,7 @@ module TerminalShop
         def subtotal=(_)
         end
 
+        # An item in the current Terminal shop user's cart.
         sig do
           params(id: String, product_variant_id: String, quantity: Integer, subtotal: Integer)
             .returns(T.attached_class)
@@ -166,6 +182,7 @@ module TerminalShop
       end
 
       class Shipping < TerminalShop::BaseModel
+        # Shipping service name.
         sig { returns(T.nilable(String)) }
         def service
         end
@@ -174,6 +191,7 @@ module TerminalShop
         def service=(_)
         end
 
+        # Shipping timeframe provided by the shipping carrier.
         sig { returns(T.nilable(String)) }
         def timeframe
         end
@@ -182,6 +200,7 @@ module TerminalShop
         def timeframe=(_)
         end
 
+        # Shipping information for the current user's cart.
         sig { params(service: String, timeframe: String).returns(T.attached_class) }
         def self.new(service: nil, timeframe: nil)
         end

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

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

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CartGetResponse < TerminalShop::BaseModel
+      # The current Terminal shop user's cart.
       sig { returns(TerminalShop::Models::CartAPI) }
       def data
       end

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

@@ -6,6 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # ID of the shipping address to set for the current user's cart.
       sig { returns(String) }
       def address_id
       end

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

@@ -6,6 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # ID of the credit card to set for the current user's cart.
       sig { returns(String) }
       def card_id
       end

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

@@ -6,6 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # ID of the product variant to add to the cart.
       sig { returns(String) }
       def product_variant_id
       end
@@ -14,6 +15,7 @@ module TerminalShop
       def product_variant_id=(_)
       end
 
+      # Quantity of the item to add to the cart.
       sig { returns(Integer) }
       def quantity
       end

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Models
     class CartSetItemResponse < TerminalShop::BaseModel
+      # The current Terminal shop user's cart.
       sig { returns(TerminalShop::Models::CartAPI) }
       def data
       end

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

@@ -6,6 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # Email address to subscribe to Terminal updates with.
       sig { returns(String) }
       def email
       end