cloudbeds-fiscal-document 1.9.1__py3-none-any.whl → 1.10.0__py3-none-any.whl

cloudbeds_fiscal_document/models/preview_request.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from cloudbeds_fiscal_document.models.fiscal_document_kind import FiscalDocumentKind
+from cloudbeds_fiscal_document.models.recipient_type import RecipientType
+from cloudbeds_fiscal_document.models.source_kind import SourceKind
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PreviewRequest(BaseModel):
+    """
+    PreviewRequest
+    """ # noqa: E501
+    document_kind: Optional[FiscalDocumentKind] = Field(default=None, alias="documentKind")
+    source_kind: Optional[SourceKind] = Field(default=None, alias="sourceKind")
+    recipient_type: Optional[RecipientType] = Field(default=None, alias="recipientType")
+    include_vat: Optional[StrictBool] = Field(default=False, description="Include VAT tax breakdown section in preview", alias="includeVat")
+    include_payments: Optional[StrictBool] = Field(default=True, description="Include payment transactions section in preview", alias="includePayments")
+    include_room_number: Optional[StrictBool] = Field(default=True, description="Include room number column in reservation previews", alias="includeRoomNumber")
+    preview_watermark: Optional[StrictBool] = Field(default=True, description="Show preview watermark on the document", alias="previewWatermark")
+    __properties: ClassVar[List[str]] = ["documentKind", "sourceKind", "recipientType", "includeVat", "includePayments", "includeRoomNumber", "previewWatermark"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PreviewRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PreviewRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "documentKind": obj.get("documentKind"),
+            "sourceKind": obj.get("sourceKind"),
+            "recipientType": obj.get("recipientType"),
+            "includeVat": obj.get("includeVat") if obj.get("includeVat") is not None else False,
+            "includePayments": obj.get("includePayments") if obj.get("includePayments") is not None else True,
+            "includeRoomNumber": obj.get("includeRoomNumber") if obj.get("includeRoomNumber") is not None else True,
+            "previewWatermark": obj.get("previewWatermark") if obj.get("previewWatermark") is not None else True
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/property_configs_response.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from cloudbeds_fiscal_document.models.configs_response import ConfigsResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PropertyConfigsResponse(BaseModel):
+    """
+    PropertyConfigsResponse
+    """ # noqa: E501
+    configs: Optional[Dict[str, ConfigsResponse]] = Field(default=None, description="Map of document kind to fiscal document configuration")
+    __properties: ClassVar[List[str]] = ["configs"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PropertyConfigsResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each value in configs (dict)
+        _field_dict = {}
+        if self.configs:
+            for _key_configs in self.configs:
+                if self.configs[_key_configs]:
+                    _field_dict[_key_configs] = self.configs[_key_configs].to_dict()
+            _dict['configs'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PropertyConfigsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "configs": dict(
+                (_k, ConfigsResponse.from_dict(_v))
+                for _k, _v in obj["configs"].items()
+            )
+            if obj.get("configs") is not None
+            else None
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/single_allocation.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SingleAllocation(BaseModel):
+    """
+    SingleAllocation
+    """ # noqa: E501
+    transaction_id: Optional[StrictInt] = None
+    allocated_amount: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["transaction_id", "allocated_amount"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SingleAllocation from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SingleAllocation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "transaction_id": obj.get("transaction_id"),
+            "allocated_amount": obj.get("allocated_amount")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/test/test_allocations_data.py

@@ -0,0 +1,59 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from cloudbeds_fiscal_document.models.allocations_data import AllocationsData
+
+class TestAllocationsData(unittest.TestCase):
+    """AllocationsData unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AllocationsData:
+        """Test AllocationsData
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `AllocationsData`
+        """
+        model = AllocationsData()
+        if include_optional:
+            return AllocationsData(
+                receipt_id = 8878321883381,
+                source_id = 8878321883383,
+                source_identifier = 'HGJXJF',
+                source_kind = 'GROUP_PROFILE',
+                allocations = [
+                    cloudbeds_fiscal_document.models.single_allocation.SingleAllocation(
+                        transaction_id = 8878321883388, 
+                        allocated_amount = 3.68, )
+                    ]
+            )
+        else:
+            return AllocationsData(
+        )
+        """
+
+    def testAllocationsData(self):
+        """Test AllocationsData"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_fiscal_document_transaction_allocation.py

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from cloudbeds_fiscal_document.models.fiscal_document_transaction_allocation import FiscalDocumentTransactionAllocation
+
+class TestFiscalDocumentTransactionAllocation(unittest.TestCase):
+    """FiscalDocumentTransactionAllocation unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> FiscalDocumentTransactionAllocation:
+        """Test FiscalDocumentTransactionAllocation
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `FiscalDocumentTransactionAllocation`
+        """
+        model = FiscalDocumentTransactionAllocation()
+        if include_optional:
+            return FiscalDocumentTransactionAllocation(
+                receipt_number = ''
+            )
+        else:
+            return FiscalDocumentTransactionAllocation(
+        )
+        """
+
+    def testFiscalDocumentTransactionAllocation(self):
+        """Test FiscalDocumentTransactionAllocation"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_get_logo_response.py

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from cloudbeds_fiscal_document.models.get_logo_response import GetLogoResponse
+
+class TestGetLogoResponse(unittest.TestCase):
+    """GetLogoResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> GetLogoResponse:
+        """Test GetLogoResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `GetLogoResponse`
+        """
+        model = GetLogoResponse()
+        if include_optional:
+            return GetLogoResponse(
+                logo_url = ''
+            )
+        else:
+            return GetLogoResponse(
+        )
+        """
+
+    def testGetLogoResponse(self):
+        """Test GetLogoResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_preview_request.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from cloudbeds_fiscal_document.models.preview_request import PreviewRequest
+
+class TestPreviewRequest(unittest.TestCase):
+    """PreviewRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PreviewRequest:
+        """Test PreviewRequest
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PreviewRequest`
+        """
+        model = PreviewRequest()
+        if include_optional:
+            return PreviewRequest(
+                document_kind = 'INVOICE',
+                source_kind = 'GROUP_PROFILE',
+                recipient_type = 'COMPANY',
+                include_vat = True,
+                include_payments = True,
+                include_room_number = True,
+                preview_watermark = True
+            )
+        else:
+            return PreviewRequest(
+        )
+        """
+
+    def testPreviewRequest(self):
+        """Test PreviewRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_property_configs_response.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from cloudbeds_fiscal_document.models.property_configs_response import PropertyConfigsResponse
+
+class TestPropertyConfigsResponse(unittest.TestCase):
+    """PropertyConfigsResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PropertyConfigsResponse:
+        """Test PropertyConfigsResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PropertyConfigsResponse`
+        """
+        model = PropertyConfigsResponse()
+        if include_optional:
+            return PropertyConfigsResponse(
+                configs = {
+                    'key' : cloudbeds_fiscal_document.models.configs_response.ConfigsResponse(
+                        property_id = '', 
+                        document_kind = 'INVOICE', 
+                        show_detailed_tax_fee = True, 
+                        show_credit_notes_and_receipts = True, 
+                        charge_breakdown = True, 
+                        use_guest_lang = True, 
+                        due_days = 56, 
+                        lang = '', 
+                        prefix = '', 
+                        suffix = '', 
+                        legal_company_name = '', 
+                        title = {
+                            'key' : ''
+                            }, 
+                        show_legal_company_name = True, 
+                        include_room_number = True, 
+                        use_document_number = True, 
+                        is_compact = True, 
+                        tax_id1 = '', 
+                        tax_id2 = '', 
+                        cpf = '', 
+                        custom_text = {
+                            'key' : ''
+                            }, 
+                        create_invoice_on_allocation = True, 
+                        trigger_events = [
+                            'manual'
+                            ], 
+                        update_invoice_on_link_document = True, 
+                        use_invoice_document_settings = True, 
+                        use_invoice_title_and_numbering = True, )
+                    }
+            )
+        else:
+            return PropertyConfigsResponse(
+        )
+        """
+
+    def testPropertyConfigsResponse(self):
+        """Test PropertyConfigsResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_single_allocation.py

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from cloudbeds_fiscal_document.models.single_allocation import SingleAllocation
+
+class TestSingleAllocation(unittest.TestCase):
+    """SingleAllocation unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> SingleAllocation:
+        """Test SingleAllocation
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `SingleAllocation`
+        """
+        model = SingleAllocation()
+        if include_optional:
+            return SingleAllocation(
+                transaction_id = 8878321883388,
+                allocated_amount = 3.68
+            )
+        else:
+            return SingleAllocation(
+        )
+        """
+
+    def testSingleAllocation(self):
+        """Test SingleAllocation"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()