terminal-shop 1.7.0 → 2.0.0

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Resources
     class Address
+      # Create and add a shipping address to the current user.
       sig do
         params(
           city: String,
@@ -13,48 +14,67 @@ module TerminalShop
           phone: String,
           province: String,
           street2: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::AddressCreateResponse)
       end
       def create(
+        # City of the address.
         city:,
+        # ISO 3166-1 alpha-2 country code of the address.
         country:,
+        # The recipient's name.
         name:,
+        # Street of the address.
         street1:,
+        # Zip code of the address.
         zip:,
+        # Phone number of the recipient.
         phone: nil,
+        # Province or state of the address.
         province: nil,
+        # Apartment, suite, etc. of the address.
         street2: nil,
         request_options: {}
       )
       end
 
+      # Get the shipping addresses associated with the current user.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::AddressListResponse)
       end
       def list(request_options: {})
       end
 
+      # Delete a shipping address from the current user.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::AddressDeleteResponse)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # ID of the shipping address to delete.
+        id,
+        request_options: {}
+      )
       end
 
+      # Get the shipping address with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::AddressGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the shipping address to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,42 +3,54 @@
 module TerminalShop
   module Resources
     class App
+      # Create an app.
       sig do
         params(
           name: String,
           redirect_uri: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::AppCreateResponse)
       end
       def create(name:, redirect_uri:, request_options: {})
       end
 
+      # List the current user's registered apps.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::AppListResponse)
       end
       def list(request_options: {})
       end
 
+      # Delete the app with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::AppDeleteResponse)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # ID of the app to delete.
+        id,
+        request_options: {}
+      )
       end
 
+      # Get the app with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::AppGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the app to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,48 +3,67 @@
 module TerminalShop
   module Resources
     class Card
+      # Attach a credit card (tokenized via Stripe) to the current user.
       sig do
         params(
           token: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::CardCreateResponse)
       end
-      def create(token:, request_options: {})
+      def create(
+        # Stripe card token. Learn how to
+        #   [create one here](https://docs.stripe.com/api/tokens/create_card).
+        token:,
+        request_options: {}
+      )
       end
 
+      # List the credit cards associated with the current user.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::CardListResponse)
       end
       def list(request_options: {})
       end
 
+      # Delete a credit card associated with the current user.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::CardDeleteResponse)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # ID of the card to delete.
+        id,
+        request_options: {}
+      )
       end
 
+      # Create a temporary URL for collecting credit card information for the current
+      #   user.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::CardCollectResponse)
       end
       def collect(request_options: {})
       end
 
+      # Get a credit card by ID associated with the current user.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::CardGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the card to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,56 +3,76 @@
 module TerminalShop
   module Resources
     class Cart
+      # Clear the current user's cart.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::CartClearResponse)
       end
       def clear(request_options: {})
       end
 
+      # Convert the current user's cart to an order.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::CartConvertResponse)
       end
       def convert(request_options: {})
       end
 
+      # Get the current user's cart.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::CartGetResponse)
       end
       def get(request_options: {})
       end
 
+      # Set the shipping address for the current user's cart.
       sig do
         params(
           address_id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::CartSetAddressResponse)
       end
-      def set_address(address_id:, request_options: {})
+      def set_address(
+        # ID of the shipping address to set for the current user's cart.
+        address_id:,
+        request_options: {}
+      )
       end
 
+      # Set the credit card for the current user's cart.
       sig do
         params(
           card_id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::CartSetCardResponse)
       end
-      def set_card(card_id:, request_options: {})
+      def set_card(
+        # ID of the credit card to set for the current user's cart.
+        card_id:,
+        request_options: {}
+      )
       end
 
+      # Add an item to the current user's cart.
       sig do
         params(
           product_variant_id: String,
           quantity: Integer,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::CartSetItemResponse)
       end
-      def set_item(product_variant_id:, quantity:, request_options: {})
+      def set_item(
+        # ID of the product variant to add to the cart.
+        product_variant_id:,
+        # Quantity of the item to add to the cart.
+        quantity:,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

data/rbi/lib/terminal-shop/resources/email.rbi

@@ -3,14 +3,19 @@
 module TerminalShop
   module Resources
     class Email
+      # Subscribe to email updates from Terminal.
       sig do
         params(
           email: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::EmailCreateResponse)
       end
-      def create(email:, request_options: {})
+      def create(
+        # Email address to subscribe to Terminal updates with.
+        email:,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,33 +3,48 @@
 module TerminalShop
   module Resources
     class Order
+      # Create an order without a cart. The order will be placed immediately.
       sig do
         params(
           address_id: String,
           card_id: String,
           variants: T::Hash[Symbol, Integer],
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::OrderCreateResponse)
       end
-      def create(address_id:, card_id:, variants:, request_options: {})
+      def create(
+        # Shipping address ID.
+        address_id:,
+        # Card ID.
+        card_id:,
+        # Product variants to include in the order, along with their quantities.
+        variants:,
+        request_options: {}
+      )
       end
 
+      # List the orders associated with the current user.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::OrderListResponse)
       end
       def list(request_options: {})
       end
 
+      # Get the order with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::OrderGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the order to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,21 +3,27 @@
 module TerminalShop
   module Resources
     class Product
+      # List all products for sale in the Terminal shop.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::ProductListResponse)
       end
       def list(request_options: {})
       end
 
+      # Get a product by ID from the Terminal shop.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::ProductGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the product to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,19 +3,21 @@
 module TerminalShop
   module Resources
     class Profile
+      # Update the current user's profile.
       sig do
         params(
           email: String,
           name: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::ProfileUpdateResponse)
       end
       def update(email:, name:, request_options: {})
       end
 
+      # Get the current user's profile.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::ProfileMeResponse)
       end
       def me(request_options: {})

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

@@ -3,6 +3,7 @@
 module TerminalShop
   module Resources
     class Subscription
+      # Create a subscription for the current user.
       sig do
         params(
           id: String,
@@ -13,49 +14,68 @@ module TerminalShop
           next_: String,
           schedule: T.any(
             TerminalShop::Models::SubscriptionAPI::Schedule::Fixed,
+            TerminalShop::Util::AnyHash,
             TerminalShop::Models::SubscriptionAPI::Schedule::Weekly
           ),
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::SubscriptionCreateResponse)
       end
       def create(
+        # Unique object identifier. The format and length of IDs may change over time.
         id:,
+        # ID of the shipping address used for the subscription.
         address_id:,
+        # ID of the card used for the subscription.
         card_id:,
+        # ID of the product variant being subscribed to.
         product_variant_id:,
+        # Quantity of the subscription.
         quantity:,
+        # Next shipment and billing date for the subscription.
         next_: nil,
+        # Schedule of the subscription.
         schedule: nil,
         request_options: {}
       )
       end
 
+      # List the subscriptions associated with the current user.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::SubscriptionListResponse)
       end
       def list(request_options: {})
       end
 
+      # Cancel a subscription for the current user.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::SubscriptionDeleteResponse)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # ID of the subscription to cancel.
+        id,
+        request_options: {}
+      )
       end
 
+      # Get the subscription with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::SubscriptionGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the subscription to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

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

@@ -3,38 +3,50 @@
 module TerminalShop
   module Resources
     class Token
+      # Create a personal access token.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::TokenCreateResponse)
       end
       def create(request_options: {})
       end
 
+      # List the current user's personal access tokens.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::TokenListResponse)
       end
       def list(request_options: {})
       end
 
+      # Delete the personal access token with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::TokenDeleteResponse)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # ID of the personal token to delete.
+        id,
+        request_options: {}
+      )
       end
 
+      # Get the personal access token with the given ID.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
         )
           .returns(TerminalShop::Models::TokenGetResponse)
       end
-      def get(id, request_options: {})
+      def get(
+        # ID of the personal token to get.
+        id,
+        request_options: {}
+      )
       end
 
       sig { params(client: TerminalShop::Client).returns(T.attached_class) }

data/rbi/lib/terminal-shop/resources/view.rbi

@@ -3,8 +3,10 @@
 module TerminalShop
   module Resources
     class View
+      # Get initial app data, including user, products, cart, addresses, cards,
+      #   subscriptions, and orders.
       sig do
-        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])))
+        params(request_options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)))
           .returns(TerminalShop::Models::ViewInitResponse)
       end
       def init(request_options: {})