terminal-shop 2.1.3 → 3.6.0

data/lib/{terminal-shop → terminal_shop}/resources/cart.rb

@@ -5,11 +5,13 @@ module TerminalShop
     class Cart
       # Clear the current user's cart.
       #
-      # @param params [TerminalShop::Models::CartClearParams, Hash{Symbol=>Object}] .
+      # @overload clear(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CartClearResponse]
+      #
+      # @see TerminalShop::Models::CartClearParams
       def clear(params = {})
         @client.request(
           method: :delete,
@@ -21,11 +23,13 @@ module TerminalShop
 
       # Convert the current user's cart to an order.
       #
-      # @param params [TerminalShop::Models::CartConvertParams, Hash{Symbol=>Object}] .
+      # @overload convert(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CartConvertResponse]
+      #
+      # @see TerminalShop::Models::CartConvertParams
       def convert(params = {})
         @client.request(
           method: :post,
@@ -37,11 +41,13 @@ module TerminalShop
 
       # Get the current user's cart.
       #
-      # @param params [TerminalShop::Models::CartGetParams, Hash{Symbol=>Object}] .
+      # @overload get(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CartGetResponse]
+      #
+      # @see TerminalShop::Models::CartGetParams
       def get(params = {})
         @client.request(
           method: :get,
@@ -53,13 +59,15 @@ module TerminalShop
 
       # Set the shipping address for the current user's cart.
       #
-      # @param params [TerminalShop::Models::CartSetAddressParams, Hash{Symbol=>Object}] .
+      # @overload set_address(address_id:, request_options: {})
       #
-      #   @option params [String] :address_id ID of the shipping address to set for the current user's cart.
+      # @param address_id [String] ID of the shipping address to set for the current user's cart.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CartSetAddressResponse]
+      #
+      # @see TerminalShop::Models::CartSetAddressParams
       def set_address(params)
         parsed, options = TerminalShop::Models::CartSetAddressParams.dump_request(params)
         @client.request(
@@ -73,13 +81,15 @@ module TerminalShop
 
       # Set the credit card for the current user's cart.
       #
-      # @param params [TerminalShop::Models::CartSetCardParams, Hash{Symbol=>Object}] .
+      # @overload set_card(card_id:, request_options: {})
       #
-      #   @option params [String] :card_id ID of the credit card to set for the current user's cart.
+      # @param card_id [String] ID of the credit card to set for the current user's cart.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CartSetCardResponse]
+      #
+      # @see TerminalShop::Models::CartSetCardParams
       def set_card(params)
         parsed, options = TerminalShop::Models::CartSetCardParams.dump_request(params)
         @client.request(
@@ -93,15 +103,17 @@ module TerminalShop
 
       # Add an item to the current user's cart.
       #
-      # @param params [TerminalShop::Models::CartSetItemParams, Hash{Symbol=>Object}] .
+      # @overload set_item(product_variant_id:, quantity:, request_options: {})
       #
-      #   @option params [String] :product_variant_id ID of the product variant to add to the cart.
+      # @param product_variant_id [String] ID of the product variant to add to the cart.
       #
-      #   @option params [Integer] :quantity Quantity of the item to add to the cart.
+      # @param quantity [Integer] Quantity of the item to add to the cart.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::CartSetItemResponse]
+      #
+      # @see TerminalShop::Models::CartSetItemParams
       def set_item(params)
         parsed, options = TerminalShop::Models::CartSetItemParams.dump_request(params)
         @client.request(
@@ -113,6 +125,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/{terminal-shop → terminal_shop}/resources/email.rb

@@ -5,13 +5,15 @@ module TerminalShop
     class Email
       # Subscribe to email updates from Terminal.
       #
-      # @param params [TerminalShop::Models::EmailCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(email:, request_options: {})
       #
-      #   @option params [String] :email Email address to subscribe to Terminal updates with.
+      # @param email [String] Email address to subscribe to Terminal updates with.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::EmailCreateResponse]
+      #
+      # @see TerminalShop::Models::EmailCreateParams
       def create(params)
         parsed, options = TerminalShop::Models::EmailCreateParams.dump_request(params)
         @client.request(
@@ -23,6 +25,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/{terminal-shop → terminal_shop}/resources/order.rb

@@ -5,17 +5,19 @@ module TerminalShop
     class Order
       # Create an order without a cart. The order will be placed immediately.
       #
-      # @param params [TerminalShop::Models::OrderCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(address_id:, card_id:, variants:, request_options: {})
       #
-      #   @option params [String] :address_id Shipping address ID.
+      # @param address_id [String] Shipping address ID.
       #
-      #   @option params [String] :card_id Card ID.
+      # @param card_id [String] Card ID.
       #
-      #   @option params [Hash{Symbol=>Integer}] :variants Product variants to include in the order, along with their quantities.
+      # @param variants [Hash{Symbol=>Integer}] Product variants to include in the order, along with their quantities.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::OrderCreateResponse]
+      #
+      # @see TerminalShop::Models::OrderCreateParams
       def create(params)
         parsed, options = TerminalShop::Models::OrderCreateParams.dump_request(params)
         @client.request(
@@ -29,11 +31,13 @@ module TerminalShop
 
       # List the orders associated with the current user.
       #
-      # @param params [TerminalShop::Models::OrderListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::OrderListResponse]
+      #
+      # @see TerminalShop::Models::OrderListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -45,13 +49,15 @@ module TerminalShop
 
       # Get the order with the given ID.
       #
-      # @param id [String] ID of the order to get.
+      # @overload get(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::OrderGetParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the order to get.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::OrderGetResponse]
+      #
+      # @see TerminalShop::Models::OrderGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -61,6 +67,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/{terminal-shop → terminal_shop}/resources/product.rb

@@ -5,11 +5,13 @@ module TerminalShop
     class Product
       # List all products for sale in the Terminal shop.
       #
-      # @param params [TerminalShop::Models::ProductListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::ProductListResponse]
+      #
+      # @see TerminalShop::Models::ProductListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -21,13 +23,15 @@ module TerminalShop
 
       # Get a product by ID from the Terminal shop.
       #
-      # @param id [String] ID of the product to get.
+      # @overload get(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::ProductGetParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the product to get.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::ProductGetResponse]
+      #
+      # @see TerminalShop::Models::ProductGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -37,6 +41,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

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

@@ -5,15 +5,15 @@ module TerminalShop
     class Profile
       # Update the current user's profile.
       #
-      # @param params [TerminalShop::Models::ProfileUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(email:, name:, request_options: {})
       #
-      #   @option params [String] :email
-      #
-      #   @option params [String] :name
-      #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param email [String]
+      # @param name [String]
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::ProfileUpdateResponse]
+      #
+      # @see TerminalShop::Models::ProfileUpdateParams
       def update(params)
         parsed, options = TerminalShop::Models::ProfileUpdateParams.dump_request(params)
         @client.request(
@@ -27,11 +27,13 @@ module TerminalShop
 
       # Get the current user's profile.
       #
-      # @param params [TerminalShop::Models::ProfileMeParams, Hash{Symbol=>Object}] .
+      # @overload me(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::ProfileMeResponse]
+      #
+      # @see TerminalShop::Models::ProfileMeParams
       def me(params = {})
         @client.request(
           method: :get,
@@ -41,6 +43,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/terminal_shop/resources/subscription.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Resources
+    class Subscription
+      # Some parameter documentations has been truncated, see
+      # {TerminalShop::Models::SubscriptionCreateParams} for more details.
+      #
+      # Create a subscription for the current user.
+      #
+      # @overload create(id:, address_id:, card_id:, created:, price:, product_variant_id:, quantity:, next_: nil, schedule: nil, request_options: {})
+      #
+      # @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.
+      #
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [TerminalShop::Models::SubscriptionCreateResponse]
+      #
+      # @see TerminalShop::Models::SubscriptionCreateParams
+      def create(params)
+        parsed, options = TerminalShop::Models::SubscriptionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "subscription",
+          body: parsed,
+          model: TerminalShop::Models::SubscriptionCreateResponse,
+          options: options
+        )
+      end
+
+      # Update card, address, or interval for an existing subscription.
+      #
+      # @overload update(id, address_id: nil, card_id: nil, schedule: nil, request_options: {})
+      #
+      # @param id [String] ID of the subscription to update.
+      #
+      # @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}, nil]
+      #
+      # @return [TerminalShop::Models::SubscriptionUpdateResponse]
+      #
+      # @see TerminalShop::Models::SubscriptionUpdateParams
+      def update(id, params = {})
+        parsed, options = TerminalShop::Models::SubscriptionUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["subscription/%1$s", id],
+          body: parsed,
+          model: TerminalShop::Models::SubscriptionUpdateResponse,
+          options: options
+        )
+      end
+
+      # List the subscriptions associated with the current user.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [TerminalShop::Models::SubscriptionListResponse]
+      #
+      # @see TerminalShop::Models::SubscriptionListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "subscription",
+          model: TerminalShop::Models::SubscriptionListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancel a subscription for the current user.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] ID of the subscription to cancel.
+      #
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [TerminalShop::Models::SubscriptionDeleteResponse]
+      #
+      # @see TerminalShop::Models::SubscriptionDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["subscription/%1$s", id],
+          model: TerminalShop::Models::SubscriptionDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get the subscription with the given ID.
+      #
+      # @overload get(id, request_options: {})
+      #
+      # @param id [String] ID of the subscription to get.
+      #
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [TerminalShop::Models::SubscriptionGetResponse]
+      #
+      # @see TerminalShop::Models::SubscriptionGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["subscription/%1$s", id],
+          model: TerminalShop::Models::SubscriptionGetResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [TerminalShop::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/{terminal-shop → terminal_shop}/resources/token.rb

@@ -5,11 +5,13 @@ module TerminalShop
     class Token
       # Create a personal access token.
       #
-      # @param params [TerminalShop::Models::TokenCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::TokenCreateResponse]
+      #
+      # @see TerminalShop::Models::TokenCreateParams
       def create(params = {})
         @client.request(
           method: :post,
@@ -21,11 +23,13 @@ module TerminalShop
 
       # List the current user's personal access tokens.
       #
-      # @param params [TerminalShop::Models::TokenListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::TokenListResponse]
+      #
+      # @see TerminalShop::Models::TokenListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -37,13 +41,15 @@ module TerminalShop
 
       # Delete the personal access token with the given ID.
       #
-      # @param id [String] ID of the personal token to delete.
+      # @overload delete(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::TokenDeleteParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the personal token to delete.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::TokenDeleteResponse]
+      #
+      # @see TerminalShop::Models::TokenDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -55,13 +61,15 @@ module TerminalShop
 
       # Get the personal access token with the given ID.
       #
-      # @param id [String] ID of the personal token to get.
+      # @overload get(id, request_options: {})
       #
-      # @param params [TerminalShop::Models::TokenGetParams, Hash{Symbol=>Object}] .
+      # @param id [String] ID of the personal token to get.
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::TokenGetResponse]
+      #
+      # @see TerminalShop::Models::TokenGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -71,6 +79,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

data/lib/{terminal-shop → terminal_shop}/resources/view.rb

@@ -4,13 +4,15 @@ module TerminalShop
   module Resources
     class View
       # Get initial app data, including user, products, cart, addresses, cards,
-      #   subscriptions, and orders.
+      # subscriptions, and orders.
       #
-      # @param params [TerminalShop::Models::ViewInitParams, Hash{Symbol=>Object}] .
+      # @overload init(request_options: {})
       #
-      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [TerminalShop::Models::ViewInitResponse]
+      #
+      # @see TerminalShop::Models::ViewInitParams
       def init(params = {})
         @client.request(
           method: :get,
@@ -20,6 +22,8 @@ module TerminalShop
         )
       end
 
+      # @api private
+      #
       # @param client [TerminalShop::Client]
       def initialize(client:)
         @client = client

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  VERSION = "2.1.3"
+  VERSION = "3.6.0"
 end