Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Commit

Permalink
Merge pull request #2 from rapid7/release/6.5.10
Browse files Browse the repository at this point in the history
release/6.5.10 - update to generated library based on 6.5.10 release …
  • Loading branch information
zyoutz-r7 authored Mar 21, 2018
2 parents 3e04e5a + 7e143cc commit 4bee83a
Show file tree
Hide file tree
Showing 376 changed files with 3,083 additions and 1,265 deletions.
1 change: 1 addition & 0 deletions api-files/console-swagger-6.5.10.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/AdministrationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **execute_command**
> ConsoleCommandOutput execute_command(param0=param0)
> ConsoleCommandOutput execute_command(command=command)
Console Commands

Expand All @@ -79,11 +79,11 @@ from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AdministrationApi()
param0 = 'param0_example' # str | The console command to execute. (optional)
command = 'command_example' # str | The console command to execute. (optional)

try:
# Console Commands
api_response = api_instance.execute_command(param0=param0)
api_response = api_instance.execute_command(command=command)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->execute_command: %s\n" % e)
Expand All @@ -93,7 +93,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param0** | **str**| The console command to execute. | [optional]
**command** | **str**| The console command to execute. | [optional]

### Return type

Expand Down
8 changes: 4 additions & 4 deletions docs/AssetApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_asset**
> CreatedReference create_asset(id, param1=param1)
> CreatedReference create_asset(id, asset=asset)
Assets

Expand All @@ -99,11 +99,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetApi()
id = 56 # int | The identifier of the site.
param1 = rapid7vmconsole.AssetCreate() # AssetCreate | The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` (optional)
asset = rapid7vmconsole.AssetCreate() # AssetCreate | The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` (optional)

try:
# Assets
api_response = api_instance.create_asset(id, param1=param1)
api_response = api_instance.create_asset(id, asset=asset)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetApi->create_asset: %s\n" % e)
Expand All @@ -114,7 +114,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the site. |
**param1** | [**AssetCreate**](AssetCreate.md)| The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` | [optional]
**asset** | [**AssetCreate**](AssetCreate.md)| The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"` | [optional]

### Return type

Expand Down
24 changes: 12 additions & 12 deletions docs/AssetDiscoveryApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Method | HTTP request | Description


# **create_sonar_query**
> CreatedReferenceDiscoveryQueryIDLink create_sonar_query(param0)
> CreatedReferenceDiscoveryQueryIDLink create_sonar_query(query=query)
Sonar Queries

Expand All @@ -33,11 +33,11 @@ from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AssetDiscoveryApi()
param0 = rapid7vmconsole.SonarQuery() # SonarQuery | param0
query = rapid7vmconsole.SonarQuery() # SonarQuery | The criteria for a Sonar query. (optional)

try:
# Sonar Queries
api_response = api_instance.create_sonar_query(param0)
api_response = api_instance.create_sonar_query(query=query)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetDiscoveryApi->create_sonar_query: %s\n" % e)
Expand All @@ -47,7 +47,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param0** | [**SonarQuery**](SonarQuery.md)| param0 |
**query** | [**SonarQuery**](SonarQuery.md)| The criteria for a Sonar query. | [optional]

### Return type

Expand Down Expand Up @@ -400,7 +400,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **sonar_query_search**
> list[DiscoveryAsset] sonar_query_search(param0)
> list[DiscoveryAsset] sonar_query_search(query=query)
Sonar Query Search

Expand All @@ -416,11 +416,11 @@ from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AssetDiscoveryApi()
param0 = rapid7vmconsole.SonarCriteria() # SonarCriteria | param0
query = rapid7vmconsole.SonarCriteria() # SonarCriteria | The criteria for a Sonar query. (optional)

try:
# Sonar Query Search
api_response = api_instance.sonar_query_search(param0)
api_response = api_instance.sonar_query_search(query=query)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetDiscoveryApi->sonar_query_search: %s\n" % e)
Expand All @@ -430,7 +430,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param0** | [**SonarCriteria**](SonarCriteria.md)| param0 |
**query** | [**SonarCriteria**](SonarCriteria.md)| The criteria for a Sonar query. | [optional]

### Return type

Expand All @@ -448,7 +448,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_sonar_query**
> Links update_sonar_query(id, param1)
> Links update_sonar_query(id, query=query)
Sonar Query

Expand All @@ -465,11 +465,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetDiscoveryApi()
id = 789 # int | The identifier of the Sonar query.
param1 = rapid7vmconsole.SonarQuery() # SonarQuery | param1
query = rapid7vmconsole.SonarQuery() # SonarQuery | The criteria for a Sonar query. (optional)

try:
# Sonar Query
api_response = api_instance.update_sonar_query(id, param1)
api_response = api_instance.update_sonar_query(id, query=query)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetDiscoveryApi->update_sonar_query: %s\n" % e)
Expand All @@ -480,7 +480,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the Sonar query. |
**param1** | [**SonarQuery**](SonarQuery.md)| param1 |
**query** | [**SonarQuery**](SonarQuery.md)| The criteria for a Sonar query. | [optional]

### Return type

Expand Down
48 changes: 24 additions & 24 deletions docs/AssetGroupApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_asset_group**
> CreatedReferenceAssetGroupIDLink create_asset_group(param0=param0)
> CreatedReferenceAssetGroupIDLink create_asset_group(asset_group=asset_group)
Asset Groups

Expand All @@ -194,11 +194,11 @@ from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.AssetGroupApi()
param0 = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)
asset_group = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)

try:
# Asset Groups
api_response = api_instance.create_asset_group(param0=param0)
api_response = api_instance.create_asset_group(asset_group=asset_group)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetGroupApi->create_asset_group: %s\n" % e)
Expand All @@ -208,7 +208,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param0** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]
**asset_group** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]

### Return type

Expand Down Expand Up @@ -816,7 +816,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_asset_group_search_criteria**
> Links set_asset_group_search_criteria(id, param1=param1)
> Links set_asset_group_search_criteria(id, criteria=criteria)
Asset Group Search Criteria

Expand All @@ -833,11 +833,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetGroupApi()
id = 56 # int | The identifier of the asset group.
param1 = rapid7vmconsole.SearchCriteria() # SearchCriteria | The search criteria specification. (optional)
criteria = rapid7vmconsole.SearchCriteria() # SearchCriteria | The search criteria specification. (optional)

try:
# Asset Group Search Criteria
api_response = api_instance.set_asset_group_search_criteria(id, param1=param1)
api_response = api_instance.set_asset_group_search_criteria(id, criteria=criteria)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetGroupApi->set_asset_group_search_criteria: %s\n" % e)
Expand All @@ -848,7 +848,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the asset group. |
**param1** | [**SearchCriteria**](SearchCriteria.md)| The search criteria specification. | [optional]
**criteria** | [**SearchCriteria**](SearchCriteria.md)| The search criteria specification. | [optional]

### Return type

Expand All @@ -866,7 +866,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_asset_group_tags**
> Links set_asset_group_tags(id, param1=param1)
> Links set_asset_group_tags(id, tags=tags)
Asset Group Tags

Expand All @@ -883,11 +883,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetGroupApi()
id = 56 # int | The identifier of the asset group.
param1 = [rapid7vmconsole.list[int]()] # list[int] | The tags to associate to the asset group. (optional)
tags = [rapid7vmconsole.list[int]()] # list[int] | The tags to associate to the asset group. (optional)

try:
# Asset Group Tags
api_response = api_instance.set_asset_group_tags(id, param1=param1)
api_response = api_instance.set_asset_group_tags(id, tags=tags)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetGroupApi->set_asset_group_tags: %s\n" % e)
Expand All @@ -898,7 +898,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the asset group. |
**param1** | **list[int]**| The tags to associate to the asset group. | [optional]
**tags** | **list[int]**| The tags to associate to the asset group. | [optional]

### Return type

Expand All @@ -916,7 +916,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_asset_group_users**
> Links set_asset_group_users(id, param1=param1)
> Links set_asset_group_users(id, users=users)
Asset Group Users

Expand All @@ -933,11 +933,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetGroupApi()
id = 56 # int | The identifier of the asset group.
param1 = [rapid7vmconsole.list[int]()] # list[int] | The users to grant access to the asset group. (optional)
users = [rapid7vmconsole.list[int]()] # list[int] | The users to grant access to the asset group. (optional)

try:
# Asset Group Users
api_response = api_instance.set_asset_group_users(id, param1=param1)
api_response = api_instance.set_asset_group_users(id, users=users)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetGroupApi->set_asset_group_users: %s\n" % e)
Expand All @@ -948,7 +948,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the asset group. |
**param1** | **list[int]**| The users to grant access to the asset group. | [optional]
**users** | **list[int]**| The users to grant access to the asset group. | [optional]

### Return type

Expand All @@ -966,7 +966,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_asset_group**
> Links update_asset_group(id, param1=param1)
> Links update_asset_group(id, asset_group=asset_group)
Asset Group

Expand All @@ -983,11 +983,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetGroupApi()
id = 56 # int | The identifier of the asset group.
param1 = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)
asset_group = rapid7vmconsole.AssetGroup() # AssetGroup | The details of the asset group. (optional)

try:
# Asset Group
api_response = api_instance.update_asset_group(id, param1=param1)
api_response = api_instance.update_asset_group(id, asset_group=asset_group)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetGroupApi->update_asset_group: %s\n" % e)
Expand All @@ -998,7 +998,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the asset group. |
**param1** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]
**asset_group** | [**AssetGroup**](AssetGroup.md)| The details of the asset group. | [optional]

### Return type

Expand All @@ -1016,7 +1016,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_asset_group_assets**
> Links update_asset_group_assets(id, param1=param1)
> Links update_asset_group_assets(id, assets=assets)
Asset Group Assets

Expand All @@ -1033,11 +1033,11 @@ from pprint import pprint
# create an instance of the API class
api_instance = rapid7vmconsole.AssetGroupApi()
id = 56 # int | The identifier of the asset group.
param1 = [rapid7vmconsole.list[int]()] # list[int] | The assets to place in the asset group. (optional)
assets = [rapid7vmconsole.list[int]()] # list[int] | The assets to place in the asset group. (optional)

try:
# Asset Group Assets
api_response = api_instance.update_asset_group_assets(id, param1=param1)
api_response = api_instance.update_asset_group_assets(id, assets=assets)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetGroupApi->update_asset_group_assets: %s\n" % e)
Expand All @@ -1048,7 +1048,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The identifier of the asset group. |
**param1** | **list[int]**| The assets to place in the asset group. | [optional]
**assets** | **list[int]**| The assets to place in the asset group. | [optional]

### Return type

Expand Down
3 changes: 2 additions & 1 deletion docs/CreateAuthenticationSource.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type of the authentication source to use to authenticate the user. Defaults to `normal`. | [optional]
**id** | **int** | The identifier of the authentication source to use to authenticate the user. The source with the specified identifier must be of the type specified by `type`. If `id` is omitted, then one source of the specified `type` is selected. | [optional]
**type** | **str** | The type of the authentication source to use to authenticate the user. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading

0 comments on commit 4bee83a

Please sign in to comment.