lithic 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b38f118b6ba402692ea2f86ae2526f63ec13f22ec3d856e6036ed2f74a1d073
-  data.tar.gz: babb1bcd368f16906742018e8e972ed0647fc0962320e4b2e00933758ed8b64b
+  metadata.gz: 47b184f8f7f65dbe0046db9543b2dbb92b2bf6d01e4210310ee34c2e456eb6df
+  data.tar.gz: 81b77116f2873efc353eb653fb1c4ad28b7fe42b28ab090c7ab20afe6cecf977
 SHA512:
-  metadata.gz: eac7c88422fc4c6e25357d72939de0b59ed35743127711747e835baaa2a3bab1c5986f137b8697d7ea3ddf4ca221c043b3ed288e2f7959eb422ec4f538aa0746
-  data.tar.gz: 0dbff29079985fa4ef50cd4ea6e8027466430004c67961bbeef38d653169c1b70d68866d8c84ccb3fdb0a963e024f64d023c77568e084cc3ff4ec688cdc61166
+  metadata.gz: 62c65279956cab3ec2f64cd8ab66a29c756e676bfbb48afb1d15bfe8f01e02198eca40a468910263138638295300fc385d8f8ce7d8ef4369f981193e09b8d4e3
+  data.tar.gz: 8f06ef17fd985d574940f9fc87a5ea74b192eaa4de81310a585d064aa857013a41c7ef50fb31926c7c5b91b45d3b82f9a0bfa39ef8a4fa4dd0045d6fffb1eee0

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.1.0-alpha.20 (2025-04-29)
+
+Full Changelog: [v0.1.0-alpha.19...v0.1.0-alpha.20](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.19...v0.1.0-alpha.20)
+
+### Features
+
+* **api:** adds new merchant lock Auth Rule ([388d8cb](https://github.com/lithic-com/lithic-ruby/commit/388d8cb18b0b89d44d9b2d0c2301e723c17c6d33))
+
+
+### Chores
+
+* add generator safe directory ([0cda408](https://github.com/lithic-com/lithic-ruby/commit/0cda40840420a00c792302dd07aa681d31680717))
+* **internal:** annotate request options with type aliases in sorbet ([552a73d](https://github.com/lithic-com/lithic-ruby/commit/552a73db90724b38cbb9f0740d8bbbd6b8cbdc74))
+* **internal:** remove unnecessary `rbi/lib` folder ([233630e](https://github.com/lithic-com/lithic-ruby/commit/233630e9abfd2f3f29e59d212a1cf6d5e3ec8cc2))
+* loosen rubocop rules that don't always make sense ([e85bd6a](https://github.com/lithic-com/lithic-ruby/commit/e85bd6a6d208c2c05d76e101edc7627e23831ffc))
+* more accurate type annotations and aliases ([347bbf6](https://github.com/lithic-com/lithic-ruby/commit/347bbf62b4a86b3e457b4ac591f526ba42f34e9c))
+
+## 0.1.0-alpha.19 (2025-04-25)
+
+Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.18...v0.1.0-alpha.19)
+
+### Bug Fixes
+
+* make a typo for `FilePart.content` ([4eb5bee](https://github.com/lithic-com/lithic-ruby/commit/4eb5bee30c1bfbc394092b72b338908643010f5a))
+
 ## 0.1.0-alpha.18 (2025-04-25)
 
 Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.1.0.pre.alpha.18"
+gem "lithic", "~> 0.1.0.pre.alpha.20"
 ```
 
 <!-- x-release-please-end -->

data/lib/lithic/errors.rb

@@ -3,9 +3,9 @@
 module Lithic
   module Errors
     class Error < StandardError
-      # @!parse
-      #   # @return [StandardError, nil]
-      #   attr_accessor :cause
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
     end
 
     class ConversionError < Lithic::Errors::Error
@@ -40,13 +40,13 @@ module Lithic
     end
 
     class APIConnectionError < Lithic::Errors::APIError
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :status
+      # @!attribute status
+      #
+      #   @return [nil]
 
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :body
+      # @!attribute body
+      #
+      #   @return [nil]
 
       # @api private
       #

data/lib/lithic/file_part.rb

@@ -15,15 +15,15 @@ module Lithic
     #
     # @return [String]
     private def read
-      case contents
+      case content
       in Pathname
-        contents.read(binmode: true)
+        content.read(binmode: true)
       in StringIO
-        contents.string
+        content.string
       in IO
-        contents.read
+        content.read
       in String
-        contents
+        content
       end
     end
 

data/lib/lithic/internal/type/boolean.rb

@@ -46,17 +46,16 @@ module Lithic
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Boolean, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Boolean, Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Boolean, Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Boolean, Object]
         end
       end
     end

data/lib/lithic/internal/type/converter.rb

@@ -44,6 +44,9 @@ module Lithic
           in Pathname | IO
             state[:can_retry] = false if value.is_a?(IO)
             Lithic::FilePart.new(value)
+          in Lithic::FilePart
+            state[:can_retry] = false if value.content.is_a?(IO)
+            value
           else
             value
           end

data/lib/lithic/internal/type/enum.rb

@@ -96,17 +96,16 @@ module Lithic
           end
         end
 
-        # @!parse
-        #   # @api private
-        #   #
-        #   # @param value [Symbol, Object]
-        #   #
-        #   # @param state [Hash{Symbol=>Object}] .
-        #   #
-        #   #   @option state [Boolean] :can_retry
-        #   #
-        #   # @return [Symbol, Object]
-        #   def dump(value, state:) = super
+        # @!method dump(value, state:)
+        #   @api private
+        #
+        #   @param value [Symbol, Object]
+        #
+        #   @param state [Hash{Symbol=>Object}] .
+        #
+        #     @option state [Boolean] :can_retry
+        #
+        #   @return [Symbol, Object]
 
         # @api private
         #

data/lib/lithic/internal/type/file_input.rb

@@ -67,17 +67,28 @@ module Lithic
             end
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Pathname, StringIO, IO, String, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Pathname, StringIO, IO, String, Object]
-          #   def dump(value, state:) = super
+          # @api private
+          #
+          # @param value [Pathname, StringIO, IO, String, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
+          # @return [Pathname, StringIO, IO, String, Object]
+          def dump(value, state:)
+            # rubocop:disable Lint/DuplicateBranch
+            case value
+            in IO
+              state[:can_retry] = false
+            in Lithic::FilePart if value.content.is_a?(IO)
+              state[:can_retry] = false
+            else
+            end
+            # rubocop:enable Lint/DuplicateBranch
+
+            value
+          end
         end
       end
     end

data/lib/lithic/internal/type/unknown.rb

@@ -48,17 +48,16 @@ module Lithic
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Object]
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/lithic/models/auth_rules/auth_rule_condition.rb

@@ -113,6 +113,7 @@ module Lithic
           # @!method self.variants
           #   @return [Array(String, Integer, Array<String>)]
 
+          # @type [Lithic::Internal::Type::Converter]
           StringArray = Lithic::Internal::Type::ArrayOf[String]
         end
       end

data/lib/lithic/models/auth_rules/v2_apply_response.rb

@@ -89,7 +89,7 @@ module Lithic
           # @!attribute parameters
           #   Parameters for the Auth Rule
           #
-          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
+          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters]
           required :parameters, union: -> { Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters }
 
           response_only do
@@ -105,7 +105,7 @@ module Lithic
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion} for more details.
           #
-          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
+          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters] Parameters for the Auth Rule
           #
           #   @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
           #   ...
@@ -120,8 +120,71 @@ module Lithic
 
             variant -> { Lithic::Models::AuthRules::VelocityLimitParams }
 
+            variant -> { Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters }
+
+            class MerchantLockParameters < Lithic::Internal::Type::BaseModel
+              # @!attribute merchants
+              #   A list of merchant locks defining specific merchants or groups of merchants
+              #   (based on descriptors or IDs) that the lock applies to.
+              #
+              #   @return [Array<Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters::Merchant>]
+              required :merchants,
+                       -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters::Merchant] }
+
+              # @!method initialize(merchants:)
+              #   Some parameter documentations has been truncated, see
+              #   {Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters}
+              #   for more details.
+              #
+              #   @param merchants [Array<Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters::Merchant>] A list of merchant locks defining specific merchants or groups of merchants (bas
+              #   ...
+
+              class Merchant < Lithic::Internal::Type::BaseModel
+                # @!attribute comment
+                #   A comment or explanation about the merchant, used internally for rule management
+                #   purposes.
+                #
+                #   @return [String, nil]
+                optional :comment, String
+
+                # @!attribute descriptor
+                #   Short description of the merchant, often used to provide more human-readable
+                #   context about the transaction merchant. This is typically the name or label
+                #   shown on transaction summaries.
+                #
+                #   @return [String, nil]
+                optional :descriptor, String
+
+                # @!attribute merchant_id
+                #   Unique alphanumeric identifier for the payment card acceptor (merchant). This
+                #   attribute specifies the merchant entity that will be locked or referenced for
+                #   authorization rules.
+                #
+                #   @return [String, nil]
+                optional :merchant_id, String
+
+                # @!method initialize(comment: nil, descriptor: nil, merchant_id: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters::Merchant}
+                #   for more details.
+                #
+                #   Represents a specific merchant lock based on their ID or descriptor. Each
+                #   merchant object allows transaction rules to work at a granular level and
+                #   requires at least one of merchant_id or descriptor.
+                #
+                #   @param comment [String] A comment or explanation about the merchant, used internally for rule management
+                #   ...
+                #
+                #   @param descriptor [String] Short description of the merchant, often used to provide more human-readable con
+                #   ...
+                #
+                #   @param merchant_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant). This at
+                #   ...
+              end
+            end
+
             # @!method self.variants
-            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams)]
+            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion::Parameters::MerchantLockParameters)]
           end
         end
 
@@ -130,7 +193,7 @@ module Lithic
           # @!attribute parameters
           #   Parameters for the Auth Rule
           #
-          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
+          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters]
           required :parameters, union: -> { Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters }
 
           response_only do
@@ -146,7 +209,7 @@ module Lithic
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion} for more details.
           #
-          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
+          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters] Parameters for the Auth Rule
           #
           #   @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
           #   ...
@@ -161,8 +224,71 @@ module Lithic
 
             variant -> { Lithic::Models::AuthRules::VelocityLimitParams }
 
+            variant -> { Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters }
+
+            class MerchantLockParameters < Lithic::Internal::Type::BaseModel
+              # @!attribute merchants
+              #   A list of merchant locks defining specific merchants or groups of merchants
+              #   (based on descriptors or IDs) that the lock applies to.
+              #
+              #   @return [Array<Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters::Merchant>]
+              required :merchants,
+                       -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters::Merchant] }
+
+              # @!method initialize(merchants:)
+              #   Some parameter documentations has been truncated, see
+              #   {Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters}
+              #   for more details.
+              #
+              #   @param merchants [Array<Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters::Merchant>] A list of merchant locks defining specific merchants or groups of merchants (bas
+              #   ...
+
+              class Merchant < Lithic::Internal::Type::BaseModel
+                # @!attribute comment
+                #   A comment or explanation about the merchant, used internally for rule management
+                #   purposes.
+                #
+                #   @return [String, nil]
+                optional :comment, String
+
+                # @!attribute descriptor
+                #   Short description of the merchant, often used to provide more human-readable
+                #   context about the transaction merchant. This is typically the name or label
+                #   shown on transaction summaries.
+                #
+                #   @return [String, nil]
+                optional :descriptor, String
+
+                # @!attribute merchant_id
+                #   Unique alphanumeric identifier for the payment card acceptor (merchant). This
+                #   attribute specifies the merchant entity that will be locked or referenced for
+                #   authorization rules.
+                #
+                #   @return [String, nil]
+                optional :merchant_id, String
+
+                # @!method initialize(comment: nil, descriptor: nil, merchant_id: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters::Merchant}
+                #   for more details.
+                #
+                #   Represents a specific merchant lock based on their ID or descriptor. Each
+                #   merchant object allows transaction rules to work at a granular level and
+                #   requires at least one of merchant_id or descriptor.
+                #
+                #   @param comment [String] A comment or explanation about the merchant, used internally for rule management
+                #   ...
+                #
+                #   @param descriptor [String] Short description of the merchant, often used to provide more human-readable con
+                #   ...
+                #
+                #   @param merchant_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant). This at
+                #   ...
+              end
+            end
+
             # @!method self.variants
-            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams)]
+            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion::Parameters::MerchantLockParameters)]
           end
         end
 
@@ -187,6 +313,7 @@ module Lithic
 
           CONDITIONAL_BLOCK = :CONDITIONAL_BLOCK
           VELOCITY_LIMIT = :VELOCITY_LIMIT
+          MERCHANT_LOCK = :MERCHANT_LOCK
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/lithic/models/auth_rules/v2_create_params.rb

@@ -23,7 +23,7 @@ module Lithic
         # @!attribute parameters
         #   Parameters for the Auth Rule
         #
-        #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil]
+        #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, nil]
         optional :parameters, union: -> { Lithic::Models::AuthRules::V2CreateParams::Parameters }
 
         # @!attribute type
@@ -59,7 +59,7 @@ module Lithic
         #
         #   @param name [String, nil] Auth Rule Name
         #
-        #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
+        #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters] Parameters for the Auth Rule
         #
         #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule
         #
@@ -75,8 +75,71 @@ module Lithic
 
           variant -> { Lithic::Models::AuthRules::VelocityLimitParams }
 
+          variant -> { Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters }
+
+          class MerchantLockParameters < Lithic::Internal::Type::BaseModel
+            # @!attribute merchants
+            #   A list of merchant locks defining specific merchants or groups of merchants
+            #   (based on descriptors or IDs) that the lock applies to.
+            #
+            #   @return [Array<Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::Merchant>]
+            required :merchants,
+                     -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::Merchant] }
+
+            # @!method initialize(merchants:)
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters}
+            #   for more details.
+            #
+            #   @param merchants [Array<Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::Merchant>] A list of merchant locks defining specific merchants or groups of merchants (bas
+            #   ...
+
+            class Merchant < Lithic::Internal::Type::BaseModel
+              # @!attribute comment
+              #   A comment or explanation about the merchant, used internally for rule management
+              #   purposes.
+              #
+              #   @return [String, nil]
+              optional :comment, String
+
+              # @!attribute descriptor
+              #   Short description of the merchant, often used to provide more human-readable
+              #   context about the transaction merchant. This is typically the name or label
+              #   shown on transaction summaries.
+              #
+              #   @return [String, nil]
+              optional :descriptor, String
+
+              # @!attribute merchant_id
+              #   Unique alphanumeric identifier for the payment card acceptor (merchant). This
+              #   attribute specifies the merchant entity that will be locked or referenced for
+              #   authorization rules.
+              #
+              #   @return [String, nil]
+              optional :merchant_id, String
+
+              # @!method initialize(comment: nil, descriptor: nil, merchant_id: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::Merchant}
+              #   for more details.
+              #
+              #   Represents a specific merchant lock based on their ID or descriptor. Each
+              #   merchant object allows transaction rules to work at a granular level and
+              #   requires at least one of merchant_id or descriptor.
+              #
+              #   @param comment [String] A comment or explanation about the merchant, used internally for rule management
+              #   ...
+              #
+              #   @param descriptor [String] Short description of the merchant, often used to provide more human-readable con
+              #   ...
+              #
+              #   @param merchant_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant). This at
+              #   ...
+            end
+          end
+
           # @!method self.variants
-          #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams)]
+          #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters)]
         end
 
         # The type of Auth Rule
@@ -85,6 +148,7 @@ module Lithic
 
           CONDITIONAL_BLOCK = :CONDITIONAL_BLOCK
           VELOCITY_LIMIT = :VELOCITY_LIMIT
+          MERCHANT_LOCK = :MERCHANT_LOCK
 
           # @!method self.values
           #   @return [Array<Symbol>]