rekord_sdk 1.0.5
Trust Layer API
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Trust Layer API

# rekord-io-sdk
API documentation for Trust Layer front-facing endpoints (Catalogs, Versions, Proofs).

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

- API version: 1.0.0
- Package version: 1.0.5
- Generator version: 7.20.0-SNAPSHOT
- 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/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import rekord_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 rekord_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import rekord_sdk
from rekord_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-dev.rekord.io
# See configuration.py for a list of all supported configuration parameters.
configuration = rekord_sdk.Configuration(
    host = "https://api-dev.rekord.io"
)

# 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 = rekord_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with rekord_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rekord_sdk.CatalogApi(api_client)
    catalog_id = 'catalog_id_example' # str | Catalog ID
    version_id = 'version_id_example' # str | Optional Version ID linked to the catalog (optional)
    multichain = None # object | Optional. When true, returns an alternate response format with additional anchor metadata. (optional)

    try:
        # Get catalog blockchain proof
        api_response = api_instance.catalog_catalog_id_proof_get(catalog_id, version_id=version_id, multichain=multichain)
        print("The response of CatalogApi->catalog_catalog_id_proof_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CatalogApi->catalog_catalog_id_proof_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api-dev.rekord.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CatalogApi* | [**catalog_catalog_id_proof_get**](docs/CatalogApi.md#catalog_catalog_id_proof_get) | **GET** /catalog/{catalogId}/proof | Get catalog blockchain proof
*CatalogApi* | [**catalog_catalog_id_update_post**](docs/CatalogApi.md#catalog_catalog_id_update_post) | **POST** /catalog/{catalogId}/update | Update catalog
*CatalogApi* | [**catalog_catalog_id_versions_get**](docs/CatalogApi.md#catalog_catalog_id_versions_get) | **GET** /catalog/{catalogId}/versions | List catalog versions
*CatalogApi* | [**catalog_create_post**](docs/CatalogApi.md#catalog_create_post) | **POST** /catalog/create | Create catalog
*CatalogApi* | [**catalog_list_get**](docs/CatalogApi.md#catalog_list_get) | **GET** /catalog/list | List catalogs
*JobsApi* | [**jobs_job_id_get**](docs/JobsApi.md#jobs_job_id_get) | **GET** /jobs/{jobId} | Get Job details. Including Status and other attached information. Note: the create callback mainly includes status updates. This is for full details.
*ProofApi* | [**proof_proof_id_get**](docs/ProofApi.md#proof_proof_id_get) | **GET** /proof/{proofId} | Get proof details
*UtilitiesApi* | [**docs_json_get**](docs/UtilitiesApi.md#docs_json_get) | **GET** /docs/json | Get OpenAPI schema
*UtilitiesApi* | [**health_get**](docs/UtilitiesApi.md#health_get) | **GET** /health | Health check
*UtilitiesApi* | [**utilities_chains_get**](docs/UtilitiesApi.md#utilities_chains_get) | **GET** /utilities/chains | List supported blockchains
*VersionApi* | [**version_version_id_get**](docs/VersionApi.md#version_version_id_get) | **GET** /version/{versionId} | Get version details
*VersionApi* | [**version_version_id_proof_get**](docs/VersionApi.md#version_version_id_proof_get) | **GET** /version/{versionId}/proof | Get version proof
*VersionApi* | [**version_version_id_verify_post**](docs/VersionApi.md#version_version_id_verify_post) | **POST** /version/{versionId}/verify | Verify Version membership


## Documentation For Models

 - [AlternateResponseDataWrapper](docs/AlternateResponseDataWrapper.md)
 - [AlternateResponseDataWrapper1](docs/AlternateResponseDataWrapper1.md)
 - [AlternateResponseDataWrapper1Data](docs/AlternateResponseDataWrapper1Data.md)
 - [AlternateResponseDataWrapper1DataJobsInner](docs/AlternateResponseDataWrapper1DataJobsInner.md)
 - [AlternateResponseDataWrapper2](docs/AlternateResponseDataWrapper2.md)
 - [AlternateResponseDataWrapper2Data](docs/AlternateResponseDataWrapper2Data.md)
 - [AlternateResponseDataWrapper3](docs/AlternateResponseDataWrapper3.md)
 - [AlternateResponseDataWrapper3AnchorsInner](docs/AlternateResponseDataWrapper3AnchorsInner.md)
 - [AlternateResponseDataWrapper3Verification](docs/AlternateResponseDataWrapper3Verification.md)
 - [AlternateResponseDataWrapperData](docs/AlternateResponseDataWrapperData.md)
 - [AlternateResponseDataWrapperDataJobsInner](docs/AlternateResponseDataWrapperDataJobsInner.md)
 - [AlternateResponseDataWrapperDataPendingVersion](docs/AlternateResponseDataWrapperDataPendingVersion.md)
 - [AlternateResponseExtendedAnchorMetadata](docs/AlternateResponseExtendedAnchorMetadata.md)
 - [AlternateResponseExtendedAnchorMetadataAnchorsInner](docs/AlternateResponseExtendedAnchorMetadataAnchorsInner.md)
 - [AlternateResponseExtendedAnchorMetadataVerification](docs/AlternateResponseExtendedAnchorMetadataVerification.md)
 - [BYTESBASE64](docs/BYTESBASE64.md)
 - [BYTESBASE641](docs/BYTESBASE641.md)
 - [BYTESBASE642](docs/BYTESBASE642.md)
 - [CatalogCatalogIdProofGet200Response](docs/CatalogCatalogIdProofGet200Response.md)
 - [CatalogCatalogIdProofGet200ResponseData](docs/CatalogCatalogIdProofGet200ResponseData.md)
 - [CatalogCatalogIdProofGet200ResponseDataVersion](docs/CatalogCatalogIdProofGet200ResponseDataVersion.md)
 - [CatalogCatalogIdProofGet200ResponseDataVersionAnchorsInner](docs/CatalogCatalogIdProofGet200ResponseDataVersionAnchorsInner.md)
 - [CatalogCatalogIdProofGet200ResponseDataVersionVerification](docs/CatalogCatalogIdProofGet200ResponseDataVersionVerification.md)
 - [CatalogCatalogIdProofGet400Response](docs/CatalogCatalogIdProofGet400Response.md)
 - [CatalogCatalogIdProofGet404Response](docs/CatalogCatalogIdProofGet404Response.md)
 - [CatalogCatalogIdProofGet500Response](docs/CatalogCatalogIdProofGet500Response.md)
 - [CatalogCatalogIdUpdatePost200Response](docs/CatalogCatalogIdUpdatePost200Response.md)
 - [CatalogCatalogIdUpdatePost201Response](docs/CatalogCatalogIdUpdatePost201Response.md)
 - [CatalogCatalogIdUpdatePost400Response](docs/CatalogCatalogIdUpdatePost400Response.md)
 - [CatalogCatalogIdUpdatePost500Response](docs/CatalogCatalogIdUpdatePost500Response.md)
 - [CatalogCatalogIdUpdatePostRequest](docs/CatalogCatalogIdUpdatePostRequest.md)
 - [CatalogCatalogIdUpdatePostRequestNewProofsInner](docs/CatalogCatalogIdUpdatePostRequestNewProofsInner.md)
 - [CatalogCatalogIdUpdatePostRequestProofsRemoveByInner](docs/CatalogCatalogIdUpdatePostRequestProofsRemoveByInner.md)
 - [CatalogCatalogIdVersionsGet200Response](docs/CatalogCatalogIdVersionsGet200Response.md)
 - [CatalogCatalogIdVersionsGet200ResponseData](docs/CatalogCatalogIdVersionsGet200ResponseData.md)
 - [CatalogCatalogIdVersionsGet200ResponseDataCatalog](docs/CatalogCatalogIdVersionsGet200ResponseDataCatalog.md)
 - [CatalogCatalogIdVersionsGet200ResponseDataVersions](docs/CatalogCatalogIdVersionsGet200ResponseDataVersions.md)
 - [CatalogCatalogIdVersionsGet200ResponseDataVersionsItemsInner](docs/CatalogCatalogIdVersionsGet200ResponseDataVersionsItemsInner.md)
 - [CatalogCatalogIdVersionsGet400Response](docs/CatalogCatalogIdVersionsGet400Response.md)
 - [CatalogCatalogIdVersionsGet500Response](docs/CatalogCatalogIdVersionsGet500Response.md)
 - [CatalogCreatePost201Response](docs/CatalogCreatePost201Response.md)
 - [CatalogCreatePost400Response](docs/CatalogCreatePost400Response.md)
 - [CatalogCreatePost401Response](docs/CatalogCreatePost401Response.md)
 - [CatalogCreatePost403Response](docs/CatalogCreatePost403Response.md)
 - [CatalogCreatePost500Response](docs/CatalogCreatePost500Response.md)
 - [CatalogCreatePostRequest](docs/CatalogCreatePostRequest.md)
 - [CatalogCreatePostRequestProofsInner](docs/CatalogCreatePostRequestProofsInner.md)
 - [CatalogListGet200Response](docs/CatalogListGet200Response.md)
 - [CatalogListGet200ResponseData](docs/CatalogListGet200ResponseData.md)
 - [CatalogListGet200ResponseDataCatalogsInner](docs/CatalogListGet200ResponseDataCatalogsInner.md)
 - [CatalogListGet200ResponseDataCount](docs/CatalogListGet200ResponseDataCount.md)
 - [CatalogListGet400Response](docs/CatalogListGet400Response.md)
 - [CatalogListGet500Response](docs/CatalogListGet500Response.md)
 - [DefaultResponseRecommended](docs/DefaultResponseRecommended.md)
 - [DefaultResponseRecommended1](docs/DefaultResponseRecommended1.md)
 - [DefaultResponseRecommended2](docs/DefaultResponseRecommended2.md)
 - [DefaultResponseRecommended3](docs/DefaultResponseRecommended3.md)
 - [DefaultResponseRecommended4](docs/DefaultResponseRecommended4.md)
 - [DefaultResponseRecommended4AnchorsInner](docs/DefaultResponseRecommended4AnchorsInner.md)
 - [DefaultResponseRecommended4CatalogOwner](docs/DefaultResponseRecommended4CatalogOwner.md)
 - [DefaultResponseRecommended4Components](docs/DefaultResponseRecommended4Components.md)
 - [DefaultResponseRecommended4ComponentsItemsInner](docs/DefaultResponseRecommended4ComponentsItemsInner.md)
 - [DefaultResponseRecommended4Proofs](docs/DefaultResponseRecommended4Proofs.md)
 - [DefaultResponseRecommended4ProofsItemsInner](docs/DefaultResponseRecommended4ProofsItemsInner.md)
 - [DefaultResponseRecommended4Tree](docs/DefaultResponseRecommended4Tree.md)
 - [DefaultResponseRecommendedPendingVersion](docs/DefaultResponseRecommendedPendingVersion.md)
 - [DocsJsonGet200Response](docs/DocsJsonGet200Response.md)
 - [DocsJsonGet200ResponseInfo](docs/DocsJsonGet200ResponseInfo.md)
 - [DocsJsonGet200ResponseServersInner](docs/DocsJsonGet200ResponseServersInner.md)
 - [FILEREF](docs/FILEREF.md)
 - [FILEREF1](docs/FILEREF1.md)
 - [HealthGet200Response](docs/HealthGet200Response.md)
 - [HealthGet200ResponseServicesInner](docs/HealthGet200ResponseServicesInner.md)
 - [HealthGet200ResponseServicesInnerBody](docs/HealthGet200ResponseServicesInnerBody.md)
 - [HealthGet503Response](docs/HealthGet503Response.md)
 - [HealthGet503ResponseServicesInner](docs/HealthGet503ResponseServicesInner.md)
 - [HealthGet503ResponseServicesInnerBody](docs/HealthGet503ResponseServicesInnerBody.md)
 - [JSON1](docs/JSON1.md)
 - [JSON2](docs/JSON2.md)
 - [JobsJobIdGet200Response](docs/JobsJobIdGet200Response.md)
 - [JobsJobIdGet200ResponseOneOf](docs/JobsJobIdGet200ResponseOneOf.md)
 - [JobsJobIdGet200ResponseOneOfData](docs/JobsJobIdGet200ResponseOneOfData.md)
 - [JobsJobIdGet200ResponseOneOfDataBlockchainProgress](docs/JobsJobIdGet200ResponseOneOfDataBlockchainProgress.md)
 - [JobsJobIdGet200ResponseOneOfDataTimestamps](docs/JobsJobIdGet200ResponseOneOfDataTimestamps.md)
 - [JobsJobIdGet200ResponseOneOfDataVersion](docs/JobsJobIdGet200ResponseOneOfDataVersion.md)
 - [JobsJobIdGet200ResponseOneOfDataWebhook](docs/JobsJobIdGet200ResponseOneOfDataWebhook.md)
 - [JobsJobIdGet400Response](docs/JobsJobIdGet400Response.md)
 - [JobsJobIdGet401Response](docs/JobsJobIdGet401Response.md)
 - [JobsJobIdGet403Response](docs/JobsJobIdGet403Response.md)
 - [JobsJobIdGet404Response](docs/JobsJobIdGet404Response.md)
 - [JobsJobIdGet500Response](docs/JobsJobIdGet500Response.md)
 - [ModelJSON](docs/ModelJSON.md)
 - [ProofProofIdGet200Response](docs/ProofProofIdGet200Response.md)
 - [ProofProofIdGet200ResponseData](docs/ProofProofIdGet200ResponseData.md)
 - [ProofProofIdGet200ResponseDataProof](docs/ProofProofIdGet200ResponseDataProof.md)
 - [ProofProofIdGet200ResponseDataStorage](docs/ProofProofIdGet200ResponseDataStorage.md)
 - [ProofProofIdGet400Response](docs/ProofProofIdGet400Response.md)
 - [ProofProofIdGet404Response](docs/ProofProofIdGet404Response.md)
 - [ProofProofIdGet500Response](docs/ProofProofIdGet500Response.md)
 - [TEXT](docs/TEXT.md)
 - [TEXT1](docs/TEXT1.md)
 - [TEXT2](docs/TEXT2.md)
 - [UtilitiesChainsGet200Response](docs/UtilitiesChainsGet200Response.md)
 - [UtilitiesChainsGet200ResponseData](docs/UtilitiesChainsGet200ResponseData.md)
 - [VersionVersionIdGet200Response](docs/VersionVersionIdGet200Response.md)
 - [VersionVersionIdGet200ResponseData](docs/VersionVersionIdGet200ResponseData.md)
 - [VersionVersionIdGet200ResponseDataVersion](docs/VersionVersionIdGet200ResponseDataVersion.md)
 - [VersionVersionIdGet500Response](docs/VersionVersionIdGet500Response.md)
 - [VersionVersionIdProofGet200Response](docs/VersionVersionIdProofGet200Response.md)
 - [VersionVersionIdProofGet200ResponseData](docs/VersionVersionIdProofGet200ResponseData.md)
 - [VersionVersionIdProofGet400Response](docs/VersionVersionIdProofGet400Response.md)
 - [VersionVersionIdProofGet500Response](docs/VersionVersionIdProofGet500Response.md)
 - [VersionVersionIdVerifyPost200Response](docs/VersionVersionIdVerifyPost200Response.md)
 - [VersionVersionIdVerifyPost200ResponseData](docs/VersionVersionIdVerifyPost200ResponseData.md)
 - [VersionVersionIdVerifyPost200ResponseDataFilesInner](docs/VersionVersionIdVerifyPost200ResponseDataFilesInner.md)
 - [VersionVersionIdVerifyPost400Response](docs/VersionVersionIdVerifyPost400Response.md)
 - [VersionVersionIdVerifyPost500Response](docs/VersionVersionIdVerifyPost500Response.md)
 - [VersionVersionIdVerifyPostRequest](docs/VersionVersionIdVerifyPostRequest.md)
 - [VersionVersionIdVerifyPostRequestAnyOf](docs/VersionVersionIdVerifyPostRequestAnyOf.md)
 - [XML](docs/XML.md)
 - [XML1](docs/XML1.md)
 - [XML2](docs/XML2.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