terminal-shop 2.1.3 → 3.6.0

data/lib/terminal_shop.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "terminal_shop/version"
+require_relative "terminal_shop/internal/util"
+require_relative "terminal_shop/internal/type/converter"
+require_relative "terminal_shop/internal/type/unknown"
+require_relative "terminal_shop/internal/type/boolean"
+require_relative "terminal_shop/internal/type/file_input"
+require_relative "terminal_shop/internal/type/enum"
+require_relative "terminal_shop/internal/type/union"
+require_relative "terminal_shop/internal/type/array_of"
+require_relative "terminal_shop/internal/type/hash_of"
+require_relative "terminal_shop/internal/type/base_model"
+require_relative "terminal_shop/internal/type/base_page"
+require_relative "terminal_shop/internal/type/request_parameters"
+require_relative "terminal_shop/internal"
+require_relative "terminal_shop/request_options"
+require_relative "terminal_shop/file_part"
+require_relative "terminal_shop/errors"
+require_relative "terminal_shop/internal/transport/base_client"
+require_relative "terminal_shop/internal/transport/pooled_net_requester"
+require_relative "terminal_shop/client"
+require_relative "terminal_shop/models/subscription"
+require_relative "terminal_shop/models/address"
+require_relative "terminal_shop/models/address_create_params"
+require_relative "terminal_shop/models/address_create_response"
+require_relative "terminal_shop/models/address_delete_params"
+require_relative "terminal_shop/models/address_delete_response"
+require_relative "terminal_shop/models/address_get_params"
+require_relative "terminal_shop/models/address_get_response"
+require_relative "terminal_shop/models/address_list_params"
+require_relative "terminal_shop/models/address_list_response"
+require_relative "terminal_shop/models/app"
+require_relative "terminal_shop/models/app_create_params"
+require_relative "terminal_shop/models/app_create_response"
+require_relative "terminal_shop/models/app_delete_params"
+require_relative "terminal_shop/models/app_delete_response"
+require_relative "terminal_shop/models/app_get_params"
+require_relative "terminal_shop/models/app_get_response"
+require_relative "terminal_shop/models/app_list_params"
+require_relative "terminal_shop/models/app_list_response"
+require_relative "terminal_shop/models/card"
+require_relative "terminal_shop/models/card_collect_params"
+require_relative "terminal_shop/models/card_collect_response"
+require_relative "terminal_shop/models/card_create_params"
+require_relative "terminal_shop/models/card_create_response"
+require_relative "terminal_shop/models/card_delete_params"
+require_relative "terminal_shop/models/card_delete_response"
+require_relative "terminal_shop/models/card_get_params"
+require_relative "terminal_shop/models/card_get_response"
+require_relative "terminal_shop/models/card_list_params"
+require_relative "terminal_shop/models/card_list_response"
+require_relative "terminal_shop/models/cart"
+require_relative "terminal_shop/models/cart_clear_params"
+require_relative "terminal_shop/models/cart_clear_response"
+require_relative "terminal_shop/models/cart_convert_params"
+require_relative "terminal_shop/models/cart_convert_response"
+require_relative "terminal_shop/models/cart_get_params"
+require_relative "terminal_shop/models/cart_get_response"
+require_relative "terminal_shop/models/cart_set_address_params"
+require_relative "terminal_shop/models/cart_set_address_response"
+require_relative "terminal_shop/models/cart_set_card_params"
+require_relative "terminal_shop/models/cart_set_card_response"
+require_relative "terminal_shop/models/cart_set_item_params"
+require_relative "terminal_shop/models/cart_set_item_response"
+require_relative "terminal_shop/models/email_create_params"
+require_relative "terminal_shop/models/email_create_response"
+require_relative "terminal_shop/models/order"
+require_relative "terminal_shop/models/order_create_params"
+require_relative "terminal_shop/models/order_create_response"
+require_relative "terminal_shop/models/order_get_params"
+require_relative "terminal_shop/models/order_get_response"
+require_relative "terminal_shop/models/order_list_params"
+require_relative "terminal_shop/models/order_list_response"
+require_relative "terminal_shop/models/product"
+require_relative "terminal_shop/models/product_get_params"
+require_relative "terminal_shop/models/product_get_response"
+require_relative "terminal_shop/models/product_list_params"
+require_relative "terminal_shop/models/product_list_response"
+require_relative "terminal_shop/models/product_variant"
+require_relative "terminal_shop/models/profile"
+require_relative "terminal_shop/models/profile_me_params"
+require_relative "terminal_shop/models/profile_me_response"
+require_relative "terminal_shop/models/profile_update_params"
+require_relative "terminal_shop/models/profile_update_response"
+require_relative "terminal_shop/models/region"
+require_relative "terminal_shop/models/subscription_create_params"
+require_relative "terminal_shop/models/subscription_create_response"
+require_relative "terminal_shop/models/subscription_delete_params"
+require_relative "terminal_shop/models/subscription_delete_response"
+require_relative "terminal_shop/models/subscription_get_params"
+require_relative "terminal_shop/models/subscription_get_response"
+require_relative "terminal_shop/models/subscription_list_params"
+require_relative "terminal_shop/models/subscription_list_response"
+require_relative "terminal_shop/models/subscription_update_params"
+require_relative "terminal_shop/models/subscription_update_response"
+require_relative "terminal_shop/models/token"
+require_relative "terminal_shop/models/token_create_params"
+require_relative "terminal_shop/models/token_create_response"
+require_relative "terminal_shop/models/token_delete_params"
+require_relative "terminal_shop/models/token_delete_response"
+require_relative "terminal_shop/models/token_get_params"
+require_relative "terminal_shop/models/token_get_response"
+require_relative "terminal_shop/models/token_list_params"
+require_relative "terminal_shop/models/token_list_response"
+require_relative "terminal_shop/models/view_init_params"
+require_relative "terminal_shop/models/view_init_response"
+require_relative "terminal_shop/resources/address"
+require_relative "terminal_shop/resources/app"
+require_relative "terminal_shop/resources/card"
+require_relative "terminal_shop/resources/cart"
+require_relative "terminal_shop/resources/email"
+require_relative "terminal_shop/resources/order"
+require_relative "terminal_shop/resources/product"
+require_relative "terminal_shop/resources/profile"
+require_relative "terminal_shop/resources/subscription"
+require_relative "terminal_shop/resources/token"
+require_relative "terminal_shop/resources/view"

data/rbi/{lib/terminal-shop → terminal_shop}/client.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module TerminalShop
-  class Client < TerminalShop::Transport::BaseClient
+  class Client < TerminalShop::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRIES = 2
 
     DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
@@ -57,16 +57,15 @@ module TerminalShop
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers
-    end
+    private def auth_headers; end
 
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        environment: NilClass,
-        base_url: T.nilable(String),
         bearer_token: T.nilable(String),
         app_id: T.nilable(String),
+        environment: NilClass,
+        base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
@@ -75,24 +74,24 @@ module TerminalShop
         .returns(T.attached_class)
     end
     def self.new(
+      # Defaults to `ENV["TERMINAL_BEARER_TOKEN"]`
+      bearer_token: ENV["TERMINAL_BEARER_TOKEN"],
+      app_id: nil,
       # Specifies the environment to use for the API.
       #
-      #   Each environment maps to a different base URL:
+      # Each environment maps to a different base URL:
       #
-      #   - `production` corresponds to `https://api.terminal.shop`
-      #   - `dev` corresponds to `https://api.dev.terminal.shop`
+      # - `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,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["TERMINAL_BASE_URL"]`
+      base_url: ENV["TERMINAL_BASE_URL"],
       # 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,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
-    )
-    end
+      max_retries: TerminalShop::Client::DEFAULT_MAX_RETRIES,
+      timeout: TerminalShop::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: TerminalShop::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: TerminalShop::Client::DEFAULT_MAX_RETRY_DELAY
+    ); end
   end
 end

data/rbi/terminal_shop/errors.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module TerminalShop
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < TerminalShop::Errors::Error
+    end
+
+    class APIError < TerminalShop::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
+    end
+
+    class APIConnectionError < TerminalShop::Errors::APIError
+      sig { void }
+      attr_accessor :status
+
+      sig { void }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      end
+    end
+
+    class APITimeoutError < TerminalShop::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      end
+    end
+
+    class APIStatusError < TerminalShop::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil); end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil); end
+    end
+
+    class BadRequestError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < TerminalShop::Errors::APIStatusError
+      HTTP_STATUS = T.let(500.., T::Range[Integer])
+    end
+  end
+end

data/rbi/terminal_shop/file_part.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module TerminalShop
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read; end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a); end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a); end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil); end
+  end
+end

data/rbi/terminal_shop/internal/transport/base_client.rbi

@@ -0,0 +1,213 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Transport
+      # @api private
+      class BaseClient
+        abstract!
+
+        RequestComponentsShape =
+          T.type_alias do
+            {
+              method: Symbol,
+              path: T.any(String, T::Array[String]),
+              query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+              headers: T.nilable(
+                T::Hash[String,
+                        T.nilable(
+                          T.any(
+                            String,
+                            Integer,
+                            T::Array[T.nilable(T.any(String, Integer))]
+                          )
+                        )]
+              ),
+              body: T.nilable(T.anything),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
+              page: T.nilable(T::Class[TerminalShop::Internal::Type::BasePage[TerminalShop::Internal::Type::BaseModel]]),
+              stream: T.nilable(T::Class[T.anything]),
+              model: T.nilable(TerminalShop::Internal::Type::Converter::Input),
+              options: T.nilable(TerminalShop::RequestOpts)
+            }
+          end
+
+        RequestInputShape =
+          T.type_alias do
+            {
+              method: Symbol,
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              body: T.anything,
+              max_retries: Integer,
+              timeout: Float
+            }
+          end
+
+        # from whatwg fetch spec
+        MAX_REDIRECTS = 20
+
+        PLATFORM_HEADERS = T::Hash[String, String]
+
+        class << self
+          # @api private
+          sig { params(req: TerminalShop::Internal::Transport::BaseClient::RequestComponentsShape).void }
+          def validate!(req); end
+
+          # @api private
+          sig do
+            params(
+              status: Integer,
+              headers: T.any(
+                T::Hash[String, String],
+                Net::HTTPHeader
+              )
+            ).returns(T::Boolean)
+          end
+          def should_retry?(status, headers:); end
+
+          # @api private
+          sig do
+            params(
+              request: TerminalShop::Internal::Transport::BaseClient::RequestInputShape,
+              status: Integer,
+              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+            )
+              .returns(TerminalShop::Internal::Transport::BaseClient::RequestInputShape)
+          end
+          def follow_redirect(request, status:, response_headers:); end
+
+          # @api private
+          sig do
+            params(
+              status: T.any(Integer, TerminalShop::Errors::APIConnectionError),
+              stream: T.nilable(T::Enumerable[String])
+            )
+              .void
+          end
+          def reap_connection!(status, stream:); end
+        end
+
+        # @api private
+        sig { returns(TerminalShop::Internal::Transport::PooledNetRequester) }
+        attr_reader :requester
+
+        # @api private
+        sig do
+          params(
+            base_url: String,
+            timeout: Float,
+            max_retries: Integer,
+            initial_retry_delay: Float,
+            max_retry_delay: Float,
+            headers: T::Hash[String,
+                             T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
+            idempotency_header: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          base_url:,
+          timeout: 0.0,
+          max_retries: 0,
+          initial_retry_delay: 0.0,
+          max_retry_delay: 0.0,
+          headers: {},
+          idempotency_header: nil
+        ); end
+        # @api private
+        sig { overridable.returns(T::Hash[String, String]) }
+        private def auth_headers; end
+
+        # @api private
+        sig { returns(String) }
+        private def generate_idempotency_key; end
+
+        # @api private
+        sig do
+          overridable
+            .params(
+              req: TerminalShop::Internal::Transport::BaseClient::RequestComponentsShape,
+              opts: TerminalShop::Internal::AnyHash
+            )
+            .returns(TerminalShop::Internal::Transport::BaseClient::RequestInputShape)
+        end
+        private def build_request(req, opts); end
+
+        # @api private
+        sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
+        private def retry_delay(headers, retry_count:); end
+
+        # @api private
+        sig do
+          params(
+            request: TerminalShop::Internal::Transport::BaseClient::RequestInputShape,
+            redirect_count: Integer,
+            retry_count: Integer,
+            send_retry_header: T::Boolean
+          )
+            .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+        end
+        private def send_request(request, redirect_count:, retry_count:, send_retry_header:); end
+
+        # Execute the request specified by `req`. This is the method that all resource
+        # methods call into.
+        #
+        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: TerminalShop::Internal::Type::Unknown, options: {})
+        sig do
+          params(
+            method: Symbol,
+            path: T.any(String, T::Array[String]),
+            query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+            headers: T.nilable(
+              T::Hash[String,
+                      T.nilable(
+                        T.any(
+                          String,
+                          Integer,
+                          T::Array[T.nilable(T.any(String, Integer))]
+                        )
+                      )]
+            ),
+            body: T.nilable(T.anything),
+            unwrap: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
+            page: T.nilable(T::Class[TerminalShop::Internal::Type::BasePage[TerminalShop::Internal::Type::BaseModel]]),
+            stream: T.nilable(T::Class[T.anything]),
+            model: T.nilable(TerminalShop::Internal::Type::Converter::Input),
+            options: T.nilable(TerminalShop::RequestOpts)
+          )
+            .returns(T.anything)
+        end
+        def request(
+          method,
+          path,
+          query: {},
+          headers: {},
+          body: nil,
+          unwrap: nil,
+          page: nil,
+          stream: nil,
+          model: TerminalShop::Internal::Type::Unknown,
+          options: {}
+        ); end
+        # @api private
+        sig { returns(String) }
+        def inspect; end
+      end
+    end
+  end
+end

data/rbi/terminal_shop/internal/transport/pooled_net_requester.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Transport
+      # @api private
+      class PooledNetRequester
+        RequestShape =
+          T.type_alias do
+            {
+              method: Symbol,
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              body: T.anything,
+              deadline: Float
+            }
+          end
+
+        # from the golang stdlib
+        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+        KEEP_ALIVE_TIMEOUT = 30
+
+        class << self
+          # @api private
+          sig { params(url: URI::Generic).returns(Net::HTTP) }
+          def connect(url); end
+
+          # @api private
+          sig { params(conn: Net::HTTP, deadline: Float).void }
+          def calibrate_socket_timeout(conn, deadline); end
+
+          # @api private
+          sig do
+            params(
+              request: TerminalShop::Internal::Transport::PooledNetRequester::RequestShape,
+              blk: T.proc.params(arg0: String).void
+            )
+              .returns([Net::HTTPGenericRequest, T.proc.void])
+          end
+          def build_request(request, &blk); end
+        end
+
+        # @api private
+        sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void }
+        private def with_pool(url, deadline:, &blk); end
+
+        # @api private
+        sig do
+          params(request: TerminalShop::Internal::Transport::PooledNetRequester::RequestShape)
+            .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+        end
+        def execute(request); end
+
+        # @api private
+        sig { params(size: Integer).returns(T.attached_class) }
+        def self.new(size: Etc.nprocessors); end
+      end
+    end
+  end
+end