Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Commit

Permalink
Merge pull request #15 from TheJumpCloud/generate-v1.3.0
Browse files Browse the repository at this point in the history
Update Ruby SDK to latest OAS definition
  • Loading branch information
Bob authored Jan 21, 2019
2 parents 0407738 + 3a37012 commit ad83f5b
Show file tree
Hide file tree
Showing 119 changed files with 4,049 additions and 492 deletions.
2 changes: 1 addition & 1 deletion config_v1.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gemName": "jcapiv1",
"moduleName": "JCAPIv1",
"gemVersion": "1.2.0"
"gemVersion": "1.3.0"
}
2 changes: 1 addition & 1 deletion config_v2.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gemName": "jcapiv2",
"moduleName": "JCAPIv2",
"gemVersion": "1.2.0"
"gemVersion": "1.3.0"
}
10 changes: 6 additions & 4 deletions jcapiv1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ JCAPIv1 - the Ruby gem for the JumpCloud APIs
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0
- Package version: 1.2.0
- Package version: 1.3.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen

## Installation
Expand All @@ -23,15 +23,15 @@ gem build jcapiv1.gemspec
Then either install the gem locally:

```shell
gem install ./jcapiv1-1.2.0.gem
gem install ./jcapiv1-1.3.0.gem
```
(for development, run `gem install --dev ./jcapiv1-1.2.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./jcapiv1-1.3.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

gem 'jcapiv1', '~> 1.2.0'
gem 'jcapiv1', '~> 1.3.0'

### Install from Git

Expand Down Expand Up @@ -146,6 +146,7 @@ Class | Method | HTTP request | Description
- [JCAPIv1::ApplicationConfigIdpEntityIdTooltipVariables](docs/ApplicationConfigIdpEntityIdTooltipVariables.md)
- [JCAPIv1::Applicationslist](docs/Applicationslist.md)
- [JCAPIv1::Body](docs/Body.md)
- [JCAPIv1::Body1](docs/Body1.md)
- [JCAPIv1::Command](docs/Command.md)
- [JCAPIv1::Commandfilereturn](docs/Commandfilereturn.md)
- [JCAPIv1::CommandfilereturnResults](docs/CommandfilereturnResults.md)
Expand All @@ -168,6 +169,7 @@ Class | Method | HTTP request | Description
- [JCAPIv1::Sshkeypost](docs/Sshkeypost.md)
- [JCAPIv1::System](docs/System.md)
- [JCAPIv1::SystemNetworkInterfaces](docs/SystemNetworkInterfaces.md)
- [JCAPIv1::SystemSshdParams](docs/SystemSshdParams.md)
- [JCAPIv1::Systemput](docs/Systemput.md)
- [JCAPIv1::SystemputAgentBoundMessages](docs/SystemputAgentBoundMessages.md)
- [JCAPIv1::Systemslist](docs/Systemslist.md)
Expand Down
2 changes: 1 addition & 1 deletion jcapiv1/docs/ApplicationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description
Applications

The endpoint returns all your SSO / SAML Applications. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
The endpoint returns all your SSO / SAML Applications. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down
9 changes: 9 additions & 0 deletions jcapiv1/docs/Body1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# JCAPIv1::Body1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**exclusion** | **BOOLEAN** | | [optional]
**exclusion_until** | **DateTime** | | [optional]


4 changes: 2 additions & 2 deletions jcapiv1/docs/CommandResultsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Method | HTTP request | Description
Delete a Command result

This endpoint deletes a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ````
This endpoint deletes a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ````

### Example
```ruby
Expand Down Expand Up @@ -78,7 +78,7 @@ Name | Type | Description | Notes
List an individual Command result

This endpoint returns a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down
4 changes: 2 additions & 2 deletions jcapiv1/docs/Commandresult.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Name | Type | Description | Notes
**user** | **String** | The user the command ran as. | [optional]
**sudo** | **BOOLEAN** | If the user had sudo rights | [optional]
**files** | **Array<String>** | An array of file ids that were included in the command | [optional]
**request_time** | **Integer** | The time that the command was sent. | [optional]
**response_time** | **Integer** | The time that the command was completed. | [optional]
**request_time** | **String** | The time that the command was sent. | [optional]
**response_time** | **String** | The time that the command was completed. | [optional]
**response** | [**CommandresultResponse**](CommandresultResponse.md) | | [optional]
**_id** | **String** | The ID of the command. | [optional]

Expand Down
4 changes: 2 additions & 2 deletions jcapiv1/docs/CommandsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Method | HTTP request | Description
Get a Command File

This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down Expand Up @@ -150,7 +150,7 @@ nil (empty response body)
List an individual Command

This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down
1 change: 1 addition & 0 deletions jcapiv1/docs/Fde.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key_present** | **BOOLEAN** | | [optional]
**active** | **BOOLEAN** | | [optional]


2 changes: 1 addition & 1 deletion jcapiv1/docs/OrganizationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description
Get Organization Details

This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down
2 changes: 1 addition & 1 deletion jcapiv1/docs/RadiusServersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Name | Type | Description | Notes
Update Radius Servers

This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ```
This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ```

### Example
```ruby
Expand Down
6 changes: 3 additions & 3 deletions jcapiv1/docs/SearchApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Method | HTTP request | Description
Search Organizations

This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ```
This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ```

### Example
```ruby
Expand Down Expand Up @@ -81,7 +81,7 @@ Name | Type | Description | Notes
Search Systems

Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : { \"$regex\" : \"^www\" }}, {\"hostname\" : {\"$regex\" : \"^db\"}} ] }, \"fields\" : \"os hostname displayName\" }' ```
Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : \"my-hostname\"}, {\"hostname\" : \"other-hostname\"} ] }, \"fields\" : \"os hostname displayName\" }' ```

### Example
```ruby
Expand Down Expand Up @@ -150,7 +150,7 @@ Name | Type | Description | Notes
Search System Users

Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : { \"$regex\" : \"gmail.com$\"}}], \"fields\" : \"email username sudo\" }' ```
Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : \"[email protected]\"}], \"fields\" : \"email username sudo\" }' ```

### Example
```ruby
Expand Down
3 changes: 2 additions & 1 deletion jcapiv1/docs/System.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**template_name** | **String** | | [optional]
**remote_ip** | **String** | | [optional]
**active** | **BOOLEAN** | | [optional]
**sshd_params** | **Array<String>** | | [optional]
**sshd_params** | [**Array<SystemSshdParams>**](SystemSshdParams.md) | | [optional]
**allow_ssh_password_authentication** | **BOOLEAN** | | [optional]
**allow_ssh_root_login** | **BOOLEAN** | | [optional]
**allow_multi_factor_authentication** | **BOOLEAN** | | [optional]
Expand All @@ -28,5 +28,6 @@ Name | Type | Description | Notes
**tags** | **Array<String>** | | [optional]
**_id** | **String** | | [optional]
**fde** | [**Fde**](Fde.md) | | [optional]
**amazon_instance_id** | **String** | | [optional]


9 changes: 9 additions & 0 deletions jcapiv1/docs/SystemSshdParams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# JCAPIv1::SystemSshdParams

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]
**value** | **String** | | [optional]


4 changes: 2 additions & 2 deletions jcapiv1/docs/SystemsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Name | Type | Description | Notes
List an individual system

This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down Expand Up @@ -155,7 +155,7 @@ Name | Type | Description | Notes
List All Systems

This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down
Loading

0 comments on commit ad83f5b

Please sign in to comment.