Metadata-Version: 2.4
Name: agentdrive_sdk
Version: 0.0.3
Summary: AgentDrive
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/tokencanopy/agentdrive-sdk
Keywords: OpenAPI,OpenAPI-Generator,AgentDrive
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# agentdrive-sdk
AgentDrive is an agent-focused artifact store: drive-scoped folders, artifacts, and immutable versions, with local grants, possession-based share links, drive-scoped search, and a cursor-resumable change feed. Bearer-authenticated with Hub-issued product tokens (see /.well-known/oauth-protected-resource); every mutation takes an Idempotency-Key, and existing-state mutations take If-Match.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: &lt;PINNED&gt;
- Package version: 0.0.1
- Generator version: 7.16.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/tokencanopy/agentdrive-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/tokencanopy/agentdrive-sdk.git`)

Then import the package:
```python
import agentdrive_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import agentdrive_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import agentdrive_sdk
from agentdrive_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://drive.tokencanopy.com
# See configuration.py for a list of all supported configuration parameters.
configuration = agentdrive_sdk.Configuration(
    host = "https://drive.tokencanopy.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = agentdrive_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with agentdrive_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agentdrive_sdk.ArtifactsApi(api_client)
    drive_id = 'drive_id_example' # str |
    artifact_id = 'artifact_id_example' # str |
    if_none_match = 'if_none_match_example' # str |  (optional)
    authorization = 'authorization_example' # str | Deprecated: redundant with the operation's `bearerAuth` security requirement, which is how a generated client should learn to authenticate. Scheduled for removal. (optional)

    try:
        # Read Artifact Content
        api_response = api_instance.artifacts_content(drive_id, artifact_id, if_none_match=if_none_match, authorization=authorization)
        print("The response of ArtifactsApi->artifacts_content:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ArtifactsApi->artifacts_content: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://drive.tokencanopy.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ArtifactsApi* | [**artifacts_content**](docs/ArtifactsApi.md#artifacts_content) | **GET** /v0/drives/{drive_id}/artifacts/{artifact_id}/content | Read Artifact Content
*ArtifactsApi* | [**artifacts_copy**](docs/ArtifactsApi.md#artifacts_copy) | **POST** /v0/drives/{drive_id}/artifacts/{artifact_id}/copy | Copy Artifact
*ArtifactsApi* | [**artifacts_create**](docs/ArtifactsApi.md#artifacts_create) | **POST** /v0/drives/{drive_id}/artifacts | Create Artifact
*ArtifactsApi* | [**artifacts_delete**](docs/ArtifactsApi.md#artifacts_delete) | **DELETE** /v0/drives/{drive_id}/artifacts/{artifact_id} | Delete Artifact
*ArtifactsApi* | [**artifacts_list**](docs/ArtifactsApi.md#artifacts_list) | **GET** /v0/drives/{drive_id}/artifacts | List Artifacts
*ArtifactsApi* | [**artifacts_read**](docs/ArtifactsApi.md#artifacts_read) | **GET** /v0/drives/{drive_id}/artifacts/{artifact_id} | Read Artifact
*ArtifactsApi* | [**artifacts_restore**](docs/ArtifactsApi.md#artifacts_restore) | **POST** /v0/drives/{drive_id}/artifacts/{artifact_id}/restore | Restore Artifact
*ArtifactsApi* | [**artifacts_update**](docs/ArtifactsApi.md#artifacts_update) | **PATCH** /v0/drives/{drive_id}/artifacts/{artifact_id} | Update Artifact
*ChangesApi* | [**changes_list**](docs/ChangesApi.md#changes_list) | **GET** /v0/drives/{drive_id}/changes | List Changes
*DefaultApi* | [**health**](docs/DefaultApi.md#health) | **GET** /health | Health
*DiscoveryApi* | [**oauth_protected_resource**](docs/DiscoveryApi.md#oauth_protected_resource) | **GET** /.well-known/oauth-protected-resource | Protected-resource metadata (RFC 9728)
*DownloadsApi* | [**download_capabilities_create**](docs/DownloadsApi.md#download_capabilities_create) | **POST** /v0/drives/{drive_id}/download-capabilities | Create Download Capability
*DrivesApi* | [**drives_create**](docs/DrivesApi.md#drives_create) | **POST** /v0/drives | Create Drive
*DrivesApi* | [**drives_delete**](docs/DrivesApi.md#drives_delete) | **DELETE** /v0/drives/{drive_id} | Delete Drive
*DrivesApi* | [**drives_list**](docs/DrivesApi.md#drives_list) | **GET** /v0/drives | List Drives
*DrivesApi* | [**drives_read**](docs/DrivesApi.md#drives_read) | **GET** /v0/drives/{drive_id} | Read Drive
*DrivesApi* | [**drives_restore**](docs/DrivesApi.md#drives_restore) | **POST** /v0/drives/{drive_id}/restore | Restore Drive
*DrivesApi* | [**drives_update**](docs/DrivesApi.md#drives_update) | **PATCH** /v0/drives/{drive_id} | Update Drive
*DrivesApi* | [**drives_usage**](docs/DrivesApi.md#drives_usage) | **GET** /v0/drives/{drive_id}/usage | Drive Usage
*FoldersApi* | [**folders_copy**](docs/FoldersApi.md#folders_copy) | **POST** /v0/drives/{drive_id}/folders/{folder_id}/copy | Copy Folder
*FoldersApi* | [**folders_create**](docs/FoldersApi.md#folders_create) | **POST** /v0/drives/{drive_id}/folders | Create Folder
*FoldersApi* | [**folders_delete**](docs/FoldersApi.md#folders_delete) | **DELETE** /v0/drives/{drive_id}/folders/{folder_id} | Delete Folder
*FoldersApi* | [**folders_list**](docs/FoldersApi.md#folders_list) | **GET** /v0/drives/{drive_id}/folders | List Folders
*FoldersApi* | [**folders_read**](docs/FoldersApi.md#folders_read) | **GET** /v0/drives/{drive_id}/folders/{folder_id} | Read Folder
*FoldersApi* | [**folders_restore**](docs/FoldersApi.md#folders_restore) | **POST** /v0/drives/{drive_id}/folders/{folder_id}/restore | Restore Folder
*FoldersApi* | [**folders_update**](docs/FoldersApi.md#folders_update) | **PATCH** /v0/drives/{drive_id}/folders/{folder_id} | Update Folder
*GrantsApi* | [**grants_create**](docs/GrantsApi.md#grants_create) | **POST** /v0/drives/{drive_id}/grants | Create Grant
*GrantsApi* | [**grants_list**](docs/GrantsApi.md#grants_list) | **GET** /v0/drives/{drive_id}/grants | List Grants
*GrantsApi* | [**grants_read**](docs/GrantsApi.md#grants_read) | **GET** /v0/drives/{drive_id}/grants/{grant_id} | Read Grant
*GrantsApi* | [**grants_revoke**](docs/GrantsApi.md#grants_revoke) | **DELETE** /v0/drives/{drive_id}/grants/{grant_id} | Revoke Grant
*GrantsApi* | [**grants_update**](docs/GrantsApi.md#grants_update) | **PATCH** /v0/drives/{drive_id}/grants/{grant_id} | Update Grant
*NavigationApi* | [**entries_list**](docs/NavigationApi.md#entries_list) | **GET** /v0/drives/{drive_id}/entries | List Entries
*NavigationApi* | [**lookup**](docs/NavigationApi.md#lookup) | **GET** /v0/drives/{drive_id}/lookup | Lookup
*SearchApi* | [**drive_search**](docs/SearchApi.md#drive_search) | **GET** /v0/drives/{drive_id}/search | Drive Search
*SharesApi* | [**shares_create**](docs/SharesApi.md#shares_create) | **POST** /v0/drives/{drive_id}/shares | Create Share
*SharesApi* | [**shares_list**](docs/SharesApi.md#shares_list) | **GET** /v0/drives/{drive_id}/shares | List Shares
*SharesApi* | [**shares_read**](docs/SharesApi.md#shares_read) | **GET** /v0/drives/{drive_id}/shares/{share_id} | Read Share
*SharesApi* | [**shares_revoke**](docs/SharesApi.md#shares_revoke) | **DELETE** /v0/drives/{drive_id}/shares/{share_id} | Revoke Share
*SharesApi* | [**shares_rotate**](docs/SharesApi.md#shares_rotate) | **POST** /v0/drives/{drive_id}/shares/{share_id}/rotate | Rotate Share
*SharesRedemptionApi* | [**shares_redeem**](docs/SharesRedemptionApi.md#shares_redeem) | **GET** /s/{share_key} | Redeem Share
*UploadsApi* | [**uploads_complete**](docs/UploadsApi.md#uploads_complete) | **POST** /v0/drives/{drive_id}/uploads/{upload_id}/complete | Complete Upload
*UploadsApi* | [**uploads_create**](docs/UploadsApi.md#uploads_create) | **POST** /v0/drives/{drive_id}/uploads | Begin Upload
*UploadsApi* | [**uploads_delete**](docs/UploadsApi.md#uploads_delete) | **DELETE** /v0/drives/{drive_id}/uploads/{upload_id} | Cancel Upload
*UploadsApi* | [**uploads_read**](docs/UploadsApi.md#uploads_read) | **GET** /v0/drives/{drive_id}/uploads/{upload_id} | Read Upload
*VersionsApi* | [**versions_append**](docs/VersionsApi.md#versions_append) | **POST** /v0/drives/{drive_id}/artifacts/{artifact_id}/versions | Append Version
*VersionsApi* | [**versions_content**](docs/VersionsApi.md#versions_content) | **GET** /v0/drives/{drive_id}/artifacts/{artifact_id}/versions/{version_id}/content | Read Version Content
*VersionsApi* | [**versions_list**](docs/VersionsApi.md#versions_list) | **GET** /v0/drives/{drive_id}/artifacts/{artifact_id}/versions | List Versions
*VersionsApi* | [**versions_read**](docs/VersionsApi.md#versions_read) | **GET** /v0/drives/{drive_id}/artifacts/{artifact_id}/versions/{version_id} | Read Version
*VersionsApi* | [**versions_restore**](docs/VersionsApi.md#versions_restore) | **POST** /v0/drives/{drive_id}/artifacts/{artifact_id}/versions/{version_id}/restore | Restore Version
*ViewerSessionsApi* | [**viewer_sessions_create**](docs/ViewerSessionsApi.md#viewer_sessions_create) | **POST** /v0/drives/{drive_id}/artifacts/{artifact_id}/viewer-sessions | Create Viewer Session


## Documentation For Models

 - [ArtifactCopyIn](docs/ArtifactCopyIn.md)
 - [ArtifactEntryOut](docs/ArtifactEntryOut.md)
 - [ArtifactListOut](docs/ArtifactListOut.md)
 - [ArtifactOut](docs/ArtifactOut.md)
 - [ArtifactUpdateIn](docs/ArtifactUpdateIn.md)
 - [ChangeActorOut](docs/ChangeActorOut.md)
 - [ChangeOut](docs/ChangeOut.md)
 - [ChangePageOut](docs/ChangePageOut.md)
 - [ChangeResourceOut](docs/ChangeResourceOut.md)
 - [DownloadCapabilitiesCreateRequest](docs/DownloadCapabilitiesCreateRequest.md)
 - [DownloadCapabilitiesCreateRequestTarget](docs/DownloadCapabilitiesCreateRequestTarget.md)
 - [DownloadCapabilitiesCreateRequestTargetOneOf](docs/DownloadCapabilitiesCreateRequestTargetOneOf.md)
 - [DownloadCapabilitiesCreateRequestTargetOneOf1](docs/DownloadCapabilitiesCreateRequestTargetOneOf1.md)
 - [DownloadCapabilityOut](docs/DownloadCapabilityOut.md)
 - [DownloadOut](docs/DownloadOut.md)
 - [DownloadTargetOut](docs/DownloadTargetOut.md)
 - [DriveCreateIn](docs/DriveCreateIn.md)
 - [DriveListOut](docs/DriveListOut.md)
 - [DriveOut](docs/DriveOut.md)
 - [DriveUpdateIn](docs/DriveUpdateIn.md)
 - [DriveUsageOut](docs/DriveUsageOut.md)
 - [EntriesInner](docs/EntriesInner.md)
 - [EntryListOut](docs/EntryListOut.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [ErrorResponseError](docs/ErrorResponseError.md)
 - [FolderCascadeOut](docs/FolderCascadeOut.md)
 - [FolderCopyIn](docs/FolderCopyIn.md)
 - [FolderCreateIn](docs/FolderCreateIn.md)
 - [FolderEntryOut](docs/FolderEntryOut.md)
 - [FolderListOut](docs/FolderListOut.md)
 - [FolderOut](docs/FolderOut.md)
 - [FolderUpdateIn](docs/FolderUpdateIn.md)
 - [GrantCreateIn](docs/GrantCreateIn.md)
 - [GrantListOut](docs/GrantListOut.md)
 - [GrantOut](docs/GrantOut.md)
 - [GrantUpdateIn](docs/GrantUpdateIn.md)
 - [HealthDegradedDetail](docs/HealthDegradedDetail.md)
 - [HealthDegradedResponse](docs/HealthDegradedResponse.md)
 - [HealthOut](docs/HealthOut.md)
 - [LookupOut](docs/LookupOut.md)
 - [SearchHitOut](docs/SearchHitOut.md)
 - [SearchPageOut](docs/SearchPageOut.md)
 - [ShareCreateIn](docs/ShareCreateIn.md)
 - [ShareCreateOut](docs/ShareCreateOut.md)
 - [ShareListOut](docs/ShareListOut.md)
 - [ShareOut](docs/ShareOut.md)
 - [Target](docs/Target.md)
 - [UploadBeginOut](docs/UploadBeginOut.md)
 - [UploadChecksumOut](docs/UploadChecksumOut.md)
 - [UploadChunksOut](docs/UploadChunksOut.md)
 - [UploadCleanupOut](docs/UploadCleanupOut.md)
 - [UploadContentOut](docs/UploadContentOut.md)
 - [UploadFailureOut](docs/UploadFailureOut.md)
 - [UploadInitiationOut](docs/UploadInitiationOut.md)
 - [UploadOut](docs/UploadOut.md)
 - [UploadResultOut](docs/UploadResultOut.md)
 - [UploadSessionOut](docs/UploadSessionOut.md)
 - [UploadTargetArtifactOut](docs/UploadTargetArtifactOut.md)
 - [UploadTargetVersionOut](docs/UploadTargetVersionOut.md)
 - [UploadTransferOut](docs/UploadTransferOut.md)
 - [UploadWithTransferOut](docs/UploadWithTransferOut.md)
 - [UploadsCreateRequest](docs/UploadsCreateRequest.md)
 - [UploadsCreateRequestContent](docs/UploadsCreateRequestContent.md)
 - [UploadsCreateRequestContentChecksum](docs/UploadsCreateRequestContentChecksum.md)
 - [UploadsCreateRequestTarget](docs/UploadsCreateRequestTarget.md)
 - [UploadsCreateRequestTargetOneOf](docs/UploadsCreateRequestTargetOneOf.md)
 - [UploadsCreateRequestTargetOneOf1](docs/UploadsCreateRequestTargetOneOf1.md)
 - [V0ErrorEnvelope](docs/V0ErrorEnvelope.md)
 - [ValidationErrorResponse](docs/ValidationErrorResponse.md)
 - [ValidationErrorResponseError](docs/ValidationErrorResponseError.md)
 - [ValidationErrorResponseErrorDetails](docs/ValidationErrorResponseErrorDetails.md)
 - [ValidationErrorResponseErrorDetailsFieldsInner](docs/ValidationErrorResponseErrorDetailsFieldsInner.md)
 - [VersionCreatedOut](docs/VersionCreatedOut.md)
 - [VersionListOut](docs/VersionListOut.md)
 - [VersionOut](docs/VersionOut.md)
 - [ViewerSessionCreateIn](docs/ViewerSessionCreateIn.md)
 - [ViewerSessionCreateOut](docs/ViewerSessionCreateOut.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)


## Author
