chore: explicitly mark apis public under Internal module

Author: stainless-app[bot]

.yardopts

@@ -1,4 +1,5 @@
 --type-name-tag generic:Generic
+--default-return void
 --markup markdown
 --markup-provider redcarpet
 --exclude /rbi

lib/orb/client.rb

@@ -91,10 +91,10 @@ class Client < Orb::Internal::Transport::BaseClient
     def initialize(
       api_key: ENV["ORB_API_KEY"],
       base_url: ENV["ORB_BASE_URL"],
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      max_retries: Orb::Client::DEFAULT_MAX_RETRIES,
+      timeout: Orb::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Orb::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Orb::Client::DEFAULT_MAX_RETRY_DELAY,
       idempotency_header: "Idempotency-Key"
     )
       base_url ||= "https://api.withorb.com/v1"

lib/orb/internal.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Orb
-  # @api private
   module Internal
     OMIT =
       Object.new.tap do

lib/orb/internal/type/array_of.rb

@@ -30,11 +30,15 @@ class ArrayOf
         #   @option spec [Boolean] :"nil?"
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = other.is_a?(Array) && other.all?(item_type)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -44,6 +48,8 @@ def ==(other)
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = [self.class, item_type].hash
 

lib/orb/internal/type/base_model.rb

@@ -159,22 +159,30 @@ def optional(name_sym, type_info, spec = {})
             @mode = nil
           end
 
+          # @api public
+          #
           # @param other [Object]
           #
           # @return [Boolean]
           def ==(other)
             other.is_a?(Class) && other <= Orb::Internal::Type::BaseModel && other.fields == fields
           end
 
+          # @api public
+          #
           # @return [Integer]
           def hash = fields.hash
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ==(other) = self.class == other.class && @data == other.to_h
 
+        # @api public
+        #
         # @return [Integer]
         def hash = [self.class, @data].hash
 
@@ -291,6 +299,8 @@ def dump(value, state:)
           end
         end
 
+        # @api public
+        #
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
         # returned.
         #
@@ -309,6 +319,8 @@ def [](key)
           @data[key]
         end
 
+        # @api public
+        #
         # Returns a Hash of the data underlying this object. O(1)
         #
         # Keys are Symbols and values are the raw values from the response. The return
@@ -361,11 +373,15 @@ def walk(model)
           end
         end
 
+        # @api public
+        #
         # @param a [Object]
         #
         # @return [String]
         def to_json(*a) = Orb::Internal::Type::Converter.dump(self.class, self).to_json(*a)
 
+        # @api public
+        #
         # @param a [Object]
         #
         # @return [String]
@@ -407,7 +423,7 @@ def inspect(depth: 0)
           end
         end
 
-        # @api private
+        # @api public
         #
         # @return [String]
         def to_s = self.class.walk(@data).to_s

lib/orb/internal/type/base_page.rb

@@ -3,19 +3,27 @@
 module Orb
   module Internal
     module Type
+      # @api private
+      #
       # @generic Elem
       #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
 
+        # @api public
+        #
         # @return [Boolean]
         def next_page? = (raise NotImplementedError)
 
+        # @api public
+        #
         # @raise [Orb::Errors::APIError]
         # @return [Orb::Internal::Type::BasePage]
         def next_page = (raise NotImplementedError)
 
+        # @api public
+        #
         # @param blk [Proc]
         #
         # @yieldparam [generic<Elem>]

lib/orb/internal/type/boolean.rb

@@ -13,11 +13,15 @@ class Boolean
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other) = other == true || other == false
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]

lib/orb/internal/type/enum.rb

@@ -44,11 +44,15 @@ module Enum
         # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
         def values = constants.map { const_get(_1) }
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = values.include?(other)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -58,6 +62,8 @@ def ==(other)
           # rubocop:enable Style/CaseEquality
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = values.to_set.hash
 

lib/orb/internal/type/hash_of.rb

@@ -30,6 +30,8 @@ class HashOf
         #   @option spec [Boolean] :"nil?"
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -50,6 +52,8 @@ def ===(other)
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -59,6 +63,8 @@ def ==(other)
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = [self.class, item_type].hash
 

lib/orb/internal/type/io_like.rb

@@ -13,6 +13,8 @@ class IOLike
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -25,6 +27,8 @@ def self.===(other)
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]