Metadata-Version: 2.4
Name: rekord_sdk
Version: 1.0.7
Summary: Trust Layer API
Home-page: https://github.com/Rekord-io/trust-layer
Author-email: support@rekord.io
Keywords: Swagger,Trust Layer API,Rekord,Rekord.io
Description-Content-Type: text/markdown
Requires-Dist: urllib3>=1.15
Requires-Dist: six>=1.10
Requires-Dist: certifi
Requires-Dist: python-dateutil
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: requires-dist
Dynamic: summary

# rekord_sdk

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

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.6
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage

### pip install

If the python package is hosted on Github, you can install directly from Github

```sh
pip install git+https://github.com/Rekord-io/trust-layer.git
```

(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/Rekord-io/trust-layer.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
```

## Getting Started

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

```python
from __future__ import print_function
import time
import rekord_sdk
from rekord_sdk.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
catalog_id = 'catalog_id_example' # str | Catalog ID
version_id = 'version_id_example' # str | Optional Version ID linked to the catalog (optional)
multichain = NULL # 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)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_catalog_id_proof_get: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
catalog_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Catalog ID to update
body = rekord_sdk.CatalogIdUpdateBody() # CatalogIdUpdateBody |  (optional)
multichain = NULL # object | Optional. When true, returns an alternate response format.  Note: this flag only affects the response shape; it does not change how `blockchain` / `blockchains` are interpreted. (optional)

try:
    # Update catalog
    api_response = api_instance.catalog_catalog_id_update_post(catalog_id, body=body, multichain=multichain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_catalog_id_update_post: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
catalog_id = 'catalog_id_example' # str |

try:
    # List catalog versions
    api_response = api_instance.catalog_catalog_id_versions_get(catalog_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_catalog_id_versions_get: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
body = rekord_sdk.CatalogCreateBody() # CatalogCreateBody |
multichain = NULL # object | Optional. When true, returns an alternate response format.  Note: this flag only affects the response shape; it does not change how `blockchain` / `blockchains` are interpreted. (optional)

try:
    # Create catalog
    api_response = api_instance.catalog_create_post(body, multichain=multichain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_create_post: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
page = 1 # float | Page number (1-indexed). Defaults to 1 when omitted. (optional) (default to 1)
limit = 10 # float | Number of results per page (max 50). Defaults to 10. (optional) (default to 10)

try:
    # List catalogs
    api_response = api_instance.catalog_list_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_list_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

- [AnyOfinlineResponse20010ServicesBody](docs/AnyOfinlineResponse20010ServicesBody.md)
- [AnyOfinlineResponse503ServicesBody](docs/AnyOfinlineResponse503ServicesBody.md)
- [CatalogCreateBody](docs/CatalogCreateBody.md)
- [CatalogIdUpdateBody](docs/CatalogIdUpdateBody.md)
- [CatalogcatalogIdupdateNewProofs](docs/CatalogcatalogIdupdateNewProofs.md)
- [CatalogcatalogIdupdateProofsRemoveBy](docs/CatalogcatalogIdupdateProofsRemoveBy.md)
- [CatalogcreateProofs](docs/CatalogcreateProofs.md)
- [InlineResponse200](docs/InlineResponse200.md)
- [InlineResponse2001](docs/InlineResponse2001.md)
- [InlineResponse20010](docs/InlineResponse20010.md)
- [InlineResponse20010Services](docs/InlineResponse20010Services.md)
- [InlineResponse20011](docs/InlineResponse20011.md)
- [InlineResponse20011Data](docs/InlineResponse20011Data.md)
- [InlineResponse20011DataBlockchainProgress](docs/InlineResponse20011DataBlockchainProgress.md)
- [InlineResponse20011DataTimestamps](docs/InlineResponse20011DataTimestamps.md)
- [InlineResponse20011DataVersion](docs/InlineResponse20011DataVersion.md)
- [InlineResponse20011DataWebhook](docs/InlineResponse20011DataWebhook.md)
- [InlineResponse2001Data](docs/InlineResponse2001Data.md)
- [InlineResponse2001DataCatalogs](docs/InlineResponse2001DataCatalogs.md)
- [InlineResponse2001DataCount](docs/InlineResponse2001DataCount.md)
- [InlineResponse2002](docs/InlineResponse2002.md)
- [InlineResponse2002Data](docs/InlineResponse2002Data.md)
- [InlineResponse2002DataVersion](docs/InlineResponse2002DataVersion.md)
- [InlineResponse2002DataVersionAnchors](docs/InlineResponse2002DataVersionAnchors.md)
- [InlineResponse2002DataVersionVerification](docs/InlineResponse2002DataVersionVerification.md)
- [InlineResponse2003](docs/InlineResponse2003.md)
- [InlineResponse2003Data](docs/InlineResponse2003Data.md)
- [InlineResponse2003DataFiles](docs/InlineResponse2003DataFiles.md)
- [InlineResponse2004](docs/InlineResponse2004.md)
- [InlineResponse2005](docs/InlineResponse2005.md)
- [InlineResponse2005Data](docs/InlineResponse2005Data.md)
- [InlineResponse2006](docs/InlineResponse2006.md)
- [InlineResponse2006Data](docs/InlineResponse2006Data.md)
- [InlineResponse2006DataCatalog](docs/InlineResponse2006DataCatalog.md)
- [InlineResponse2006DataVersions](docs/InlineResponse2006DataVersions.md)
- [InlineResponse2006DataVersionsItems](docs/InlineResponse2006DataVersionsItems.md)
- [InlineResponse2007](docs/InlineResponse2007.md)
- [InlineResponse2007Data](docs/InlineResponse2007Data.md)
- [InlineResponse2008](docs/InlineResponse2008.md)
- [InlineResponse2008Data](docs/InlineResponse2008Data.md)
- [InlineResponse2008DataProof](docs/InlineResponse2008DataProof.md)
- [InlineResponse2008DataStorage](docs/InlineResponse2008DataStorage.md)
- [InlineResponse2009](docs/InlineResponse2009.md)
- [InlineResponse2009Info](docs/InlineResponse2009Info.md)
- [InlineResponse2009Servers](docs/InlineResponse2009Servers.md)
- [InlineResponse200Data](docs/InlineResponse200Data.md)
- [InlineResponse200DataJobs](docs/InlineResponse200DataJobs.md)
- [InlineResponse201](docs/InlineResponse201.md)
- [InlineResponse2011](docs/InlineResponse2011.md)
- [InlineResponse2011Data](docs/InlineResponse2011Data.md)
- [InlineResponse201Data](docs/InlineResponse201Data.md)
- [InlineResponse201DataJobs](docs/InlineResponse201DataJobs.md)
- [InlineResponse201DataPendingVersion](docs/InlineResponse201DataPendingVersion.md)
- [InlineResponse201PendingVersion](docs/InlineResponse201PendingVersion.md)
- [InlineResponse400](docs/InlineResponse400.md)
- [InlineResponse4001](docs/InlineResponse4001.md)
- [InlineResponse4002](docs/InlineResponse4002.md)
- [InlineResponse4003](docs/InlineResponse4003.md)
- [InlineResponse4004](docs/InlineResponse4004.md)
- [InlineResponse4005](docs/InlineResponse4005.md)
- [InlineResponse4006](docs/InlineResponse4006.md)
- [InlineResponse4007](docs/InlineResponse4007.md)
- [InlineResponse4008](docs/InlineResponse4008.md)
- [InlineResponse401](docs/InlineResponse401.md)
- [InlineResponse4011](docs/InlineResponse4011.md)
- [InlineResponse403](docs/InlineResponse403.md)
- [InlineResponse4031](docs/InlineResponse4031.md)
- [InlineResponse404](docs/InlineResponse404.md)
- [InlineResponse4041](docs/InlineResponse4041.md)
- [InlineResponse4042](docs/InlineResponse4042.md)
- [InlineResponse500](docs/InlineResponse500.md)
- [InlineResponse5001](docs/InlineResponse5001.md)
- [InlineResponse5002](docs/InlineResponse5002.md)
- [InlineResponse5003](docs/InlineResponse5003.md)
- [InlineResponse5004](docs/InlineResponse5004.md)
- [InlineResponse5005](docs/InlineResponse5005.md)
- [InlineResponse5006](docs/InlineResponse5006.md)
- [InlineResponse5007](docs/InlineResponse5007.md)
- [InlineResponse5008](docs/InlineResponse5008.md)
- [InlineResponse5009](docs/InlineResponse5009.md)
- [InlineResponse503](docs/InlineResponse503.md)
- [InlineResponse503Services](docs/InlineResponse503Services.md)
- [OneOfinlineResponse2004Data](docs/OneOfinlineResponse2004Data.md)
- [OneOfinlineResponse2007DataVersion](docs/OneOfinlineResponse2007DataVersion.md)
- [VersionIdVerifyBody](docs/VersionIdVerifyBody.md)
- [VersionIdVerifyBody1](docs/VersionIdVerifyBody1.md)

## Documentation For Authorization

## bearerAuth

## Author
