release: 0.1.0-alpha.26

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.25"
+  ".": "0.1.0-alpha.26"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 195
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-8f6c4012863716d091d2212f4a079ceb2af3b5b4e776b00aab9b5cba7f452960.yml
-openapi_spec_hash: 11c039f345002ae50d39988570ae266e
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-4efe1f515d5c4297c1f4d2f52381e6a0de84cb1c1bcd9a15d53e54f559351b45.yml
+openapi_spec_hash: 0ab70cea1b42e0179a3ef3b5e4268634
 config_hash: 1619155422217276e2489ae10ce63a25

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.1.0-alpha.26 (2025-05-22)
+
+Full Changelog: [v0.1.0-alpha.25...v0.1.0-alpha.26](https://github.com/Increase/increase-ruby/compare/v0.1.0-alpha.25...v0.1.0-alpha.26)
+
+### Features
+
+* **api:** api update ([02d1d7a](https://github.com/Increase/increase-ruby/commit/02d1d7a9743f2fa636c1f7c5da1239651942e84f))
+* **api:** api update ([0048087](https://github.com/Increase/increase-ruby/commit/004808756c486b90f9d3bbac352d209c77fc0044))
+
+
+### Chores
+
+* **docs:** grammar improvements ([7528787](https://github.com/Increase/increase-ruby/commit/752878761b5cd474fe3f751b33b8a66f360ca2e3))
+* force utf-8 locale via `RUBYOPT` when formatting ([9836cc4](https://github.com/Increase/increase-ruby/commit/9836cc43f50da4049117fd2724bfbcf41a2c3283))
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([3846f08](https://github.com/Increase/increase-ruby/commit/3846f08fefcddec7cefbf86e3a3fbfa535318d94))
+* use fully qualified names for yard annotations and rbs aliases ([7a81744](https://github.com/Increase/increase-ruby/commit/7a81744d65096fc1af4b633f04f85f0d01c90617))
+
 ## 0.1.0-alpha.25 (2025-05-20)
 
 Full Changelog: [v0.1.0-alpha.24...v0.1.0-alpha.25](https://github.com/Increase/increase-ruby/compare/v0.1.0-alpha.24...v0.1.0-alpha.25)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (0.1.0.pre.alpha.25)
+    increase (0.1.0.pre.alpha.26)
       connection_pool
 
 GEM

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 "increase", "~> 0.1.0.pre.alpha.25"
+gem "increase", "~> 0.1.0.pre.alpha.26"
 ```
 
 <!-- x-release-please-end -->
@@ -209,7 +209,7 @@ puts(account[:my_undocumented_property])
 
 #### Undocumented request params
 
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
 
 #### Undocumented endpoints
 
@@ -227,7 +227,7 @@ response = client.request(
 
 ### Concurrency & connection pooling
 
-The `Increase::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
+The `Increase::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
 
 Each instance of `Increase::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
@@ -289,7 +289,7 @@ increase.account_numbers.update(
   # …
 )
 
-# Literal values is also permissible:
+# Literal values are also permissible:
 increase.account_numbers.update(
   status: :active,
   # …

Rakefile

@@ -9,6 +9,7 @@ require "rake/clean"
 require "rubocop/rake_task"
 
 tapioca = "sorbet/tapioca"
+examples = "examples"
 ignore_file = ".ignore"
 
 CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file)
@@ -35,11 +36,11 @@ multitask(:test) do
 end
 
 xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --]
-locale = {"LC_ALL" => "C.UTF-8"}
+ruby_opt = {"RUBYOPT" => [ENV["RUBYOPT"], "--encoding=UTF-8"].compact.join(" ")}
 
 desc("Lint `*.rb(i)`")
 multitask(:"lint:rubocop") do
-  find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
+  find = %w[find ./lib ./test ./rbi ./examples -type f -and ( -name *.rb -or -name *.rbi ) -print0]
 
   rubocop = %w[rubocop]
   rubocop += %w[--format github] if ENV.key?("CI")
@@ -54,7 +55,7 @@ end
 desc("Format `*.rb`")
 multitask(:"format:rb") do
   # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support
-  find = %w[find ./lib ./test -type f -and -name *.rb -print0]
+  find = %w[find ./lib ./test ./examples -type f -and -name *.rb -print0]
   fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --]
   sh("#{find.shelljoin} | #{fmt.shelljoin}")
 end
@@ -63,7 +64,7 @@ desc("Format `*.rbi`")
 multitask(:"format:rbi") do
   find = %w[find ./rbi -type f -and -name *.rbi -print0]
   fmt = xargs + %w[stree write --]
-  sh(locale, "#{find.shelljoin} | #{fmt.shelljoin}")
+  sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}")
 end
 
 desc("Format `*.rbs`")
@@ -99,7 +100,7 @@ multitask(:"format:rbs") do
   # transform class aliases to type aliases, which syntax tree has no trouble with
   sh("#{find.shelljoin} | #{pre.shelljoin}")
   # run syntax tree to format `*.rbs` files
-  sh(locale, "#{find.shelljoin} | #{fmt.shelljoin}") do
+  sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}") do
     success = _1
   end
   # transform type aliases back to class aliases
@@ -117,12 +118,14 @@ multitask(:"typecheck:steep") do
   sh(*%w[steep check])
 end
 
+directory(examples)
+
 desc("Typecheck `*.rbi`")
-multitask(:"typecheck:sorbet") do
-  sh(*%w[srb typecheck])
+multitask("typecheck:sorbet": examples) do
+  sh(*%w[srb typecheck --dir], examples)
 end
 
-file(tapioca) do
+directory(tapioca) do
   sh(*%w[tapioca init])
 end
 

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Increase please follow the respective company's security reporting guidelines.
+or products provided by Increase, please follow the respective company's security reporting guidelines.
 
 ### Increase Terms and Policies
 
-Please contact dev-feedback@increase.com for any questions or concerns regarding security of our services.
+Please contact dev-feedback@increase.com for any questions or concerns regarding the security of our services.
 
 ---
 

lib/increase/internal.rb

@@ -13,5 +13,8 @@ module Internal
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Increase::FilePart) }
+    end
   end
 end

lib/increase/models/account.rb

@@ -13,7 +13,7 @@ class Account < Increase::Internal::Type::BaseModel
       # @!attribute bank
       #   The bank the Account is with.
       #
-      #   @return [Symbol, Increase::Account::Bank]
+      #   @return [Symbol, Increase::Models::Account::Bank]
       required :bank, enum: -> { Increase::Account::Bank }
 
       # @!attribute closed_at
@@ -34,7 +34,7 @@ class Account < Increase::Internal::Type::BaseModel
       #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
       #   currency.
       #
-      #   @return [Symbol, Increase::Account::Currency]
+      #   @return [Symbol, Increase::Models::Account::Currency]
       required :currency, enum: -> { Increase::Account::Currency }
 
       # @!attribute entity_id
@@ -96,32 +96,32 @@ class Account < Increase::Internal::Type::BaseModel
       # @!attribute status
       #   The status of the Account.
       #
-      #   @return [Symbol, Increase::Account::Status]
+      #   @return [Symbol, Increase::Models::Account::Status]
       required :status, enum: -> { Increase::Account::Status }
 
       # @!attribute type
       #   A constant representing the object's type. For this resource it will always be
       #   `account`.
       #
-      #   @return [Symbol, Increase::Account::Type]
+      #   @return [Symbol, Increase::Models::Account::Type]
       required :type, enum: -> { Increase::Account::Type }
 
       # @!method initialize(id:, bank:, closed_at:, created_at:, currency:, entity_id:, idempotency_key:, informational_entity_id:, interest_accrued:, interest_accrued_at:, interest_rate:, name:, program_id:, status:, type:)
-      #   Some parameter documentations has been truncated, see {Increase::Account} for
-      #   more details.
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::Account} for more details.
       #
       #   Accounts are your bank accounts with Increase. They store money, receive
       #   transfers, and send payments. They earn interest and have depository insurance.
       #
       #   @param id [String] The Account identifier.
       #
-      #   @param bank [Symbol, Increase::Account::Bank] The bank the Account is with.
+      #   @param bank [Symbol, Increase::Models::Account::Bank] The bank the Account is with.
       #
       #   @param closed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
       #
       #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
       #
-      #   @param currency [Symbol, Increase::Account::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account curr
+      #   @param currency [Symbol, Increase::Models::Account::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account curr
       #
       #   @param entity_id [String, nil] The identifier for the Entity the Account belongs to.
       #
@@ -139,13 +139,13 @@ class Account < Increase::Internal::Type::BaseModel
       #
       #   @param program_id [String] The identifier of the Program determining the compliance and commercial terms of
       #
-      #   @param status [Symbol, Increase::Account::Status] The status of the Account.
+      #   @param status [Symbol, Increase::Models::Account::Status] The status of the Account.
       #
-      #   @param type [Symbol, Increase::Account::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::Account::Type] A constant representing the object's type. For this resource it will always be `
 
       # The bank the Account is with.
       #
-      # @see Increase::Account#bank
+      # @see Increase::Models::Account#bank
       module Bank
         extend Increase::Internal::Type::Enum
 
@@ -165,7 +165,7 @@ module Bank
       # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
       # currency.
       #
-      # @see Increase::Account#currency
+      # @see Increase::Models::Account#currency
       module Currency
         extend Increase::Internal::Type::Enum
 
@@ -193,7 +193,7 @@ module Currency
 
       # The status of the Account.
       #
-      # @see Increase::Account#status
+      # @see Increase::Models::Account#status
       module Status
         extend Increase::Internal::Type::Enum
 
@@ -210,7 +210,7 @@ module Status
       # A constant representing the object's type. For this resource it will always be
       # `account`.
       #
-      # @see Increase::Account#type
+      # @see Increase::Models::Account#type
       module Type
         extend Increase::Internal::Type::Enum
 

lib/increase/models/account_list_params.rb

@@ -9,7 +9,7 @@ class AccountListParams < Increase::Internal::Type::BaseModel
 
       # @!attribute created_at
       #
-      #   @return [Increase::AccountListParams::CreatedAt, nil]
+      #   @return [Increase::Models::AccountListParams::CreatedAt, nil]
       optional :created_at, -> { Increase::AccountListParams::CreatedAt }
 
       # @!attribute cursor
@@ -54,14 +54,14 @@ class AccountListParams < Increase::Internal::Type::BaseModel
 
       # @!attribute status
       #
-      #   @return [Increase::AccountListParams::Status, nil]
+      #   @return [Increase::Models::AccountListParams::Status, nil]
       optional :status, -> { Increase::AccountListParams::Status }
 
       # @!method initialize(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::AccountListParams} for more details.
       #
-      #   @param created_at [Increase::AccountListParams::CreatedAt]
+      #   @param created_at [Increase::Models::AccountListParams::CreatedAt]
       #
       #   @param cursor [String] Return the page of entries after this one.
       #
@@ -75,7 +75,7 @@ class AccountListParams < Increase::Internal::Type::BaseModel
       #
       #   @param program_id [String] Filter Accounts for those in a specific Program.
       #
-      #   @param status [Increase::AccountListParams::Status]
+      #   @param status [Increase::Models::AccountListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -110,7 +110,7 @@ class CreatedAt < Increase::Internal::Type::BaseModel
 
         # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Increase::AccountListParams::CreatedAt} for more details.
+        #   {Increase::Models::AccountListParams::CreatedAt} for more details.
         #
         #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
         #
@@ -126,16 +126,16 @@ class Status < Increase::Internal::Type::BaseModel
         #   Filter Accounts for those with the specified status. For GET requests, this
         #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
         #
-        #   @return [Array<Symbol, Increase::AccountListParams::Status::In>, nil]
+        #   @return [Array<Symbol, Increase::Models::AccountListParams::Status::In>, nil]
         optional :in_,
                  -> { Increase::Internal::Type::ArrayOf[enum: Increase::AccountListParams::Status::In] },
                  api_name: :in
 
         # @!method initialize(in_: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Increase::AccountListParams::Status} for more details.
+        #   {Increase::Models::AccountListParams::Status} for more details.
         #
-        #   @param in_ [Array<Symbol, Increase::AccountListParams::Status::In>] Filter Accounts for those with the specified status. For GET requests, this shou
+        #   @param in_ [Array<Symbol, Increase::Models::AccountListParams::Status::In>] Filter Accounts for those with the specified status. For GET requests, this shou
 
         module In
           extend Increase::Internal::Type::Enum