cloudbeds-fiscal-document 1.6.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. cloudbeds_fiscal_document/__init__.py +20 -1
  2. cloudbeds_fiscal_document/api/__init__.py +1 -0
  3. cloudbeds_fiscal_document/api/configs_api.py +263 -2
  4. cloudbeds_fiscal_document/api/features_api.py +299 -0
  5. cloudbeds_fiscal_document/api/fiscal_documents_api.py +4602 -561
  6. cloudbeds_fiscal_document/api_client.py +1 -1
  7. cloudbeds_fiscal_document/configuration.py +1 -1
  8. cloudbeds_fiscal_document/models/__init__.py +18 -0
  9. cloudbeds_fiscal_document/models/allocate_receipt_payment_request.py +98 -0
  10. cloudbeds_fiscal_document/models/allocations_summary.py +89 -0
  11. cloudbeds_fiscal_document/models/create_credit_note_request.py +9 -3
  12. cloudbeds_fiscal_document/models/create_invoice_request.py +9 -3
  13. cloudbeds_fiscal_document/models/create_receipt_request.py +135 -0
  14. cloudbeds_fiscal_document/models/create_simple_receipt_request.py +108 -0
  15. cloudbeds_fiscal_document/models/fiscal_document_detailed_response.py +26 -2
  16. cloudbeds_fiscal_document/models/fiscal_document_filters.py +133 -0
  17. cloudbeds_fiscal_document/models/fiscal_document_kind.py +1 -0
  18. cloudbeds_fiscal_document/models/fiscal_document_status.py +4 -0
  19. cloudbeds_fiscal_document/models/fiscal_document_transaction_response.py +15 -3
  20. cloudbeds_fiscal_document/models/fiscal_document_transactions_for_allocation_paginated.py +97 -0
  21. cloudbeds_fiscal_document/models/fiscal_document_transactions_summary.py +103 -0
  22. cloudbeds_fiscal_document/models/fiscal_document_transactions_summary_taxes_inner.py +89 -0
  23. cloudbeds_fiscal_document/models/get_credit_note_preview_request.py +120 -0
  24. cloudbeds_fiscal_document/models/get_invoice_preview_request.py +119 -0
  25. cloudbeds_fiscal_document/models/get_rectify_invoice_note_preview_request.py +123 -0
  26. cloudbeds_fiscal_document/models/government_integration.py +5 -2
  27. cloudbeds_fiscal_document/models/latest_linked_document.py +98 -0
  28. cloudbeds_fiscal_document/models/linked_document.py +112 -0
  29. cloudbeds_fiscal_document/models/pro_forma_invoice_preview_request.py +124 -0
  30. cloudbeds_fiscal_document/models/pro_forma_invoice_request.py +124 -0
  31. cloudbeds_fiscal_document/models/pro_forma_status_update_request.py +94 -0
  32. cloudbeds_fiscal_document/models/receipt_transaction_allocation.py +89 -0
  33. cloudbeds_fiscal_document/models/rectify_invoice_note_request.py +28 -7
  34. cloudbeds_fiscal_document/models/transaction_for_allocation_response.py +116 -0
  35. cloudbeds_fiscal_document/test/test_allocate_receipt_payment_request.py +62 -0
  36. cloudbeds_fiscal_document/test/test_allocations_summary.py +52 -0
  37. cloudbeds_fiscal_document/test/test_create_receipt_request.py +70 -0
  38. cloudbeds_fiscal_document/test/test_create_simple_receipt_request.py +69 -0
  39. cloudbeds_fiscal_document/test/test_features_api.py +38 -0
  40. cloudbeds_fiscal_document/test/test_fiscal_document_filters.py +74 -0
  41. cloudbeds_fiscal_document/test/test_fiscal_document_transactions_for_allocation_paginated.py +74 -0
  42. cloudbeds_fiscal_document/test/test_fiscal_document_transactions_summary.py +59 -0
  43. cloudbeds_fiscal_document/test/test_fiscal_document_transactions_summary_taxes_inner.py +52 -0
  44. cloudbeds_fiscal_document/test/test_get_credit_note_preview_request.py +69 -0
  45. cloudbeds_fiscal_document/test/test_get_invoice_preview_request.py +77 -0
  46. cloudbeds_fiscal_document/test/test_get_rectify_invoice_note_preview_request.py +68 -0
  47. cloudbeds_fiscal_document/test/test_latest_linked_document.py +55 -0
  48. cloudbeds_fiscal_document/test/test_linked_document.py +57 -0
  49. cloudbeds_fiscal_document/test/test_pro_forma_invoice_preview_request.py +81 -0
  50. cloudbeds_fiscal_document/test/test_pro_forma_invoice_request.py +81 -0
  51. cloudbeds_fiscal_document/test/test_pro_forma_status_update_request.py +52 -0
  52. cloudbeds_fiscal_document/test/test_receipt_transaction_allocation.py +54 -0
  53. cloudbeds_fiscal_document/test/test_transaction_for_allocation_response.py +71 -0
  54. {cloudbeds_fiscal_document-1.6.0.dist-info → cloudbeds_fiscal_document-1.7.1.dist-info}/METADATA +36 -3
  55. {cloudbeds_fiscal_document-1.6.0.dist-info → cloudbeds_fiscal_document-1.7.1.dist-info}/RECORD +58 -20
  56. {cloudbeds_fiscal_document-1.6.0.dist-info → cloudbeds_fiscal_document-1.7.1.dist-info}/WHEEL +0 -0
  57. {cloudbeds_fiscal_document-1.6.0.dist-info → cloudbeds_fiscal_document-1.7.1.dist-info}/licenses/LICENSE +0 -0
  58. {cloudbeds_fiscal_document-1.6.0.dist-info → cloudbeds_fiscal_document-1.7.1.dist-info}/top_level.txt +0 -0
@@ -90,7 +90,7 @@ class ApiClient:
90
90
  self.default_headers[header_name] = header_value
91
91
  self.cookie = cookie
92
92
  # Set default User-Agent.
93
- self.user_agent = 'OpenAPI-Generator/1.6.0/python'
93
+ self.user_agent = 'OpenAPI-Generator/1.7.1/python'
94
94
  self.client_side_validation = configuration.client_side_validation
95
95
 
96
96
  def __enter__(self):
@@ -504,7 +504,7 @@ class Configuration:
504
504
  "OS: {env}\n"\
505
505
  "Python Version: {pyversion}\n"\
506
506
  "Version of the API: v1\n"\
507
- "SDK Package Version: 1.6.0".\
507
+ "SDK Package Version: 1.7.1".\
508
508
  format(env=sys.platform, pyversion=sys.version)
509
509
 
510
510
  def get_host_settings(self) -> List[HostSetting]:
@@ -15,15 +15,20 @@
15
15
 
16
16
  # import models into model package
17
17
  from cloudbeds_fiscal_document.models.action import Action
18
+ from cloudbeds_fiscal_document.models.allocate_receipt_payment_request import AllocateReceiptPaymentRequest
19
+ from cloudbeds_fiscal_document.models.allocations_summary import AllocationsSummary
18
20
  from cloudbeds_fiscal_document.models.api_error import ApiError
19
21
  from cloudbeds_fiscal_document.models.configs_response import ConfigsResponse
20
22
  from cloudbeds_fiscal_document.models.configs_update_request import ConfigsUpdateRequest
21
23
  from cloudbeds_fiscal_document.models.create_credit_note_request import CreateCreditNoteRequest
22
24
  from cloudbeds_fiscal_document.models.create_invoice_request import CreateInvoiceRequest
25
+ from cloudbeds_fiscal_document.models.create_receipt_request import CreateReceiptRequest
26
+ from cloudbeds_fiscal_document.models.create_simple_receipt_request import CreateSimpleReceiptRequest
23
27
  from cloudbeds_fiscal_document.models.creation_method import CreationMethod
24
28
  from cloudbeds_fiscal_document.models.document_action import DocumentAction
25
29
  from cloudbeds_fiscal_document.models.fiscal_document_detailed_response import FiscalDocumentDetailedResponse
26
30
  from cloudbeds_fiscal_document.models.fiscal_document_email_request import FiscalDocumentEmailRequest
31
+ from cloudbeds_fiscal_document.models.fiscal_document_filters import FiscalDocumentFilters
27
32
  from cloudbeds_fiscal_document.models.fiscal_document_kind import FiscalDocumentKind
28
33
  from cloudbeds_fiscal_document.models.fiscal_document_paginated import FiscalDocumentPaginated
29
34
  from cloudbeds_fiscal_document.models.fiscal_document_patch_request import FiscalDocumentPatchRequest
@@ -31,9 +36,21 @@ from cloudbeds_fiscal_document.models.fiscal_document_recipient import FiscalDoc
31
36
  from cloudbeds_fiscal_document.models.fiscal_document_status import FiscalDocumentStatus
32
37
  from cloudbeds_fiscal_document.models.fiscal_document_summary_response import FiscalDocumentSummaryResponse
33
38
  from cloudbeds_fiscal_document.models.fiscal_document_transaction_response import FiscalDocumentTransactionResponse
39
+ from cloudbeds_fiscal_document.models.fiscal_document_transactions_for_allocation_paginated import FiscalDocumentTransactionsForAllocationPaginated
34
40
  from cloudbeds_fiscal_document.models.fiscal_document_transactions_paginated import FiscalDocumentTransactionsPaginated
41
+ from cloudbeds_fiscal_document.models.fiscal_document_transactions_summary import FiscalDocumentTransactionsSummary
42
+ from cloudbeds_fiscal_document.models.fiscal_document_transactions_summary_taxes_inner import FiscalDocumentTransactionsSummaryTaxesInner
43
+ from cloudbeds_fiscal_document.models.get_credit_note_preview_request import GetCreditNotePreviewRequest
44
+ from cloudbeds_fiscal_document.models.get_invoice_preview_request import GetInvoicePreviewRequest
45
+ from cloudbeds_fiscal_document.models.get_rectify_invoice_note_preview_request import GetRectifyInvoiceNotePreviewRequest
35
46
  from cloudbeds_fiscal_document.models.government_integration import GovernmentIntegration
36
47
  from cloudbeds_fiscal_document.models.government_integration_qr import GovernmentIntegrationQr
48
+ from cloudbeds_fiscal_document.models.latest_linked_document import LatestLinkedDocument
49
+ from cloudbeds_fiscal_document.models.linked_document import LinkedDocument
50
+ from cloudbeds_fiscal_document.models.pro_forma_invoice_preview_request import ProFormaInvoicePreviewRequest
51
+ from cloudbeds_fiscal_document.models.pro_forma_invoice_request import ProFormaInvoiceRequest
52
+ from cloudbeds_fiscal_document.models.pro_forma_status_update_request import ProFormaStatusUpdateRequest
53
+ from cloudbeds_fiscal_document.models.receipt_transaction_allocation import ReceiptTransactionAllocation
37
54
  from cloudbeds_fiscal_document.models.recipient_address import RecipientAddress
38
55
  from cloudbeds_fiscal_document.models.recipient_contact_details import RecipientContactDetails
39
56
  from cloudbeds_fiscal_document.models.recipient_details import RecipientDetails
@@ -43,3 +60,4 @@ from cloudbeds_fiscal_document.models.recipient_tax_info import RecipientTaxInfo
43
60
  from cloudbeds_fiscal_document.models.recipient_type import RecipientType
44
61
  from cloudbeds_fiscal_document.models.rectify_invoice_note_request import RectifyInvoiceNoteRequest
45
62
  from cloudbeds_fiscal_document.models.source_kind import SourceKind
63
+ from cloudbeds_fiscal_document.models.transaction_for_allocation_response import TransactionForAllocationResponse
@@ -0,0 +1,98 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Fiscal document service API
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: v1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictInt
21
+ from typing import Any, ClassVar, Dict, List
22
+ from typing_extensions import Annotated
23
+ from cloudbeds_fiscal_document.models.receipt_transaction_allocation import ReceiptTransactionAllocation
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class AllocateReceiptPaymentRequest(BaseModel):
28
+ """
29
+ AllocateReceiptPaymentRequest
30
+ """ # noqa: E501
31
+ allocations: Annotated[List[ReceiptTransactionAllocation], Field(min_length=1)]
32
+ receipt_id: StrictInt = Field(description="Id of the receipt. ", alias="receiptId")
33
+ __properties: ClassVar[List[str]] = ["allocations", "receiptId"]
34
+
35
+ model_config = ConfigDict(
36
+ populate_by_name=True,
37
+ validate_assignment=True,
38
+ protected_namespaces=(),
39
+ )
40
+
41
+
42
+ def to_str(self) -> str:
43
+ """Returns the string representation of the model using alias"""
44
+ return pprint.pformat(self.model_dump(by_alias=True))
45
+
46
+ def to_json(self) -> str:
47
+ """Returns the JSON representation of the model using alias"""
48
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
49
+ return json.dumps(self.to_dict())
50
+
51
+ @classmethod
52
+ def from_json(cls, json_str: str) -> Optional[Self]:
53
+ """Create an instance of AllocateReceiptPaymentRequest from a JSON string"""
54
+ return cls.from_dict(json.loads(json_str))
55
+
56
+ def to_dict(self) -> Dict[str, Any]:
57
+ """Return the dictionary representation of the model using alias.
58
+
59
+ This has the following differences from calling pydantic's
60
+ `self.model_dump(by_alias=True)`:
61
+
62
+ * `None` is only added to the output dict for nullable fields that
63
+ were set at model initialization. Other fields with value `None`
64
+ are ignored.
65
+ """
66
+ excluded_fields: Set[str] = set([
67
+ ])
68
+
69
+ _dict = self.model_dump(
70
+ by_alias=True,
71
+ exclude=excluded_fields,
72
+ exclude_none=True,
73
+ )
74
+ # override the default output from pydantic by calling `to_dict()` of each item in allocations (list)
75
+ _items = []
76
+ if self.allocations:
77
+ for _item_allocations in self.allocations:
78
+ if _item_allocations:
79
+ _items.append(_item_allocations.to_dict())
80
+ _dict['allocations'] = _items
81
+ return _dict
82
+
83
+ @classmethod
84
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
85
+ """Create an instance of AllocateReceiptPaymentRequest from a dict"""
86
+ if obj is None:
87
+ return None
88
+
89
+ if not isinstance(obj, dict):
90
+ return cls.model_validate(obj)
91
+
92
+ _obj = cls.model_validate({
93
+ "allocations": [ReceiptTransactionAllocation.from_dict(_item) for _item in obj["allocations"]] if obj.get("allocations") is not None else None,
94
+ "receiptId": obj.get("receiptId")
95
+ })
96
+ return _obj
97
+
98
+
@@ -0,0 +1,89 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Fiscal document service API
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: v1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
21
+ from typing import Any, ClassVar, Dict, List, Optional, Union
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class AllocationsSummary(BaseModel):
26
+ """
27
+ AllocationsSummary
28
+ """ # noqa: E501
29
+ total_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalAmount")
30
+ total_allocated: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalAllocated")
31
+ __properties: ClassVar[List[str]] = ["totalAmount", "totalAllocated"]
32
+
33
+ model_config = ConfigDict(
34
+ populate_by_name=True,
35
+ validate_assignment=True,
36
+ protected_namespaces=(),
37
+ )
38
+
39
+
40
+ def to_str(self) -> str:
41
+ """Returns the string representation of the model using alias"""
42
+ return pprint.pformat(self.model_dump(by_alias=True))
43
+
44
+ def to_json(self) -> str:
45
+ """Returns the JSON representation of the model using alias"""
46
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
47
+ return json.dumps(self.to_dict())
48
+
49
+ @classmethod
50
+ def from_json(cls, json_str: str) -> Optional[Self]:
51
+ """Create an instance of AllocationsSummary from a JSON string"""
52
+ return cls.from_dict(json.loads(json_str))
53
+
54
+ def to_dict(self) -> Dict[str, Any]:
55
+ """Return the dictionary representation of the model using alias.
56
+
57
+ This has the following differences from calling pydantic's
58
+ `self.model_dump(by_alias=True)`:
59
+
60
+ * `None` is only added to the output dict for nullable fields that
61
+ were set at model initialization. Other fields with value `None`
62
+ are ignored.
63
+ """
64
+ excluded_fields: Set[str] = set([
65
+ ])
66
+
67
+ _dict = self.model_dump(
68
+ by_alias=True,
69
+ exclude=excluded_fields,
70
+ exclude_none=True,
71
+ )
72
+ return _dict
73
+
74
+ @classmethod
75
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
76
+ """Create an instance of AllocationsSummary from a dict"""
77
+ if obj is None:
78
+ return None
79
+
80
+ if not isinstance(obj, dict):
81
+ return cls.model_validate(obj)
82
+
83
+ _obj = cls.model_validate({
84
+ "totalAmount": obj.get("totalAmount"),
85
+ "totalAllocated": obj.get("totalAllocated")
86
+ })
87
+ return _obj
88
+
89
+
@@ -33,8 +33,11 @@ class CreateCreditNoteRequest(BaseModel):
33
33
  reason: Optional[StrictStr] = None
34
34
  user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="userId")
35
35
  method: CreationMethod
36
- transaction_ids: Optional[List[StrictInt]] = Field(default=None, alias="transactionIds")
37
- __properties: ClassVar[List[str]] = ["sequenceId", "invoiceId", "reason", "userId", "method", "transactionIds"]
36
+ transaction_ids: Optional[List[StrictInt]] = Field(default=None, description="Include transactions with the specified IDs (deprecated, use `includeTransactionIds` instead)", alias="transactionIds")
37
+ folio_ids: Optional[List[StrictInt]] = Field(default=None, description="Include all transactions from the specified folio IDs", alias="folioIds")
38
+ exclude_transaction_ids: Optional[List[StrictInt]] = Field(default=None, description="Exclude transactions with the specified IDs associated with selected folio IDs", alias="excludeTransactionIds")
39
+ include_transaction_ids: Optional[List[StrictInt]] = Field(default=None, description="Include transactions with the specified IDs", alias="includeTransactionIds")
40
+ __properties: ClassVar[List[str]] = ["sequenceId", "invoiceId", "reason", "userId", "method", "transactionIds", "folioIds", "excludeTransactionIds", "includeTransactionIds"]
38
41
 
39
42
  model_config = ConfigDict(
40
43
  populate_by_name=True,
@@ -107,7 +110,10 @@ class CreateCreditNoteRequest(BaseModel):
107
110
  "reason": obj.get("reason"),
108
111
  "userId": obj.get("userId"),
109
112
  "method": obj.get("method"),
110
- "transactionIds": obj.get("transactionIds")
113
+ "transactionIds": obj.get("transactionIds"),
114
+ "folioIds": obj.get("folioIds"),
115
+ "excludeTransactionIds": obj.get("excludeTransactionIds"),
116
+ "includeTransactionIds": obj.get("includeTransactionIds")
111
117
  })
112
118
  return _obj
113
119
 
@@ -29,13 +29,16 @@ class CreateInvoiceRequest(BaseModel):
29
29
  """
30
30
  CreateInvoiceRequest
31
31
  """ # noqa: E501
32
- transaction_ids: Annotated[List[Annotated[int, Field(strict=True, ge=1)]], Field(min_length=1)] = Field(alias="transactionIds")
32
+ transaction_ids: List[Annotated[int, Field(strict=True, ge=1)]] = Field(description="Include transactions with the specified IDs (deprecated, use `includeTransactionIds` instead)", alias="transactionIds")
33
33
  source_id: Annotated[int, Field(strict=True, ge=1)] = Field(alias="sourceId")
34
34
  sequence_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, alias="sequenceId")
35
35
  source_kind: SourceKind = Field(alias="sourceKind")
36
36
  user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="userId")
37
37
  recipient: RecipientRequest
38
- __properties: ClassVar[List[str]] = ["transactionIds", "sourceId", "sequenceId", "sourceKind", "userId", "recipient"]
38
+ 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")
39
+ exclude_transaction_ids: Optional[List[Annotated[int, Field(strict=True, ge=1)]]] = Field(default=None, description="Exclude transactions with the specified IDs associated with selected folio IDs", alias="excludeTransactionIds")
40
+ include_transaction_ids: Optional[List[Annotated[int, Field(strict=True, ge=1)]]] = Field(default=None, description="Include transactions with the specified IDs", alias="includeTransactionIds")
41
+ __properties: ClassVar[List[str]] = ["transactionIds", "sourceId", "sequenceId", "sourceKind", "userId", "recipient", "folioIds", "excludeTransactionIds", "includeTransactionIds"]
39
42
 
40
43
  model_config = ConfigDict(
41
44
  populate_by_name=True,
@@ -106,7 +109,10 @@ class CreateInvoiceRequest(BaseModel):
106
109
  "sequenceId": obj.get("sequenceId"),
107
110
  "sourceKind": obj.get("sourceKind"),
108
111
  "userId": obj.get("userId"),
109
- "recipient": RecipientRequest.from_dict(obj["recipient"]) if obj.get("recipient") is not None else None
112
+ "recipient": RecipientRequest.from_dict(obj["recipient"]) if obj.get("recipient") is not None else None,
113
+ "folioIds": obj.get("folioIds"),
114
+ "excludeTransactionIds": obj.get("excludeTransactionIds"),
115
+ "includeTransactionIds": obj.get("includeTransactionIds")
110
116
  })
111
117
  return _obj
112
118
 
@@ -0,0 +1,135 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Fiscal document service API
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: v1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictInt
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from typing_extensions import Annotated
23
+ from cloudbeds_fiscal_document.models.receipt_transaction_allocation import ReceiptTransactionAllocation
24
+ from cloudbeds_fiscal_document.models.recipient_request import RecipientRequest
25
+ from cloudbeds_fiscal_document.models.source_kind import SourceKind
26
+ from typing import Optional, Set
27
+ from typing_extensions import Self
28
+
29
+ class CreateReceiptRequest(BaseModel):
30
+ """
31
+ CreateReceiptRequest
32
+ """ # noqa: E501
33
+ allocations: Optional[Annotated[List[ReceiptTransactionAllocation], Field(min_length=1)]] = None
34
+ transaction_id: Optional[StrictInt] = Field(default=None, description="Id of the transaction associated to a payment. This parameter is mutually exclusive with `paymentId`. ", alias="transactionId")
35
+ payment_id: Optional[StrictInt] = Field(default=None, description="Id of the payment. This parameter is mutually exclusive with `transactionId`. ", alias="paymentId")
36
+ sequence_id: Optional[StrictInt] = Field(default=None, alias="sequenceId")
37
+ user_id: StrictInt = Field(alias="userId")
38
+ source_id: Annotated[int, Field(strict=True, ge=1)] = Field(alias="sourceId")
39
+ source_kind: SourceKind = Field(alias="sourceKind")
40
+ recipient: RecipientRequest
41
+ __properties: ClassVar[List[str]] = ["allocations", "transactionId", "paymentId", "sequenceId", "userId", "sourceId", "sourceKind", "recipient"]
42
+
43
+ model_config = ConfigDict(
44
+ populate_by_name=True,
45
+ validate_assignment=True,
46
+ protected_namespaces=(),
47
+ )
48
+
49
+
50
+ def to_str(self) -> str:
51
+ """Returns the string representation of the model using alias"""
52
+ return pprint.pformat(self.model_dump(by_alias=True))
53
+
54
+ def to_json(self) -> str:
55
+ """Returns the JSON representation of the model using alias"""
56
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
57
+ return json.dumps(self.to_dict())
58
+
59
+ @classmethod
60
+ def from_json(cls, json_str: str) -> Optional[Self]:
61
+ """Create an instance of CreateReceiptRequest from a JSON string"""
62
+ return cls.from_dict(json.loads(json_str))
63
+
64
+ def to_dict(self) -> Dict[str, Any]:
65
+ """Return the dictionary representation of the model using alias.
66
+
67
+ This has the following differences from calling pydantic's
68
+ `self.model_dump(by_alias=True)`:
69
+
70
+ * `None` is only added to the output dict for nullable fields that
71
+ were set at model initialization. Other fields with value `None`
72
+ are ignored.
73
+ """
74
+ excluded_fields: Set[str] = set([
75
+ ])
76
+
77
+ _dict = self.model_dump(
78
+ by_alias=True,
79
+ exclude=excluded_fields,
80
+ exclude_none=True,
81
+ )
82
+ # override the default output from pydantic by calling `to_dict()` of each item in allocations (list)
83
+ _items = []
84
+ if self.allocations:
85
+ for _item_allocations in self.allocations:
86
+ if _item_allocations:
87
+ _items.append(_item_allocations.to_dict())
88
+ _dict['allocations'] = _items
89
+ # override the default output from pydantic by calling `to_dict()` of recipient
90
+ if self.recipient:
91
+ _dict['recipient'] = self.recipient.to_dict()
92
+ # set to None if allocations (nullable) is None
93
+ # and model_fields_set contains the field
94
+ if self.allocations is None and "allocations" in self.model_fields_set:
95
+ _dict['allocations'] = None
96
+
97
+ # set to None if transaction_id (nullable) is None
98
+ # and model_fields_set contains the field
99
+ if self.transaction_id is None and "transaction_id" in self.model_fields_set:
100
+ _dict['transactionId'] = None
101
+
102
+ # set to None if payment_id (nullable) is None
103
+ # and model_fields_set contains the field
104
+ if self.payment_id is None and "payment_id" in self.model_fields_set:
105
+ _dict['paymentId'] = None
106
+
107
+ # set to None if sequence_id (nullable) is None
108
+ # and model_fields_set contains the field
109
+ if self.sequence_id is None and "sequence_id" in self.model_fields_set:
110
+ _dict['sequenceId'] = None
111
+
112
+ return _dict
113
+
114
+ @classmethod
115
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
116
+ """Create an instance of CreateReceiptRequest from a dict"""
117
+ if obj is None:
118
+ return None
119
+
120
+ if not isinstance(obj, dict):
121
+ return cls.model_validate(obj)
122
+
123
+ _obj = cls.model_validate({
124
+ "allocations": [ReceiptTransactionAllocation.from_dict(_item) for _item in obj["allocations"]] if obj.get("allocations") is not None else None,
125
+ "transactionId": obj.get("transactionId"),
126
+ "paymentId": obj.get("paymentId"),
127
+ "sequenceId": obj.get("sequenceId"),
128
+ "userId": obj.get("userId"),
129
+ "sourceId": obj.get("sourceId"),
130
+ "sourceKind": obj.get("sourceKind"),
131
+ "recipient": RecipientRequest.from_dict(obj["recipient"]) if obj.get("recipient") is not None else None
132
+ })
133
+ return _obj
134
+
135
+
@@ -0,0 +1,108 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Fiscal document service API
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: v1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictInt
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from typing_extensions import Annotated
23
+ from cloudbeds_fiscal_document.models.recipient_request import RecipientRequest
24
+ from cloudbeds_fiscal_document.models.source_kind import SourceKind
25
+ from typing import Optional, Set
26
+ from typing_extensions import Self
27
+
28
+ class CreateSimpleReceiptRequest(BaseModel):
29
+ """
30
+ CreateSimpleReceiptRequest
31
+ """ # noqa: E501
32
+ transaction_ids: List[Annotated[int, Field(strict=True)]] = Field(description="Ids of the transactions associated to payments", alias="transactionIds")
33
+ sequence_id: Optional[StrictInt] = Field(default=None, alias="sequenceId")
34
+ user_id: StrictInt = Field(alias="userId")
35
+ source_id: Annotated[int, Field(strict=True, ge=1)] = Field(alias="sourceId")
36
+ source_kind: SourceKind = Field(alias="sourceKind")
37
+ recipient: RecipientRequest
38
+ __properties: ClassVar[List[str]] = ["transactionIds", "sequenceId", "userId", "sourceId", "sourceKind", "recipient"]
39
+
40
+ model_config = ConfigDict(
41
+ populate_by_name=True,
42
+ validate_assignment=True,
43
+ protected_namespaces=(),
44
+ )
45
+
46
+
47
+ def to_str(self) -> str:
48
+ """Returns the string representation of the model using alias"""
49
+ return pprint.pformat(self.model_dump(by_alias=True))
50
+
51
+ def to_json(self) -> str:
52
+ """Returns the JSON representation of the model using alias"""
53
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
54
+ return json.dumps(self.to_dict())
55
+
56
+ @classmethod
57
+ def from_json(cls, json_str: str) -> Optional[Self]:
58
+ """Create an instance of CreateSimpleReceiptRequest from a JSON string"""
59
+ return cls.from_dict(json.loads(json_str))
60
+
61
+ def to_dict(self) -> Dict[str, Any]:
62
+ """Return the dictionary representation of the model using alias.
63
+
64
+ This has the following differences from calling pydantic's
65
+ `self.model_dump(by_alias=True)`:
66
+
67
+ * `None` is only added to the output dict for nullable fields that
68
+ were set at model initialization. Other fields with value `None`
69
+ are ignored.
70
+ """
71
+ excluded_fields: Set[str] = set([
72
+ ])
73
+
74
+ _dict = self.model_dump(
75
+ by_alias=True,
76
+ exclude=excluded_fields,
77
+ exclude_none=True,
78
+ )
79
+ # override the default output from pydantic by calling `to_dict()` of recipient
80
+ if self.recipient:
81
+ _dict['recipient'] = self.recipient.to_dict()
82
+ # set to None if sequence_id (nullable) is None
83
+ # and model_fields_set contains the field
84
+ if self.sequence_id is None and "sequence_id" in self.model_fields_set:
85
+ _dict['sequenceId'] = None
86
+
87
+ return _dict
88
+
89
+ @classmethod
90
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
91
+ """Create an instance of CreateSimpleReceiptRequest from a dict"""
92
+ if obj is None:
93
+ return None
94
+
95
+ if not isinstance(obj, dict):
96
+ return cls.model_validate(obj)
97
+
98
+ _obj = cls.model_validate({
99
+ "transactionIds": obj.get("transactionIds"),
100
+ "sequenceId": obj.get("sequenceId"),
101
+ "userId": obj.get("userId"),
102
+ "sourceId": obj.get("sourceId"),
103
+ "sourceKind": obj.get("sourceKind"),
104
+ "recipient": RecipientRequest.from_dict(obj["recipient"]) if obj.get("recipient") is not None else None
105
+ })
106
+ return _obj
107
+
108
+
@@ -24,6 +24,8 @@ from cloudbeds_fiscal_document.models.action import Action
24
24
  from cloudbeds_fiscal_document.models.fiscal_document_kind import FiscalDocumentKind
25
25
  from cloudbeds_fiscal_document.models.fiscal_document_status import FiscalDocumentStatus
26
26
  from cloudbeds_fiscal_document.models.government_integration import GovernmentIntegration
27
+ from cloudbeds_fiscal_document.models.latest_linked_document import LatestLinkedDocument
28
+ from cloudbeds_fiscal_document.models.linked_document import LinkedDocument
27
29
  from cloudbeds_fiscal_document.models.recipient_details import RecipientDetails
28
30
  from cloudbeds_fiscal_document.models.source_kind import SourceKind
29
31
  from typing import Optional, Set
@@ -38,14 +40,17 @@ class FiscalDocumentDetailedResponse(BaseModel):
38
40
  property_id: Optional[StrictStr] = Field(default=None, alias="propertyId")
39
41
  user_id: Optional[StrictStr] = Field(default=None, alias="userId")
40
42
  user_full_name: Optional[StrictStr] = Field(default=None, alias="userFullName")
43
+ source_name: Optional[StrictStr] = Field(default=None, alias="sourceName")
41
44
  source_id: Optional[StrictStr] = Field(default=None, alias="sourceId")
42
45
  source_kind: Optional[SourceKind] = Field(default=None, alias="sourceKind")
43
46
  kind: Optional[FiscalDocumentKind] = None
44
47
  invoice_date: Optional[date] = Field(default=None, alias="invoiceDate")
48
+ invoice_date_property_timezone: Optional[date] = Field(default=None, alias="invoiceDatePropertyTimezone")
45
49
  file_name: Optional[StrictStr] = Field(default=None, alias="fileName")
46
50
  amount: Optional[Union[StrictFloat, StrictInt]] = None
47
51
  balance: Optional[Union[StrictFloat, StrictInt]] = None
48
52
  due_date: Optional[date] = Field(default=None, alias="dueDate")
53
+ due_date_property_timezone: Optional[date] = Field(default=None, alias="dueDatePropertyTimezone")
49
54
  recipients: Optional[List[RecipientDetails]] = None
50
55
  status: Optional[FiscalDocumentStatus] = None
51
56
  origin: Optional[StrictStr] = None
@@ -55,8 +60,11 @@ class FiscalDocumentDetailedResponse(BaseModel):
55
60
  parent_id: Optional[StrictStr] = Field(default=None, alias="parentId")
56
61
  updated_at: Optional[datetime] = Field(default=None, alias="updatedAt")
57
62
  government_integration: Optional[GovernmentIntegration] = Field(default=None, alias="governmentIntegration")
63
+ latest_linked_document: Optional[LatestLinkedDocument] = Field(default=None, alias="latestLinkedDocument")
64
+ linked_documents: Optional[List[LinkedDocument]] = Field(default=None, description="List of documents linked to this fiscal document (both parent and child relationships)", alias="linkedDocuments")
58
65
  actions: Optional[List[Action]] = Field(default=None, description="Returns the list of actions available for the transaction")
59
- __properties: ClassVar[List[str]] = ["id", "number", "propertyId", "userId", "userFullName", "sourceId", "sourceKind", "kind", "invoiceDate", "fileName", "amount", "balance", "dueDate", "recipients", "status", "origin", "externalId", "failReason", "createdAt", "parentId", "updatedAt", "governmentIntegration", "actions"]
66
+ source_identifier: Optional[StrictStr] = Field(default=None, description="Reservation Identifier or a group code", alias="sourceIdentifier")
67
+ __properties: ClassVar[List[str]] = ["id", "number", "propertyId", "userId", "userFullName", "sourceName", "sourceId", "sourceKind", "kind", "invoiceDate", "invoiceDatePropertyTimezone", "fileName", "amount", "balance", "dueDate", "dueDatePropertyTimezone", "recipients", "status", "origin", "externalId", "failReason", "createdAt", "parentId", "updatedAt", "governmentIntegration", "latestLinkedDocument", "linkedDocuments", "actions", "sourceIdentifier"]
60
68
 
61
69
  model_config = ConfigDict(
62
70
  populate_by_name=True,
@@ -107,6 +115,16 @@ class FiscalDocumentDetailedResponse(BaseModel):
107
115
  # override the default output from pydantic by calling `to_dict()` of government_integration
108
116
  if self.government_integration:
109
117
  _dict['governmentIntegration'] = self.government_integration.to_dict()
118
+ # override the default output from pydantic by calling `to_dict()` of latest_linked_document
119
+ if self.latest_linked_document:
120
+ _dict['latestLinkedDocument'] = self.latest_linked_document.to_dict()
121
+ # override the default output from pydantic by calling `to_dict()` of each item in linked_documents (list)
122
+ _items = []
123
+ if self.linked_documents:
124
+ for _item_linked_documents in self.linked_documents:
125
+ if _item_linked_documents:
126
+ _items.append(_item_linked_documents.to_dict())
127
+ _dict['linkedDocuments'] = _items
110
128
  # override the default output from pydantic by calling `to_dict()` of each item in actions (list)
111
129
  _items = []
112
130
  if self.actions:
@@ -131,14 +149,17 @@ class FiscalDocumentDetailedResponse(BaseModel):
131
149
  "propertyId": obj.get("propertyId"),
132
150
  "userId": obj.get("userId"),
133
151
  "userFullName": obj.get("userFullName"),
152
+ "sourceName": obj.get("sourceName"),
134
153
  "sourceId": obj.get("sourceId"),
135
154
  "sourceKind": obj.get("sourceKind"),
136
155
  "kind": obj.get("kind"),
137
156
  "invoiceDate": obj.get("invoiceDate"),
157
+ "invoiceDatePropertyTimezone": obj.get("invoiceDatePropertyTimezone"),
138
158
  "fileName": obj.get("fileName"),
139
159
  "amount": obj.get("amount"),
140
160
  "balance": obj.get("balance"),
141
161
  "dueDate": obj.get("dueDate"),
162
+ "dueDatePropertyTimezone": obj.get("dueDatePropertyTimezone"),
142
163
  "recipients": [RecipientDetails.from_dict(_item) for _item in obj["recipients"]] if obj.get("recipients") is not None else None,
143
164
  "status": obj.get("status"),
144
165
  "origin": obj.get("origin"),
@@ -148,7 +169,10 @@ class FiscalDocumentDetailedResponse(BaseModel):
148
169
  "parentId": obj.get("parentId"),
149
170
  "updatedAt": obj.get("updatedAt"),
150
171
  "governmentIntegration": GovernmentIntegration.from_dict(obj["governmentIntegration"]) if obj.get("governmentIntegration") is not None else None,
151
- "actions": [Action.from_dict(_item) for _item in obj["actions"]] if obj.get("actions") is not None else None
172
+ "latestLinkedDocument": LatestLinkedDocument.from_dict(obj["latestLinkedDocument"]) if obj.get("latestLinkedDocument") is not None else None,
173
+ "linkedDocuments": [LinkedDocument.from_dict(_item) for _item in obj["linkedDocuments"]] if obj.get("linkedDocuments") is not None else None,
174
+ "actions": [Action.from_dict(_item) for _item in obj["actions"]] if obj.get("actions") is not None else None,
175
+ "sourceIdentifier": obj.get("sourceIdentifier")
152
176
  })
153
177
  return _obj
154
178