Skip to content

Commit a6f700d

Browse files
committed
Update ruby SDK from OpenAPI spec
1 parent f2c2ab6 commit a6f700d

13 files changed

+27
-45
lines changed

README.md

Lines changed: 11 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,40 +13,22 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
1313

1414
## Installation
1515

16-
### Build a gem
16+
Add this line to your application's Gemfile:
1717

18-
To build the Ruby code into a gem:
19-
20-
```shell
21-
gem build whatpulse-sdk.gemspec
18+
```ruby
19+
gem 'whatpulse-sdk'
2220
```
2321

24-
Then either install the gem locally:
22+
And then execute:
2523

26-
```shell
27-
gem install ./whatpulse-sdk-1.0.0.gem
24+
```bash
25+
bundle install
2826
```
2927

30-
(for development, run `gem install --dev ./whatpulse-sdk-1.0.0.gem` to install the development dependencies)
31-
32-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33-
34-
Finally add this to the Gemfile:
35-
36-
gem 'whatpulse-sdk', '~> 1.0.0'
37-
38-
### Install from Git
39-
40-
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
41-
42-
gem 'whatpulse-sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
43-
44-
### Include the Ruby code directly
45-
46-
Include the Ruby code directly using `-I` as follows:
28+
Or install it yourself as:
4729

48-
```shell
49-
ruby -Ilib script.rb
30+
```bash
31+
gem install whatpulse-sdk
5032
```
5133

5234
## API Key
@@ -72,7 +54,7 @@ end
7254
api_instance = WhatpulseSdk::ComputersApi.new
7355
id = 'id_example' # String | User ID or username
7456
opts = {
75-
is_archived: 'is_archived_example' # String | Get filter parameters
57+
is_archived: true # Boolean |
7658
}
7759

7860
begin
@@ -87,7 +69,7 @@ end
8769

8870
## Documentation for API Endpoints
8971

90-
All URIs are relative to *https://whatpulse.org/api/v1*
72+
All URIs are relative to *https://whatpulse.test/api/v1*
9173

9274
Class | Method | HTTP request | Description
9375
------------ | ------------- | ------------- | -------------

docs/ComputersApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::ComputersApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |
@@ -29,7 +29,7 @@ end
2929
api_instance = WhatpulseSdk::ComputersApi.new
3030
id = 'id_example' # String | User ID or username
3131
opts = {
32-
is_archived: 'is_archived_example' # String | Get filter parameters
32+
is_archived: true # Boolean |
3333
}
3434

3535
begin
@@ -64,7 +64,7 @@ end
6464
| Name | Type | Description | Notes |
6565
| ---- | ---- | ----------- | ----- |
6666
| **id** | **String** | User ID or username | |
67-
| **is_archived** | **String** | Get filter parameters | [optional] |
67+
| **is_archived** | **Boolean** | | [optional] |
6868

6969
### Return type
7070

docs/MembersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::MembersApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/ProfilesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::ProfilesApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/PulsesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::PulsesApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/SubteamMembersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::SubteamMembersApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/SubteamsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::SubteamsApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/TeamsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::TeamsApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/TimeSeriesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::TimeSeriesApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

docs/UsersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WhatpulseSdk::UsersApi
22

3-
All URIs are relative to *https://whatpulse.org/api/v1*
3+
All URIs are relative to *https://whatpulse.test/api/v1*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |

0 commit comments

Comments
 (0)