colorado-booth-sdk 1.0.6 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +28 -28
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4329d89320cc3887350b83dfca4b190ad0e0288a973c4015aa6124d0d8d848cc
|
|
4
|
+
data.tar.gz: 9eee26ac980b054f18b51c7c4fd0a6cefa8ffc5eef696ccba00ea3633dbabfae
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 86a2e67812d427b1c110bd7d52b4740859d615f8f60f366011f5bdb60577f6dd05bdd349b048b7df26bf1fb1f6bb73b051110ca234ac2b975560f8b1ed861324
|
|
7
|
+
data.tar.gz: 1b375c583efd84df6754a64fe7226aaec905d2c43f19f9b7f15af7daa8d3750678b1594c95039aa139b6ccb4440bfcded8d2e82dc989e280b133748d88f8be7a
|
data/README.md
CHANGED
|
@@ -10,16 +10,16 @@ API for Markdown Notes app.
|
|
|
10
10
|
Install the gem from the command line:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
gem install colorado-booth-sdk -v 1.
|
|
13
|
+
gem install colorado-booth-sdk -v 1.1.3
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
Or add the gem to your Gemfile and run `bundle`:
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
|
-
gem 'colorado-booth-sdk', '1.
|
|
19
|
+
gem 'colorado-booth-sdk', '1.1.3'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
For additional gem details, see the [RubyGems page for the colorado-booth-sdk gem](https://rubygems.org/gems/colorado-booth-sdk/versions/1.
|
|
22
|
+
For additional gem details, see the [RubyGems page for the colorado-booth-sdk gem](https://rubygems.org/gems/colorado-booth-sdk/versions/1.1.3).
|
|
23
23
|
|
|
24
24
|
## IRB Console Usage
|
|
25
25
|
|
|
@@ -66,7 +66,7 @@ rake
|
|
|
66
66
|
|
|
67
67
|
## Initialize the API Client
|
|
68
68
|
|
|
69
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
69
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/client.md)
|
|
70
70
|
|
|
71
71
|
The following parameters are configurable for the API Client:
|
|
72
72
|
|
|
@@ -75,7 +75,7 @@ The following parameters are configurable for the API Client:
|
|
|
75
75
|
| access_token | `String` | |
|
|
76
76
|
| port | `String` | *Default*: `'80'` |
|
|
77
77
|
| suites | `SuiteCodeEnum` | *Default*: `SuiteCodeEnum::HEARTS` |
|
|
78
|
-
| environment | [`Environment`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
78
|
+
| environment | [`Environment`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/README.md#environments) | The API environment. <br> **Default: `Environment.TESTING`** |
|
|
79
79
|
| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
|
|
80
80
|
| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
|
|
81
81
|
| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
|
|
@@ -85,14 +85,14 @@ The following parameters are configurable for the API Client:
|
|
|
85
85
|
| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
|
86
86
|
| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
|
87
87
|
| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
|
88
|
-
| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
89
|
-
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
90
|
-
| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
91
|
-
| api_header_credentials | [`ApiHeaderCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
92
|
-
| o_auth_ccg_credentials | [`OAuthCCGCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
93
|
-
| o_auth_acg_credentials | [`OAuthACGCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
94
|
-
| o_auth_ropcg_credentials | [`OAuthROPCGCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
95
|
-
| o_auth_bearer_token_credentials | [`OAuthBearerTokenCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
88
|
+
| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
|
|
89
|
+
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
|
|
90
|
+
| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/custom-query-parameter.md) | The credential object for Custom Query Parameter |
|
|
91
|
+
| api_header_credentials | [`ApiHeaderCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
|
|
92
|
+
| o_auth_ccg_credentials | [`OAuthCCGCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
|
|
93
|
+
| o_auth_acg_credentials | [`OAuthACGCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
|
|
94
|
+
| o_auth_ropcg_credentials | [`OAuthROPCGCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-resource-owner-credentials-grant.md) | The credential object for OAuth 2 Resource Owner Credentials Grant |
|
|
95
|
+
| o_auth_bearer_token_credentials | [`OAuthBearerTokenCredentials`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
|
|
96
96
|
|
|
97
97
|
The API client can be initialized as follows:
|
|
98
98
|
|
|
@@ -153,7 +153,7 @@ include MultiAuthSample
|
|
|
153
153
|
client = Client.from_env
|
|
154
154
|
```
|
|
155
155
|
|
|
156
|
-
See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
156
|
+
See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/environment-based-client-initialization.md) section for details.
|
|
157
157
|
|
|
158
158
|
## Environments
|
|
159
159
|
|
|
@@ -170,33 +170,33 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
|
170
170
|
|
|
171
171
|
This API uses the following authentication schemes.
|
|
172
172
|
|
|
173
|
-
* [`basicAuth (Basic Authentication)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
174
|
-
* [`apiKey (Custom Query Parameter)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
175
|
-
* [`apiHeader (Custom Header Signature)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
176
|
-
* [`OAuthCCG (OAuth 2 Client Credentials Grant)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
177
|
-
* [`OAuthACG (OAuth 2 Authorization Code Grant)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
178
|
-
* [`OAuthROPCG (OAuth 2 Resource Owner Credentials Grant)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
179
|
-
* [`OAuthBearerToken (OAuth 2 Bearer token)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
173
|
+
* [`basicAuth (Basic Authentication)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/basic-authentication.md)
|
|
174
|
+
* [`apiKey (Custom Query Parameter)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/custom-query-parameter.md)
|
|
175
|
+
* [`apiHeader (Custom Header Signature)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/custom-header-signature.md)
|
|
176
|
+
* [`OAuthCCG (OAuth 2 Client Credentials Grant)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-client-credentials-grant.md)
|
|
177
|
+
* [`OAuthACG (OAuth 2 Authorization Code Grant)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-authorization-code-grant.md)
|
|
178
|
+
* [`OAuthROPCG (OAuth 2 Resource Owner Credentials Grant)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-resource-owner-credentials-grant.md)
|
|
179
|
+
* [`OAuthBearerToken (OAuth 2 Bearer token)`](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/auth/oauth-2-bearer-token.md)
|
|
180
180
|
* `CustomAuth (Custom Authentication)`
|
|
181
181
|
|
|
182
182
|
## List of APIs
|
|
183
183
|
|
|
184
|
-
* [Authentication](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
184
|
+
* [Authentication](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/controllers/authentication.md)
|
|
185
185
|
|
|
186
186
|
## SDK Infrastructure
|
|
187
187
|
|
|
188
188
|
### Configuration
|
|
189
189
|
|
|
190
|
-
* [ProxySettings](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
191
|
-
* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
190
|
+
* [ProxySettings](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/proxy-settings.md)
|
|
191
|
+
* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/environment-based-client-initialization.md)
|
|
192
192
|
|
|
193
193
|
### HTTP
|
|
194
194
|
|
|
195
|
-
* [HttpResponse](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
196
|
-
* [HttpRequest](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
195
|
+
* [HttpResponse](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/http-response.md)
|
|
196
|
+
* [HttpRequest](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/http-request.md)
|
|
197
197
|
|
|
198
198
|
### Utilities
|
|
199
199
|
|
|
200
|
-
* [ApiHelper](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
201
|
-
* [DateTimeHelper](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.
|
|
200
|
+
* [ApiHelper](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/api-helper.md)
|
|
201
|
+
* [DateTimeHelper](https://www.github.com/ZahraN444/colorado-booth-ruby-sdk/tree/1.1.3/doc/date-time-helper.md)
|
|
202
202
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: colorado-booth-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.1.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Driscoll Dunn
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-04-
|
|
11
|
+
date: 2026-04-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: apimatic_core_interfaces
|