cloudbeds-fiscal-document 1.9.2__py3-none-any.whl → 1.11.0__py3-none-any.whl

cloudbeds_fiscal_document/models/get_invoice_preview_request.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from cloudbeds_fiscal_document.models.recipient_request import RecipientRequest
@@ -38,7 +38,8 @@ class GetInvoicePreviewRequest(BaseModel):
     folio_ids: Optional[List[Annotated[int, Field(strict=True, ge=1)]]] = Field(default=None, description="Include all transactions from the specified folio IDs", alias="folioIds")
     exclude_transaction_ids: Optional[List[Annotated[int, Field(strict=True, ge=1)]]] = Field(default=None, description="Exclude transactions with the specified IDs", alias="excludeTransactionIds")
     include_transaction_ids: Optional[List[Annotated[int, Field(strict=True, ge=1)]]] = Field(default=None, description="Include transactions with the specified IDs", alias="includeTransactionIds")
-    __properties: ClassVar[List[str]] = ["transactionIds", "sourceId", "sequenceId", "sourceKind", "userId", "recipient", "folioIds", "excludeTransactionIds", "includeTransactionIds"]
+    simplified: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["transactionIds", "sourceId", "sequenceId", "sourceKind", "userId", "recipient", "folioIds", "excludeTransactionIds", "includeTransactionIds", "simplified"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -112,7 +113,8 @@ class GetInvoicePreviewRequest(BaseModel):
             "recipient": RecipientRequest.from_dict(obj["recipient"]) if obj.get("recipient") is not None else None,
             "folioIds": obj.get("folioIds"),
             "excludeTransactionIds": obj.get("excludeTransactionIds"),
-            "includeTransactionIds": obj.get("includeTransactionIds")
+            "includeTransactionIds": obj.get("includeTransactionIds"),
+            "simplified": obj.get("simplified") if obj.get("simplified") is not None else False
         })
         return _obj
 

cloudbeds_fiscal_document/models/get_logo_response.py

@@ -0,0 +1,87 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetLogoResponse(BaseModel):
+    """
+    GetLogoResponse
+    """ # noqa: E501
+    logo_url: Optional[StrictStr] = Field(default=None, description="Presigned URL to access the logo file", alias="logoUrl")
+    __properties: ClassVar[List[str]] = ["logoUrl"]
+
+    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 GetLogoResponse 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 GetLogoResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "logoUrl": obj.get("logoUrl")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/government_integration.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from cloudbeds_fiscal_document.models.fiscal_document_status import FiscalDocumentStatus
 from cloudbeds_fiscal_document.models.government_integration_qr import GovernmentIntegrationQr
@@ -37,8 +37,7 @@ class GovernmentIntegration(BaseModel):
     external_id: Optional[StrictStr] = Field(default=None, alias="externalId")
     rectifying_invoice_type: Optional[StrictStr] = Field(default=None, alias="rectifyingInvoiceType")
     cancellation_failed_fallback_status: Optional[FiscalDocumentStatus] = Field(default=None, alias="cancellationFailedFallbackStatus")
-    generate_receipt: Optional[StrictBool] = Field(default=None, description="Indicates if the receipt was generated/sent to fiscal printer", alias="generateReceipt")
-    __properties: ClassVar[List[str]] = ["number", "series", "status", "qr", "url", "officialId", "externalId", "rectifyingInvoiceType", "cancellationFailedFallbackStatus", "generateReceipt"]
+    __properties: ClassVar[List[str]] = ["number", "series", "status", "qr", "url", "officialId", "externalId", "rectifyingInvoiceType", "cancellationFailedFallbackStatus"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -102,8 +101,7 @@ class GovernmentIntegration(BaseModel):
             "officialId": obj.get("officialId"),
             "externalId": obj.get("externalId"),
             "rectifyingInvoiceType": obj.get("rectifyingInvoiceType"),
-            "cancellationFailedFallbackStatus": obj.get("cancellationFailedFallbackStatus"),
-            "generateReceipt": obj.get("generateReceipt")
+            "cancellationFailedFallbackStatus": obj.get("cancellationFailedFallbackStatus")
         })
         return _obj
 

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/transaction_for_allocation_response.py

@@ -21,6 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from cloudbeds_fiscal_document.models.source_kind import SourceKind
+from cloudbeds_fiscal_document.models.transaction_status import TransactionStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -37,8 +38,9 @@ class TransactionForAllocationResponse(BaseModel):
     internal_code: Optional[StrictStr] = Field(default=None, alias="internalCode")
     amount: Optional[Union[StrictFloat, StrictInt]] = None
     allocated_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="allocatedAmount")
+    status: Optional[TransactionStatus] = None
     taxes: Optional[List[TransactionForAllocationResponse]] = None
-    __properties: ClassVar[List[str]] = ["id", "propertyId", "sourceId", "sourceKind", "transactionDate", "description", "internalCode", "amount", "allocatedAmount", "taxes"]
+    __properties: ClassVar[List[str]] = ["id", "propertyId", "sourceId", "sourceKind", "transactionDate", "description", "internalCode", "amount", "allocatedAmount", "status", "taxes"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -107,6 +109,7 @@ class TransactionForAllocationResponse(BaseModel):
             "internalCode": obj.get("internalCode"),
             "amount": obj.get("amount"),
             "allocatedAmount": obj.get("allocatedAmount"),
+            "status": obj.get("status"),
             "taxes": [TransactionForAllocationResponse.from_dict(_item) for _item in obj["taxes"]] if obj.get("taxes") is not None else None
         })
         return _obj

cloudbeds_fiscal_document/models/transaction_status.py

@@ -0,0 +1,37 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TransactionStatus(str, Enum):
+    """
+    Status for transactions
+    """
+
+    """
+    allowed enum values
+    """
+    POSTED = 'POSTED'
+    PENDING = 'PENDING'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TransactionStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cloudbeds_fiscal_document/test/test_configs_api.py

@@ -26,6 +26,13 @@ class TestConfigsApi(unittest.TestCase):
     def tearDown(self) -> None:
         pass
 
+    def test_delete_logo(self) -> None:
+        """Test case for delete_logo
+
+        Delete logo image for fiscal documents
+        """
+        pass
+
     def test_get_configs(self) -> None:
         """Test case for get_configs
 
@@ -33,6 +40,20 @@ class TestConfigsApi(unittest.TestCase):
         """
         pass
 
+    def test_get_logo(self) -> None:
+        """Test case for get_logo
+
+        Get logo image for fiscal documents
+        """
+        pass
+
+    def test_get_pdf_preview(self) -> None:
+        """Test case for get_pdf_preview
+
+        Get PDF document preview
+        """
+        pass
+
     def test_update_configs(self) -> None:
         """Test case for update_configs
 
@@ -40,6 +61,13 @@ class TestConfigsApi(unittest.TestCase):
         """
         pass
 
+    def test_upload_logo(self) -> None:
+        """Test case for upload_logo
+
+        Upload logo image for fiscal documents
+        """
+        pass
+
 
 if __name__ == '__main__':
     unittest.main()

cloudbeds_fiscal_document/test/test_configs_response.py

@@ -38,6 +38,7 @@ class TestConfigsResponse(unittest.TestCase):
                 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,
@@ -57,7 +58,14 @@ class TestConfigsResponse(unittest.TestCase):
                 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 ConfigsResponse(

cloudbeds_fiscal_document/test/test_configs_update_request.py

@@ -35,27 +35,35 @@ class TestConfigsUpdateRequest(unittest.TestCase):
         model = ConfigsUpdateRequest()
         if include_optional:
             return ConfigsUpdateRequest(
+                trigger_events = [
+                    'manual'
+                    ],
                 show_detailed_tax_fee = True,
                 charge_breakdown = True,
                 use_guest_lang = True,
                 due_days = 56,
+                sequence_start_number = 1,
                 lang = '',
                 prefix = '',
                 suffix = '',
                 legal_company_name = '',
-                title = {
-                    'key' : ''
-                    },
+                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,
+                use_invoice_document_settings = True,
+                show_credit_notes_and_receipts = True,
                 tax_id1 = '',
                 tax_id2 = '',
                 cpf = '',
                 custom_text = {
                     'key' : ''
-                    }
+                    },
+                logo_id = 56
             )
         else:
             return ConfigsUpdateRequest(

cloudbeds_fiscal_document/test/test_create_credit_note_request.py

@@ -35,21 +35,28 @@ class TestCreateCreditNoteRequest(unittest.TestCase):
         model = CreateCreditNoteRequest()
         if include_optional:
             return CreateCreditNoteRequest(
-                sequence_id = 56,
-                invoice_id = 56,
+                sequence_id = 1,
+                invoice_id = 1,
                 reason = '',
-                user_id = 56,
+                user_id = 0,
                 method = 'VOID',
                 transaction_ids = [
                     56
                     ],
-                guest_id = 56
+                folio_ids = [
+                    56
+                    ],
+                exclude_transaction_ids = [
+                    56
+                    ],
+                include_transaction_ids = [
+                    56
+                    ]
             )
         else:
             return CreateCreditNoteRequest(
-                invoice_id = 56,
+                invoice_id = 1,
                 method = 'VOID',
-                guest_id = 56,
         )
         """
 

cloudbeds_fiscal_document/test/test_create_invoice_request.py

@@ -36,22 +36,36 @@ class TestCreateInvoiceRequest(unittest.TestCase):
         if include_optional:
             return CreateInvoiceRequest(
                 transaction_ids = [
-                    56
+                    1
                     ],
-                source_id = 56,
-                sequence_id = 56,
+                source_id = 1,
+                sequence_id = 1,
                 source_kind = 'GROUP_PROFILE',
-                user_id = 56,
-                guest_id = 56
+                user_id = 0,
+                recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
+                    type = 'GUEST', 
+                    id = 1, ),
+                folio_ids = [
+                    1
+                    ],
+                exclude_transaction_ids = [
+                    1
+                    ],
+                include_transaction_ids = [
+                    1
+                    ],
+                simplified = True
             )
         else:
             return CreateInvoiceRequest(
                 transaction_ids = [
-                    56
+                    1
                     ],
-                source_id = 56,
+                source_id = 1,
                 source_kind = 'GROUP_PROFILE',
-                guest_id = 56,
+                recipient = cloudbeds_fiscal_document.models.recipient_request.RecipientRequest(
+                    type = 'GUEST', 
+                    id = 1, ),
         )
         """