terminal-shop 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd8072a075bff0dc001f6aaabb37415cada6dfc11b82cb2362fd78400ef2fd69
-  data.tar.gz: 69a0df094ac931a412378137fe036c50b11d36ae628fe526e7392c985ef79466
+  metadata.gz: 54c0b0033036302e9ea998b80699f3a8947a0438aa0354013d3f43830b5b29a9
+  data.tar.gz: 545054c9b181d799dc8c1f0a420a095149d156b0dc789af5dd7c729247b3010d
 SHA512:
-  metadata.gz: b29c0d30aa9ec41963e5aa21d24e2821741868cb591fbec9fd1e015eef059ec06ae2adda746de1c2584b2b20e8babd6382058d85ae89e6948e4998b484c0042a
-  data.tar.gz: cb9eb1e052ec4b94b46523bc698b689fc425fd6ff66b036337138bdfa59108acddcf59ce088876db204eb61284e81643a825ddf43f0d74835c28f52000aef7f9
+  metadata.gz: 6506991e3b923b599db1c2872edb5301d461f35f2bb1efd018472f6b318b1d06a2f5a577a05e76693eb1639de8262d8fd564c87e7ef186eb08f9c8d2a3010556
+  data.tar.gz: 7c7e72acd2d2de78683b47a85e6ab89e471d2ad51d005355fae9adc1f699c774fb5f06f5993473e6a203c0bbbb5ca6bda264ac2cd5127546ccd90d1cc04aec21

data/README.md

@@ -12,10 +12,10 @@ The underlying REST API documentation can be found on [terminal.shop](https://te
 
 ## Installation
 
-To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
 ```ruby
-gem "terminal-shop", git: "https://github.com/terminaldotshop/terminal-sdk-ruby", branch: "main"
+gem "terminal-shop", "~> 2.1.0"
 ```
 
 To fetch an initial copy of the gem:
@@ -24,12 +24,6 @@ To fetch an initial copy of the gem:
 bundle install
 ```
 
-To update the version used by your application when updates are pushed to GitHub:
-
-```sh
-bundle update terminal-shop
-```
-
 ## Usage
 
 ```ruby

data/lib/terminal-shop/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  class Client < TerminalShop::BaseClient
+  class Client < TerminalShop::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -17,7 +17,7 @@ module TerminalShop
 
     # rubocop:disable Style/MutableConstant
     # @type [Hash{Symbol=>String}]
-    ENVIRONMENTS = {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"}
+    ENVIRONMENTS = {production: "https://api.terminal.shop", dev: "https://api.dev.terminal.shop"}
     # rubocop:enable Style/MutableConstant
 
     # @return [String]
@@ -74,8 +74,8 @@ module TerminalShop
     #
     #   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`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
     #

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

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute city

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

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

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

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

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

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AddressListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/app_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute name

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

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/app_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/app_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class AppListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_collect_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardCollectParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute token

data/lib/terminal-shop/models/card_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/card_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CardListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_clear_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartClearParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_convert_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartConvertParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/cart_set_address_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartSetAddressParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute address_id

data/lib/terminal-shop/models/cart_set_card_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartSetCardParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute card_id

data/lib/terminal-shop/models/cart_set_item_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class CartSetItemParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute product_variant_id

data/lib/terminal-shop/models/email_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class EmailCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute email

data/lib/terminal-shop/models/order_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class OrderCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute address_id

data/lib/terminal-shop/models/order_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class OrderGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/order_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class OrderListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/product_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProductGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/product_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProductListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/profile_me_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProfileMeParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/profile_update_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ProfileUpdateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!attribute email

data/lib/terminal-shop/models/subscription_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionCreateParams < TerminalShop::Models::SubscriptionAPI
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/subscription_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/subscription_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/subscription_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class SubscriptionListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_create_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenCreateParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_delete_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenDeleteParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_get_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenGetParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/token_list_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class TokenListParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/models/view_init_params.rb

@@ -4,7 +4,7 @@ module TerminalShop
   module Models
     class ViewInitParams < TerminalShop::BaseModel
       # @!parse
-      #   extend TerminalShop::RequestParameters::Converter
+      #   extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       # @!parse

data/lib/terminal-shop/request_options.rb

@@ -1,39 +1,6 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  # @api private
-  module RequestParameters
-    # @!parse
-    #   # Options to specify HTTP behaviour for this request.
-    #   # @return [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
-    #   attr_accessor :request_options
-
-    # @param mod [Module]
-    def self.included(mod)
-      return unless mod <= TerminalShop::BaseModel
-
-      mod.extend(TerminalShop::RequestParameters::Converter)
-      mod.optional(:request_options, TerminalShop::RequestOptions)
-    end
-
-    # @api private
-    module Converter
-      # @api private
-      #
-      # @param params [Object]
-      #
-      # @return [Array(Object, Hash{Symbol=>Object})]
-      def dump_request(params)
-        case (dumped = dump(params))
-        in Hash
-          [dumped.except(:request_options), dumped[:request_options]]
-        else
-          [dumped, nil]
-        end
-      end
-    end
-  end
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   #   or override those provided at the client level.
   #