cloudbeds-fiscal-document 1.12.0__py3-none-any.whl → 1.13.0__py3-none-any.whl

cloudbeds_fiscal_document/models/manual_recipient_request_document.py

@@ -0,0 +1,117 @@
+# 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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cloudbeds_fiscal_document.models.guest_document_type import GuestDocumentType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ManualRecipientRequestDocument(BaseModel):
+    """
+    ManualRecipientRequestDocument
+    """ # noqa: E501
+    type: Optional[GuestDocumentType] = None
+    number: Optional[StrictStr] = Field(default=None, description="Document number")
+    issue_date: Optional[date] = Field(default=None, description="Document issue date", alias="issueDate")
+    issuing_country: Optional[StrictStr] = Field(default=None, description="Country that issued the document", alias="issuingCountry")
+    expiration_date: Optional[date] = Field(default=None, description="Document expiration date", alias="expirationDate")
+    __properties: ClassVar[List[str]] = ["type", "number", "issueDate", "issuingCountry", "expirationDate"]
+
+    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 ManualRecipientRequestDocument 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,
+        )
+        # set to None if number (nullable) is None
+        # and model_fields_set contains the field
+        if self.number is None and "number" in self.model_fields_set:
+            _dict['number'] = None
+
+        # set to None if issue_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.issue_date is None and "issue_date" in self.model_fields_set:
+            _dict['issueDate'] = None
+
+        # set to None if issuing_country (nullable) is None
+        # and model_fields_set contains the field
+        if self.issuing_country is None and "issuing_country" in self.model_fields_set:
+            _dict['issuingCountry'] = None
+
+        # set to None if expiration_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.expiration_date is None and "expiration_date" in self.model_fields_set:
+            _dict['expirationDate'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ManualRecipientRequestDocument from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "number": obj.get("number"),
+            "issueDate": obj.get("issueDate"),
+            "issuingCountry": obj.get("issuingCountry"),
+            "expirationDate": obj.get("expirationDate")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/recipient_request.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
@@ -29,13 +29,24 @@ class RecipientRequest(BaseModel):
     """ # noqa: E501
     type: StrictStr = Field(description="Type of the recipient.")
     id: Annotated[int, Field(strict=True, ge=1)] = Field(description="ID of the recipient, references guestId, contactId, groupId, etc. depending on type.")
-    __properties: ClassVar[List[str]] = ["type", "id"]
+    tax_document_source: Optional[StrictStr] = Field(default=None, description="Source of the tax document number.", alias="taxDocumentSource")
+    __properties: ClassVar[List[str]] = ["type", "id", "taxDocumentSource"]
 
     @field_validator('type')
     def type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['GUEST', 'CONTACT', 'GROUP', 'COMPANY']):
-            raise ValueError("must be one of enum values ('GUEST', 'CONTACT', 'GROUP', 'COMPANY')")
+        if value not in set(['GUEST', 'CONTACT', 'GROUP', 'COMPANY', 'GROUP_PROFILE', 'GROUP_PROFILE_CONTACT']):
+            raise ValueError("must be one of enum values ('GUEST', 'CONTACT', 'GROUP', 'COMPANY', 'GROUP_PROFILE', 'GROUP_PROFILE_CONTACT')")
+        return value
+
+    @field_validator('tax_document_source')
+    def tax_document_source_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['GUEST_TAX_ID', 'GUEST_DOCUMENT_NUMBER']):
+            raise ValueError("must be one of enum values ('GUEST_TAX_ID', 'GUEST_DOCUMENT_NUMBER')")
         return value
 
     model_config = ConfigDict(
@@ -90,7 +101,8 @@ class RecipientRequest(BaseModel):
 
         _obj = cls.model_validate({
             "type": obj.get("type"),
-            "id": obj.get("id")
+            "id": obj.get("id"),
+            "taxDocumentSource": obj.get("taxDocumentSource")
         })
         return _obj
 

cloudbeds_fiscal_document/models/recipient_type.py

@@ -28,6 +28,7 @@ class RecipientType(str, Enum):
     """
     COMPANY = 'COMPANY'
     PERSON = 'PERSON'
+    MANUAL = 'MANUAL'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

cloudbeds_fiscal_document/test/test_configs_response.py

@@ -41,10 +41,12 @@ class TestConfigsResponse(unittest.TestCase):
                 show_credit_notes_and_receipts = True,
                 charge_breakdown = True,
                 use_guest_lang = True,
+                allow_pending_transactions = True,
                 due_days = 56,
                 lang = '',
                 prefix = '',
                 suffix = '',
+                separator = '',
                 legal_company_name = '',
                 title = {
                     'key' : ''
@@ -59,7 +61,6 @@ class TestConfigsResponse(unittest.TestCase):
                 custom_text = {
                     'key' : ''
                     },
-                create_invoice_on_allocation = True,
                 trigger_events = [
                     'manual'
                     ],

cloudbeds_fiscal_document/test/test_configs_update_request.py

@@ -40,18 +40,19 @@ class TestConfigsUpdateRequest(unittest.TestCase):
                     ],
                 show_detailed_tax_fee = True,
                 charge_breakdown = True,
+                allow_pending_transactions = True,
                 use_guest_lang = True,
                 due_days = 56,
                 sequence_start_number = 1,
                 lang = '',
                 prefix = '',
+                separator = '',
                 suffix = '',
                 legal_company_name = '',
                 title = {"en":"Invoice","es":"Factura"},
                 show_legal_company_name = True,
                 include_room_number = True,
                 use_document_number = True,
-                create_invoice_on_allocation = True,
                 update_invoice_on_link_document = True,
                 is_compact = True,
                 use_invoice_title_and_numbering = True,

cloudbeds_fiscal_document/test/test_create_invoice_request.py

@@ -44,7 +44,30 @@ class TestCreateInvoiceRequest(unittest.TestCase):
                 user_id = 0,
                 recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
                     type = 'GUEST', 
-                    id = 1, ),
+                    id = 1, 
+                    tax_document_source = 'GUEST_TAX_ID', ),
+                manual_recipient = cloudbeds_fiscal_document.models.manual_recipient_request.ManualRecipientRequest(
+                    type = 'PERSON', 
+                    name = '', 
+                    gender = 'M', 
+                    email = '', 
+                    birthday = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                    phone = '', 
+                    cell_phone = '', 
+                    tax_id = '', 
+                    address = cloudbeds_fiscal_document.models.manual_recipient_request_address.ManualRecipientRequest_address(
+                        country = '', 
+                        state = '', 
+                        city = '', 
+                        address1 = '', 
+                        address2 = '', 
+                        zip = '', ), 
+                    document = cloudbeds_fiscal_document.models.manual_recipient_request_document.ManualRecipientRequest_document(
+                        type = 'na', 
+                        number = '', 
+                        issue_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                        issuing_country = '', 
+                        expiration_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), ), ),
                 folio_ids = [
                     1
                     ],
@@ -54,7 +77,8 @@ class TestCreateInvoiceRequest(unittest.TestCase):
                 include_transaction_ids = [
                     1
                     ],
-                simplified = True
+                simplified = True,
+                due_date_property_timezone = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date()
             )
         else:
             return CreateInvoiceRequest(
@@ -63,9 +87,6 @@ class TestCreateInvoiceRequest(unittest.TestCase):
                     ],
                 source_id = 1,
                 source_kind = 'GROUP_PROFILE',
-                recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
-                    type = 'GUEST', 
-                    id = 1, ),
         )
         """
 

cloudbeds_fiscal_document/test/test_create_receipt_request.py

@@ -43,21 +43,42 @@ class TestCreateReceiptRequest(unittest.TestCase):
                 transaction_id = 56,
                 payment_id = 56,
                 sequence_id = 56,
+                skip_integration = True,
                 user_id = 56,
                 source_id = 1,
                 source_kind = 'GROUP_PROFILE',
                 recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
                     type = 'GUEST', 
-                    id = 1, )
+                    id = 1, 
+                    tax_document_source = 'GUEST_TAX_ID', ),
+                manual_recipient = cloudbeds_fiscal_document.models.manual_recipient_request.ManualRecipientRequest(
+                    type = 'PERSON', 
+                    name = '', 
+                    gender = 'M', 
+                    email = '', 
+                    birthday = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                    phone = '', 
+                    cell_phone = '', 
+                    tax_id = '', 
+                    address = cloudbeds_fiscal_document.models.manual_recipient_request_address.ManualRecipientRequest_address(
+                        country = '', 
+                        state = '', 
+                        city = '', 
+                        address1 = '', 
+                        address2 = '', 
+                        zip = '', ), 
+                    document = cloudbeds_fiscal_document.models.manual_recipient_request_document.ManualRecipientRequest_document(
+                        type = 'na', 
+                        number = '', 
+                        issue_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                        issuing_country = '', 
+                        expiration_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), ), )
             )
         else:
             return CreateReceiptRequest(
                 user_id = 56,
                 source_id = 1,
                 source_kind = 'GROUP_PROFILE',
-                recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
-                    type = 'GUEST', 
-                    id = 1, ),
         )
         """
 

cloudbeds_fiscal_document/test/test_create_simple_receipt_request.py

@@ -44,7 +44,30 @@ class TestCreateSimpleReceiptRequest(unittest.TestCase):
                 source_kind = 'GROUP_PROFILE',
                 recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
                     type = 'GUEST', 
-                    id = 1, )
+                    id = 1, 
+                    tax_document_source = 'GUEST_TAX_ID', ),
+                manual_recipient = cloudbeds_fiscal_document.models.manual_recipient_request.ManualRecipientRequest(
+                    type = 'PERSON', 
+                    name = '', 
+                    gender = 'M', 
+                    email = '', 
+                    birthday = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                    phone = '', 
+                    cell_phone = '', 
+                    tax_id = '', 
+                    address = cloudbeds_fiscal_document.models.manual_recipient_request_address.ManualRecipientRequest_address(
+                        country = '', 
+                        state = '', 
+                        city = '', 
+                        address1 = '', 
+                        address2 = '', 
+                        zip = '', ), 
+                    document = cloudbeds_fiscal_document.models.manual_recipient_request_document.ManualRecipientRequest_document(
+                        type = 'na', 
+                        number = '', 
+                        issue_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                        issuing_country = '', 
+                        expiration_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), ), )
             )
         else:
             return CreateSimpleReceiptRequest(
@@ -56,7 +79,8 @@ class TestCreateSimpleReceiptRequest(unittest.TestCase):
                 source_kind = 'GROUP_PROFILE',
                 recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
                     type = 'GUEST', 
-                    id = 1, ),
+                    id = 1, 
+                    tax_document_source = 'GUEST_TAX_ID', ),
         )
         """
 

cloudbeds_fiscal_document/test/test_export_api.py

@@ -0,0 +1,38 @@
+# 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.api.export_api import ExportApi
+
+
+class TestExportApi(unittest.TestCase):
+    """ExportApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = ExportApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_get_folio_pdf(self) -> None:
+        """Test case for get_folio_pdf
+
+        Get folio list of transactions exported as PDF
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_fiscal_document_detailed_response.py

@@ -79,7 +79,8 @@ class TestFiscalDocumentDetailedResponse(unittest.TestCase):
                     official_id = '', 
                     external_id = '', 
                     rectifying_invoice_type = '', 
-                    cancellation_failed_fallback_status = 'COMPLETED', ),
+                    cancellation_failed_fallback_status = 'COMPLETED', 
+                    pdf_file_base64 = 'YQ==', ),
                 latest_linked_document = cloudbeds_fiscal_document.models.latest_linked_document.LatestLinkedDocument(
                     id = '', 
                     number = '', 

cloudbeds_fiscal_document/test/test_fiscal_document_paginated.py

@@ -80,7 +80,8 @@ class TestFiscalDocumentPaginated(unittest.TestCase):
                             official_id = '', 
                             external_id = '', 
                             rectifying_invoice_type = '', 
-                            cancellation_failed_fallback_status = 'COMPLETED', ), 
+                            cancellation_failed_fallback_status = 'COMPLETED', 
+                            pdf_file_base64 = 'YQ==', ), 
                         latest_linked_document = cloudbeds_fiscal_document.models.latest_linked_document.LatestLinkedDocument(
                             id = '', 
                             number = '', 

cloudbeds_fiscal_document/test/test_fiscal_document_patch_request.py

@@ -48,7 +48,8 @@ class TestFiscalDocumentPatchRequest(unittest.TestCase):
                     official_id = '', 
                     external_id = '', 
                     rectifying_invoice_type = '', 
-                    cancellation_failed_fallback_status = 'COMPLETED', )
+                    cancellation_failed_fallback_status = 'COMPLETED', 
+                    pdf_file_base64 = 'YQ==', )
             )
         else:
             return FiscalDocumentPatchRequest(

cloudbeds_fiscal_document/test/test_fiscal_document_summary_response.py

@@ -49,7 +49,8 @@ class TestFiscalDocumentSummaryResponse(unittest.TestCase):
                     official_id = '', 
                     external_id = '', 
                     rectifying_invoice_type = '', 
-                    cancellation_failed_fallback_status = 'COMPLETED', ),
+                    cancellation_failed_fallback_status = 'COMPLETED', 
+                    pdf_file_base64 = 'YQ==', ),
                 linked_to = ''
             )
         else:

cloudbeds_fiscal_document/test/test_get_folio_export_request.py

@@ -0,0 +1,60 @@
+# 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_folio_export_request import GetFolioExportRequest
+
+class TestGetFolioExportRequest(unittest.TestCase):
+    """GetFolioExportRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> GetFolioExportRequest:
+        """Test GetFolioExportRequest
+            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 `GetFolioExportRequest`
+        """
+        model = GetFolioExportRequest()
+        if include_optional:
+            return GetFolioExportRequest(
+                folio_ids = [3774744,7763263217],
+                source_kind = 'GROUP_PROFILE',
+                source_id = 56,
+                credit_debit_view = True,
+                revenue_compact = True,
+                date_from = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(),
+                date_to = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date()
+            )
+        else:
+            return GetFolioExportRequest(
+                folio_ids = [3774744,7763263217],
+                source_kind = 'GROUP_PROFILE',
+                source_id = 56,
+        )
+        """
+
+    def testGetFolioExportRequest(self):
+        """Test GetFolioExportRequest"""
+        # 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_invoice_preview_request.py

@@ -44,7 +44,30 @@ class TestGetInvoicePreviewRequest(unittest.TestCase):
                 user_id = 0,
                 recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
                     type = 'GUEST', 
-                    id = 1, ),
+                    id = 1, 
+                    tax_document_source = 'GUEST_TAX_ID', ),
+                manual_recipient = cloudbeds_fiscal_document.models.manual_recipient_request.ManualRecipientRequest(
+                    type = 'PERSON', 
+                    name = '', 
+                    gender = 'M', 
+                    email = '', 
+                    birthday = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                    phone = '', 
+                    cell_phone = '', 
+                    tax_id = '', 
+                    address = cloudbeds_fiscal_document.models.manual_recipient_request_address.ManualRecipientRequest_address(
+                        country = '', 
+                        state = '', 
+                        city = '', 
+                        address1 = '', 
+                        address2 = '', 
+                        zip = '', ), 
+                    document = cloudbeds_fiscal_document.models.manual_recipient_request_document.ManualRecipientRequest_document(
+                        type = 'na', 
+                        number = '', 
+                        issue_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
+                        issuing_country = '', 
+                        expiration_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), ), ),
                 folio_ids = [
                     1
                     ],
@@ -54,7 +77,8 @@ class TestGetInvoicePreviewRequest(unittest.TestCase):
                 include_transaction_ids = [
                     1
                     ],
-                simplified = True
+                simplified = True,
+                due_date_property_timezone = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date()
             )
         else:
             return GetInvoicePreviewRequest(
@@ -63,9 +87,6 @@ class TestGetInvoicePreviewRequest(unittest.TestCase):
                     ],
                 source_id = 1,
                 source_kind = 'GROUP_PROFILE',
-                recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
-                    type = 'GUEST', 
-                    id = 1, ),
         )
         """
 

cloudbeds_fiscal_document/test/test_government_integration.py

@@ -45,7 +45,8 @@ class TestGovernmentIntegration(unittest.TestCase):
                 official_id = '',
                 external_id = '',
                 rectifying_invoice_type = '',
-                cancellation_failed_fallback_status = 'COMPLETED'
+                cancellation_failed_fallback_status = 'COMPLETED',
+                pdf_file_base64 = 'YQ=='
             )
         else:
             return GovernmentIntegration(

cloudbeds_fiscal_document/test/test_guest_document_type.py

@@ -0,0 +1,33 @@
+# 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.guest_document_type import GuestDocumentType
+
+class TestGuestDocumentType(unittest.TestCase):
+    """GuestDocumentType unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testGuestDocumentType(self):
+        """Test GuestDocumentType"""
+        # inst = GuestDocumentType()
+
+if __name__ == '__main__':
+    unittest.main()

cloudbeds_fiscal_document/test/test_guest_gender.py

@@ -0,0 +1,33 @@
+# 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.guest_gender import GuestGender
+
+class TestGuestGender(unittest.TestCase):
+    """GuestGender unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testGuestGender(self):
+        """Test GuestGender"""
+        # inst = GuestGender()
+
+if __name__ == '__main__':
+    unittest.main()