docker-hub 2.pre.beta.2

data/docs/AuthenticationApiApi.md

@@ -0,0 +1,204 @@
+# DockerHub::AuthenticationApiApi
+
+All URIs are relative to *https://hub.docker.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**auth_create_access_token**](AuthenticationApiApi.md#auth_create_access_token) | **POST** /v2/auth/token | Create access token |
+| [**post_users2_fa_login**](AuthenticationApiApi.md#post_users2_fa_login) | **POST** /v2/users/2fa-login | Second factor authentication |
+| [**post_users_login**](AuthenticationApiApi.md#post_users_login) | **POST** /v2/users/login | Create an authentication token |
+
+
+## auth_create_access_token
+
+> <AuthCreateTokenResponse> auth_create_access_token(opts)
+
+Create access token
+
+Creates and returns a short-lived access token in JWT format for use as a bearer when calling Docker APIs.  If successful, the access token returned should be used in the HTTP Authorization header like  `Authorization: Bearer {access_token}`.  _**If your organization has SSO enforced, you must use a personal access token (PAT) instead of a password.**_ 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+
+api_instance = DockerHub::AuthenticationApiApi.new
+opts = {
+  auth_create_access_token_request: DockerHub::AuthCreateAccessTokenRequest.new({identifier: 'myusername', secret: 'dckr_pat_124509ugsdjga93'}) # AuthCreateAccessTokenRequest | 
+}
+
+begin
+  # Create access token
+  result = api_instance.auth_create_access_token(opts)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuthenticationApiApi->auth_create_access_token: #{e}"
+end
+```
+
+#### Using the auth_create_access_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthCreateTokenResponse>, Integer, Hash)> auth_create_access_token_with_http_info(opts)
+
+```ruby
+begin
+  # Create access token
+  data, status_code, headers = api_instance.auth_create_access_token_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthCreateTokenResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuthenticationApiApi->auth_create_access_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_create_access_token_request** | [**AuthCreateAccessTokenRequest**](AuthCreateAccessTokenRequest.md) |  | [optional] |
+
+### Return type
+
+[**AuthCreateTokenResponse**](AuthCreateTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_users2_fa_login
+
+> <PostUsersLoginSuccessResponse> post_users2_fa_login(users2_fa_login_request)
+
+Second factor authentication
+
+When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/users/login` call.  Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.  The returned token is used in the HTTP Authorization header like `Authorization: Bearer {TOKEN}`.  Most Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+
+api_instance = DockerHub::AuthenticationApiApi.new
+users2_fa_login_request = DockerHub::Users2FALoginRequest.new({login_2fa_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c', code: '123456'}) # Users2FALoginRequest | Login details.
+
+begin
+  # Second factor authentication
+  result = api_instance.post_users2_fa_login(users2_fa_login_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuthenticationApiApi->post_users2_fa_login: #{e}"
+end
+```
+
+#### Using the post_users2_fa_login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostUsersLoginSuccessResponse>, Integer, Hash)> post_users2_fa_login_with_http_info(users2_fa_login_request)
+
+```ruby
+begin
+  # Second factor authentication
+  data, status_code, headers = api_instance.post_users2_fa_login_with_http_info(users2_fa_login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostUsersLoginSuccessResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuthenticationApiApi->post_users2_fa_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users2_fa_login_request** | [**Users2FALoginRequest**](Users2FALoginRequest.md) | Login details. |  |
+
+### Return type
+
+[**PostUsersLoginSuccessResponse**](PostUsersLoginSuccessResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_users_login
+
+> <PostUsersLoginSuccessResponse> post_users_login(users_login_request)
+
+Create an authentication token
+
+Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.  The returned token is used in the HTTP Authorization header like `Authorization: Bearer {TOKEN}`.  _**As of September 16, 2024, this route requires a personal access token (PAT) instead of a password if your organization has SSO enforced.**_  <div style=\"background-color:rgb(255, 165, 0, .25); padding:5px; border-radius:4px\">   <strong>Deprecated</strong>: Use [<a href=\"#tag/authentication-api/operation/AuthCreateAccessToken\">Create access token</a>] instead. </div> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docker-hub'
+
+api_instance = DockerHub::AuthenticationApiApi.new
+users_login_request = DockerHub::UsersLoginRequest.new({username: 'myusername', password: 'p@ssw0rd'}) # UsersLoginRequest | Login details.
+
+begin
+  # Create an authentication token
+  result = api_instance.post_users_login(users_login_request)
+  p result
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuthenticationApiApi->post_users_login: #{e}"
+end
+```
+
+#### Using the post_users_login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostUsersLoginSuccessResponse>, Integer, Hash)> post_users_login_with_http_info(users_login_request)
+
+```ruby
+begin
+  # Create an authentication token
+  data, status_code, headers = api_instance.post_users_login_with_http_info(users_login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostUsersLoginSuccessResponse>
+rescue DockerHub::ApiError => e
+  puts "Error when calling AuthenticationApiApi->post_users_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users_login_request** | [**UsersLoginRequest**](UsersLoginRequest.md) | Login details. |  |
+
+### Return type
+
+[**PostUsersLoginSuccessResponse**](PostUsersLoginSuccessResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/BulkInvite.md

@@ -0,0 +1,18 @@
+# DockerHub::BulkInvite
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invitees** | [**Array<BulkInviteInviteesInner>**](BulkInviteInviteesInner.md) | A list of invitees | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::BulkInvite.new(
+  invitees: null
+)
+```
+

data/docs/BulkInviteInviteesInner.md

@@ -0,0 +1,22 @@
+# DockerHub::BulkInviteInviteesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invitee** | **String** | invitee email or Docker ID | [optional] |
+| **status** | **String** | status of the invite or validation error | [optional] |
+| **invite** | [**Invite**](Invite.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::BulkInviteInviteesInner.new(
+  invitee: null,
+  status: null,
+  invite: null
+)
+```
+

data/docs/Category.md

@@ -0,0 +1,20 @@
+# DockerHub::Category
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Human-readable name of the category |  |
+| **slug** | **String** | URL-friendly identifier for the category |  |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::Category.new(
+  name: Databases,
+  slug: databases
+)
+```
+

data/docs/CreateAccessTokenRequest.md

@@ -0,0 +1,22 @@
+# DockerHub::CreateAccessTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token_label** | **String** | Friendly name for you to identify the token. |  |
+| **scopes** | **Array<String>** | Valid scopes: \"repo:admin\", \"repo:write\", \"repo:read\", \"repo:public_read\"  |  |
+| **expires_at** | **Time** | Optional expiration date for the token. If omitted, the token will remain valid indefinitely.  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::CreateAccessTokenRequest.new(
+  token_label: My read only token,
+  scopes: ["repo:read"],
+  expires_at: 2021-10-28T18:30:19.520861Z
+)
+```
+

data/docs/CreateOrgAccessTokenRequest.md

@@ -0,0 +1,24 @@
+# DockerHub::CreateOrgAccessTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Label for the access token | [optional] |
+| **description** | **String** | Description of the access token | [optional] |
+| **resources** | [**Array<OrgAccessTokenResource>**](OrgAccessTokenResource.md) | Resources this token has access to | [optional] |
+| **expires_at** | **Time** | Expiration date for the token | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::CreateOrgAccessTokenRequest.new(
+  label: My organization token,
+  description: Token for CI/CD pipeline,
+  resources: null,
+  expires_at: 2023-05-20T00:54:18Z
+)
+```
+

data/docs/CreateOrgAccessTokenResponse.md

@@ -0,0 +1,34 @@
+# DockerHub::CreateOrgAccessTokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **created_by** | **String** |  | [optional] |
+| **is_active** | **Boolean** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+| **last_used_at** | **Time** |  | [optional] |
+| **token** | **String** | The actual token value that can be used for authentication | [optional] |
+| **resources** | [**Array<OrgAccessTokenResource>**](OrgAccessTokenResource.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::CreateOrgAccessTokenResponse.new(
+  id: a7a5ef25-8889-43a0-8cc7-f2a94268e861,
+  label: My organization token,
+  created_by: johndoe,
+  is_active: true,
+  created_at: 2022-05-20T00:54:18Z,
+  expires_at: 2023-05-20T00:54:18Z,
+  last_used_at: 2022-06-15T12:30:45Z,
+  token: dckr_oat_7awgM4jG5SQvxcvmNzhKj8PQjxo,
+  resources: null
+)
+```
+

data/docs/EmailAddress.md

@@ -0,0 +1,26 @@
+# DockerHub::EmailAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Float** |  | [optional] |
+| **user_id** | **Float** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **verified** | **Boolean** |  | [optional] |
+| **primary** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::EmailAddress.new(
+  id: null,
+  user_id: null,
+  email: dockeruser@docker.com,
+  verified: null,
+  primary: null
+)
+```
+

data/docs/EmailWithUsername.md

@@ -0,0 +1,28 @@
+# DockerHub::EmailWithUsername
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Float** |  | [optional] |
+| **user_id** | **Float** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **verified** | **Boolean** |  | [optional] |
+| **primary** | **Boolean** |  | [optional] |
+| **username** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::EmailWithUsername.new(
+  id: null,
+  user_id: null,
+  email: dockeruser@docker.com,
+  verified: null,
+  primary: null,
+  username: dockeruser
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,22 @@
+# DockerHub::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errinfo** | **Array<String>** |  | [optional] |
+| **detail** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::Error.new(
+  errinfo: null,
+  detail: null,
+  message: null
+)
+```
+

data/docs/GetAccessTokensResponse.md

@@ -0,0 +1,26 @@
+# DockerHub::GetAccessTokensResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Float** |  | [optional] |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **active_count** | **Float** |  | [optional] |
+| **results** | [**Array<V2AccessTokensUuidGet200Response>**](V2AccessTokensUuidGet200Response.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::GetAccessTokensResponse.new(
+  count: 1,
+  _next: null,
+  previous: null,
+  active_count: 1,
+  results: null
+)
+```
+

data/docs/GetAuditActionsResponse.md

@@ -0,0 +1,18 @@
+# DockerHub::GetAuditActionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actions** | [**Hash<String, AuditLogActions>**](AuditLogActions.md) | Map of audit log actions. | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::GetAuditActionsResponse.new(
+  actions: null
+)
+```
+

data/docs/GetAuditLogsResponse.md

@@ -0,0 +1,18 @@
+# DockerHub::GetAuditLogsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **logs** | [**Array<AuditLog>**](AuditLog.md) | List of audit log events. | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::GetAuditLogsResponse.new(
+  logs: null
+)
+```
+

data/docs/GetOrgAccessTokenResponse.md

@@ -0,0 +1,32 @@
+# DockerHub::GetOrgAccessTokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **created_by** | **String** |  | [optional] |
+| **is_active** | **Boolean** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+| **last_used_at** | **Time** |  | [optional] |
+| **resources** | [**Array<OrgAccessTokenResource>**](OrgAccessTokenResource.md) | Resources this token has access to | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::GetOrgAccessTokenResponse.new(
+  id: a7a5ef25-8889-43a0-8cc7-f2a94268e861,
+  label: My organization token,
+  created_by: johndoe,
+  is_active: true,
+  created_at: 2022-05-20T00:54:18Z,
+  expires_at: 2023-05-20T00:54:18Z,
+  last_used_at: 2022-06-15T12:30:45Z,
+  resources: null
+)
+```
+

data/docs/GetOrgAccessTokensResponse.md

@@ -0,0 +1,24 @@
+# DockerHub::GetOrgAccessTokensResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Float** |  | [optional] |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<OrgAccessToken>**](OrgAccessToken.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::GetOrgAccessTokensResponse.new(
+  total: 10,
+  _next: https://hub.docker.com/v2/orgs/docker/access-tokens?page=2&page_size=10,
+  previous: https://hub.docker.com/v2/orgs/docker/access-tokens?page=1&page_size=10,
+  results: null
+)
+```
+

data/docs/GroupMember.md

@@ -0,0 +1,38 @@
+# DockerHub::GroupMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The UUID trimmed | [optional] |
+| **company** | **String** |  | [optional] |
+| **date_joined** | **Time** |  | [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] |
+| **email** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'docker-hub'
+
+instance = DockerHub::GroupMember.new(
+  id: 0ab70deb065a43fcacd55d48caa945d8,
+  company: Docker Inc,
+  date_joined: 2021-01-05T21:06:53.506400Z,
+  full_name: John Snow,
+  gravatar_email: null,
+  gravatar_url: null,
+  location: null,
+  profile_url: null,
+  type: User,
+  username: dockeruser,
+  email: dockeruser@docker.com
+)
+```
+