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 #18 from TheJumpCloud/DE-325-sdks
Browse files Browse the repository at this point in the history
DE-325 Update API v1 and v2 03-28-2019
  • Loading branch information
radduccijc authored Apr 11, 2019
2 parents 9c3d49d + 664e36a commit d40d689
Show file tree
Hide file tree
Showing 94 changed files with 2,033 additions and 320 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": "2.1.0"
"gemVersion": "2.2.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": "2.1.0"
"gemVersion": "2.2.0"
}
8 changes: 4 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: 2.1.0
- Package version: 2.2.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-2.1.0.gem
gem install ./jcapiv1-2.2.0.gem
```
(for development, run `gem install --dev ./jcapiv1-2.1.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./jcapiv1-2.2.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', '~> 2.1.0'
gem 'jcapiv1', '~> 2.2.0'

### Install from Git

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
12 changes: 6 additions & 6 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/{CommandResultID} \\ -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/{CommandResultID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand All @@ -101,7 +101,7 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
filter: "filter_example" # String | A filter to apply to the query.
x_org_id: "" # String |
}
Expand All @@ -122,7 +122,7 @@ Name | Type | Description | Notes
**id** | **String**| |
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

Expand Down Expand Up @@ -167,7 +167,7 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
limit: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
sort: "", # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
Expand All @@ -190,7 +190,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
**sort** | **String**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
Expand Down
16 changes: 8 additions & 8 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 All @@ -40,7 +40,7 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
limit: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
x_org_id: "" # String |
Expand All @@ -62,7 +62,7 @@ Name | Type | Description | Notes
**id** | **String**| |
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
**x_org_id** | **String**| | [optional] [default to ]
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 All @@ -173,7 +173,7 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
filter: "filter_example" # String | A filter to apply to the query.
x_org_id: "" # String |
}
Expand All @@ -194,7 +194,7 @@ Name | Type | Description | Notes
**id** | **String**| |
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

Expand Down Expand Up @@ -240,7 +240,7 @@ accept = "application/json" # String |

opts = {
skip: 0, # Integer | The offset into the records to return.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
limit: 10, # Integer | The number of records to return at once. Limited to 100.
sort: "", # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
filter: "filter_example" # String | A filter to apply to the query.
Expand All @@ -263,7 +263,7 @@ Name | Type | Description | Notes
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**sort** | **String**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
Expand Down
6 changes: 3 additions & 3 deletions 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 All @@ -33,7 +33,7 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
filter: "filter_example" # String | A filter to apply to the query.
limit: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
Expand All @@ -56,7 +56,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
Expand Down
6 changes: 3 additions & 3 deletions jcapiv1/docs/RadiusServersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
filter: "filter_example" # String | A filter to apply to the query.
limit: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
Expand All @@ -58,7 +58,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
Expand Down Expand Up @@ -148,7 +148,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
1 change: 1 addition & 0 deletions jcapiv1/docs/Search.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filter** | **Object** | | [optional]
**fields** | **String** | | [optional]
**search_filter** | **Object** | | [optional]


Loading

0 comments on commit d40d689

Please sign in to comment.