terminal-shop 2.1.2 → 3.5.0

data/lib/{terminal-shop → terminal_shop}/models/profile.rb

@@ -2,23 +2,20 @@
 
 module TerminalShop
   module Models
-    class ProfileAPI < TerminalShop::BaseModel
+    class ProfileAPI < TerminalShop::Internal::Type::BaseModel
       # @!attribute user
       #   A Terminal shop user. (We have users, btw.)
       #
       #   @return [TerminalShop::Models::ProfileAPI::User]
       required :user, -> { TerminalShop::Models::ProfileAPI::User }
 
-      # @!parse
-      #   # A Terminal shop user's profile. (We have users, btw.)
-      #   #
-      #   # @param user [TerminalShop::Models::ProfileAPI::User]
-      #   #
-      #   def initialize(user:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(user:)
+      #   A Terminal shop user's profile. (We have users, btw.)
+      #
+      #   @param user [TerminalShop::Models::ProfileAPI::User] A Terminal shop user. (We have users, btw.)
 
-      class User < TerminalShop::BaseModel
+      # @see TerminalShop::Models::ProfileAPI#user
+      class User < TerminalShop::Internal::Type::BaseModel
         # @!attribute id
         #   Unique object identifier. The format and length of IDs may change over time.
         #
@@ -49,18 +46,21 @@ module TerminalShop
         #   @return [String]
         required :stripe_customer_id, String, api_name: :stripeCustomerID
 
-        # @!parse
-        #   # A Terminal shop user. (We have users, btw.)
-        #   #
-        #   # @param id [String]
-        #   # @param email [String, nil]
-        #   # @param fingerprint [String, nil]
-        #   # @param name [String, nil]
-        #   # @param stripe_customer_id [String]
-        #   #
-        #   def initialize(id:, email:, fingerprint:, name:, stripe_customer_id:, **) = super
-
-        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+        # @!method initialize(id:, email:, fingerprint:, name:, stripe_customer_id:)
+        #   Some parameter documentations has been truncated, see
+        #   {TerminalShop::Models::ProfileAPI::User} for more details.
+        #
+        #   A Terminal shop user. (We have users, btw.)
+        #
+        #   @param id [String] Unique object identifier. ...
+        #
+        #   @param email [String, nil] Email address of the user.
+        #
+        #   @param fingerprint [String, nil] The user's fingerprint, derived from their public SSH key.
+        #
+        #   @param name [String, nil] Name of the user.
+        #
+        #   @param stripe_customer_id [String] Stripe customer ID of the user.
       end
     end
   end

data/lib/terminal_shop/models/profile_me_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Profile#me
+    class ProfileMeParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/{terminal-shop → terminal_shop}/models/profile_me_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class ProfileMeResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Profile#me
+    class ProfileMeResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   A Terminal shop user's profile. (We have users, btw.)
       #
       #   @return [TerminalShop::Models::ProfileAPI]
       required :data, -> { TerminalShop::Models::ProfileAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::ProfileAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
     end
   end
 end

data/lib/terminal_shop/models/profile_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Profile#update
+    class ProfileUpdateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(email:, name:, request_options: {})
+      #   @param email [String]
+      #   @param name [String]
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/{terminal-shop → terminal_shop}/models/profile_update_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class ProfileUpdateResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Profile#update
+    class ProfileUpdateResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   A Terminal shop user's profile. (We have users, btw.)
       #
       #   @return [TerminalShop::Models::ProfileAPI]
       required :data, -> { TerminalShop::Models::ProfileAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::ProfileAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::ProfileAPI] A Terminal shop user's profile. (We have users, btw.)
     end
   end
 end

data/lib/{terminal-shop → terminal_shop}/models/region.rb

@@ -4,16 +4,14 @@ module TerminalShop
   module Models
     # A Terminal shop user's region.
     module Region
-      extend TerminalShop::Enum
+      extend TerminalShop::Internal::Type::Enum
 
       EU = :eu
       NA = :na
+      GLOBAL = :global
 
-      finalize!
-
-      # @!parse
-      #   # @return [Array<Symbol>]
-      #   def self.values; end
+      # @!method self.values
+      #   @return [Array<Symbol>]
     end
   end
 end

data/lib/terminal_shop/models/subscription.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class SubscriptionAPI < TerminalShop::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique object identifier. The format and length of IDs may change over time.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute address_id
+      #   ID of the shipping address used for the subscription.
+      #
+      #   @return [String]
+      required :address_id, String, api_name: :addressID
+
+      # @!attribute card_id
+      #   ID of the card used for the subscription.
+      #
+      #   @return [String]
+      required :card_id, String, api_name: :cardID
+
+      # @!attribute created
+      #   Date the subscription was created.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!attribute price
+      #   Price of the subscription in cents (USD).
+      #
+      #   @return [Integer]
+      required :price, Integer
+
+      # @!attribute product_variant_id
+      #   ID of the product variant being subscribed to.
+      #
+      #   @return [String]
+      required :product_variant_id, String, api_name: :productVariantID
+
+      # @!attribute quantity
+      #   Quantity of the subscription.
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!attribute next_
+      #   Next shipment and billing date for the subscription.
+      #
+      #   @return [String, nil]
+      optional :next_, String, api_name: :next
+
+      # @!attribute schedule
+      #   Schedule of the subscription.
+      #
+      #   @return [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly, nil]
+      optional :schedule, union: -> { TerminalShop::Models::SubscriptionAPI::Schedule }
+
+      # @!method initialize(id:, address_id:, card_id:, created:, price:, product_variant_id:, quantity:, next_: nil, schedule: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::SubscriptionAPI} for more details.
+      #
+      #   Subscription to a Terminal shop product.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param address_id [String] ID of the shipping address used for the subscription.
+      #
+      #   @param card_id [String] ID of the card used for the subscription.
+      #
+      #   @param created [String] Date the subscription was created.
+      #
+      #   @param price [Integer] Price of the subscription in cents (USD).
+      #
+      #   @param product_variant_id [String] ID of the product variant being subscribed to.
+      #
+      #   @param quantity [Integer] Quantity of the subscription.
+      #
+      #   @param next_ [String] Next shipment and billing date for the subscription.
+      #
+      #   @param schedule [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly] Schedule of the subscription.
+
+      # Schedule of the subscription.
+      #
+      # @see TerminalShop::Models::SubscriptionAPI#schedule
+      module Schedule
+        extend TerminalShop::Internal::Type::Union
+
+        variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Fixed }
+
+        variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Weekly }
+
+        class Fixed < TerminalShop::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :fixed]
+          required :type, const: :fixed
+
+          # @!method initialize(type: :fixed)
+          #   @param type [Symbol, :fixed]
+        end
+
+        class Weekly < TerminalShop::Internal::Type::BaseModel
+          # @!attribute interval
+          #
+          #   @return [Integer]
+          required :interval, Integer
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :weekly]
+          required :type, const: :weekly
+
+          # @!method initialize(interval:, type: :weekly)
+          #   @param interval [Integer]
+          #   @param type [Symbol, :weekly]
+        end
+
+        # @!method self.variants
+        #   @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#create
+    class SubscriptionCreateParams < TerminalShop::Models::SubscriptionAPI
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#create
+    class SubscriptionCreateResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!method initialize(data: :ok)
+      #   @param data [Symbol, :ok]
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#delete
+    class SubscriptionDeleteParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#delete
+    class SubscriptionDeleteResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!method initialize(data: :ok)
+      #   @param data [Symbol, :ok]
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#get
+    class SubscriptionGetParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/{terminal-shop → terminal_shop}/models/subscription_get_response.rb

@@ -2,19 +2,16 @@
 
 module TerminalShop
   module Models
-    class SubscriptionGetResponse < TerminalShop::BaseModel
+    # @see TerminalShop::Resources::Subscription#get
+    class SubscriptionGetResponse < TerminalShop::Internal::Type::BaseModel
       # @!attribute data
       #   Subscription to a Terminal shop product.
       #
       #   @return [TerminalShop::Models::SubscriptionAPI]
       required :data, -> { TerminalShop::Models::SubscriptionAPI }
 
-      # @!parse
-      #   # @param data [TerminalShop::Models::SubscriptionAPI]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::SubscriptionAPI] Subscription to a Terminal shop product.
     end
   end
 end

data/lib/terminal_shop/models/subscription_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#list
+    class SubscriptionListParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_list_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#list
+    class SubscriptionListResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   List of subscriptions.
+      #
+      #   @return [Array<TerminalShop::Models::SubscriptionAPI>]
+      required :data, -> { TerminalShop::Internal::Type::ArrayOf[TerminalShop::Models::SubscriptionAPI] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<TerminalShop::Models::SubscriptionAPI>] List of subscriptions.
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_update_params.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#update
+    class SubscriptionUpdateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!attribute address_id
+      #   New shipping address ID for the subscription.
+      #
+      #   @return [String, nil]
+      optional :address_id, String, api_name: :addressID
+
+      # @!attribute card_id
+      #   New payment method ID for the subscription.
+      #
+      #   @return [String, nil]
+      optional :card_id, String, api_name: :cardID
+
+      # @!attribute schedule
+      #   New schedule for the subscription.
+      #
+      #   @return [TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly, nil]
+      optional :schedule, union: -> { TerminalShop::Models::SubscriptionUpdateParams::Schedule }
+
+      # @!method initialize(address_id: nil, card_id: nil, schedule: nil, request_options: {})
+      #   @param address_id [String] New shipping address ID for the subscription.
+      #
+      #   @param card_id [String] New payment method ID for the subscription.
+      #
+      #   @param schedule [TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly] New schedule for the subscription.
+      #
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+
+      # New schedule for the subscription.
+      module Schedule
+        extend TerminalShop::Internal::Type::Union
+
+        variant -> { TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed }
+
+        variant -> { TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly }
+
+        class Fixed < TerminalShop::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :fixed]
+          required :type, const: :fixed
+
+          # @!method initialize(type: :fixed)
+          #   @param type [Symbol, :fixed]
+        end
+
+        class Weekly < TerminalShop::Internal::Type::BaseModel
+          # @!attribute interval
+          #
+          #   @return [Integer]
+          required :interval, Integer
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :weekly]
+          required :type, const: :weekly
+
+          # @!method initialize(interval:, type: :weekly)
+          #   @param interval [Integer]
+          #   @param type [Symbol, :weekly]
+        end
+
+        # @!method self.variants
+        #   @return [Array(TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly)]
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/subscription_update_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Subscription#update
+    class SubscriptionUpdateResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #   Subscription to a Terminal shop product.
+      #
+      #   @return [TerminalShop::Models::SubscriptionAPI]
+      required :data, -> { TerminalShop::Models::SubscriptionAPI }
+
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::SubscriptionAPI] Subscription to a Terminal shop product.
+    end
+  end
+end

data/lib/terminal_shop/models/token.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class TokenAPI < TerminalShop::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique object identifier. The format and length of IDs may change over time.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute token
+      #   Personal access token (obfuscated).
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute created
+      #   The created time for the token.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!method initialize(id:, token:, created:)
+      #   Some parameter documentations has been truncated, see
+      #   {TerminalShop::Models::TokenAPI} for more details.
+      #
+      #   A personal access token used to access the Terminal API. If you leak this,
+      #   expect large sums of coffee to be ordered on your credit card.
+      #
+      #   @param id [String] Unique object identifier. ...
+      #
+      #   @param token [String] Personal access token (obfuscated).
+      #
+      #   @param created [String] The created time for the token.
+    end
+  end
+end

data/lib/terminal_shop/models/token_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#create
+    class TokenCreateParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/token_create_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#create
+    class TokenCreateResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [TerminalShop::Models::TokenCreateResponse::Data]
+      required :data, -> { TerminalShop::Models::TokenCreateResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [TerminalShop::Models::TokenCreateResponse::Data]
+
+      # @see TerminalShop::Models::TokenCreateResponse#data
+      class Data < TerminalShop::Internal::Type::BaseModel
+        # @!attribute id
+        #   Personal token ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute token
+        #   Personal access token. Include this in the Authorization header
+        #   (`Bearer <token>`) when accessing the Terminal API.
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!method initialize(id:, token:)
+        #   Some parameter documentations has been truncated, see
+        #   {TerminalShop::Models::TokenCreateResponse::Data} for more details.
+        #
+        #   @param id [String] Personal token ID.
+        #
+        #   @param token [String] Personal access token. Include this in the Authorization header (`Bearer <token>
+        #   ...
+      end
+    end
+  end
+end

data/lib/terminal_shop/models/token_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#delete
+    class TokenDeleteParams < TerminalShop::Internal::Type::BaseModel
+      extend TerminalShop::Internal::Type::RequestParameters::Converter
+      include TerminalShop::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/terminal_shop/models/token_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @see TerminalShop::Resources::Token#delete
+    class TokenDeleteResponse < TerminalShop::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!method initialize(data: :ok)
+      #   @param data [Symbol, :ok]
+    end
+  end
+end