Metadata-Version: 2.4
Name: agribackup-sdk
Version: 1.0.0
Summary: AgriBackup Enterprise EUDR API
Home-page: 
Author: AgriBackup Architecture Team
Author-email: AgriBackup Architecture Team <contact@agribackup.com>
License: Proprietary
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,AgriBackup Enterprise EUDR API
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.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# openapi-client
# Introduction

AgriBackup is the cryptographic compliance engine for EU-bound commodity imports. Built on Deterministic Logic, Immutable Evidence, and High-Throughput Ingestion, our API provides Tier-1 enterprise routing for EU Deforestation Regulation (EUDR).

## The Integration Vector
To integrate this Digital Trust Layer into your ERP, you must execute the following sequence:
1. **Authentication:** Generate your `X-API-Key` from the client dashboard.
2. **Telemetry:** Register your webhook URLs via `POST /webhooks`.
3. **Ingestion:** Push your GeoJSON polygons via `POST /polygons`.
4. **Logistics:** Lock the batch to a shipment via `POST /shipments/link`.

## Asynchronous Architecture
Because satellite deforestation screening and Hedera DLT anchoring take time, ingestion endpoints return a `202 Accepted`. You must listen for the corresponding Webhook to confirm cryptographic execution.

## Base URLs
* **Production:** `https://live.agribackup.com`
* **Sandbox:** `https://sandbox.agribackup.com`

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

- API version: v1.0
- Package version: 1.0.0
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://agribackup.com](https://agribackup.com)

## Requirements.

Python 3.10+

## 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 openapi_client
```

### 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 openapi_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.EnterpriseAPIKeysApi(api_client)
    api_key_create_request = openapi_client.ApiKeyCreateRequest() # ApiKeyCreateRequest | 

    try:
        # Generate a new API Key
        api_response = api_instance.create_api_key(api_key_create_request)
        print("The response of EnterpriseAPIKeysApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EnterpriseAPIKeysApi->create_api_key: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://live.agribackup.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EnterpriseAPIKeysApi* | [**create_api_key**](docs/EnterpriseAPIKeysApi.md#create_api_key) | **POST** /api/v1/enterprise/api-keys | Generate a new API Key
*EnterpriseAPIKeysApi* | [**delete_api_key**](docs/EnterpriseAPIKeysApi.md#delete_api_key) | **DELETE** /api/v1/enterprise/api-keys/{keyId} | Delete an API Key
*EnterpriseAPIKeysApi* | [**list_api_keys**](docs/EnterpriseAPIKeysApi.md#list_api_keys) | **GET** /api/v1/enterprise/api-keys | List API Keys
*EnterpriseAPIKeysApi* | [**rotate_api_key**](docs/EnterpriseAPIKeysApi.md#rotate_api_key) | **POST** /api/v1/enterprise/api-keys/{keyId}/rotate | Rotate an API Key
*EnterpriseArchivalApi* | [**download_archive_report**](docs/EnterpriseArchivalApi.md#download_archive_report) | **GET** /api/v1/enterprise/eudr/reports/archive/{reportId}/download | Download Bulk Archive ZIP
*EnterpriseArchivalApi* | [**trigger_archive_report**](docs/EnterpriseArchivalApi.md#trigger_archive_report) | **POST** /api/v1/enterprise/eudr/reports/archive | Generate Bulk Archive Report
*EnterpriseBatchesApi* | [**delete_batch**](docs/EnterpriseBatchesApi.md#delete_batch) | **DELETE** /api/v1/enterprise/eudr/batches/{batchId} | Delete an EUDR batch
*EnterpriseBatchesApi* | [**get_batch_by_id**](docs/EnterpriseBatchesApi.md#get_batch_by_id) | **GET** /api/v1/enterprise/eudr/batches/{batchId} | Get batch by ID
*EnterpriseBatchesApi* | [**get_batches**](docs/EnterpriseBatchesApi.md#get_batches) | **GET** /api/v1/enterprise/eudr/batches | List Batches
*EnterpriseBatchesApi* | [**register_batch**](docs/EnterpriseBatchesApi.md#register_batch) | **POST** /api/v1/enterprise/eudr/batches | Register a consolidated EUDR batch (Async)
*EnterpriseBatchesApi* | [**update_batch**](docs/EnterpriseBatchesApi.md#update_batch) | **PATCH** /api/v1/enterprise/eudr/batches/{batchId} | Update an EUDR batch
*EnterpriseClearanceWebhooksApi* | [**handle_clearance_webhook**](docs/EnterpriseClearanceWebhooksApi.md#handle_clearance_webhook) | **POST** /api/v1/enterprise/eudr/clearance/webhook | Receive TRACES NT Clearance Webhook
*EnterpriseCredentialsApi* | [**delete_traces_credentials**](docs/EnterpriseCredentialsApi.md#delete_traces_credentials) | **DELETE** /api/v1/enterprise/eudr/credentials/traces | Revoke and purge TRACES NT credentials
*EnterpriseCredentialsApi* | [**get_traces_credentials_status**](docs/EnterpriseCredentialsApi.md#get_traces_credentials_status) | **GET** /api/v1/enterprise/eudr/credentials/traces/status | Check TRACES NT credential delegation status
*EnterpriseCredentialsApi* | [**ingest_traces_credentials**](docs/EnterpriseCredentialsApi.md#ingest_traces_credentials) | **POST** /api/v1/enterprise/eudr/credentials/traces | Ingest TRACES NT Credentials into Vault
*EnterpriseDeclarationsApi* | [**generate_dds**](docs/EnterpriseDeclarationsApi.md#generate_dds) | **POST** /api/v1/enterprise/eudr/declarations/dds | Generate Due Diligence Statement (DDS)
*EnterpriseDeclarationsApi* | [**get_dds_payload**](docs/EnterpriseDeclarationsApi.md#get_dds_payload) | **GET** /api/v1/enterprise/eudr/declarations/dds/{referenceId} | Retrieve finalized DDS payload
*EnterpriseDeclarationsApi* | [**list_dds_payloads**](docs/EnterpriseDeclarationsApi.md#list_dds_payloads) | **GET** /api/v1/enterprise/eudr/declarations/dds | List Generated Due Diligence Statements
*EnterpriseDeclarationsApi* | [**revoke_dds**](docs/EnterpriseDeclarationsApi.md#revoke_dds) | **POST** /api/v1/enterprise/eudr/declarations/dds/{referenceId}/revoke | Revoke a submitted DDS
*EnterpriseDeclarationsApi* | [**submit_dds**](docs/EnterpriseDeclarationsApi.md#submit_dds) | **POST** /api/v1/enterprise/eudr/declarations/dds/{referenceId}/submit | Submit DDS to TRACES NT
*EnterpriseDeclarationsApi* | [**upload_document**](docs/EnterpriseDeclarationsApi.md#upload_document) | **POST** /api/v1/enterprise/eudr/declarations/documents/upload | Upload Legal Land Tenure Document
*EnterpriseDiagnosticsApi* | [**check_health**](docs/EnterpriseDiagnosticsApi.md#check_health) | **GET** /api/v1/enterprise/eudr/health | Check infrastructure and service dependency health
*EnterpriseEvidenceApi* | [**get_batch_ledger_evidence**](docs/EnterpriseEvidenceApi.md#get_batch_ledger_evidence) | **GET** /api/v1/enterprise/eudr/evidence/ledger/batch/{batchId} | Retrieve batch cryptographic evidence
*EnterpriseEvidenceApi* | [**get_polygon_ledger_evidence**](docs/EnterpriseEvidenceApi.md#get_polygon_ledger_evidence) | **GET** /api/v1/enterprise/eudr/evidence/ledger/polygon/{polygonId} | Retrieve polygon cryptographic evidence
*EnterpriseEvidenceApi* | [**get_shipment_ledger_evidence**](docs/EnterpriseEvidenceApi.md#get_shipment_ledger_evidence) | **GET** /api/v1/enterprise/eudr/evidence/ledger/shipment/{shipmentId} | Retrieve shipment cryptographic evidence
*EnterpriseJobsApi* | [**cancel_job**](docs/EnterpriseJobsApi.md#cancel_job) | **DELETE** /api/v1/enterprise/eudr/jobs/{jobId} | Halt asynchronous ingestion processing
*EnterpriseJobsApi* | [**get_job_status**](docs/EnterpriseJobsApi.md#get_job_status) | **GET** /api/v1/enterprise/eudr/jobs/{jobId} | Retrieve job status and metrics
*EnterpriseLogisticsApi* | [**link_batch_to_shipment**](docs/EnterpriseLogisticsApi.md#link_batch_to_shipment) | **POST** /api/v1/enterprise/eudr/shipments/link | Cryptographically link a batch to a shipment (Async)
*EnterpriseLogisticsApi* | [**unlink_shipment**](docs/EnterpriseLogisticsApi.md#unlink_shipment) | **DELETE** /api/v1/enterprise/eudr/shipments/{batchId}/shipment/{shipmentId} | Unlink a Batch from a Shipment (EVM Rollback)
*EnterprisePolygonsApi* | [**delete_polygon**](docs/EnterprisePolygonsApi.md#delete_polygon) | **DELETE** /api/v1/enterprise/eudr/polygons/{polygonId} | Delete Polygon
*EnterprisePolygonsApi* | [**get_polygon_status**](docs/EnterprisePolygonsApi.md#get_polygon_status) | **GET** /api/v1/enterprise/eudr/polygons/{polygonId} | Get Polygon compliance status
*EnterprisePolygonsApi* | [**get_polygons**](docs/EnterprisePolygonsApi.md#get_polygons) | **GET** /api/v1/enterprise/eudr/polygons | List Verified Polygons
*EnterprisePolygonsApi* | [**ingest_polygons**](docs/EnterprisePolygonsApi.md#ingest_polygons) | **POST** /api/v1/enterprise/eudr/polygons | Ingest GeoJSON Polygons (Async)
*EnterpriseRiskManagementApi* | [**assess_coordinate_risk**](docs/EnterpriseRiskManagementApi.md#assess_coordinate_risk) | **POST** /api/v1/enterprise/eudr/risk/assess-coordinate | Assess risk by coordinate (Pre-Assessment)
*EnterpriseRiskManagementApi* | [**assess_polygon_risk**](docs/EnterpriseRiskManagementApi.md#assess_polygon_risk) | **POST** /api/v1/enterprise/eudr/risk/assess-polygon | Assess risk by polygon (Pre-Assessment)
*EnterpriseSuppliersApi* | [**get_supplier**](docs/EnterpriseSuppliersApi.md#get_supplier) | **GET** /api/v1/enterprise/eudr/suppliers/{vendorId} | Get Supplier Mapping
*EnterpriseSuppliersApi* | [**list_suppliers**](docs/EnterpriseSuppliersApi.md#list_suppliers) | **GET** /api/v1/enterprise/eudr/suppliers | List Supplier Mappings
*EnterpriseSuppliersApi* | [**register_supplier**](docs/EnterpriseSuppliersApi.md#register_supplier) | **POST** /api/v1/enterprise/eudr/suppliers | Register Supplier Mapping
*EnterpriseWebhooksApi* | [**delete_bulk_dlq_messages**](docs/EnterpriseWebhooksApi.md#delete_bulk_dlq_messages) | **DELETE** /api/v1/enterprise/eudr/webhooks/dlq/bulk | Acknowledge and delete multiple DLQ messages
*EnterpriseWebhooksApi* | [**delete_dlq_message**](docs/EnterpriseWebhooksApi.md#delete_dlq_message) | **DELETE** /api/v1/enterprise/eudr/webhooks/dlq/{eventId} | Acknowledge and delete a DLQ message
*EnterpriseWebhooksApi* | [**delete_webhook**](docs/EnterpriseWebhooksApi.md#delete_webhook) | **DELETE** /api/v1/enterprise/eudr/webhooks/{webhookId} | Delete a Webhook Registration
*EnterpriseWebhooksApi* | [**get_dlq_messages**](docs/EnterpriseWebhooksApi.md#get_dlq_messages) | **GET** /api/v1/enterprise/eudr/webhooks/dlq | Retrieve permanently failed webhook payloads
*EnterpriseWebhooksApi* | [**get_webhooks**](docs/EnterpriseWebhooksApi.md#get_webhooks) | **GET** /api/v1/enterprise/eudr/webhooks | List Active Webhook Subscriptions
*EnterpriseWebhooksApi* | [**ping_webhook**](docs/EnterpriseWebhooksApi.md#ping_webhook) | **POST** /api/v1/enterprise/eudr/webhooks/{webhookId}/ping | Webhook Cryptographic Handshake (Ping)
*EnterpriseWebhooksApi* | [**register_webhook**](docs/EnterpriseWebhooksApi.md#register_webhook) | **POST** /api/v1/enterprise/eudr/webhooks | Register Webhook Endpoint
*EnterpriseWebhooksApi* | [**replay_bulk_dlq_messages**](docs/EnterpriseWebhooksApi.md#replay_bulk_dlq_messages) | **POST** /api/v1/enterprise/eudr/webhooks/dlq/replay-bulk | Replay multiple DLQ messages to the primary exchange
*EnterpriseWebhooksApi* | [**replay_dlq_message**](docs/EnterpriseWebhooksApi.md#replay_dlq_message) | **POST** /api/v1/enterprise/eudr/webhooks/dlq/{eventId}/replay | Replay a DLQ message to the primary exchange
*EnterpriseWebhooksApi* | [**rotate_secret**](docs/EnterpriseWebhooksApi.md#rotate_secret) | **POST** /api/v1/enterprise/eudr/webhooks/{webhookId}/rotate-secret | Rotate Webhook Secret


## Documentation For Models

 - [ApiError](docs/ApiError.md)
 - [ApiErrorDetail](docs/ApiErrorDetail.md)
 - [ApiKeyCreateRequest](docs/ApiKeyCreateRequest.md)
 - [ApiKeyGenerationResponse](docs/ApiKeyGenerationResponse.md)
 - [ArchiveReportRequest](docs/ArchiveReportRequest.md)
 - [ArchiveReportResponse](docs/ArchiveReportResponse.md)
 - [BatchDetailResponse](docs/BatchDetailResponse.md)
 - [BatchRegistrationRequest](docs/BatchRegistrationRequest.md)
 - [BatchRegistrationResponse](docs/BatchRegistrationResponse.md)
 - [BatchUpdateRequest](docs/BatchUpdateRequest.md)
 - [CoordinateRiskAssessmentResponse](docs/CoordinateRiskAssessmentResponse.md)
 - [CoordinateRiskRequest](docs/CoordinateRiskRequest.md)
 - [CopernicusHealth](docs/CopernicusHealth.md)
 - [CredentialIngestionResponse](docs/CredentialIngestionResponse.md)
 - [DdsGenerationRequest](docs/DdsGenerationRequest.md)
 - [DdsRetrievalResponse](docs/DdsRetrievalResponse.md)
 - [DocumentUploadResponse](docs/DocumentUploadResponse.md)
 - [EnterpriseBatchCollectionResponse](docs/EnterpriseBatchCollectionResponse.md)
 - [EnterpriseDdsCollectionResponse](docs/EnterpriseDdsCollectionResponse.md)
 - [EnterpriseJobError](docs/EnterpriseJobError.md)
 - [EnterpriseJobStatusResponse](docs/EnterpriseJobStatusResponse.md)
 - [EnterprisePolygonCollectionResponse](docs/EnterprisePolygonCollectionResponse.md)
 - [EnterpriseSupplierRequest](docs/EnterpriseSupplierRequest.md)
 - [EnterpriseSupplierResponse](docs/EnterpriseSupplierResponse.md)
 - [FeatureProperties](docs/FeatureProperties.md)
 - [GeoJsonFeature](docs/GeoJsonFeature.md)
 - [GeoJsonGeometry](docs/GeoJsonGeometry.md)
 - [HealthResponse](docs/HealthResponse.md)
 - [HealthServices](docs/HealthServices.md)
 - [HederaHealth](docs/HederaHealth.md)
 - [HederaStateProof](docs/HederaStateProof.md)
 - [JobAcceptedResponse](docs/JobAcceptedResponse.md)
 - [LedgerEvidenceResponse](docs/LedgerEvidenceResponse.md)
 - [PolygonIngestionRequest](docs/PolygonIngestionRequest.md)
 - [PolygonRiskRequest](docs/PolygonRiskRequest.md)
 - [PolygonStatusResponse](docs/PolygonStatusResponse.md)
 - [PolygonVerifiedData](docs/PolygonVerifiedData.md)
 - [RiskAuditTrail](docs/RiskAuditTrail.md)
 - [ShipmentLinkRequest](docs/ShipmentLinkRequest.md)
 - [ShipmentLinkedData](docs/ShipmentLinkedData.md)
 - [TracesCredentialRequest](docs/TracesCredentialRequest.md)
 - [TracesCredentialStatusResponse](docs/TracesCredentialStatusResponse.md)
 - [TracesRevocationResponse](docs/TracesRevocationResponse.md)
 - [TracesSubmissionResponse](docs/TracesSubmissionResponse.md)
 - [TracesWebhookPayload](docs/TracesWebhookPayload.md)
 - [VaultHealth](docs/VaultHealth.md)
 - [WebhookDlqBulkRequest](docs/WebhookDlqBulkRequest.md)
 - [WebhookDlqMessage](docs/WebhookDlqMessage.md)
 - [WebhookDlqResponse](docs/WebhookDlqResponse.md)
 - [WebhookPolygonVerifiedPayload](docs/WebhookPolygonVerifiedPayload.md)
 - [WebhookRegistrationRequest](docs/WebhookRegistrationRequest.md)
 - [WebhookRegistrationResponse](docs/WebhookRegistrationResponse.md)
 - [WebhookShipmentLinkedPayload](docs/WebhookShipmentLinkedPayload.md)
 - [WebhookSubscriptionResponse](docs/WebhookSubscriptionResponse.md)


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


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

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header


## Author

contact@agribackup.com


