Metadata-Version: 2.4
Name: cloudbeds_fiscal_document
Version: 1.1.0
Summary: OpenAPI client for Cloudbeds Fiscal Document API.
Author: Cloudbeds
License: The MIT License
        
        Copyright (c) 2025 Cloudbeds (http://cloudbeds.com)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Documentation, https://github.com/cloudbeds/cloudbeds-fiscal-document-python#README
Project-URL: Repository, https://github.com/cloudbeds/cloudbeds-fiscal-document-python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=1.25.3
Requires-Dist: python-dateutil<3.0.0,>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: coverage; extra == "testing"
Dynamic: license-file

# Cloudbeds Fiscal Document
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

- API version: v1
- Package version: 1.1.0
- Generator version: 7.11.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.8+

## Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

* urllib3 >= 1.25.3, < 3.0.0
* python-dateutil >= 2.8.2
* pydantic >= 2
* typing-extensions >= 4.7.1

## Getting Started

In your own code, to use this library to connect and interact with Cloudbeds Fiscal Document,
you can run the following:

```python

import cloudbeds_fiscal_document
from cloudbeds_fiscal_document.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8700
# See configuration.py for a list of all supported configuration parameters.
configuration = cloudbeds_fiscal_document.Configuration(
    host = "http://localhost:8700"
)

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


# Enter a context with an instance of the API client
with cloudbeds_fiscal_document.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cloudbeds_fiscal_document.ConfigsApi(api_client)
    x_property_id = 56 # int | Property id

    try:
        # Get list of fiscal documents configs
        api_response = api_instance.get_configs(x_property_id)
        print("The response of ConfigsApi->get_configs:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConfigsApi->get_configs: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8700*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConfigsApi* | [**get_configs**](cloudbeds_fiscal_document/docs/ConfigsApi.md#get_configs) | **GET** /fiscal-document/v1/configs | Get list of fiscal documents configs
*ConfigsApi* | [**update_configs**](cloudbeds_fiscal_document/docs/ConfigsApi.md#update_configs) | **PUT** /fiscal-document/v1/configs/{documentKind} | 
*FiscalDocumentsApi* | [**create_credit_note**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_credit_note) | **POST** /fiscal-document/v1/fiscal-documents/credit-note | 
*FiscalDocumentsApi* | [**create_invoice**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_invoice) | **POST** /fiscal-document/v1/fiscal-documents/invoice | 
*FiscalDocumentsApi* | [**download_fiscal_document**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#download_fiscal_document) | **GET** /fiscal-document/v1/fiscal-documents/{id}/download | Download fiscal document
*FiscalDocumentsApi* | [**email_fiscal_document**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#email_fiscal_document) | **POST** /fiscal-document/v1/fiscal-documents/{id}/email | Email a fiscal document
*FiscalDocumentsApi* | [**get_fiscal_document_transactions**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_transactions) | **GET** /fiscal-document/v1/fiscal-documents/transactions | Get list of fiscal documents
*FiscalDocumentsApi* | [**get_fiscal_document_transactions_by_id**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_transactions_by_id) | **GET** /fiscal-document/v1/fiscal-documents/{id}/transactions | Get list of transactions for a given fiscal document id
*FiscalDocumentsApi* | [**get_fiscal_documents**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_documents) | **GET** /fiscal-document/v1/fiscal-documents | Get list of fiscal documents
*FiscalDocumentsApi* | [**put_fiscal_document**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#put_fiscal_document) | **PUT** /fiscal-document/v1/fiscal-documents/{id} | 


## Documentation For Models

 - [Action](cloudbeds_fiscal_document/docs/Action.md)
 - [ApiError](cloudbeds_fiscal_document/docs/ApiError.md)
 - [ConfigsResponse](cloudbeds_fiscal_document/docs/ConfigsResponse.md)
 - [ConfigsUpdateRequest](cloudbeds_fiscal_document/docs/ConfigsUpdateRequest.md)
 - [CreateCreditNoteRequest](cloudbeds_fiscal_document/docs/CreateCreditNoteRequest.md)
 - [CreateInvoiceRequest](cloudbeds_fiscal_document/docs/CreateInvoiceRequest.md)
 - [DocumentAction](cloudbeds_fiscal_document/docs/DocumentAction.md)
 - [FiscalDocumentDetailedResponse](cloudbeds_fiscal_document/docs/FiscalDocumentDetailedResponse.md)
 - [FiscalDocumentEmailRequest](cloudbeds_fiscal_document/docs/FiscalDocumentEmailRequest.md)
 - [FiscalDocumentKind](cloudbeds_fiscal_document/docs/FiscalDocumentKind.md)
 - [FiscalDocumentPaginated](cloudbeds_fiscal_document/docs/FiscalDocumentPaginated.md)
 - [FiscalDocumentPatchRequest](cloudbeds_fiscal_document/docs/FiscalDocumentPatchRequest.md)
 - [FiscalDocumentStatus](cloudbeds_fiscal_document/docs/FiscalDocumentStatus.md)
 - [FiscalDocumentSummaryResponse](cloudbeds_fiscal_document/docs/FiscalDocumentSummaryResponse.md)
 - [FiscalDocumentTransactionResponse](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionResponse.md)
 - [FiscalDocumentTransactionsPaginated](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionsPaginated.md)
 - [GovernmentIntegration](cloudbeds_fiscal_document/docs/GovernmentIntegration.md)
 - [GovernmentIntegrationQr](cloudbeds_fiscal_document/docs/GovernmentIntegrationQr.md)
 - [GuestDetails](cloudbeds_fiscal_document/docs/GuestDetails.md)
 - [SourceKind](cloudbeds_fiscal_document/docs/SourceKind.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




