Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.1.2"
".": "0.1.3"
}
4 changes: 2 additions & 2 deletions .solargraph.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include:
- 'Rakefile'
- 'examples/**/*.rb'
- 'lib/**/*.rb'
- 'test/orb-billing/resource_namespaces.rb'
- 'test/orb-billing/test_helper.rb'
- 'test/orb/resource_namespaces.rb'
- 'test/orb/test_helper.rb'
exclude:
- 'rbi/**/*'
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## 0.1.3 (2025-04-11)

Full Changelog: [v0.1.2...v0.1.3](https://github.com/orbcorp/orb-ruby/compare/v0.1.2...v0.1.3)

### Bug Fixes

* inaccuracies in the README.md ([f07ef0e](https://github.com/orbcorp/orb-ruby/commit/f07ef0e9ecbecd44e66bfb8df9fe5e271f19c09a))


### Chores

* fix lsp configuration file for local development ([9574fe5](https://github.com/orbcorp/orb-ruby/commit/9574fe55bec14d4356758e27f61b3be97395023a))
* **internal:** version bump ([a8232d6](https://github.com/orbcorp/orb-ruby/commit/a8232d644f3a97a6d8e339037faa5f4af7174c2a))

## 0.1.2 (2025-04-09)

Full Changelog: [v0.1.1...v0.1.2](https://github.com/orbcorp/orb-ruby/compare/v0.1.1...v0.1.2)
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GIT
PATH
remote: .
specs:
orb-billing (0.1.1)
orb-billing (0.1.2)
connection_pool

GEM
Expand Down
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,16 @@ To use this gem, install via Bundler by adding the following to your application
<!-- x-release-please-start-version -->

```ruby
gem "orb-billing", "~> 0.1.2"
gem "orb-billing", "~> 0.1.3"
```

<!-- x-release-please-end -->

To fetch an initial copy of the gem:

```sh
bundle install
```

## Usage

```ruby
require "bundler/setup"
require "orb-billing"
require "orb"

orb = Orb::Client.new(
api_key: "My API Key" # defaults to ENV["ORB_API_KEY"]
Expand Down Expand Up @@ -62,7 +56,7 @@ end

### Errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Orb::Error` will be thrown:
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Orb::Errors::APIError` will be thrown:

```ruby
begin
Expand Down Expand Up @@ -168,8 +162,7 @@ Due to limitations with the Sorbet type system, where a method otherwise can tak
Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.

```ruby
params =
Orb::Models::CustomerCreateParams.new(email: "[email protected]", name: "My Customer")
params = Orb::Models::CustomerCreateParams.new(email: "[email protected]", name: "My Customer")

orb.customers.create(**params)
```
Expand Down Expand Up @@ -197,8 +190,7 @@ If you want to explicitly send an extra param, you can do so with the `extra_que
To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.

```ruby
response =
client.request(
response = client.request(
method: :post,
path: '/undocumented/endpoint',
query: {"dog": "woof"},
Expand Down
2 changes: 1 addition & 1 deletion lib/orb/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Orb
VERSION = "0.1.2"
VERSION = "0.1.3"
end
2 changes: 1 addition & 1 deletion orb.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Gem::Specification.new do |s|
s.summary = "Ruby library to access the Orb API"
s.authors = ["Orb"]
s.email = "[email protected]"
s.files = Dir["lib/**/*.rb", "rbi/**/*.rbi", "sig/**/*.rbs", "manifest.yaml"]
s.files = Dir["lib/**/*.rb", "rbi/**/*.rbi", "sig/**/*.rbs", "manifest.yaml", "CHANGELOG.md", "SECURITY.md"]
s.extra_rdoc_files = ["README.md"]
s.required_ruby_version = ">= 3.0.0"
s.add_dependency "connection_pool"
Expand Down
Loading