terminal-shop 2.1.3 → 3.5.0

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

@@ -2,7 +2,7 @@
 
 module TerminalShop
   module Models
-    class OrderAPI < TerminalShop::BaseModel
+    class OrderAPI < TerminalShop::Internal::Type::BaseModel
       # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       attr_accessor :id
@@ -11,9 +11,13 @@ module TerminalShop
       sig { returns(TerminalShop::Models::OrderAPI::Amount) }
       attr_reader :amount
 
-      sig { params(amount: T.any(TerminalShop::Models::OrderAPI::Amount, TerminalShop::Util::AnyHash)).void }
+      sig { params(amount: T.any(TerminalShop::Models::OrderAPI::Amount, TerminalShop::Internal::AnyHash)).void }
       attr_writer :amount
 
+      # Date the order was created.
+      sig { returns(String) }
+      attr_accessor :created
+
       # Items in the order.
       sig { returns(T::Array[TerminalShop::Models::OrderAPI::Item]) }
       attr_accessor :items
@@ -22,14 +26,14 @@ module TerminalShop
       sig { returns(TerminalShop::Models::OrderAPI::Shipping) }
       attr_reader :shipping
 
-      sig { params(shipping: T.any(TerminalShop::Models::OrderAPI::Shipping, TerminalShop::Util::AnyHash)).void }
+      sig { params(shipping: T.any(TerminalShop::Models::OrderAPI::Shipping, TerminalShop::Internal::AnyHash)).void }
       attr_writer :shipping
 
       # Tracking information of the order.
       sig { returns(TerminalShop::Models::OrderAPI::Tracking) }
       attr_reader :tracking
 
-      sig { params(tracking: T.any(TerminalShop::Models::OrderAPI::Tracking, TerminalShop::Util::AnyHash)).void }
+      sig { params(tracking: T.any(TerminalShop::Models::OrderAPI::Tracking, TerminalShop::Internal::AnyHash)).void }
       attr_writer :tracking
 
       # Zero-based index of the order for this user only.
@@ -43,23 +47,38 @@ module TerminalShop
       sig do
         params(
           id: String,
-          amount: T.any(TerminalShop::Models::OrderAPI::Amount, TerminalShop::Util::AnyHash),
-          items: T::Array[T.any(TerminalShop::Models::OrderAPI::Item, TerminalShop::Util::AnyHash)],
-          shipping: T.any(TerminalShop::Models::OrderAPI::Shipping, TerminalShop::Util::AnyHash),
-          tracking: T.any(TerminalShop::Models::OrderAPI::Tracking, TerminalShop::Util::AnyHash),
+          amount: T.any(TerminalShop::Models::OrderAPI::Amount, TerminalShop::Internal::AnyHash),
+          created: String,
+          items: T::Array[T.any(TerminalShop::Models::OrderAPI::Item, TerminalShop::Internal::AnyHash)],
+          shipping: T.any(TerminalShop::Models::OrderAPI::Shipping, TerminalShop::Internal::AnyHash),
+          tracking: T.any(TerminalShop::Models::OrderAPI::Tracking, TerminalShop::Internal::AnyHash),
           index: Integer
         )
           .returns(T.attached_class)
       end
-      def self.new(id:, amount:, items:, shipping:, tracking:, index: nil)
-      end
-
+      def self.new(
+        # Unique object identifier. The format and length of IDs may change over time.
+        id:,
+        # The subtotal and shipping amounts of the order.
+        amount:,
+        # Date the order was created.
+        created:,
+        # Items in the order.
+        items:,
+        # Shipping address of the order.
+        shipping:,
+        # Tracking information of the order.
+        tracking:,
+        # Zero-based index of the order for this user only.
+        index: nil
+      ); end
       sig do
         override
           .returns(
             {
               id: String,
               amount: TerminalShop::Models::OrderAPI::Amount,
+              created: String,
               items: T::Array[TerminalShop::Models::OrderAPI::Item],
               shipping: TerminalShop::Models::OrderAPI::Shipping,
               tracking: TerminalShop::Models::OrderAPI::Tracking,
@@ -67,10 +86,9 @@ module TerminalShop
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
-      class Amount < TerminalShop::BaseModel
+      class Amount < TerminalShop::Internal::Type::BaseModel
         # Shipping amount of the order, in cents (USD).
         sig { returns(Integer) }
         attr_accessor :shipping
@@ -81,15 +99,17 @@ module TerminalShop
 
         # The subtotal and shipping amounts of the order.
         sig { params(shipping: Integer, subtotal: Integer).returns(T.attached_class) }
-        def self.new(shipping:, subtotal:)
-        end
-
+        def self.new(
+          # Shipping amount of the order, in cents (USD).
+          shipping:,
+          # Subtotal amount of the order, in cents (USD).
+          subtotal:
+        ); end
         sig { override.returns({shipping: Integer, subtotal: Integer}) }
-        def to_hash
-        end
+        def to_hash; end
       end
 
-      class Item < TerminalShop::BaseModel
+      class Item < TerminalShop::Internal::Type::BaseModel
         # Unique object identifier. The format and length of IDs may change over time.
         sig { returns(String) }
         attr_accessor :id
@@ -126,9 +146,18 @@ module TerminalShop
           )
             .returns(T.attached_class)
         end
-        def self.new(id:, amount:, quantity:, description: nil, product_variant_id: nil)
-        end
-
+        def self.new(
+          # Unique object identifier. The format and length of IDs may change over time.
+          id:,
+          # Amount of the item in the order, in cents (USD).
+          amount:,
+          # Quantity of the item in the order.
+          quantity:,
+          # Description of the item in the order.
+          description: nil,
+          # ID of the product variant of the item in the order.
+          product_variant_id: nil
+        ); end
         sig do
           override
             .returns({
@@ -139,11 +168,10 @@ module TerminalShop
                        product_variant_id: String
                      })
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
-      class Shipping < TerminalShop::BaseModel
+      class Shipping < TerminalShop::Internal::Type::BaseModel
         # City of the address.
         sig { returns(String) }
         attr_accessor :city
@@ -199,9 +227,24 @@ module TerminalShop
           )
             .returns(T.attached_class)
         end
-        def self.new(city:, country:, name:, street1:, zip:, phone: nil, province: nil, street2: nil)
-        end
-
+        def self.new(
+          # 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
+        ); end
         sig do
           override
             .returns(
@@ -217,11 +260,10 @@ module TerminalShop
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
-      class Tracking < TerminalShop::BaseModel
+      class Tracking < TerminalShop::Internal::Type::BaseModel
         # Tracking number of the order.
         sig { returns(T.nilable(String)) }
         attr_reader :number
@@ -236,6 +278,27 @@ module TerminalShop
         sig { params(service: String).void }
         attr_writer :service
 
+        # Current tracking status of the shipment.
+        sig { returns(T.nilable(TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)) }
+        attr_reader :status
+
+        sig { params(status: TerminalShop::Models::OrderAPI::Tracking::Status::OrSymbol).void }
+        attr_writer :status
+
+        # Additional details about the tracking status.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status_details
+
+        sig { params(status_details: String).void }
+        attr_writer :status_details
+
+        # When the tracking status was last updated.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status_updated_at
+
+        sig { params(status_updated_at: String).void }
+        attr_writer :status_updated_at
+
         # Tracking URL of the order.
         sig { returns(T.nilable(String)) }
         attr_reader :url
@@ -244,12 +307,62 @@ module TerminalShop
         attr_writer :url
 
         # 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)
+        sig do
+          params(
+            number: String,
+            service: String,
+            status: TerminalShop::Models::OrderAPI::Tracking::Status::OrSymbol,
+            status_details: String,
+            status_updated_at: String,
+            url: String
+          )
+            .returns(T.attached_class)
         end
+        def self.new(
+          # Tracking number of the order.
+          number: nil,
+          # Shipping service of the order.
+          service: nil,
+          # Current tracking status of the shipment.
+          status: nil,
+          # Additional details about the tracking status.
+          status_details: nil,
+          # When the tracking status was last updated.
+          status_updated_at: nil,
+          # Tracking URL of the order.
+          url: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                number: String,
+                service: String,
+                status: TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol,
+                status_details: String,
+                status_updated_at: String,
+                url: String
+              }
+            )
+        end
+        def to_hash; end
+
+        # Current tracking status of the shipment.
+        module Status
+          extend TerminalShop::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, TerminalShop::Models::OrderAPI::Tracking::Status) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRE_TRANSIT = T.let(:PRE_TRANSIT, TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)
+          TRANSIT = T.let(:TRANSIT, TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)
+          DELIVERED = T.let(:DELIVERED, TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)
+          RETURNED = T.let(:RETURNED, TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)
+          FAILURE = T.let(:FAILURE, TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)
+          UNKNOWN = T.let(:UNKNOWN, TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol)
 
-        sig { override.returns({number: String, service: String, url: String}) }
-        def to_hash
+          sig { override.returns(T::Array[TerminalShop::Models::OrderAPI::Tracking::Status::TaggedSymbol]) }
+          def self.values; end
         end
       end
     end

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

@@ -2,9 +2,9 @@
 
 module TerminalShop
   module Models
-    class OrderCreateParams < TerminalShop::BaseModel
-      extend TerminalShop::Type::RequestParameters::Converter
-      include TerminalShop::RequestParameters
+    class OrderCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
 
       # Shipping address ID.
       sig { returns(String) }
@@ -23,13 +23,19 @@ module TerminalShop
           address_id: String,
           card_id: String,
           variants: T::Hash[Symbol, Integer],
-          request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash)
+          request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Internal::AnyHash)
         )
           .returns(T.attached_class)
       end
-      def self.new(address_id:, card_id:, variants:, request_options: {})
-      end
-
+      def self.new(
+        # Shipping address ID.
+        address_id:,
+        # Card ID.
+        card_id:,
+        # Product variants to include in the order, along with their quantities.
+        variants:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -41,8 +47,7 @@ module TerminalShop
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
     end
   end
 end

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

@@ -2,18 +2,18 @@
 
 module TerminalShop
   module Models
-    class OrderCreateResponse < TerminalShop::BaseModel
+    class OrderCreateResponse < TerminalShop::Internal::Type::BaseModel
       # Order ID.
       sig { returns(String) }
       attr_accessor :data
 
       sig { params(data: String).returns(T.attached_class) }
-      def self.new(data:)
-      end
-
+      def self.new(
+        # Order ID.
+        data:
+      ); end
       sig { override.returns({data: String}) }
-      def to_hash
-      end
+      def to_hash; end
     end
   end
 end

data/rbi/lib/terminal_shop/models/order_get_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module TerminalShop
+  module Models
+    class OrderGetParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: TerminalShop::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/lib/terminal_shop/models/order_get_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module TerminalShop
+  module Models
+    class OrderGetResponse < TerminalShop::Internal::Type::BaseModel
+      # An order from the Terminal shop.
+      sig { returns(TerminalShop::Models::OrderAPI) }
+      attr_reader :data
+
+      sig { params(data: T.any(TerminalShop::Models::OrderAPI, TerminalShop::Internal::AnyHash)).void }
+      attr_writer :data
+
+      sig do
+        params(data: T.any(TerminalShop::Models::OrderAPI, TerminalShop::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # An order from the Terminal shop.
+        data:
+      ); end
+      sig { override.returns({data: TerminalShop::Models::OrderAPI}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/lib/terminal_shop/models/order_list_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module TerminalShop
+  module Models
+    class OrderListParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: TerminalShop::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

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

@@ -2,21 +2,21 @@
 
 module TerminalShop
   module Models
-    class OrderListResponse < TerminalShop::BaseModel
+    class OrderListResponse < TerminalShop::Internal::Type::BaseModel
       # List of orders.
       sig { returns(T::Array[TerminalShop::Models::OrderAPI]) }
       attr_accessor :data
 
       sig do
-        params(data: T::Array[T.any(TerminalShop::Models::OrderAPI, TerminalShop::Util::AnyHash)])
+        params(data: T::Array[T.any(TerminalShop::Models::OrderAPI, TerminalShop::Internal::AnyHash)])
           .returns(T.attached_class)
       end
-      def self.new(data:)
-      end
-
+      def self.new(
+        # List of orders.
+        data:
+      ); end
       sig { override.returns({data: T::Array[TerminalShop::Models::OrderAPI]}) }
-      def to_hash
-      end
+      def to_hash; end
     end
   end
 end

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

@@ -2,7 +2,7 @@
 
 module TerminalShop
   module Models
-    class ProductAPI < TerminalShop::BaseModel
+    class ProductAPI < TerminalShop::Internal::Type::BaseModel
       # Unique object identifier. The format and length of IDs may change over time.
       sig { returns(String) }
       attr_accessor :id
@@ -37,7 +37,7 @@ module TerminalShop
       sig { returns(T.nilable(TerminalShop::Models::ProductAPI::Tags)) }
       attr_reader :tags
 
-      sig { params(tags: T.any(TerminalShop::Models::ProductAPI::Tags, TerminalShop::Util::AnyHash)).void }
+      sig { params(tags: T.any(TerminalShop::Models::ProductAPI::Tags, TerminalShop::Internal::AnyHash)).void }
       attr_writer :tags
 
       # Product sold in the Terminal shop.
@@ -46,16 +46,29 @@ module TerminalShop
           id: String,
           description: String,
           name: String,
-          variants: T::Array[T.any(TerminalShop::Models::ProductVariant, TerminalShop::Util::AnyHash)],
+          variants: T::Array[T.any(TerminalShop::Models::ProductVariant, TerminalShop::Internal::AnyHash)],
           order: Integer,
           subscription: TerminalShop::Models::ProductAPI::Subscription::OrSymbol,
-          tags: T.any(TerminalShop::Models::ProductAPI::Tags, TerminalShop::Util::AnyHash)
+          tags: T.any(TerminalShop::Models::ProductAPI::Tags, TerminalShop::Internal::AnyHash)
         )
           .returns(T.attached_class)
       end
-      def self.new(id:, description:, name:, variants:, order: nil, subscription: nil, tags: nil)
-      end
-
+      def self.new(
+        # Unique object identifier. The format and length of IDs may change over time.
+        id:,
+        # Description of the product.
+        description:,
+        # Name of the product.
+        name:,
+        # List of variants of the product.
+        variants:,
+        # Order of the product used when displaying a sorted list of products.
+        order: nil,
+        # Whether the product must be or can be subscribed to.
+        subscription: nil,
+        # Tags for the product.
+        tags: nil
+      ); end
       sig do
         override
           .returns(
@@ -70,25 +83,23 @@ module TerminalShop
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
       # Whether the product must be or can be subscribed to.
       module Subscription
-        extend TerminalShop::Enum
+        extend TerminalShop::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, TerminalShop::Models::ProductAPI::Subscription) }
-        OrSymbol = T.type_alias { T.any(Symbol, TerminalShop::Models::ProductAPI::Subscription::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         ALLOWED = T.let(:allowed, TerminalShop::Models::ProductAPI::Subscription::TaggedSymbol)
         REQUIRED = T.let(:required, TerminalShop::Models::ProductAPI::Subscription::TaggedSymbol)
 
         sig { override.returns(T::Array[TerminalShop::Models::ProductAPI::Subscription::TaggedSymbol]) }
-        def self.values
-        end
+        def self.values; end
       end
 
-      class Tags < TerminalShop::BaseModel
+      class Tags < TerminalShop::Internal::Type::BaseModel
         sig { returns(T.nilable(String)) }
         attr_reader :app
 
@@ -113,6 +124,12 @@ module TerminalShop
         sig { params(market_eu: T::Boolean).void }
         attr_writer :market_eu
 
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :market_global
+
+        sig { params(market_global: T::Boolean).void }
+        attr_writer :market_global
+
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :market_na
 
@@ -126,25 +143,28 @@ module TerminalShop
             color: String,
             featured: T::Boolean,
             market_eu: T::Boolean,
+            market_global: T::Boolean,
             market_na: T::Boolean
           )
             .returns(T.attached_class)
         end
-        def self.new(app: nil, color: nil, featured: nil, market_eu: nil, market_na: nil)
+        def self.new(app: nil, color: nil, featured: nil, market_eu: nil, market_global: nil, market_na: nil)
         end
 
         sig do
           override
-            .returns({
-                       app: String,
-                       color: String,
-                       featured: T::Boolean,
-                       market_eu: T::Boolean,
-                       market_na: T::Boolean
-                     })
-        end
-        def to_hash
+            .returns(
+              {
+                app: String,
+                color: String,
+                featured: T::Boolean,
+                market_eu: T::Boolean,
+                market_global: T::Boolean,
+                market_na: T::Boolean
+              }
+            )
         end
+        def to_hash; end
       end
     end
   end

data/rbi/lib/terminal_shop/models/product_get_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module TerminalShop
+  module Models
+    class ProductGetParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: TerminalShop::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

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

@@ -2,24 +2,24 @@
 
 module TerminalShop
   module Models
-    class ProductGetResponse < TerminalShop::BaseModel
+    class ProductGetResponse < TerminalShop::Internal::Type::BaseModel
       # Product sold in the Terminal shop.
       sig { returns(TerminalShop::Models::ProductAPI) }
       attr_reader :data
 
-      sig { params(data: T.any(TerminalShop::Models::ProductAPI, TerminalShop::Util::AnyHash)).void }
+      sig { params(data: T.any(TerminalShop::Models::ProductAPI, TerminalShop::Internal::AnyHash)).void }
       attr_writer :data
 
       sig do
-        params(data: T.any(TerminalShop::Models::ProductAPI, TerminalShop::Util::AnyHash))
+        params(data: T.any(TerminalShop::Models::ProductAPI, TerminalShop::Internal::AnyHash))
           .returns(T.attached_class)
       end
-      def self.new(data:)
-      end
-
+      def self.new(
+        # Product sold in the Terminal shop.
+        data:
+      ); end
       sig { override.returns({data: TerminalShop::Models::ProductAPI}) }
-      def to_hash
-      end
+      def to_hash; end
     end
   end
 end

data/rbi/lib/terminal_shop/models/product_list_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module TerminalShop
+  module Models
+    class ProductListParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(TerminalShop::RequestOptions, TerminalShop::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: TerminalShop::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end