Metadata-Version: 2.4
Name: tachain_sdk
Version: 0.1.0
Summary: Tactic Chain Public API
Home-page: https://github.com/ta-chain/tachain-sdk
Author: Tactic Chain contributors
License-Expression: MIT
Project-URL: Repository, https://github.com/ta-chain/tachain-sdk
Keywords: OpenAPI,OpenAPI-Generator,Tactic Chain Public API
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: home-page
Dynamic: license-file

# tachain-sdk
Public integration endpoints. Set your own base URL and credential before calling.

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

- API version: 1.0.0
- Package version: 0.1.0
- Generator version: 7.25.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## 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/ta-chain/tachain-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ta-chain/tachain-sdk.git`)

Then import the package:
```python
import tachain_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 tachain_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import tachain_sdk
from tachain_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.example.com
# See configuration.py for a list of all supported configuration parameters.
configuration = tachain_sdk.Configuration(
    host = "https://api.example.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Configure API key authorization: Signature
configuration.api_key['Signature'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Signature'] = 'Bearer'

# Configure Bearer authorization: BearerToken
configuration = tachain_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: Timestamp
configuration.api_key['Timestamp'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Timestamp'] = 'Bearer'


# Enter a context with an instance of the API client
with tachain_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tachain_sdk.ApiDeclarationApi(api_client)
    x_credential_type = 'x_credential_type_example' # str | Use 'Token' with bearer authorization, or 'API Key' with signed API key headers. This header is mandatory in the deployed API.
    attachment_id = 'attachment_id_example' # str | query 方式传入的单个附件申报 ID。 (optional)
    form_data_id = 'form_data_id_example' # str | query 方式传入的单个表单申报 ID。 (optional)
    tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request = tachain_sdk.TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest() # TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest |  (optional)

    try:
        # 申报信息删除接口。
        api_response = api_instance.delete_v1_declaration_delete(x_credential_type, attachment_id=attachment_id, form_data_id=form_data_id, tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request=tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request)
        print("The response of ApiDeclarationApi->delete_v1_declaration_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiDeclarationApi->delete_v1_declaration_delete: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.example.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiDeclarationApi* | [**delete_v1_declaration_delete**](docs/ApiDeclarationApi.md#delete_v1_declaration_delete) | **DELETE** /v1/declaration/Delete | 申报信息删除接口。
*ApiDeclarationApi* | [**get_v1_declaration_list_paging**](docs/ApiDeclarationApi.md#get_v1_declaration_list_paging) | **GET** /v1/declaration/ListPaging | 申报信息查询接口。
*ApiDeclarationApi* | [**get_v1_declaration_required_documents**](docs/ApiDeclarationApi.md#get_v1_declaration_required_documents) | **GET** /v1/declaration/RequiredDocuments | 单据所需申报信息查询接口。
*ApiDeclarationApi* | [**post_v1_declaration_submit**](docs/ApiDeclarationApi.md#post_v1_declaration_submit) | **POST** /v1/declaration/Submit | 申报文件/表单提交接口。
*ApiDeliveryApi* | [**delete_v1_delivery_delete**](docs/ApiDeliveryApi.md#delete_v1_delivery_delete) | **DELETE** /v1/delivery/Delete | 删除发货单。
*ApiDeliveryApi* | [**get_v1_delivery_list_paging**](docs/ApiDeliveryApi.md#get_v1_delivery_list_paging) | **GET** /v1/delivery/ListPaging | 查询发货单信息及明细信息。
*ApiDeliveryApi* | [**get_v1_delivery_receipt_list_paging**](docs/ApiDeliveryApi.md#get_v1_delivery_receipt_list_paging) | **GET** /v1/delivery/ReceiptListPaging | 查询收货单集合，核对收货信息。
*ApiDeliveryApi* | [**post_v1_delivery_create**](docs/ApiDeliveryApi.md#post_v1_delivery_create) | **POST** /v1/delivery/Create | 创建发货单。
*ApiDeliveryApi* | [**put_v1_delivery_confirm_receipt**](docs/ApiDeliveryApi.md#put_v1_delivery_confirm_receipt) | **PUT** /v1/delivery/ConfirmReceipt | 确认收货。
*ApiDeliveryApi* | [**put_v1_delivery_return_receipt**](docs/ApiDeliveryApi.md#put_v1_delivery_return_receipt) | **PUT** /v1/delivery/ReturnReceipt | 收货退回。
*ApiDeliveryApi* | [**put_v1_delivery_update**](docs/ApiDeliveryApi.md#put_v1_delivery_update) | **PUT** /v1/delivery/Update | 修改发货单。
*ApiEnumApi* | [**get_v1_enum_get_list**](docs/ApiEnumApi.md#get_v1_enum_get_list) | **GET** /v1/enum/GetList | 第三方-获取统一枚举列表（支持批量查询/查询所有）
*ApiOrderApi* | [**delete_v1_order_delete**](docs/ApiOrderApi.md#delete_v1_order_delete) | **DELETE** /v1/order/Delete | 第三方-更新订单状态（通过匹配条件获取订单ID）
*ApiOrderApi* | [**delete_v1_order_delete_line**](docs/ApiOrderApi.md#delete_v1_order_delete_line) | **DELETE** /v1/order/DeleteLine | 第三方-更新订单明细状态（通过匹配条件获取明细ID）
*ApiOrderApi* | [**get_v1_order_po_list_paging**](docs/ApiOrderApi.md#get_v1_order_po_list_paging) | **GET** /v1/order/POListPaging | 第三方-获取采购订单分页列表（含明细）
*ApiOrderApi* | [**get_v1_order_so_list_paging**](docs/ApiOrderApi.md#get_v1_order_so_list_paging) | **GET** /v1/order/SOListPaging | 第三方-获取销售订单分页列表（含明细）
*ApiOrderApi* | [**post_v1_order_create**](docs/ApiOrderApi.md#post_v1_order_create) | **POST** /v1/order/Create | 第三方-创建订单（含明细）
*ApiOrderApi* | [**post_v1_order_so_accept**](docs/ApiOrderApi.md#post_v1_order_so_accept) | **POST** /v1/order/SoAccept | 第三方-销售订单接单（支持绑定成品/自动创建成品）
*ApiOrderApi* | [**put_v1_order_update**](docs/ApiOrderApi.md#put_v1_order_update) | **PUT** /v1/order/Update | 第三方-更新订单（部分字段）
*ApiOrderWorkflowApi* | [**post_v1_order_submit_audit**](docs/ApiOrderWorkflowApi.md#post_v1_order_submit_audit) | **POST** /v1/order/SubmitAudit | 销售方根据已入库的订单、生产、发货及申报资料提交审核。
*ApiOrderWorkflowApi* | [**put_v1_order_confirm_receipt**](docs/ApiOrderWorkflowApi.md#put_v1_order_confirm_receipt) | **PUT** /v1/order/ConfirmReceipt | 采购方按整单或单条订单明细确认收货。
*ApiProductionApi* | [**delete_v1_production_delete**](docs/ApiProductionApi.md#delete_v1_production_delete) | **DELETE** /v1/production/Delete | 删除生产记录单。
*ApiProductionApi* | [**get_v1_production_list_paging**](docs/ApiProductionApi.md#get_v1_production_list_paging) | **GET** /v1/production/ListPaging | 查询生产记录单及详细领料信息。
*ApiProductionApi* | [**post_v1_production_create**](docs/ApiProductionApi.md#post_v1_production_create) | **POST** /v1/production/Create | 创建生产记录单。
*ApiProductionApi* | [**put_v1_production_update**](docs/ApiProductionApi.md#put_v1_production_update) | **PUT** /v1/production/Update | 修改生产记录单。


## Documentation For Models

 - [GetV1EnumGetList200Response](docs/GetV1EnumGetList200Response.md)
 - [MicrosoftAspNetCoreMvcProblemDetails](docs/MicrosoftAspNetCoreMvcProblemDetails.md)
 - [Model1](docs/Model1.md)
 - [Model3](docs/Model3.md)
 - [Model4](docs/Model4.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest](docs/TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDocumentRequest](docs/TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDocumentRequest.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListDto](docs/TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListDto.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitRequest](docs/TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitRequest.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResultDto](docs/TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResultDto.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiIntegrationDeleteRequest](docs/TacticChainApiServiceControllersApiIntegrationV1ApiIntegrationDeleteRequest.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiOrderConfirmReceiptRequest](docs/TacticChainApiServiceControllersApiIntegrationV1ApiOrderConfirmReceiptRequest.md)
 - [TacticChainApiServiceControllersApiIntegrationV1ApiOrderSubmitAuditRequest](docs/TacticChainApiServiceControllersApiIntegrationV1ApiOrderSubmitAuditRequest.md)
 - [TacticChainApiServiceDataEntitiesCompany](docs/TacticChainApiServiceDataEntitiesCompany.md)
 - [TacticChainApiServiceDataEntitiesCompanyComplianceProfile](docs/TacticChainApiServiceDataEntitiesCompanyComplianceProfile.md)
 - [TacticChainApiServiceDataEntitiesCompanyUtilityDeclaration](docs/TacticChainApiServiceDataEntitiesCompanyUtilityDeclaration.md)
 - [TacticChainApiServiceDataEntitiesCustomer](docs/TacticChainApiServiceDataEntitiesCustomer.md)
 - [TacticChainApiServiceDataEntitiesFactory](docs/TacticChainApiServiceDataEntitiesFactory.md)
 - [TacticChainApiServiceDataEntitiesOrder](docs/TacticChainApiServiceDataEntitiesOrder.md)
 - [TacticChainApiServiceDataEntitiesOrderLine](docs/TacticChainApiServiceDataEntitiesOrderLine.md)
 - [TacticChainApiServiceDataEntitiesSupplier](docs/TacticChainApiServiceDataEntitiesSupplier.md)
 - [TacticChainApiServiceDataEntitiesSupplierOnboardingExt](docs/TacticChainApiServiceDataEntitiesSupplierOnboardingExt.md)
 - [TacticChainApiServiceDataEntitiesTrader](docs/TacticChainApiServiceDataEntitiesTrader.md)
 - [TacticChainApiServiceHelperResultApiEnum](docs/TacticChainApiServiceHelperResultApiEnum.md)
 - [TacticChainApiServiceHelperResultBrandReportAllocatedDeliveryKpiDetail](docs/TacticChainApiServiceHelperResultBrandReportAllocatedDeliveryKpiDetail.md)
 - [TacticChainApiServiceHelperResultBrandReportUnlinkedOrderDetail](docs/TacticChainApiServiceHelperResultBrandReportUnlinkedOrderDetail.md)
 - [TacticChainApiServiceHelperResultKpiArchivedDataChangeDetail](docs/TacticChainApiServiceHelperResultKpiArchivedDataChangeDetail.md)
 - [TacticChainApiServiceHelperResultMappingOrderSelect](docs/TacticChainApiServiceHelperResultMappingOrderSelect.md)
 - [TacticChainApiServiceHelperResultOrderTraceReport](docs/TacticChainApiServiceHelperResultOrderTraceReport.md)
 - [TacticChainApiServiceHelperTemplateDtoBusinessRiskWarnInfoDto](docs/TacticChainApiServiceHelperTemplateDtoBusinessRiskWarnInfoDto.md)
 - [TacticChainApiServiceHelperTemplateDtoMultiSoLineCompleteStatus](docs/TacticChainApiServiceHelperTemplateDtoMultiSoLineCompleteStatus.md)
 - [TacticChainApiServiceModelsBrandKpiPolicyResult](docs/TacticChainApiServiceModelsBrandKpiPolicyResult.md)
 - [TacticChainApiServiceModelsBrandOrderKpiSnapshotDto](docs/TacticChainApiServiceModelsBrandOrderKpiSnapshotDto.md)
 - [TacticChainApiServiceModelsBrandOrderSupplierOrderSnapshotDto](docs/TacticChainApiServiceModelsBrandOrderSupplierOrderSnapshotDto.md)
 - [TacticChainApiServiceModelsBrandOrderUncompletedDeclareSnapshotDto](docs/TacticChainApiServiceModelsBrandOrderUncompletedDeclareSnapshotDto.md)
 - [TacticChainApiServiceModelsOrderStageFormDto](docs/TacticChainApiServiceModelsOrderStageFormDto.md)
 - [TacticChainApiServiceModelsProductBomGroupingDto](docs/TacticChainApiServiceModelsProductBomGroupingDto.md)
 - [TacticChainApiServiceModelsProductionRawMaterialDto](docs/TacticChainApiServiceModelsProductionRawMaterialDto.md)
 - [TacticChainApiServiceViewModelsAttachmentInApiCreateDto](docs/TacticChainApiServiceViewModelsAttachmentInApiCreateDto.md)
 - [TacticChainApiServiceViewModelsAttachmentInApiDto](docs/TacticChainApiServiceViewModelsAttachmentInApiDto.md)
 - [TacticChainApiServiceViewModelsCommonApiResponse1SystemStringSystemPrivateCoreLibVersion9000CultureNeutralPublicKeyToken7cec85d7bea7798e](docs/TacticChainApiServiceViewModelsCommonApiResponse1SystemStringSystemPrivateCoreLibVersion9000CultureNeutralPublicKeyToken7cec85d7bea7798e.md)
 - [TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResultDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResultDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsDeliveryNoteApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsDeliveryNoteApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsOrderApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsOrderApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsProductionApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsProductionApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsDeliveryNoteApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsDeliveryNoteApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsOrderApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsOrderApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsProductionApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull](docs/TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsProductionApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull.md)
 - [TacticChainApiServiceViewModelsDeliveryNoteApiDto](docs/TacticChainApiServiceViewModelsDeliveryNoteApiDto.md)
 - [TacticChainApiServiceViewModelsDeliveryNoteDetailApiDto](docs/TacticChainApiServiceViewModelsDeliveryNoteDetailApiDto.md)
 - [TacticChainApiServiceViewModelsDocumentTypeApiDto](docs/TacticChainApiServiceViewModelsDocumentTypeApiDto.md)
 - [TacticChainApiServiceViewModelsOrderApiDto](docs/TacticChainApiServiceViewModelsOrderApiDto.md)
 - [TacticChainApiServiceViewModelsOrderLineApiDto](docs/TacticChainApiServiceViewModelsOrderLineApiDto.md)
 - [TacticChainApiServiceViewModelsOrderStageFormApiDto](docs/TacticChainApiServiceViewModelsOrderStageFormApiDto.md)
 - [TacticChainApiServiceViewModelsOrderStageFormDatumApiDto](docs/TacticChainApiServiceViewModelsOrderStageFormDatumApiDto.md)
 - [TacticChainApiServiceViewModelsProductionApiDto](docs/TacticChainApiServiceViewModelsProductionApiDto.md)
 - [TacticChainApiServiceViewModelsProductionRawMaterialApiDto](docs/TacticChainApiServiceViewModelsProductionRawMaterialApiDto.md)
 - [TacticChainApiServiceViewModelsProductionSalesOrderApiDto](docs/TacticChainApiServiceViewModelsProductionSalesOrderApiDto.md)
 - [TacticChainApiServiceViewModelsStageAttachmentApiDto](docs/TacticChainApiServiceViewModelsStageAttachmentApiDto.md)


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


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

- **Type**: Bearer authentication

<a id="ApiKey"></a>
### ApiKey

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

<a id="Timestamp"></a>
### Timestamp

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

<a id="Signature"></a>
### Signature

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


## Author




