terminal-shop 1.7.0 → 2.0.0

data/rbi/lib/terminal-shop/base_page.rbi

@@ -2,8 +2,6 @@
 
 module TerminalShop
   module BasePage
-    abstract!
-
     Elem = type_member(:out)
 
     sig { overridable.returns(T::Boolean) }
@@ -22,8 +20,7 @@ module TerminalShop
     def to_enum
     end
 
-    alias_method :enum_for, :to_enum
-
+    # @api private
     sig do
       params(
         client: TerminalShop::BaseClient,

data/rbi/lib/terminal-shop/client.rbi

@@ -10,67 +10,57 @@ module TerminalShop
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
-    ENVIRONMENTS = T.let(
-      {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"},
-      T::Hash[Symbol, String]
-    )
+    ENVIRONMENTS =
+      T.let(
+        {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"},
+        T::Hash[Symbol, String]
+      )
 
     sig { returns(String) }
-    def bearer_token
-    end
+    attr_reader :bearer_token
 
     sig { returns(T.nilable(String)) }
-    def app_id
-    end
+    attr_reader :app_id
 
     sig { returns(TerminalShop::Resources::Product) }
-    def product
-    end
+    attr_reader :product
 
     sig { returns(TerminalShop::Resources::Profile) }
-    def profile
-    end
+    attr_reader :profile
 
     sig { returns(TerminalShop::Resources::Address) }
-    def address
-    end
+    attr_reader :address
 
     sig { returns(TerminalShop::Resources::Card) }
-    def card
-    end
+    attr_reader :card
 
     sig { returns(TerminalShop::Resources::Cart) }
-    def cart
-    end
+    attr_reader :cart
 
     sig { returns(TerminalShop::Resources::Order) }
-    def order
-    end
+    attr_reader :order
 
     sig { returns(TerminalShop::Resources::Subscription) }
-    def subscription
-    end
+    attr_reader :subscription
 
     sig { returns(TerminalShop::Resources::Token) }
-    def token
-    end
+    attr_reader :token
 
     sig { returns(TerminalShop::Resources::App) }
-    def app
-    end
+    attr_reader :app
 
     sig { returns(TerminalShop::Resources::Email) }
-    def email
-    end
+    attr_reader :email
 
     sig { returns(TerminalShop::Resources::View) }
-    def view
-    end
+    attr_reader :view
 
+    # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers
     end
 
+    # Creates and returns a new client for interacting with the API.
     sig do
       params(
         environment: NilClass,
@@ -85,10 +75,19 @@ module TerminalShop
         .returns(T.attached_class)
     end
     def self.new(
+      # Specifies the environment to use for the API.
+      #
+      #   Each environment maps to a different base URL:
+      #
+      #   - `production` corresponds to `https://api.terminal.shop/`
+      #   - `dev` corresponds to `https://api.dev.terminal.shop/`
       environment: nil,
+      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
       base_url: nil,
+      # Defaults to `ENV["TERMINAL_BEARER_TOKEN"]`
       bearer_token: ENV["TERMINAL_BEARER_TOKEN"],
       app_id: nil,
+      # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,

data/rbi/lib/terminal-shop/errors.rbi

@@ -3,8 +3,7 @@
 module TerminalShop
   class Error < StandardError
     sig { returns(T.nilable(StandardError)) }
-    def cause
-    end
+    attr_accessor :cause
   end
 
   class ConversionError < TerminalShop::Error
@@ -12,17 +11,15 @@ module TerminalShop
 
   class APIError < TerminalShop::Error
     sig { returns(URI::Generic) }
-    def url
-    end
+    attr_accessor :url
 
     sig { returns(T.nilable(Integer)) }
-    def status
-    end
+    attr_accessor :status
 
     sig { returns(T.nilable(T.anything)) }
-    def body
-    end
+    attr_accessor :body
 
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -40,13 +37,12 @@ module TerminalShop
 
   class APIConnectionError < TerminalShop::APIError
     sig { void }
-    def status
-    end
+    attr_accessor :status
 
     sig { void }
-    def body
-    end
+    attr_accessor :body
 
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -63,6 +59,7 @@ module TerminalShop
   end
 
   class APITimeoutError < TerminalShop::APIConnectionError
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -79,6 +76,7 @@ module TerminalShop
   end
 
   class APIStatusError < TerminalShop::APIError
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -94,9 +92,9 @@ module TerminalShop
     end
 
     sig { returns(Integer) }
-    def status
-    end
+    attr_accessor :status
 
+    # @api private
     sig do
       params(
         url: URI::Generic,

data/rbi/lib/terminal-shop/extern.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module TerminalShop
+  # @api private
   module Extern
-    abstract!
   end
 end

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

@@ -3,78 +3,52 @@
 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
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :id
 
+      # City of the address.
       sig { returns(String) }
-      def city
-      end
-
-      sig { params(_: String).returns(String) }
-      def city=(_)
-      end
+      attr_accessor :city
 
+      # ISO 3166-1 alpha-2 country code of the address.
       sig { returns(String) }
-      def country
-      end
-
-      sig { params(_: String).returns(String) }
-      def country=(_)
-      end
+      attr_accessor :country
 
+      # The recipient's name.
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
+      # Street of the address.
       sig { returns(String) }
-      def street1
-      end
-
-      sig { params(_: String).returns(String) }
-      def street1=(_)
-      end
+      attr_accessor :street1
 
+      # Zip code of the address.
       sig { returns(String) }
-      def zip
-      end
-
-      sig { params(_: String).returns(String) }
-      def zip=(_)
-      end
+      attr_accessor :zip
 
+      # Phone number of the recipient.
       sig { returns(T.nilable(String)) }
-      def phone
-      end
+      attr_reader :phone
 
-      sig { params(_: String).returns(String) }
-      def phone=(_)
-      end
+      sig { params(phone: String).void }
+      attr_writer :phone
 
+      # Province or state of the address.
       sig { returns(T.nilable(String)) }
-      def province
-      end
+      attr_reader :province
 
-      sig { params(_: String).returns(String) }
-      def province=(_)
-      end
+      sig { params(province: String).void }
+      attr_writer :province
 
+      # Apartment, suite, etc. of the address.
       sig { returns(T.nilable(String)) }
-      def street2
-      end
+      attr_reader :street2
 
-      sig { params(_: String).returns(String) }
-      def street2=(_)
-      end
+      sig { params(street2: String).void }
+      attr_writer :street2
 
+      # Physical address associated with a Terminal shop user.
       sig do
         params(
           id: String,

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

@@ -6,69 +6,46 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # City of the address.
       sig { returns(String) }
-      def city
-      end
-
-      sig { params(_: String).returns(String) }
-      def city=(_)
-      end
+      attr_accessor :city
 
+      # ISO 3166-1 alpha-2 country code of the address.
       sig { returns(String) }
-      def country
-      end
-
-      sig { params(_: String).returns(String) }
-      def country=(_)
-      end
+      attr_accessor :country
 
+      # The recipient's name.
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
+      # Street of the address.
       sig { returns(String) }
-      def street1
-      end
-
-      sig { params(_: String).returns(String) }
-      def street1=(_)
-      end
+      attr_accessor :street1
 
+      # Zip code of the address.
       sig { returns(String) }
-      def zip
-      end
-
-      sig { params(_: String).returns(String) }
-      def zip=(_)
-      end
+      attr_accessor :zip
 
+      # Phone number of the recipient.
       sig { returns(T.nilable(String)) }
-      def phone
-      end
+      attr_reader :phone
 
-      sig { params(_: String).returns(String) }
-      def phone=(_)
-      end
+      sig { params(phone: String).void }
+      attr_writer :phone
 
+      # Province or state of the address.
       sig { returns(T.nilable(String)) }
-      def province
-      end
+      attr_reader :province
 
-      sig { params(_: String).returns(String) }
-      def province=(_)
-      end
+      sig { params(province: String).void }
+      attr_writer :province
 
+      # Apartment, suite, etc. of the address.
       sig { returns(T.nilable(String)) }
-      def street2
-      end
+      attr_reader :street2
 
-      sig { params(_: String).returns(String) }
-      def street2=(_)
-      end
+      sig { params(street2: String).void }
+      attr_writer :street2
 
       sig do
         params(
@@ -80,7 +57,7 @@ module TerminalShop
           phone: String,
           province: String,
           street2: String,
-          request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)
         )
           .returns(T.attached_class)
       end

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

@@ -3,13 +3,9 @@
 module TerminalShop
   module Models
     class AddressCreateResponse < TerminalShop::BaseModel
+      # Shipping address ID.
       sig { returns(String) }
-      def data
-      end
-
-      sig { params(_: String).returns(String) }
-      def data=(_)
-      end
+      attr_accessor :data
 
       sig { params(data: String).returns(T.attached_class) }
       def self.new(data:)

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

@@ -7,7 +7,7 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       sig do
-        params(request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
           .returns(T.attached_class)
       end
       def self.new(request_options: {})

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

@@ -4,12 +4,7 @@ module TerminalShop
   module Models
     class AddressDeleteResponse < TerminalShop::BaseModel
       sig { returns(Symbol) }
-      def data
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def data=(_)
-      end
+      attr_accessor :data
 
       sig { params(data: Symbol).returns(T.attached_class) }
       def self.new(data: :ok)

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

@@ -7,7 +7,7 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       sig do
-        params(request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
           .returns(T.attached_class)
       end
       def self.new(request_options: {})

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

@@ -3,15 +3,17 @@
 module TerminalShop
   module Models
     class AddressGetResponse < TerminalShop::BaseModel
+      # Physical address associated with a Terminal shop user.
       sig { returns(TerminalShop::Models::AddressAPI) }
-      def data
-      end
+      attr_reader :data
 
-      sig { params(_: TerminalShop::Models::AddressAPI).returns(TerminalShop::Models::AddressAPI) }
-      def data=(_)
-      end
+      sig { params(data: T.any(TerminalShop::Models::AddressAPI, TerminalShop::Util::AnyHash)).void }
+      attr_writer :data
 
-      sig { params(data: TerminalShop::Models::AddressAPI).returns(T.attached_class) }
+      sig do
+        params(data: T.any(TerminalShop::Models::AddressAPI, TerminalShop::Util::AnyHash))
+          .returns(T.attached_class)
+      end
       def self.new(data:)
       end
 

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

@@ -7,7 +7,7 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       sig do
-        params(request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
           .returns(T.attached_class)
       end
       def self.new(request_options: {})

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

@@ -3,15 +3,14 @@
 module TerminalShop
   module Models
     class AddressListResponse < TerminalShop::BaseModel
+      # Shipping addresses.
       sig { returns(T::Array[TerminalShop::Models::AddressAPI]) }
-      def data
-      end
+      attr_accessor :data
 
-      sig { params(_: T::Array[TerminalShop::Models::AddressAPI]).returns(T::Array[TerminalShop::Models::AddressAPI]) }
-      def data=(_)
+      sig do
+        params(data: T::Array[T.any(TerminalShop::Models::AddressAPI, TerminalShop::Util::AnyHash)])
+          .returns(T.attached_class)
       end
-
-      sig { params(data: T::Array[TerminalShop::Models::AddressAPI]).returns(T.attached_class) }
       def self.new(data:)
       end
 

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

@@ -3,38 +3,23 @@
 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
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :id
 
+      # Name of the app.
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
+      # Redirect URI of the app.
       sig { returns(String) }
-      def redirect_uri
-      end
-
-      sig { params(_: String).returns(String) }
-      def redirect_uri=(_)
-      end
+      attr_accessor :redirect_uri
 
+      # OAuth 2.0 client secret of the app (obfuscated).
       sig { returns(String) }
-      def secret
-      end
-
-      sig { params(_: String).returns(String) }
-      def secret=(_)
-      end
+      attr_accessor :secret
 
+      # 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_params.rbi

@@ -7,26 +7,16 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
       sig { returns(String) }
-      def redirect_uri
-      end
-
-      sig { params(_: String).returns(String) }
-      def redirect_uri=(_)
-      end
+      attr_accessor :redirect_uri
 
       sig do
         params(
           name: String,
           redirect_uri: String,
-          request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)
         )
           .returns(T.attached_class)
       end

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

@@ -4,17 +4,15 @@ module TerminalShop
   module Models
     class AppCreateResponse < TerminalShop::BaseModel
       sig { returns(TerminalShop::Models::AppCreateResponse::Data) }
-      def data
-      end
+      attr_reader :data
+
+      sig { params(data: T.any(TerminalShop::Models::AppCreateResponse::Data, TerminalShop::Util::AnyHash)).void }
+      attr_writer :data
 
       sig do
-        params(_: TerminalShop::Models::AppCreateResponse::Data)
-          .returns(TerminalShop::Models::AppCreateResponse::Data)
-      end
-      def data=(_)
+        params(data: T.any(TerminalShop::Models::AppCreateResponse::Data, TerminalShop::Util::AnyHash))
+          .returns(T.attached_class)
       end
-
-      sig { params(data: TerminalShop::Models::AppCreateResponse::Data).returns(T.attached_class) }
       def self.new(data:)
       end
 
@@ -23,21 +21,13 @@ module TerminalShop
       end
 
       class Data < TerminalShop::BaseModel
+        # OAuth 2.0 client ID.
         sig { returns(String) }
-        def id
-        end
-
-        sig { params(_: String).returns(String) }
-        def id=(_)
-        end
+        attr_accessor :id
 
+        # OAuth 2.0 client secret.
         sig { returns(String) }
-        def secret
-        end
-
-        sig { params(_: String).returns(String) }
-        def secret=(_)
-        end
+        attr_accessor :secret
 
         sig { params(id: String, secret: String).returns(T.attached_class) }
         def self.new(id:, secret:)

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

@@ -7,7 +7,7 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       sig do
-        params(request_options: T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
           .returns(T.attached_class)
       end
       def self.new(request_options: {})

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

@@ -4,12 +4,7 @@ module TerminalShop
   module Models
     class AppDeleteResponse < TerminalShop::BaseModel
       sig { returns(Symbol) }
-      def data
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def data=(_)
-      end
+      attr_accessor :data
 
       sig { params(data: Symbol).returns(T.attached_class) }
       def self.new(data: :ok)