You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This will install all the required dependencies.
14
14
15
15
## Modifying/Adding code
16
16
17
-
Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/tilda/helpers/` and `examples/` directory.
17
+
Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/tilda_ruby/helpers/` and `examples/` directory.
18
18
19
19
## Adding and running examples
20
20
@@ -24,7 +24,7 @@ All files in the `examples/` directory are not modified by the generator and can
24
24
#!/usr/bin/env ruby
25
25
# frozen_string_literal: true
26
26
27
-
require_relative"../lib/tilda"
27
+
require_relative"../lib/tilda_ruby"
28
28
29
29
# ...
30
30
```
@@ -43,7 +43,7 @@ If you’d like to use the repository from source, you can either install from g
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ It is generated with [Stainless](https://www.stainless.com/).
6
6
7
7
## Documentation
8
8
9
-
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/tilda).
9
+
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/tilda-ruby).
10
10
11
11
## Installation
12
12
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
<!-- x-release-please-start-version -->
16
16
17
17
```ruby
18
-
gem "tilda", "~> 0.0.1"
18
+
gem "tilda-ruby", "~> 0.0.1"
19
19
```
20
20
21
21
<!-- x-release-please-end -->
@@ -24,9 +24,9 @@ gem "tilda", "~> 0.0.1"
24
24
25
25
```ruby
26
26
require"bundler/setup"
27
-
require"tilda"
27
+
require"tilda_ruby"
28
28
29
-
tilda =Tilda::Client.new(
29
+
tilda =TildaRuby::Client.new(
30
30
api_key:ENV["TILDA_API_KEY"] # This is the default and can be omitted
31
31
)
32
32
@@ -37,17 +37,17 @@ puts(getpage)
37
37
38
38
### Handling errors
39
39
40
-
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 `Tilda::Errors::APIError` will be thrown:
40
+
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 `TildaRuby::Errors::APIError` will be thrown:
On timeout, `Tilda::Errors::APITimeoutError` is raised.
104
+
On timeout, `TildaRuby::Errors::APITimeoutError` is raised.
105
105
106
106
Note that requests that time out are retried by default.
107
107
108
108
## Advanced concepts
109
109
110
110
### BaseModel
111
111
112
-
All parameter and response objects inherit from `Tilda::Internal::Type::BaseModel`, which provides several conveniences, including:
112
+
All parameter and response objects inherit from `TildaRuby::Internal::Type::BaseModel`, which provides several conveniences, including:
113
113
114
114
1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
115
115
@@ -161,9 +161,9 @@ response = client.request(
161
161
162
162
### Concurrency & connection pooling
163
163
164
-
The `Tilda::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
164
+
The `TildaRuby::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
165
165
166
-
Each instance of `Tilda::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.
166
+
Each instance of `TildaRuby::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.
167
167
168
168
When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
0 commit comments