docker-hub 2.pre.beta.2

data/docs/AccessTokensApi.md

@@ -0,0 +1,362 @@
+# DockerHub::AccessTokensApi
+
+All URIs are relative to *https://hub.docker.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v2_access_tokens_get**](AccessTokensApi.md#v2_access_tokens_get) | **GET** /v2/access-tokens | List personal access tokens |
+| [**v2_access_tokens_post**](AccessTokensApi.md#v2_access_tokens_post) | **POST** /v2/access-tokens | Create personal access token |
+| [**v2_access_tokens_uuid_delete**](AccessTokensApi.md#v2_access_tokens_uuid_delete) | **DELETE** /v2/access-tokens/{uuid} | Delete personal access token |
+| [**v2_access_tokens_uuid_get**](AccessTokensApi.md#v2_access_tokens_uuid_get) | **GET** /v2/access-tokens/{uuid} | Get personal access token |
+| [**v2_access_tokens_uuid_patch**](AccessTokensApi.md#v2_access_tokens_uuid_patch) | **PATCH** /v2/access-tokens/{uuid} | Update personal access token |
+
+
+## v2_access_tokens_get
+
+> <GetAccessTokensResponse> v2_access_tokens_get(opts)
+
+List personal access tokens
+
+Returns a paginated list of personal access tokens.
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AccessTokensApi.new
+opts = {
+  page: 8.14, # Float | 
+  page_size: 8.14 # Float | 
+}
+
+begin
+  # List personal access tokens
+  result = api_instance.v2_access_tokens_get(opts)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_get: #{e}"
+end
+```
+
+#### Using the v2_access_tokens_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccessTokensResponse>, Integer, Hash)> v2_access_tokens_get_with_http_info(opts)
+
+```ruby
+begin
+  # List personal access tokens
+  data, status_code, headers = api_instance.v2_access_tokens_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccessTokensResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Float** |  | [optional][default to 1] |
+| **page_size** | **Float** |  | [optional][default to 10] |
+
+### Return type
+
+[**GetAccessTokensResponse**](GetAccessTokensResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_access_tokens_post
+
+> <AccessToken> v2_access_tokens_post(create_access_token_request)
+
+Create personal access token
+
+Creates and returns a personal access token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AccessTokensApi.new
+create_access_token_request = DockerHub::CreateAccessTokenRequest.new({token_label: 'My read only token', scopes: ["repo: read"]}) # CreateAccessTokenRequest | 
+
+begin
+  # Create personal access token
+  result = api_instance.v2_access_tokens_post(create_access_token_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_post: #{e}"
+end
+```
+
+#### Using the v2_access_tokens_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccessToken>, Integer, Hash)> v2_access_tokens_post_with_http_info(create_access_token_request)
+
+```ruby
+begin
+  # Create personal access token
+  data, status_code, headers = api_instance.v2_access_tokens_post_with_http_info(create_access_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccessToken>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_access_token_request** | [**CreateAccessTokenRequest**](CreateAccessTokenRequest.md) |  |  |
+
+### Return type
+
+[**AccessToken**](AccessToken.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v2_access_tokens_uuid_delete
+
+> v2_access_tokens_uuid_delete(uuid)
+
+Delete personal access token
+
+Deletes a personal access token permanently. This cannot be undone. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AccessTokensApi.new
+uuid = 'uuid_example' # String | 
+
+begin
+  # Delete personal access token
+  api_instance.v2_access_tokens_uuid_delete(uuid)
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_uuid_delete: #{e}"
+end
+```
+
+#### Using the v2_access_tokens_uuid_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v2_access_tokens_uuid_delete_with_http_info(uuid)
+
+```ruby
+begin
+  # Delete personal access token
+  data, status_code, headers = api_instance.v2_access_tokens_uuid_delete_with_http_info(uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_uuid_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_access_tokens_uuid_get
+
+> <V2AccessTokensUuidGet200Response> v2_access_tokens_uuid_get(uuid)
+
+Get personal access token
+
+Returns a personal access token by UUID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AccessTokensApi.new
+uuid = 'uuid_example' # String | 
+
+begin
+  # Get personal access token
+  result = api_instance.v2_access_tokens_uuid_get(uuid)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_uuid_get: #{e}"
+end
+```
+
+#### Using the v2_access_tokens_uuid_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V2AccessTokensUuidGet200Response>, Integer, Hash)> v2_access_tokens_uuid_get_with_http_info(uuid)
+
+```ruby
+begin
+  # Get personal access token
+  data, status_code, headers = api_instance.v2_access_tokens_uuid_get_with_http_info(uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V2AccessTokensUuidGet200Response>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_uuid_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+
+### Return type
+
+[**V2AccessTokensUuidGet200Response**](V2AccessTokensUuidGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_access_tokens_uuid_patch
+
+> <AccessToken> v2_access_tokens_uuid_patch(uuid, patch_access_token_request)
+
+Update personal access token
+
+Updates a personal access token partially. You can either update the token's label or enable/disable it. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AccessTokensApi.new
+uuid = 'uuid_example' # String | 
+patch_access_token_request = DockerHub::PatchAccessTokenRequest.new # PatchAccessTokenRequest | 
+
+begin
+  # Update personal access token
+  result = api_instance.v2_access_tokens_uuid_patch(uuid, patch_access_token_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_uuid_patch: #{e}"
+end
+```
+
+#### Using the v2_access_tokens_uuid_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccessToken>, Integer, Hash)> v2_access_tokens_uuid_patch_with_http_info(uuid, patch_access_token_request)
+
+```ruby
+begin
+  # Update personal access token
+  data, status_code, headers = api_instance.v2_access_tokens_uuid_patch_with_http_info(uuid, patch_access_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccessToken>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AccessTokensApi->v2_access_tokens_uuid_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+| **patch_access_token_request** | [**PatchAccessTokenRequest**](PatchAccessTokenRequest.md) |  |  |
+
+### Return type
+
+[**AccessToken**](AccessToken.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AuditLog.md

@@ -0,0 +1,30 @@
+# DockerHub::AuditLog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** |  | [optional] |
+| **action** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **actor** | **String** |  | [optional] |
+| **data** | **Hash<String, String>** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+| **action_description** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::AuditLog.new(
+  account: null,
+  action: null,
+  name: null,
+  actor: null,
+  data: null,
+  timestamp: null,
+  action_description: null
+)
+```
+

data/docs/AuditLogAction.md

@@ -0,0 +1,22 @@
+# DockerHub::AuditLogAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of audit log action. | [optional] |
+| **description** | **String** | Description of audit log action. | [optional] |
+| **label** | **String** | Label for audit log action. | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::AuditLogAction.new(
+  name: null,
+  description: null,
+  label: null
+)
+```
+

data/docs/AuditLogActions.md

@@ -0,0 +1,20 @@
+# DockerHub::AuditLogActions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actions** | [**Array<AuditLogAction>**](AuditLogAction.md) | List of audit log actions. | [optional] |
+| **label** | **String** | Grouping label for a particular set of audit log actions. | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::AuditLogActions.new(
+  actions: null,
+  label: null
+)
+```
+

data/docs/AuditLogsApi.md

@@ -0,0 +1,163 @@
+# DockerHub::AuditLogsApi
+
+All URIs are relative to *https://hub.docker.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**audit_logs_list_audit_actions**](AuditLogsApi.md#audit_logs_list_audit_actions) | **GET** /v2/auditlogs/{account}/actions | List audit log actions |
+| [**audit_logs_list_audit_logs**](AuditLogsApi.md#audit_logs_list_audit_logs) | **GET** /v2/auditlogs/{account} | List audit log events |
+
+
+## audit_logs_list_audit_actions
+
+> <GetAuditActionsResponse> audit_logs_list_audit_actions(account)
+
+List audit log actions
+
+List audit log actions for a namespace to be used as a filter for querying audit log events.  <span class=\"oat\"></span> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AuditLogsApi.new
+account = 'account_example' # String | Namespace to query audit log actions for.
+
+begin
+  # List audit log actions
+  result = api_instance.audit_logs_list_audit_actions(account)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuditLogsApi->audit_logs_list_audit_actions: #{e}"
+end
+```
+
+#### Using the audit_logs_list_audit_actions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAuditActionsResponse>, Integer, Hash)> audit_logs_list_audit_actions_with_http_info(account)
+
+```ruby
+begin
+  # List audit log actions
+  data, status_code, headers = api_instance.audit_logs_list_audit_actions_with_http_info(account)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAuditActionsResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuditLogsApi->audit_logs_list_audit_actions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** | Namespace to query audit log actions for. |  |
+
+### Return type
+
+[**GetAuditActionsResponse**](GetAuditActionsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## audit_logs_list_audit_logs
+
+> <GetAuditLogsResponse> audit_logs_list_audit_logs(account, opts)
+
+List audit log events
+
+List audit log events for a given namespace.  <span class=\"oat\"></span> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+# setup authorization
+DockerHub.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DockerHub::AuditLogsApi.new
+account = 'account_example' # String | Namespace to query audit logs for.
+opts = {
+  action: 'action_example', # String | action name one of [\"repo.tag.push\", ...]. Optional parameter to filter specific audit log actions. 
+  name: 'name_example', # String | name. Optional parameter to filter audit log events to a specific name. For repository events, this is the name of the repository. For organization events, this is the name of the organization. For team member events, this is the username of the team member. 
+  actor: 'actor_example', # String | actor name. Optional parameter to filter audit log events to the specific user who triggered the event. 
+  from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Start of the time window you wish to query audit events for.
+  to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | End of the time window you wish to query audit events for.
+  page: 56, # Integer | page - specify page number. Page number to get.
+  page_size: 56 # Integer | page_size - specify page size. Number of events to return per page.
+}
+
+begin
+  # List audit log events
+  result = api_instance.audit_logs_list_audit_logs(account, opts)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuditLogsApi->audit_logs_list_audit_logs: #{e}"
+end
+```
+
+#### Using the audit_logs_list_audit_logs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAuditLogsResponse>, Integer, Hash)> audit_logs_list_audit_logs_with_http_info(account, opts)
+
+```ruby
+begin
+  # List audit log events
+  data, status_code, headers = api_instance.audit_logs_list_audit_logs_with_http_info(account, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAuditLogsResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuditLogsApi->audit_logs_list_audit_logs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** | Namespace to query audit logs for. |  |
+| **action** | **String** | action name one of [\&quot;repo.tag.push\&quot;, ...]. Optional parameter to filter specific audit log actions.  | [optional] |
+| **name** | **String** | name. Optional parameter to filter audit log events to a specific name. For repository events, this is the name of the repository. For organization events, this is the name of the organization. For team member events, this is the username of the team member.  | [optional] |
+| **actor** | **String** | actor name. Optional parameter to filter audit log events to the specific user who triggered the event.  | [optional] |
+| **from** | **Time** | Start of the time window you wish to query audit events for. | [optional] |
+| **to** | **Time** | End of the time window you wish to query audit events for. | [optional] |
+| **page** | **Integer** | page - specify page number. Page number to get. | [optional][default to 1] |
+| **page_size** | **Integer** | page_size - specify page size. Number of events to return per page. | [optional][default to 25] |
+
+### Return type
+
+[**GetAuditLogsResponse**](GetAuditLogsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AuthCreateAccessTokenRequest.md

@@ -0,0 +1,20 @@
+# DockerHub::AuthCreateAccessTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | The identifier of the account to create an access token for. If using a password or personal access token, this must be a username. If using an organization access token, this must be an organization name.  |  |
+| **secret** | **String** | The secret of the account to create an access token for. This can be a password, personal access token, or organization access token.  |  |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::AuthCreateAccessTokenRequest.new(
+  identifier: myusername,
+  secret: dckr_pat_124509ugsdjga93
+)
+```
+

data/docs/AuthCreateTokenResponse.md

@@ -0,0 +1,18 @@
+# DockerHub::AuthCreateTokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | The created access token. This expires in 10 minutes. | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::AuthCreateTokenResponse.new(
+  access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+)
+```
+