wesley-key-sdk 3.0.5 → 3.0.7
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 +14 -14
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 784656e06493786bdbd19fb9edb6c3937440703f401e611933de3aa5974cd64e
|
|
4
|
+
data.tar.gz: ef76250bba23b0a785aaca63c02cf83dc271fc29fd7346f83a248e24221ff13a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fc1de4713f9f89bc8dd517e1350676182f963069cf431639e87ab5befc55cdf39fbedec5bc37db700ffdfabac478ba15ebd107df8e94c8dc5da45085102f5021
|
|
7
|
+
data.tar.gz: 955843f36310a6a95479a3a7eb523c41c0acba470583c4d259eb3f6cd40e4e607bef83c33f8a81e7f1fe9ae8bfd772e6b9cd160ff2bb0579e784d5bf8cce79a2
|
data/README.md
CHANGED
|
@@ -10,16 +10,16 @@ This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and
|
|
|
10
10
|
Install the gem from the command line:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
gem install wesley-key-sdk -v 3.0.
|
|
13
|
+
gem install wesley-key-sdk -v 3.0.7
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
Or add the gem to your Gemfile and run `bundle`:
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
|
-
gem 'wesley-key-sdk', '3.0.
|
|
19
|
+
gem 'wesley-key-sdk', '3.0.7'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/3.0.
|
|
22
|
+
For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/3.0.7).
|
|
23
23
|
|
|
24
24
|
## IRB Console Usage
|
|
25
25
|
|
|
@@ -66,14 +66,14 @@ 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/wesley-key-ruby-sdk/tree/3.0.
|
|
69
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/client.md)
|
|
70
70
|
|
|
71
71
|
The following parameters are configurable for the API Client:
|
|
72
72
|
|
|
73
73
|
| Parameter | Type | Description |
|
|
74
74
|
| --- | --- | --- |
|
|
75
75
|
| default_host | `String` | *Default*: `'www.example.com'` |
|
|
76
|
-
| environment | [`Environment`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
76
|
+
| environment | [`Environment`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
|
|
77
77
|
| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
|
|
78
78
|
| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
|
|
79
79
|
| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
|
|
@@ -83,7 +83,7 @@ The following parameters are configurable for the API Client:
|
|
|
83
83
|
| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
|
84
84
|
| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
|
85
85
|
| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
|
86
|
-
| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
86
|
+
| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
|
|
87
87
|
|
|
88
88
|
The API client can be initialized as follows:
|
|
89
89
|
|
|
@@ -109,7 +109,7 @@ include CypressTestApi
|
|
|
109
109
|
client = Client.from_env
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
112
|
+
See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/environment-based-client-initialization.md) section for details.
|
|
113
113
|
|
|
114
114
|
## Environments
|
|
115
115
|
|
|
@@ -123,22 +123,22 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
|
123
123
|
|
|
124
124
|
## List of APIs
|
|
125
125
|
|
|
126
|
-
* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
126
|
+
* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/controllers/api.md)
|
|
127
127
|
|
|
128
128
|
## SDK Infrastructure
|
|
129
129
|
|
|
130
130
|
### Configuration
|
|
131
131
|
|
|
132
|
-
* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
133
|
-
* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
132
|
+
* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/proxy-settings.md)
|
|
133
|
+
* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/environment-based-client-initialization.md)
|
|
134
134
|
|
|
135
135
|
### HTTP
|
|
136
136
|
|
|
137
|
-
* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
138
|
-
* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
137
|
+
* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/http-response.md)
|
|
138
|
+
* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/http-request.md)
|
|
139
139
|
|
|
140
140
|
### Utilities
|
|
141
141
|
|
|
142
|
-
* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
143
|
-
* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.
|
|
142
|
+
* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/api-helper.md)
|
|
143
|
+
* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/date-time-helper.md)
|
|
144
144
|
|