shipengine_sdk 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d370ae8b38bb9f56249210fe89f0cbddc5258aee3ab9e820023fadcf90c9f0f5
+  data.tar.gz: de99f00ab5f8c44a9c9efdf051507cf1bc0095c56a4c37cf4480fdb0a1306e05
+SHA512:
+  metadata.gz: fc676b66315b85a71794755904ccc3f97b9bc6b2258b1da034e0f585487dbec81bfd20c0aa84d853e54156996d3656434039395d76245e80bd4506ccd1ad4bbe
+  data.tar.gz: 04d3117b6ae9bf6c19990c1edd34a186c37d94643f771dd1aa0c5e1beee8256e1f3531f3401af9d27cef1602c00340830af33a447e5aca8e22dc0f040a7734d8

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [1.0.3](https://github.com/ShipEngine/shipengine-ruby/compare/v1.0.2...v1.0.3) (2023-06-16)
+
+
+### Bug Fixes
+
+* Update publish to Gem API Key ([3f9c8e5](https://github.com/ShipEngine/shipengine-ruby/commit/3f9c8e5eec8147e2fb1b38a114fa0e2ff24a5f9e))

data/README.md

@@ -0,0 +1,96 @@
+[![ShipEngine](https://shipengine.github.io/img/shipengine-logo-wide.png)](https://shipengine.com)
+
+ShipEngine Ruby SDK
+===================
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ShipEngine/shipengine-ruby/CI?label=shipengine-ruby&logo=github)
+![GitHub](https://img.shields.io/github/license/ShipEngine/shipengine-ruby?color=teal)
+
+The Official Ruby SDK for [ShipEngine API](https://shipengine.com) offering low-level access as well as convenience methods.
+
+Quick Start
+===========
+
+Install ShipEngine via [RubyGems](https://rubygems.org/)
+```bash
+gem install shipengine_sdk
+```
+- The only configuration requirement is an [API Key](https://www.shipengine.com/docs/auth/#api-keys).
+
+Methods
+-------
+* [`create_label_from_rate`](./docs/create-label-from-rate.md) - When retrieving rates for shipments using the `get_rates` method, the returned information contains a `rate_id` property that can be used to purchase a label without having to refill in the shipment information repeatedly.
+* [`create_label_from_shipment_details`](./docs/create-label-from-shipment-details.md) - Purchase and print a label for shipment.
+* [`get_rates`](./docs/get-rates.md) - Given some shipment details and rate options, this method returns a list of rate quotes.
+* [`list_carrier_accounts`](./docs/list-carrier-accounts.md) - Returns a list of carrier accounts that have been connected through
+the [ShipEngine dashboard](https://www.shipengine.com/docs/carriers/setup/).
+* [`track_by_label_id`](./docs/track-by-label-id.md) - Track a package by its associated label ID.
+* [`track_using_carrier_code_and_tracking_number`](./docs/track-by-tracking-number.md) - Track a package by its associated trackng number.
+* [`validate_addresses`](./docs/validate-addresses.md) - Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned.
+* [`void_label_by_id`](./docs/void-label-by-id.md) - Void a label by its ID.
+
+Class Objects
+-------------
+- [ShipEngine]() - A configurable entry point to the ShipEngine API SDK, this class provides convenience methods
+  for various ShipEngine API Services.
+
+Instantiate ShipEngine Class
+----------------------------
+```ruby
+require "shipengine"
+
+api_key = ENV["SHIPENGINE_API_KEY"]
+
+shipengine = ShipEngine.new(api_key)
+```
+
+Contributing
+============
+
+Install dependencies
+--------------------
+- You will need to `gem install bundler` before using the following command to install dependencies from the Gemfile.
+```bash
+./bin/setup
+```
+
+Committing
+-------------------------
+This project adheres to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+Pre-Commit/Pre-Push Hooks
+-------------------------
+This project makes use of [Overcommit](https://github.com/sds/overcommit#usage) to enforce `pre-commit/push hooks`.
+Overcommit will be downloaded and initialized as part of running the `./bin/setup` script, as outlined in the previous section.
+
+- From then on when you commit code `rake lint` will run, and when you push code `rake test` and `rake lint` will run.
+Upon failure of either of these, you can run `rake fix` to auto-fix lint issues and format code, and re-commit/push.
+
+Testing & Development
+---------------------
+- While you are writing tests as you contribute code you can run tests ad-hoc via `rake` using the following command:
+```bash
+rake test
+```
+- You can run tests and have them re-run when you save changes to a given file with `guard`.
+```bash
+guard
+```
+Lastly, you can `format code & auto-fix lint errors` with the following:
+```bash
+rake fix
+```
+
+> Note: `guard` also provides a repl after tests run for quick repl development.
+
+Repl Development
+----------------
+- You can start a `pry` repl that already has `shipengine` required bun running the following command.
+```bash
+./bin/console
+```
+> If you prefer `irb` over `pry`, you can follow the instructions in the [./bin/console](./bin/console) file. Please
+DO NOT commit any changes you make to that file, unless they are improvements to the console workflow.
+
+Publishing
+-------------------------
+Publishing new versions of the SDK to [RubyGems](https://rubygems.org/) is handled on GitHub via the [Release Please](https://github.com/googleapis/release-please) GitHub Actions workflow. Learn more about about Release PRs, updating the changelog, and commit messages [here](https://github.com/googleapis/release-please#how-should-i-write-my-commits).

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'faraday'
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400, 401, 404, 500, 502, 503, 504
+          raise ShipEngine::Exceptions::ShipEngineError.new(
+            message: error_body(response[:body]),
+            source: error_source(response[:body]),
+            type: error_type(response[:body]),
+            code: error_code(response[:body]),
+            request_id: response[:body]['request_id'],
+            url: response[:url].to_s
+          )
+        when 429
+          raise ShipEngine::Exceptions::RateLimitError.new(retries: env.request_headers['Retries'].to_i, source: error_source(response[:body]), request_id: response[:body]['request_id'])
+        end
+      end
+    end
+
+    def initialize(app)
+      super(app)
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response) # rubocop:todo Naming/VariableNumber
+      "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
+
+      if body.nil?
+        nil
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['message']
+      end
+    end
+
+    def error_source(body)
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
+
+      if body.nil?
+        nil
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['error_source']
+      end
+    end
+
+    def error_type(body)
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
+
+      if body.nil?
+        nil
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['error_type']
+      end
+    end
+
+    def error_code(body)
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
+
+      if body.nil?
+        nil
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['error_code']
+      end
+    end
+  end
+end

data/lib/shipengine/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  class Configuration
+    attr_accessor :api_key, :retries, :base_url, :timeout, :page_size
+
+    def initialize(api_key:, retries: nil, timeout: nil, page_size: nil, base_url: nil)
+      @api_key = api_key
+      @base_url = base_url || Constants.base_url
+      @retries = retries || 1
+      @timeout = timeout || 30_000
+      @page_size = page_size || 50
+      validate
+    end
+
+    # @param opts [Hash] the options to create a message with.
+    # @option opts [String] :ap The subject
+    # @option opts [String] :from ('nobody') From address
+    # @option opts [String] :to Recipient email
+    # @option opts [String] :body ('') The email's bod
+    def merge(config)
+      copy = clone
+      copy.api_key   = config[:api_key] if config.key?(:api_key)
+      copy.base_url  = config[:base_url] if config.key?(:base_url)
+      copy.retries   =  config[:retries] if config.key?(:retries)
+      copy.timeout   =  config[:timeout] if config.key?(:timeout)
+      copy.page_size = config[:page_size] if config.key?(:page_size)
+      copy.validate
+      copy
+    end
+
+    # since the fields in the class are mutable, we should be able to validate them at any time.
+    protected
+
+    def validate
+      Utils::Validate.str('A ShipEngine API key', @api_key)
+      Utils::Validate.str('Base URL', @base_url)
+      Utils::Validate.non_neg_int('Retries', @retries)
+      Utils::Validate.positive_int('Timeout', @timeout)
+      Utils::Validate.positive_int('Page size', @page_size)
+    end
+  end
+end

data/lib/shipengine/constants/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Constants
+    # A stub API Key to use in the test suite.
+    API_KEY = 'TEST_ycvJAgX6tLB1Awm9WGJmD8mpZ8wXiQ20WhqFowCk32s'
+
+    # The base_url for the ShipEngine SDK - for use in production environment.
+    PROD_URL = 'https://api.shipengine.com'
+
+    # Regex pattern to match a valid *ISO-8601* string with timezone.
+    VALID_ISO_STRING = /^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$/
+
+    # Regex pattern to match a valid *ISO-8601* string with no timezone.
+    VALID_ISO_STRING_WITH_NO_TZ = /^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?([+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$/
+
+    # Check env variables to set the appropriate base_url.
+    def self.base_url
+      ShipEngine::Constants::PROD_URL
+    end
+  end
+end

data/lib/shipengine/constants/countries.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Constants
+    class Country
+      # rubocop:disable Layout/LineLength
+      @countries = %w[AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SK SI SB SO ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW].freeze
+      # rubocop:enable Layout/LineLength
+
+      # @param [String] country - 2 letter country code
+      def self.valid?(country)
+        @countries.include?(country.upcase)
+      end
+    end
+  end
+end

data/lib/shipengine/constants.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'constants/countries'
+require_relative 'constants/base'

data/lib/shipengine/domain/addresses/address_validation.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Domain
+    class Addresses
+      module AddressValidation
+        class Response
+          attr_reader :status, :original_address, :matched_address, :messages
+
+          # type ["unverified" | "verified" | "warning" | "error"] status
+          # @param [NormalizedAddress] original_address
+          # @param [NormalizedAddress?] matched_address
+          # @param [Array<Response>] messages
+          def initialize(status:, original_address:, matched_address:, messages:)
+            @status = status
+            @original_address = original_address
+            @matched_address = matched_address
+            @messages = messages
+          end
+        end
+
+        class Request
+          attr_reader :address_line1,
+                      :address_line2,
+                      :address_line3,
+                      :name,
+                      :company_name,
+                      :phone,
+                      :city_locality,
+                      :state_province,
+                      :postal_code,
+                      :country_code,
+                      :address_residential_indicator
+
+          # @param [String] address_line1 - e.g. ["123 FAKE ST."]
+          # @param [String?] address_line2 - e.g. ["123 FAKE ST."]
+          # @param [String?] address_line3 - e.g. ["123 FAKE ST."]
+          # @param [String] country_code - e.g. "US". @see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+          # @param [String] postal_code - e.g "78751"
+          # @param [String?] name - e.g. "John Smith"
+          # @param [String?] company_name - e.g. "ShipEngine"
+          # @param [String?] phone - e.g. 5551234567
+          # @param [String?] city_locality - e.g. "AUSTIN"
+          # @param [String?] state_province - e.g. "TX"
+          # @param [String?] address_residential_indicator
+          def initialize(address_line1:, address_line2:, address_line3:, name:, company_name:, phone:, city_locality:, state_province:, postal_code:, # rubocop:todo Metrics/ParameterLists
+                         country_code:, address_residential_indicator:)
+
+            @name = name
+            @company_name = company_name
+            @address_line1 = address_line1
+            @address_line2 = address_line2
+            @address_line3 = address_line3
+            @phone = phone
+            @city_locality = city_locality
+            @state_province = state_province
+            @postal_code = postal_code
+            @country_code = country_code
+            @address_residential_indicator = address_residential_indicator
+          end
+        end
+
+        class Address
+          attr_reader :address_line1,
+                      :address_line2,
+                      :address_line3,
+                      :name,
+                      :company_name,
+                      :phone,
+                      :city_locality,
+                      :state_province,
+                      :postal_code,
+                      :country_code,
+                      :address_residential_indicator
+
+          # @param [String] address_line1 - e.g. ["123 FAKE ST."]
+          # @param [String?] address_line2 - e.g. ["123 FAKE ST."]
+          # @param [String?] address_line3 - e.g. ["123 FAKE ST."]
+          # @param [String] country_code - e.g. "US". @see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+          # @param [String] postal_code - e.g "78751"
+          # @param [String?] name - e.g. "John Smith"
+          # @param [String?] company_name - e.g. "ShipEngine"
+          # @param [String?] phone - e.g. 5551234567
+          # @param [String?] city_locality - e.g. "AUSTIN"
+          # @param [String?] state_province - e.g. "TX"
+          # @param [String?] address_residential_indicator
+          def initialize(address_line1:, address_line2:, address_line3:, name:, company_name:, phone:, city_locality:, state_province:, postal_code:, # rubocop:todo Metrics/ParameterLists
+                         country_code:, address_residential_indicator:)
+
+            @name = name
+            @company_name = company_name
+            @address_line1 = address_line1
+            @address_line2 = address_line2
+            @address_line3 = address_line3
+            @phone = phone
+            @city_locality = city_locality
+            @state_province = state_province
+            @postal_code = postal_code
+            @country_code = country_code
+            @address_residential_indicator = address_residential_indicator
+          end
+        end
+
+        class Message
+          attr_reader :type, :code, :message
+
+          # @param type [:info" | :warning | :error"]
+          # @param code [String] = e.g. "suite_missing"
+          def initialize(type:, code:, message:)
+            @type = type
+            @code = code
+            @message = message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/domain/addresses.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'hashie'
+require_relative 'addresses/address_validation'
+
+module ShipEngine
+  module Domain
+    class Addresses
+      require 'shipengine/constants'
+
+      # @param [ShipEngine::InternalClient] internal_client
+      def initialize(internal_client)
+        @internal_client = internal_client
+      end
+
+      # @param addresses [ShipEngine::Domain::Addresses::AddressValidationRequest]
+      # @param config [Hash?]
+      #
+      # @return [Array<ShipEngine::Domain::Addresses::AddressValidationResponse>]
+      #
+      # @see https://shipengine.github.io/shipengine-openapi/#operation/validate_address
+      def validate(addresses, config)
+        addresses_array = addresses.map(&:compact)
+
+        response = @internal_client.post('/v1/addresses/validate', addresses_array, config)
+        address_api_result = response.body
+
+        address_api_result.map do |result|
+          mash_result = Hashie::Mash.new(result)
+          normalized_original_address_api_result = AddressValidation::Address.new(
+            address_line1: mash_result.original_address.address_line1,
+            address_line2: mash_result.original_address.address_line2,
+            address_line3: mash_result.original_address.address_line3,
+            name: mash_result.original_address.name,
+            company_name: mash_result.original_address.company_name,
+            phone: mash_result.original_address.phone,
+            city_locality: mash_result.original_address.city_locality,
+            state_province: mash_result.original_address.state_province,
+            postal_code: mash_result.original_address.postal_code,
+            country_code: mash_result.original_address.country_code,
+            address_residential_indicator: mash_result.original_address.address_residential_indicator
+          )
+
+          normalized_matched_address_api_result = if mash_result.matched_address
+                                                    AddressValidation::Address.new(
+                                                      address_line1: mash_result.matched_address.address_line1,
+                                                      address_line2: mash_result.matched_address.address_line2,
+                                                      address_line3: mash_result.matched_address.address_line3,
+                                                      name: mash_result.matched_address.name,
+                                                      company_name: mash_result.matched_address.company_name,
+                                                      phone: mash_result.matched_address.phone,
+                                                      city_locality: mash_result.matched_address.city_locality,
+                                                      state_province: mash_result.matched_address.state_province,
+                                                      postal_code: mash_result.matched_address.postal_code,
+                                                      country_code: mash_result.matched_address.country_code,
+                                                      address_residential_indicator: mash_result.matched_address.address_residential_indicator
+                                                    )
+                                                  end
+
+          status = mash_result.status
+
+          messages_classes = mash_result.messages.map do |msg|
+            AddressValidation::Message.new(type: msg['type'], code: msg['code'], message: msg['message'])
+          end
+
+          AddressValidation::Response.new(
+            status:,
+            messages: messages_classes,
+            original_address: normalized_original_address_api_result,
+            matched_address: normalized_matched_address_api_result
+          )
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/domain/carriers/list_carriers.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Domain
+    class Carriers
+      module ListCarriers
+        class Response
+          attr_reader :carriers, :request_id, :errors
+
+          # @param [Carrier] carriers
+          # @param [String?] request_id
+          # @param [Array<Error>?] carriers
+          def initialize(carriers:, request_id:, errors:)
+            @carriers = carriers
+            @request_id = request_id
+            @errors = errors
+          end
+        end
+
+        class Error
+          attr_reader :error_source, :error_type, :error_code, :message
+
+          # type ["carrier" | "order_source" | "shipengine"] error_source
+          # type ["account_status" | "business_rules" | "validation" | "security" | "system" | "integrations"] error_type
+          # @param [String] error_code
+          # @param [String] message
+          def initialize(error_source:, error_type:, error_code:, message:)
+            @error_source = error_source
+            @error_type = error_type
+            @error_code = error_code
+            @message = message
+          end
+        end
+
+        class Carrier
+          attr_reader :carrier_id, :carrier_code, :account_number, :requires_funded_amount, :balance, :nickname, :friendly_name, :primary, :has_multi_package_supporting_services, :supports_label_messages, :services, :packages, :options
+
+          # @param [String] carrier_id - e.g. "se-28529731"
+          # @param [String] carrier_code - e.g. "se-28529731"
+          # @param [String] account_number - e.g. "account_570827"
+          # @param [Boolean] requires_funded_amount - e.g. true
+          # @param [Float] balance - e.g. 3799.52
+          # @param [String] nickname - e.g. "ShipEngine Account - Stamps.com"
+          # @param [String] friendly_name - e.g. "Stamps.com",
+          # @param [Boolean] primary - e.g. true,
+          # @param [Boolean] has_multi_package_supporting_services - e.g. true,
+          # @param [Boolean] supports_label_messages - e.g. true,
+          # @param [Array<Carrier::Service>] services
+          # @param [Array<Carrier::Package>] packages
+          # @param [Array<Carrier::Option>] options
+          def initialize(carrier_id:, carrier_code:, account_number:, requires_funded_amount:, balance:, nickname:, friendly_name:, primary:, has_multi_package_supporting_services:, supports_label_messages:, services:, packages:, options:) # rubocop:todo Metrics/ParameterLists
+            @carrier_id = carrier_id
+            @carrier_code = carrier_code
+            @account_number = account_number
+            @requires_funded_amount = requires_funded_amount
+            @balance = balance
+            @nickname = nickname
+            @friendly_name = friendly_name
+            @primary = primary
+            @has_multi_package_supporting_services = has_multi_package_supporting_services
+            @supports_label_messages = supports_label_messages
+            @services = services
+            @packages = packages
+            @options = options
+          end
+
+          class Service
+            attr_reader :carrier_id, :carrier_code, :service_code, :name, :domestic, :international, :is_multi_package_supported
+
+            # @param [String] carrier_id - e.g. "se-28529731"
+            # @param [String] carrier_code - e.g. "se-28529731"
+            # @param [String] service_code - e.g. "usps_media_mail"
+            # @param [String] name - e.g. "USPS First Class Mail"
+            # @param [Boolean] domestic - e.g. true
+            # @param [Boolean] international - e.g. true
+            # @param [Boolean] is_multi_package_supported - e.g. true
+
+            def initialize(carrier_id:, carrier_code:, service_code:, name:, domestic:, international:, is_multi_package_supported:) # rubocop:todo Metrics/ParameterLists
+              @carrier_id = carrier_id
+              @carrier_code = carrier_code
+              @service_code = service_code
+              @name = name
+              @domestic = domestic
+              @international = international
+              @is_multi_package_supported = is_multi_package_supported
+            end
+          end
+
+          class Package
+            attr_reader :package_id, :package_code, :name, :dimensions, :description
+
+            # @param [String?] package_id - e.g. "se-28529731"
+            # @param [String] package_code - e.g. "small_flat_rate_box"
+            # @param [name] name - e.g. "laptop_box"
+            # @param [Package::Dimensions?] dimensions - e.g. true
+            # @param [String?] description - e.g. true
+
+            def initialize(package_id:, package_code:, name:, dimensions:, description:)
+              @package_id = package_id
+              @package_code = package_code
+              @name = name
+              @dimensions = dimensions
+              @description = description
+            end
+
+            class Dimensions
+              attr_reader :unit, :length, :width, :height
+
+              # type ["inch" | "centimeter"] unit
+              # @param [Double] length - e.g. 1.0
+              # @param [Double] width - e.g. 1.0
+              # @param [Double] height - e.g. 1.0
+
+              def initialize(unit:, length:, width:, height:)
+                @unit = unit
+                @length = length
+                @width = width
+                @height = height
+              end
+            end
+          end
+
+          class Option
+            attr_reader :name, :default_value, :description
+
+            # @param [String] name - e.g. "contains_alcohol"
+            # @param [String] default_value - e.g. "false"
+            # @param [String?] description - e.g. "Option"
+
+            def initialize(name:, default_value:, description:)
+              @name = name
+              @default_value = default_value
+              @description = description
+            end
+          end
+        end
+      end
+    end
+  end
+end