docker-hub 2.pre.beta.2

data/docs/OrgAccessTokensApi.md

@@ -0,0 +1,368 @@
+# DockerHub::OrgAccessTokensApi
+
+All URIs are relative to *https://hub.docker.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v2_orgs_name_access_tokens_get**](OrgAccessTokensApi.md#v2_orgs_name_access_tokens_get) | **GET** /v2/orgs/{name}/access-tokens | List access tokens |
+| [**v2_orgs_name_access_tokens_post**](OrgAccessTokensApi.md#v2_orgs_name_access_tokens_post) | **POST** /v2/orgs/{name}/access-tokens | Create access token |
+| [**v2_orgs_org_name_access_tokens_access_token_id_delete**](OrgAccessTokensApi.md#v2_orgs_org_name_access_tokens_access_token_id_delete) | **DELETE** /v2/orgs/{org_name}/access-tokens/{access_token_id} | Delete access token |
+| [**v2_orgs_org_name_access_tokens_access_token_id_get**](OrgAccessTokensApi.md#v2_orgs_org_name_access_tokens_access_token_id_get) | **GET** /v2/orgs/{org_name}/access-tokens/{access_token_id} | Get access token |
+| [**v2_orgs_org_name_access_tokens_access_token_id_patch**](OrgAccessTokensApi.md#v2_orgs_org_name_access_tokens_access_token_id_patch) | **PATCH** /v2/orgs/{org_name}/access-tokens/{access_token_id} | Update access token |
+
+
+## v2_orgs_name_access_tokens_get
+
+> <GetOrgAccessTokensResponse> v2_orgs_name_access_tokens_get(opts)
+
+List access tokens
+
+List access tokens for an organization. 
+
+### 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::OrgAccessTokensApi.new
+opts = {
+  page: 8.14, # Float | 
+  page_size: 8.14 # Float | 
+}
+
+begin
+  # List access tokens
+  result = api_instance.v2_orgs_name_access_tokens_get(opts)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_name_access_tokens_get: #{e}"
+end
+```
+
+#### Using the v2_orgs_name_access_tokens_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetOrgAccessTokensResponse>, Integer, Hash)> v2_orgs_name_access_tokens_get_with_http_info(opts)
+
+```ruby
+begin
+  # List access tokens
+  data, status_code, headers = api_instance.v2_orgs_name_access_tokens_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetOrgAccessTokensResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_name_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
+
+[**GetOrgAccessTokensResponse**](GetOrgAccessTokensResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_orgs_name_access_tokens_post
+
+> <CreateOrgAccessTokenResponse> v2_orgs_name_access_tokens_post(create_org_access_token_request)
+
+Create access token
+
+Create an access token for an organization. 
+
+### 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::OrgAccessTokensApi.new
+create_org_access_token_request = DockerHub::CreateOrgAccessTokenRequest.new # CreateOrgAccessTokenRequest | 
+
+begin
+  # Create access token
+  result = api_instance.v2_orgs_name_access_tokens_post(create_org_access_token_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_name_access_tokens_post: #{e}"
+end
+```
+
+#### Using the v2_orgs_name_access_tokens_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateOrgAccessTokenResponse>, Integer, Hash)> v2_orgs_name_access_tokens_post_with_http_info(create_org_access_token_request)
+
+```ruby
+begin
+  # Create access token
+  data, status_code, headers = api_instance.v2_orgs_name_access_tokens_post_with_http_info(create_org_access_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateOrgAccessTokenResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_name_access_tokens_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_org_access_token_request** | [**CreateOrgAccessTokenRequest**](CreateOrgAccessTokenRequest.md) |  |  |
+
+### Return type
+
+[**CreateOrgAccessTokenResponse**](CreateOrgAccessTokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v2_orgs_org_name_access_tokens_access_token_id_delete
+
+> v2_orgs_org_name_access_tokens_access_token_id_delete(org_name, access_token_id)
+
+Delete access token
+
+Delete a specific access token for an organization. This action 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::OrgAccessTokensApi.new
+org_name = 'myorganization' # String | Name of the organization (namespace).
+access_token_id = 'a7a5ef25-8889-43a0-8cc7-f2a94268e861' # String | The ID of the access token to retrieve
+
+begin
+  # Delete access token
+  api_instance.v2_orgs_org_name_access_tokens_access_token_id_delete(org_name, access_token_id)
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_org_name_access_tokens_access_token_id_delete: #{e}"
+end
+```
+
+#### Using the v2_orgs_org_name_access_tokens_access_token_id_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_orgs_org_name_access_tokens_access_token_id_delete_with_http_info(org_name, access_token_id)
+
+```ruby
+begin
+  # Delete access token
+  data, status_code, headers = api_instance.v2_orgs_org_name_access_tokens_access_token_id_delete_with_http_info(org_name, access_token_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_org_name_access_tokens_access_token_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_name** | **String** | Name of the organization (namespace). |  |
+| **access_token_id** | **String** | The ID of the access token to retrieve |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_orgs_org_name_access_tokens_access_token_id_get
+
+> <GetOrgAccessTokenResponse> v2_orgs_org_name_access_tokens_access_token_id_get(org_name, access_token_id)
+
+Get access token
+
+Get details of a specific access token for an organization. 
+
+### 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::OrgAccessTokensApi.new
+org_name = 'myorganization' # String | Name of the organization (namespace).
+access_token_id = 'a7a5ef25-8889-43a0-8cc7-f2a94268e861' # String | The ID of the access token to retrieve
+
+begin
+  # Get access token
+  result = api_instance.v2_orgs_org_name_access_tokens_access_token_id_get(org_name, access_token_id)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_org_name_access_tokens_access_token_id_get: #{e}"
+end
+```
+
+#### Using the v2_orgs_org_name_access_tokens_access_token_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetOrgAccessTokenResponse>, Integer, Hash)> v2_orgs_org_name_access_tokens_access_token_id_get_with_http_info(org_name, access_token_id)
+
+```ruby
+begin
+  # Get access token
+  data, status_code, headers = api_instance.v2_orgs_org_name_access_tokens_access_token_id_get_with_http_info(org_name, access_token_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetOrgAccessTokenResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_org_name_access_tokens_access_token_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_name** | **String** | Name of the organization (namespace). |  |
+| **access_token_id** | **String** | The ID of the access token to retrieve |  |
+
+### Return type
+
+[**GetOrgAccessTokenResponse**](GetOrgAccessTokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_orgs_org_name_access_tokens_access_token_id_patch
+
+> <UpdateOrgAccessTokenResponse> v2_orgs_org_name_access_tokens_access_token_id_patch(org_name, access_token_id, update_org_access_token_request)
+
+Update access token
+
+Update a specific access token for an organization. 
+
+### 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::OrgAccessTokensApi.new
+org_name = 'myorganization' # String | Name of the organization (namespace).
+access_token_id = 'a7a5ef25-8889-43a0-8cc7-f2a94268e861' # String | The ID of the access token to retrieve
+update_org_access_token_request = DockerHub::UpdateOrgAccessTokenRequest.new # UpdateOrgAccessTokenRequest | 
+
+begin
+  # Update access token
+  result = api_instance.v2_orgs_org_name_access_tokens_access_token_id_patch(org_name, access_token_id, update_org_access_token_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_org_name_access_tokens_access_token_id_patch: #{e}"
+end
+```
+
+#### Using the v2_orgs_org_name_access_tokens_access_token_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateOrgAccessTokenResponse>, Integer, Hash)> v2_orgs_org_name_access_tokens_access_token_id_patch_with_http_info(org_name, access_token_id, update_org_access_token_request)
+
+```ruby
+begin
+  # Update access token
+  data, status_code, headers = api_instance.v2_orgs_org_name_access_tokens_access_token_id_patch_with_http_info(org_name, access_token_id, update_org_access_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateOrgAccessTokenResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgAccessTokensApi->v2_orgs_org_name_access_tokens_access_token_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_name** | **String** | Name of the organization (namespace). |  |
+| **access_token_id** | **String** | The ID of the access token to retrieve |  |
+| **update_org_access_token_request** | [**UpdateOrgAccessTokenRequest**](UpdateOrgAccessTokenRequest.md) |  |  |
+
+### Return type
+
+[**UpdateOrgAccessTokenResponse**](UpdateOrgAccessTokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OrgGroup.md

@@ -0,0 +1,26 @@
+# DockerHub::OrgGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Float** | Group ID | [optional] |
+| **uuid** | **String** | UUID for the group | [optional] |
+| **name** | **String** | Name of the group | [optional] |
+| **description** | **String** | Description of the group | [optional] |
+| **member_count** | **Float** | Member count of the group | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::OrgGroup.new(
+  id: 10,
+  uuid: null,
+  name: mygroup,
+  description: Groups description,
+  member_count: 10
+)
+```
+

data/docs/OrgMember.md

@@ -0,0 +1,52 @@
+# DockerHub::OrgMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User's email address | [optional] |
+| **role** | **String** | User's role in the Organization | [optional] |
+| **groups** | **Array<String>** | Groups (Teams) that the user is member of | [optional] |
+| **is_guest** | **Boolean** | If the organization has verified domains, members that have email addresses outside of those domains will be flagged as guests. | [optional] |
+| **primary_email** | **String** | The user's email primary address. | [optional] |
+| **last_logged_in_at** | **Time** | Last time the user logged in. To access this field, you must have insights visible for your organization. See  [Insights](https://docs.docker.com/admin/organization/insights/#view-insights-for-organization-users).  | [optional] |
+| **last_seen_at** | **Time** | Last time the user was seen. To access this field, you must have insights visible for your organization. See  [Insights](https://docs.docker.com/admin/organization/insights/#view-insights-for-organization-users).  | [optional] |
+| **last_desktop_version** | **String** | Last desktop version the user used. To access this field, you must have insights visible for your organization. See  [Insights](https://docs.docker.com/admin/organization/insights/#view-insights-for-organization-users).  | [optional] |
+| **id** | **String** | The UUID trimmed | [optional] |
+| **company** | **String** |  | [optional] |
+| **date_joined** | **String** |  | [optional] |
+| **full_name** | **String** |  | [optional] |
+| **gravatar_email** | **String** |  | [optional] |
+| **gravatar_url** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **profile_url** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **username** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::OrgMember.new(
+  email: example@docker.com,
+  role: Owner,
+  groups: ["developers","owners"],
+  is_guest: false,
+  primary_email: example@docker.com,
+  last_logged_in_at: 2021-01-05T21:06:53.506400Z,
+  last_seen_at: 2021-01-05T21:06:53.506400Z,
+  last_desktop_version: 4.29.0,
+  id: 0ab70deb065a43fcacd55d48caa945d8,
+  company: Docker Inc,
+  date_joined: 2021-01-05T21:06:53.506400Z,
+  full_name: Jon Snow,
+  gravatar_email: null,
+  gravatar_url: null,
+  location: null,
+  profile_url: null,
+  type: User,
+  username: dockeruser
+)
+```
+

data/docs/OrgMemberPaginated.md

@@ -0,0 +1,24 @@
+# DockerHub::OrgMemberPaginated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Float** | The total number of items that match with the search. | [optional] |
+| **previous** | **String** | The URL or link for the previous page of items. | [optional] |
+| **_next** | **String** | The URL or link for the next page of items. | [optional] |
+| **results** | [**Array<OrgMember>**](OrgMember.md) | List of accounts. | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::OrgMemberPaginated.new(
+  count: 120,
+  previous: https://hub.docker.com/v2/some/resources/items?page=1&page_size=20,
+  _next: https://hub.docker.com/v2/some/resources/items?page=3&page_size=20,
+  results: null
+)
+```
+

data/docs/OrgSettings.md

@@ -0,0 +1,18 @@
+# DockerHub::OrgSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **restricted_images** | [**RestrictedImages**](RestrictedImages.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::OrgSettings.new(
+  restricted_images: null
+)
+```
+

data/docs/OrgSettingsApi.md

@@ -0,0 +1,149 @@
+# DockerHub::OrgSettingsApi
+
+All URIs are relative to *https://hub.docker.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v2_orgs_name_settings_get**](OrgSettingsApi.md#v2_orgs_name_settings_get) | **GET** /v2/orgs/{name}/settings | Get organization settings |
+| [**v2_orgs_name_settings_put**](OrgSettingsApi.md#v2_orgs_name_settings_put) | **PUT** /v2/orgs/{name}/settings | Update organization settings |
+
+
+## v2_orgs_name_settings_get
+
+> <OrgSettings> v2_orgs_name_settings_get(name)
+
+Get organization settings
+
+Returns organization settings by name. 
+
+### 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::OrgSettingsApi.new
+name = 'name_example' # String | Name of the organization.
+
+begin
+  # Get organization settings
+  result = api_instance.v2_orgs_name_settings_get(name)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgSettingsApi->v2_orgs_name_settings_get: #{e}"
+end
+```
+
+#### Using the v2_orgs_name_settings_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrgSettings>, Integer, Hash)> v2_orgs_name_settings_get_with_http_info(name)
+
+```ruby
+begin
+  # Get organization settings
+  data, status_code, headers = api_instance.v2_orgs_name_settings_get_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrgSettings>
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgSettingsApi->v2_orgs_name_settings_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the organization. |  |
+
+### Return type
+
+[**OrgSettings**](OrgSettings.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_orgs_name_settings_put
+
+> <OrgSettings> v2_orgs_name_settings_put(name, v2_orgs_name_settings_put_request)
+
+Update organization settings
+
+Updates an organization's settings. Some settings are only used when the organization is on a business subscription.  ***Only users with administrative privileges for the organization (owner role) can modify these settings.***  The following settings are only used on a business subscription: - `restricted_images` 
+
+### 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::OrgSettingsApi.new
+name = 'name_example' # String | Name of the organization.
+v2_orgs_name_settings_put_request = DockerHub::V2OrgsNameSettingsPutRequest.new({restricted_images: DockerHub::V2OrgsNameSettingsPutRequestRestrictedImages.new({enabled: true, allow_official_images: true, allow_verified_publishers: true})}) # V2OrgsNameSettingsPutRequest | 
+
+begin
+  # Update organization settings
+  result = api_instance.v2_orgs_name_settings_put(name, v2_orgs_name_settings_put_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgSettingsApi->v2_orgs_name_settings_put: #{e}"
+end
+```
+
+#### Using the v2_orgs_name_settings_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrgSettings>, Integer, Hash)> v2_orgs_name_settings_put_with_http_info(name, v2_orgs_name_settings_put_request)
+
+```ruby
+begin
+  # Update organization settings
+  data, status_code, headers = api_instance.v2_orgs_name_settings_put_with_http_info(name, v2_orgs_name_settings_put_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrgSettings>
+rescue DockerHub::ApiError => e
+  puts "Error when calling OrgSettingsApi->v2_orgs_name_settings_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the organization. |  |
+| **v2_orgs_name_settings_put_request** | [**V2OrgsNameSettingsPutRequest**](V2OrgsNameSettingsPutRequest.md) |  |  |
+
+### Return type
+
+[**OrgSettings**](OrgSettings.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+