wflow-api 0.1.0__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.
- wflow_api/__init__.py +20 -0
- wflow_api/auth.py +85 -0
- wflow_api/client.py +130 -0
- wflow_api/errors.py +13 -0
- wflow_api/guards.py +132 -0
- wflow_api/models/__init__.py +128 -0
- wflow_api/models/account.py +127 -0
- wflow_api/models/admin.py +98 -0
- wflow_api/models/common.py +117 -0
- wflow_api/models/documents.py +514 -0
- wflow_api/models/registers.py +165 -0
- wflow_api/models/requests.py +341 -0
- wflow_api/models/storage.py +38 -0
- wflow_api/operation.py +50 -0
- wflow_api/operations/__init__.py +21 -0
- wflow_api/operations/account.py +46 -0
- wflow_api/operations/admin.py +307 -0
- wflow_api/operations/approvals.py +235 -0
- wflow_api/operations/document_files.py +145 -0
- wflow_api/operations/document_properties.py +204 -0
- wflow_api/operations/document_tags.py +60 -0
- wflow_api/operations/documents.py +603 -0
- wflow_api/operations/integrations.py +63 -0
- wflow_api/operations/organization.py +51 -0
- wflow_api/operations/registers.py +2273 -0
- wflow_api/operations/storage_files.py +477 -0
- wflow_api/operations/storage_folders.py +132 -0
- wflow_api/operations/webhooks.py +67 -0
- wflow_api/py.typed +0 -0
- wflow_api-0.1.0.dist-info/METADATA +48 -0
- wflow_api-0.1.0.dist-info/RECORD +33 -0
- wflow_api-0.1.0.dist-info/WHEEL +4 -0
- wflow_api-0.1.0.dist-info/licenses/LICENSE +202 -0
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
"""Register models, mirroring the schemas in the wflow OpenAPI spec.
|
|
2
|
+
|
|
3
|
+
These carry the spec's own schema names, including BusinessItemUpdateC and
|
|
4
|
+
PartnerPersonUpdateC, so the code and the published reference read side by side. The
|
|
5
|
+
register GET endpoints document no response body; every model here is the item schema
|
|
6
|
+
that the PUT on the same path documents.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
from pydantic import Field
|
|
10
|
+
|
|
11
|
+
from wflow_api.models.common import WflowModel
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class Register(WflowModel):
|
|
15
|
+
"""The five fields every register shares."""
|
|
16
|
+
|
|
17
|
+
id: str | None = None
|
|
18
|
+
externalId: str | None = None
|
|
19
|
+
code: str | None = None
|
|
20
|
+
description: str | None = None
|
|
21
|
+
isValid: bool | None = None
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
class RegisterBase(WflowModel):
|
|
25
|
+
"""A reference to a register record. The spec declares three fields; wflow sends five."""
|
|
26
|
+
|
|
27
|
+
id: str | None = None
|
|
28
|
+
externalId: str | None = None
|
|
29
|
+
code: str | None = None
|
|
30
|
+
description: str | None = None
|
|
31
|
+
isValid: bool | None = None
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class RegisterId(WflowModel):
|
|
35
|
+
"""A reference to a partner."""
|
|
36
|
+
|
|
37
|
+
id: str | None = None
|
|
38
|
+
externalId: str | None = None
|
|
39
|
+
ic: str | None = Field(default=None, description="Company registration number")
|
|
40
|
+
vat: str | None = Field(default=None, description="VAT identification number")
|
|
41
|
+
name: str | None = None
|
|
42
|
+
address: str | None = Field(default=None, description="Street, post code, town, country as one string")
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
# The spec gives this shape two names; RegisterId is the same fields.
|
|
46
|
+
NoCodeRegisterBase = RegisterId
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
class KindRegister(Register):
|
|
50
|
+
kind: str | None = Field(
|
|
51
|
+
default=None,
|
|
52
|
+
description="IncomingInvoice, OutgoingInvoice, ExpenditureCashSlip, SupplierOrder, "
|
|
53
|
+
"CustomerOrder, Contract, IncomeCashReceipt or Other",
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# The spec gives this shape two names; PaymentMethods is a KindRegister field for field.
|
|
58
|
+
PaymentMethods = KindRegister
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
class Serie(KindRegister):
|
|
62
|
+
invoiceType: str | None = Field(
|
|
63
|
+
default=None, description="TaxInvoice, CreditNote, DebitNote, Proforma or TaxInvoicePayment"
|
|
64
|
+
)
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
class VATReturnLine(Register):
|
|
68
|
+
reverseCharge: bool | None = None
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
class Location(Register):
|
|
72
|
+
address: str | None = None
|
|
73
|
+
contact: str | None = None
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
class AddressType(WflowModel):
|
|
77
|
+
streetAndNumber: str | None = None
|
|
78
|
+
addressSupplement: str | None = None
|
|
79
|
+
postalCode: str | None = None
|
|
80
|
+
city: str | None = None
|
|
81
|
+
countryCode: str | None = Field(default=None, description="ISO two-letter country code")
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
class PartnerAccount(WflowModel):
|
|
85
|
+
accountNo: str | None = None
|
|
86
|
+
bankCode: str | None = None
|
|
87
|
+
iban: str | None = None
|
|
88
|
+
bic: str | None = Field(default=None, description="SWIFT code")
|
|
89
|
+
currency: str | None = None
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
class PartnerPeppolId(WflowModel):
|
|
93
|
+
peppolId: str | None = None
|
|
94
|
+
isDefault: bool | None = None
|
|
95
|
+
isValid: bool | None = None
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
class OrganizationPerson(WflowModel):
|
|
99
|
+
id: str | None = None
|
|
100
|
+
externalId: str | None = None
|
|
101
|
+
firstName: str | None = None
|
|
102
|
+
lastName: str | None = None
|
|
103
|
+
street: str | None = None
|
|
104
|
+
postCode: str | None = None
|
|
105
|
+
city: str | None = None
|
|
106
|
+
phoneNo: str | None = None
|
|
107
|
+
mailAddress: str | None = None
|
|
108
|
+
language: str | None = Field(default=None, description="ISO 639-1 code")
|
|
109
|
+
isValid: bool | None = None
|
|
110
|
+
contractRole: str | None = Field(
|
|
111
|
+
default=None, description="Sign, Stamp, Approve, SignWithBankId or SignWithCertificate"
|
|
112
|
+
)
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
class PartnerPersonUpdateC(OrganizationPerson):
|
|
116
|
+
partner: NoCodeRegisterBase | None = Field(default=None, description="The partner this person belongs to")
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
class PartnerFull(WflowModel):
|
|
120
|
+
id: str | None = None
|
|
121
|
+
externalId: str | None = None
|
|
122
|
+
ic: str | None = Field(default=None, description="Company registration number")
|
|
123
|
+
vat: str | None = Field(default=None, description="VAT identification number")
|
|
124
|
+
name: str | None = None
|
|
125
|
+
address: str | None = Field(default=None, description="Street, post code, town, country as one string")
|
|
126
|
+
mainAddress: AddressType | None = None
|
|
127
|
+
localVAT: str | None = None
|
|
128
|
+
note: str | None = None
|
|
129
|
+
phoneNo: str | None = None
|
|
130
|
+
mailAddress: str | None = None
|
|
131
|
+
deliveryPeriod: int | None = Field(default=None, description="Standard delivery period in days")
|
|
132
|
+
minOrderTotal: float | None = None
|
|
133
|
+
toleranceRate: int | None = Field(default=None, description="Automatic pairing tolerance by total amount")
|
|
134
|
+
language: str | None = Field(default=None, description="ISO 639-1 code")
|
|
135
|
+
isValid: bool | None = None
|
|
136
|
+
businessRegisterRegistration: str | None = None
|
|
137
|
+
customer: bool | None = None
|
|
138
|
+
supplier: bool | None = None
|
|
139
|
+
accountNo: str | None = None
|
|
140
|
+
bankCode: str | None = None
|
|
141
|
+
iban: str | None = None
|
|
142
|
+
bic: str | None = None
|
|
143
|
+
currency: str | None = None
|
|
144
|
+
mainAccount: PartnerAccount | None = None
|
|
145
|
+
accounts: list[PartnerAccount] | None = Field(default=None, description="Other bank accounts")
|
|
146
|
+
peppolIds: list[PartnerPeppolId] | None = None
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
class BusinessItemUpdateC(WflowModel):
|
|
150
|
+
"""The spec declares no `updated`; wflow sends one on a read, so a PUT of that record carries it."""
|
|
151
|
+
|
|
152
|
+
id: str | None = None
|
|
153
|
+
externalId: str | None = None
|
|
154
|
+
code: str | None = None
|
|
155
|
+
description: str | None = None
|
|
156
|
+
isValid: bool | None = None
|
|
157
|
+
updated: str | None = Field(default=None, description="Last update date (yyyy-mm-ddThh:mm:ss.ffffff)")
|
|
158
|
+
unitPrice: float | None = None
|
|
159
|
+
vatType: str | None = Field(default=None, description="Exempt, FirstReduced, SecondReduced or Basic")
|
|
160
|
+
currency: str | None = None
|
|
161
|
+
purchase: bool | None = None
|
|
162
|
+
sales: bool | None = None
|
|
163
|
+
category: RegisterBase | None = None
|
|
164
|
+
partner: RegisterId | None = None
|
|
165
|
+
measureUnit: RegisterBase | None = None
|
|
@@ -0,0 +1,341 @@
|
|
|
1
|
+
"""Request bodies for the write endpoints, generated from the wflow OpenAPI spec.
|
|
2
|
+
|
|
3
|
+
Regenerate with:
|
|
4
|
+
|
|
5
|
+
uv run scripts/wflow_spec.py --models DocumentUpdate DocumentTypeFull PropertyUpdate PropertyDefinition PaymentCreate IdType RoleUpdate TeamUpdate UserUpdate StorageFolderUpdate WebHookRegistration ApprovalsTemplateUpdate ApprovalsTemplateTeams StructuredFilter ApiClientResult
|
|
6
|
+
|
|
7
|
+
then review the diff; hand-written descriptions live here and must not be lost.
|
|
8
|
+
|
|
9
|
+
Every field is optional, and operations serialise with `model_dump(exclude_none=True)`: a whole-record
|
|
10
|
+
write that sent every unset optional as null would clear data the caller never mentioned.
|
|
11
|
+
|
|
12
|
+
That command's dependency closure emits 32 classes, not the 23 below. The other 9 are schemas
|
|
13
|
+
this codebase already models elsewhere, so delete them from the regenerated output — one name
|
|
14
|
+
must mean one shape. Four are imported back, so that every write body is reachable from here:
|
|
15
|
+
|
|
16
|
+
- from wflow_api.models.admin: ApprovalsTemplatesTeam, WebHookRegistration
|
|
17
|
+
- from wflow_api.models.documents: DocumentTypeFull, PropertyDefinition
|
|
18
|
+
|
|
19
|
+
The remaining five — `Identity`, `SequenceBase`, `UserBase` and `UserPermission` from
|
|
20
|
+
wflow_api.models.documents, `Serie` from wflow_api.models.registers — reach the closure only as
|
|
21
|
+
dependencies of DocumentTypeFull. With that imported, nothing here needs them: drop them."""
|
|
22
|
+
|
|
23
|
+
from typing import Any
|
|
24
|
+
|
|
25
|
+
from pydantic import Field
|
|
26
|
+
|
|
27
|
+
from wflow_api.models.admin import ApprovalsTemplatesTeam, WebHookRegistration # noqa: F401 — re-exported
|
|
28
|
+
from wflow_api.models.common import WflowModel, WflowTimestamp
|
|
29
|
+
from wflow_api.models.documents import DocumentTypeFull, PropertyDefinition # noqa: F401 — re-exported
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
class DocumentUpdateType(WflowModel):
|
|
33
|
+
"""Document update model"""
|
|
34
|
+
|
|
35
|
+
id: str | None = Field(default=None, description="Id")
|
|
36
|
+
kind: str | None = Field(
|
|
37
|
+
default=None,
|
|
38
|
+
description="One of: IncomingInvoice, OutgoingInvoice, ExpenditureCashSlip, SupplierOrder, CustomerOrder, Other, Contract, IncomeCashReceipt",
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
class DocumentUpdateAddressType(WflowModel):
|
|
43
|
+
"""Document update address type with individual property change tracking"""
|
|
44
|
+
|
|
45
|
+
streetAndNumber: str | None = Field(default=None, description="Street and number")
|
|
46
|
+
addressSupplement: str | None = Field(default=None, description="Address supplement (additional address info)")
|
|
47
|
+
postalCode: str | None = Field(default=None, description="Postal code")
|
|
48
|
+
city: str | None = Field(default=None, description="City")
|
|
49
|
+
countryCode: str | None = Field(default=None, description="Country code (ISO 3166-1 alpha-2)")
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
class DocumentUpdateRegister(WflowModel):
|
|
53
|
+
"""Document update register"""
|
|
54
|
+
|
|
55
|
+
id: str | None = Field(default=None, description="Id")
|
|
56
|
+
externalId: str | None = Field(default=None, description="External Id")
|
|
57
|
+
code: str | None = Field(default=None, description="Code")
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
class DocumentUpdatePartner(WflowModel):
|
|
61
|
+
"""Document update model"""
|
|
62
|
+
|
|
63
|
+
id: str | None = Field(default=None, description="Gets or sets the identifier.")
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
class DocumentUpdateVat(WflowModel):
|
|
67
|
+
"""Document update VAT"""
|
|
68
|
+
|
|
69
|
+
type: str | None = Field(default=None, description="One of: Exempt, FirstReduced, SecondReduced, Basic")
|
|
70
|
+
rate: float | None = Field(default=None, description="VAT percent rate (decimal (4,2))")
|
|
71
|
+
base: float | None = Field(default=None, description="VAT base amount (decimal (18,2))")
|
|
72
|
+
tax: float | None = Field(default=None, description="VAT tax amount (decimal (18,2))")
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class DocumentUpdateAccounting(WflowModel):
|
|
76
|
+
"""Document for update accounting"""
|
|
77
|
+
|
|
78
|
+
businessItemCode: str | None = Field(default=None, description="Business item code")
|
|
79
|
+
accountingRule: DocumentUpdateRegister | None = None
|
|
80
|
+
activity: DocumentUpdateRegister | None = None
|
|
81
|
+
businessCase: DocumentUpdateRegister | None = None
|
|
82
|
+
cardDocumentType: DocumentUpdateRegister | None = None
|
|
83
|
+
cashDocumentType: DocumentUpdateRegister | None = None
|
|
84
|
+
cashRegister: DocumentUpdateRegister | None = None
|
|
85
|
+
contraAccount: DocumentUpdateRegister | None = None
|
|
86
|
+
contract: DocumentUpdateRegister | None = None
|
|
87
|
+
costCenter: DocumentUpdateRegister | None = None
|
|
88
|
+
employee: DocumentUpdateRegister | None = None
|
|
89
|
+
paymentMethod: DocumentUpdateRegister | None = None
|
|
90
|
+
project: DocumentUpdateRegister | None = None
|
|
91
|
+
vatControlStatementLine: DocumentUpdateRegister | None = None
|
|
92
|
+
vatReturnLine: DocumentUpdateRegister | None = None
|
|
93
|
+
vatReverseChargeCode: DocumentUpdateRegister | None = None
|
|
94
|
+
vehicle: DocumentUpdateRegister | None = None
|
|
95
|
+
vatSupplyModeCode: str | None = Field(default=None, description="One of: Normal, TravelService, UsedGoods")
|
|
96
|
+
vatApplyReductionCoefficient: bool | None = Field(
|
|
97
|
+
default=None, description="VAT apply reduction coefficient indicator"
|
|
98
|
+
)
|
|
99
|
+
vatFixedAssets: bool | None = Field(default=None, description="VAT fixed assets indicator")
|
|
100
|
+
vatMode: str | None = Field(
|
|
101
|
+
default=None, description="One of: Standard, ReverseChargeDomestic, ReverseCharge, Excluded, InForeignCurrency"
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
class DocumentUpdateLine(WflowModel):
|
|
106
|
+
"""Document update line"""
|
|
107
|
+
|
|
108
|
+
id: str | None = Field(default=None, description="Id")
|
|
109
|
+
totalAmount: float | None = Field(default=None, description="Total amount (decimal (18,2))")
|
|
110
|
+
totalAmountFC: float | None = Field(default=None, description="Total amonut in foriegn currency (decimal (18,2))")
|
|
111
|
+
accountCode: str | None = Field(default=None, description="Accounting account code")
|
|
112
|
+
currency: str | None = Field(default=None, description="Currency ISO code (fixed length 3 chars)")
|
|
113
|
+
description: str | None = Field(default=None, description="Item description")
|
|
114
|
+
quantity: float | None = Field(default=None, description="Quantity (decimal (14,6))")
|
|
115
|
+
unitPrice: float | None = Field(default=None, description="Unit price (decimal (14,6))")
|
|
116
|
+
measureUnit: str | None = Field(default=None, description="Measure unit")
|
|
117
|
+
order: int | None = Field(default=None, description="Item order index in list")
|
|
118
|
+
accounting: DocumentUpdateAccounting | None = None
|
|
119
|
+
vatType: str | None = Field(default=None, description="One of: Exempt, FirstReduced, SecondReduced, Basic")
|
|
120
|
+
vatRate: float | None = Field(default=None, description="VAT percent rate (decimal (4,2))")
|
|
121
|
+
code: str | None = Field(default=None, description="Item code")
|
|
122
|
+
costCenter: DocumentUpdateRegister | None = None
|
|
123
|
+
contract: DocumentUpdateRegister | None = None
|
|
124
|
+
activity: DocumentUpdateRegister | None = None
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
class DocumentUpdate(WflowModel):
|
|
128
|
+
"""Document for update"""
|
|
129
|
+
|
|
130
|
+
id: str | None = Field(default=None, description="Id")
|
|
131
|
+
type: DocumentUpdateType | None = None
|
|
132
|
+
number: str | None = Field(default=None, description="Number")
|
|
133
|
+
internalCode: str | None = Field(default=None, description="Internal code")
|
|
134
|
+
vatDocumentCode: str | None = Field(default=None, description="VAT code")
|
|
135
|
+
variableSymbol: str | None = Field(default=None, description="Variable symbol")
|
|
136
|
+
constantSymbol: str | None = Field(default=None, description="Constant symbol")
|
|
137
|
+
specificSymbol: str | None = Field(default=None, description="Specific symbol")
|
|
138
|
+
issueDate: WflowTimestamp | None = Field(default=None, description="Issue date (yyyy-mm-ddThh:mm:ss.ffffff)")
|
|
139
|
+
dueDate: WflowTimestamp | None = Field(default=None, description="Due date (yyyy-mm-ddThh:mm:ss.ffffff)")
|
|
140
|
+
vatDate: WflowTimestamp | None = Field(default=None, description="VAT date (yyyy-mm-ddThh:mm:ss.ffffff)")
|
|
141
|
+
acceptDate: WflowTimestamp | None = Field(default=None, description="Accept date (yyyy-mm-ddThh:mm:ss.ffffff)")
|
|
142
|
+
caseDate: WflowTimestamp | None = Field(default=None, description="Case date (yyyy-mm-ddThh:mm:ss.ffffff)")
|
|
143
|
+
validFrom: WflowTimestamp | None = Field(
|
|
144
|
+
default=None, description="Valid from (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
145
|
+
)
|
|
146
|
+
validTo: WflowTimestamp | None = Field(
|
|
147
|
+
default=None, description="Valid to (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
148
|
+
)
|
|
149
|
+
effectiveFrom: WflowTimestamp | None = Field(
|
|
150
|
+
default=None, description="Effective from (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
151
|
+
)
|
|
152
|
+
effectiveTo: WflowTimestamp | None = Field(
|
|
153
|
+
default=None, description="Effective to (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
154
|
+
)
|
|
155
|
+
signatureDate: WflowTimestamp | None = Field(
|
|
156
|
+
default=None, description="Signature date (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
157
|
+
)
|
|
158
|
+
reviewDate: WflowTimestamp | None = Field(
|
|
159
|
+
default=None, description="Review date (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
160
|
+
)
|
|
161
|
+
accountTerm: str | None = Field(default=None, description="Accounting period (yyyy/mm)")
|
|
162
|
+
vatTerm: str | None = Field(default=None, description="VAT period (yyyy/mm)")
|
|
163
|
+
totalAmount: float | None = Field(default=None, description="Total amount (decimal (18,2))")
|
|
164
|
+
roundingAmount: float | None = Field(default=None, description="Rounding ammount (decimal (3,2))")
|
|
165
|
+
totalAmountFC: float | None = Field(default=None, description="Total amonut in foriegn currency (decimal (18,2))")
|
|
166
|
+
advanceAmount: float | None = Field(default=None, description="Advance amount (decimal (18,2))")
|
|
167
|
+
currency: str | None = Field(default=None, description="Currency ISO code (fixed length 3 chars)")
|
|
168
|
+
partnerIC: str | None = Field(default=None, description="Partner ID")
|
|
169
|
+
partnerVAT: str | None = Field(default=None, description="Partner VAT ID")
|
|
170
|
+
partnerLocalVAT: str | None = Field(default=None, description="Partner local VAT ID")
|
|
171
|
+
partnerName: str | None = Field(default=None, description="Partner name")
|
|
172
|
+
partnerAddress: str | None = Field(
|
|
173
|
+
default=None, description="Partner address (street, post code, town, country,...)"
|
|
174
|
+
)
|
|
175
|
+
partnerMainAddress: DocumentUpdateAddressType | None = None
|
|
176
|
+
partnerEmail: str | None = Field(default=None, description="Partner e-mail address")
|
|
177
|
+
accountNo: str | None = Field(default=None, description="Partner bank account No")
|
|
178
|
+
bankCode: str | None = Field(default=None, description="Partner bank code")
|
|
179
|
+
iban: str | None = Field(default=None, description="Partner IBAN")
|
|
180
|
+
bic: str | None = Field(default=None, description="Partner BIC code (SWIFT)")
|
|
181
|
+
meIC: str | None = Field(default=None, description="Recipient's ID")
|
|
182
|
+
meVAT: str | None = Field(default=None, description="Recipient's VAT")
|
|
183
|
+
myBankAccountNo: str | None = Field(
|
|
184
|
+
default=None, description="Recipient's bank account number (snapshot taken at document creation)"
|
|
185
|
+
)
|
|
186
|
+
myBankCode: str | None = Field(
|
|
187
|
+
default=None, description="Recipient's bank code (snapshot taken at document creation)"
|
|
188
|
+
)
|
|
189
|
+
myIBAN: str | None = Field(default=None, description="Recipient's IBAN (snapshot taken at document creation)")
|
|
190
|
+
myBIC: str | None = Field(default=None, description="Recipient's BIC/SWIFT (snapshot taken at document creation)")
|
|
191
|
+
myBankCurrency: str | None = Field(
|
|
192
|
+
default=None, description="Recipient's bank account currency (snapshot taken at document creation)"
|
|
193
|
+
)
|
|
194
|
+
exchangeRate: float | None = Field(default=None, description="Exchange rate")
|
|
195
|
+
exchangeRateUnits: int | None = Field(default=None, description="Exchange rate units")
|
|
196
|
+
tag: str | None = Field(default=None, description="Special document identification")
|
|
197
|
+
orderNo: str | None = Field(default=None, description="Linked order number")
|
|
198
|
+
description: str | None = Field(default=None, description="Document description")
|
|
199
|
+
contactPersonName: str | None = Field(default=None, description="Contact person name")
|
|
200
|
+
contactPersonEmail: str | None = Field(default=None, description="Contact person email")
|
|
201
|
+
invoiceType: str | None = Field(
|
|
202
|
+
default=None, description="One of: TaxInvoice, CreditNote, DebitNote, Proforma, TaxInvoicePayment"
|
|
203
|
+
)
|
|
204
|
+
expectedDeliveryDate: WflowTimestamp | None = Field(
|
|
205
|
+
default=None, description="Expected delivery date - for orders only (yyyy-mm-ddThh:mm:ss.ffffff)"
|
|
206
|
+
)
|
|
207
|
+
deliveryLocation: DocumentUpdateRegister | None = None
|
|
208
|
+
series: str | None = Field(default=None, description="Series")
|
|
209
|
+
depricatedSeries: bool | None = None
|
|
210
|
+
serie: DocumentUpdateRegister | None = None
|
|
211
|
+
accountCode: str | None = Field(default=None, description="Accounting account code")
|
|
212
|
+
doNotPay: bool | None = Field(default=None, description="Do not pay")
|
|
213
|
+
partner: DocumentUpdatePartner | None = None
|
|
214
|
+
vaTs: list[DocumentUpdateVat] | None = Field(default=None, description="VAT subtotals")
|
|
215
|
+
lines: list[DocumentUpdateLine] | None = Field(default=None, description="Lines list")
|
|
216
|
+
accounting: DocumentUpdateAccounting | None = None
|
|
217
|
+
taxExclusiveAmount: float | None = None
|
|
218
|
+
taxAmount: float | None = None
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
class PropertyUpdate(WflowModel):
|
|
222
|
+
"""Custom property for update"""
|
|
223
|
+
|
|
224
|
+
id: str | None = Field(default=None, description="Id")
|
|
225
|
+
value: Any | None = Field(default=None, description="Value")
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
class PaymentCreate(WflowModel):
|
|
229
|
+
date: WflowTimestamp | None = None
|
|
230
|
+
info: str | None = None
|
|
231
|
+
amount: float | None = None
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
class IdType(WflowModel):
|
|
235
|
+
id: str | None = None
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
class RoleUpdate(WflowModel):
|
|
239
|
+
"""Role for update"""
|
|
240
|
+
|
|
241
|
+
name: str | None = Field(default=None, description="Gets or sets the name.")
|
|
242
|
+
description: str | None = Field(default=None, description="Gets or sets the description.")
|
|
243
|
+
users: list[str] | None = Field(default=None, description="Gets or sets the users collection.")
|
|
244
|
+
rights: list[str] | None = Field(
|
|
245
|
+
default=None,
|
|
246
|
+
description="Gets or sets the rights collection. One of: CanApprove, CanReview, CanManageApprovalPath, CanCreateDocument, CanDeleteDocument, CanManageAccess, CanChangeDocumentType, CanLock, CanManageAttachments, CanSendToExtraction, CanSendToReview, CanSendToErp, CanManageDocumentLinks, CanManageDocument, CanManageDocumentAccounting, CanManageCustomProperty, CanManageTags, CanManagePayments, CanMarkForPayment, CanExport, CanManageExternalSignature, CanStamp, CanManagePartners, CanManageBusinessItems, CanManageDocumentLinesTemplates, CanManageRegisters, CanManageSettings, CanManageFileStorage, CanManageExpenses, CanViewExpenses, CanViewReporting, CanManageBudgeting, CanManageDocumentBudgets, CanMoveDocumentToOtherOrganization, CanAccessInbox, CanRejectPeppolMessage",
|
|
247
|
+
)
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
class TeamUpdate(WflowModel):
|
|
251
|
+
"""Team for updating"""
|
|
252
|
+
|
|
253
|
+
name: str | None = Field(default=None, description="Gets or sets the name.")
|
|
254
|
+
description: str | None = Field(default=None, description="Gets or sets the description.")
|
|
255
|
+
users: list[str] | None = Field(default=None, description="Gets or sets the users collection.")
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
class IdAndPermission(WflowModel):
|
|
259
|
+
id: str | None = None
|
|
260
|
+
permission: str | None = Field(default=None, description="One of: All, OnlyAssigned, FullAccess")
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
class UserUpdate(WflowModel):
|
|
264
|
+
"""User to update"""
|
|
265
|
+
|
|
266
|
+
login: str | None = Field(default=None, description="Login name.")
|
|
267
|
+
hasFullAccess: bool | None = Field(default=None, description="Has full access permission.")
|
|
268
|
+
roles: list[IdType] | None = Field(default=None, description="Role membership.")
|
|
269
|
+
teams: list[IdType] | None = Field(default=None, description="Team membership.")
|
|
270
|
+
documentTypes: list[IdAndPermission] | None = Field(default=None, description="Document Type access")
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
class StorageFolderUpdate(WflowModel):
|
|
274
|
+
"""Storage folder for udate"""
|
|
275
|
+
|
|
276
|
+
id: str | None = Field(default=None, description="Gets or sets the identifier.")
|
|
277
|
+
parentId: str | None = Field(default=None, description="Gets or sets the parent identifier.")
|
|
278
|
+
name: str | None = Field(default=None, description="Gets or sets the name.")
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
class ApprovalsTemplateUpdate(WflowModel):
|
|
282
|
+
"""Approvals template for update"""
|
|
283
|
+
|
|
284
|
+
teams: list[ApprovalsTemplatesTeam] | None = Field(default=None, description="Approvals teams collection")
|
|
285
|
+
accessTeams: list[str] | None = Field(default=None, description="Teams collection for automatic set access")
|
|
286
|
+
id: str | None = Field(default=None, description="Id")
|
|
287
|
+
name: str | None = Field(default=None, description="Name")
|
|
288
|
+
conditionFolders: list[str] | None = Field(
|
|
289
|
+
default=None, description="Storage folder IDs collection for conditional assignment"
|
|
290
|
+
)
|
|
291
|
+
validationLockLevel: int | None = Field(default=None, description="Validation lock level")
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
class ApprovalsTemplateTeams(WflowModel):
|
|
295
|
+
"""Approvals template teams for update"""
|
|
296
|
+
|
|
297
|
+
teams: list[ApprovalsTemplatesTeam] | None = Field(default=None, description="Approvals teams collection")
|
|
298
|
+
accessTeams: list[str] | None = Field(default=None, description="Teams collection for automatic set access")
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
class Filter(WflowModel):
|
|
302
|
+
operator: str | None = Field(default=None, description="One of: EQ, NE, GT, GE, LT, LE, IN, NI, CO, NC, DR, FD")
|
|
303
|
+
value: Any | None = None
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
class ColumnAndFilter(WflowModel):
|
|
307
|
+
column: str | None = None
|
|
308
|
+
filters: list[Filter] | None = None
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
class PropertyFilter(WflowModel):
|
|
312
|
+
operator: str | None = Field(default=None, description="One of: EQ, NE, GT, GE, LT, LE, IN, NI, CO, NC, DR, FD")
|
|
313
|
+
value: Any | None = None
|
|
314
|
+
key: str | None = None
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
class StructuredFilter(WflowModel):
|
|
318
|
+
search: str | None = None
|
|
319
|
+
sort: str | None = None
|
|
320
|
+
filters: list[ColumnAndFilter] | None = None
|
|
321
|
+
propertyFilters: list[PropertyFilter] | None = None
|
|
322
|
+
validationType: list[str] | None = Field(
|
|
323
|
+
default=None,
|
|
324
|
+
description="One of: Duplicity, UnreliablePayer, RequiredField, InconsistentAmountsTotal, InconsistentAmountsLines, VatCalculation, VatRate, ExtremeDate, InvalidOrganization, InconsistentLines, MissingPartner, PartnerBankAccountMismatch, IbanValidation",
|
|
325
|
+
)
|
|
326
|
+
|
|
327
|
+
def with_empty_restrictions(self) -> "StructuredFilter":
|
|
328
|
+
"""The export endpoint answers 500 to a null `search`, `filters` or `propertyFilters`;
|
|
329
|
+
sent empty, each one restricts nothing, which is what leaving it out means."""
|
|
330
|
+
return self.model_copy(
|
|
331
|
+
update={
|
|
332
|
+
"search": self.search if self.search is not None else "",
|
|
333
|
+
"filters": self.filters if self.filters is not None else [],
|
|
334
|
+
"propertyFilters": self.propertyFilters if self.propertyFilters is not None else [],
|
|
335
|
+
}
|
|
336
|
+
)
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
class ApiClientResult(WflowModel):
|
|
340
|
+
id: str | None = None
|
|
341
|
+
secret: str | None = None
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"""Generated from the wflow OpenAPI spec, then refined by hand.
|
|
2
|
+
|
|
3
|
+
Regenerate with `uv run scripts/wflow_spec.py --models <Name> ...` and review
|
|
4
|
+
the diff; hand-written descriptions live here and must not be lost."""
|
|
5
|
+
|
|
6
|
+
from pydantic import Field
|
|
7
|
+
|
|
8
|
+
from wflow_api.models.common import WflowModel, WflowTimestamp
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class StorageFile(WflowModel):
|
|
12
|
+
"""Storage file"""
|
|
13
|
+
|
|
14
|
+
id: str | None = Field(default=None, description="Gets or sets the identifier.")
|
|
15
|
+
name: str | None = Field(default=None, description="Gets or sets the name.")
|
|
16
|
+
description: str | None = Field(default=None, description="Gets or sets the description.")
|
|
17
|
+
created: WflowTimestamp | None = Field(default=None, description="Gets or sets the created date.")
|
|
18
|
+
updated: WflowTimestamp | None = Field(default=None, description="Gets or sets the updated date.")
|
|
19
|
+
removed: WflowTimestamp | None = Field(default=None, description="Gets or sets the removed date.")
|
|
20
|
+
locked: bool | None = Field(
|
|
21
|
+
default=None,
|
|
22
|
+
description="Gets or sets a value indicating whether this wflow.Core.Contracts.Storage.Files.StorageFile is locked.",
|
|
23
|
+
)
|
|
24
|
+
approvalStatus: str | None = Field(
|
|
25
|
+
default=None, description="One of: NotApproved, Approved, Rejected, Returned, None"
|
|
26
|
+
)
|
|
27
|
+
folderId: str | None = Field(default=None, description="Gets or sets the folder identifier.")
|
|
28
|
+
location: str | None = Field(default=None, description="Gets or sets the location.")
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
class StorageFolder(WflowModel):
|
|
32
|
+
"""Storage folder"""
|
|
33
|
+
|
|
34
|
+
id: str | None = Field(default=None, description="Gets or sets the identifier.")
|
|
35
|
+
parentId: str | None = Field(default=None, description="Gets or sets the parent identifier.")
|
|
36
|
+
name: str | None = Field(default=None, description="Gets or sets the name.")
|
|
37
|
+
fullPath: str | None = Field(default=None, description="Gets or sets the full path.")
|
|
38
|
+
hasChildren: bool | None = Field(default=None, description="Gets or sets the has children.")
|
wflow_api/operation.py
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"""Argument validation for every operation, so a direct call is checked as strictly as a schema-validated one."""
|
|
2
|
+
|
|
3
|
+
import functools
|
|
4
|
+
import inspect
|
|
5
|
+
from collections.abc import Awaitable, Callable
|
|
6
|
+
from typing import Annotated, Any
|
|
7
|
+
|
|
8
|
+
from pydantic import ConfigDict, Strict, ValidationError, validate_call
|
|
9
|
+
|
|
10
|
+
from wflow_api.errors import WflowError
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def _problems(error: ValidationError) -> str:
|
|
14
|
+
return "; ".join(f"{'.'.join(map(str, e['loc']))}: {e['msg']}" if e["loc"] else e["msg"] for e in error.errors())
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
def _strict_bytes(annotation: Any) -> Any:
|
|
18
|
+
return Annotated[bytes, Strict()] if annotation is bytes else annotation
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def operation[**P, R](fn: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]:
|
|
22
|
+
def start(*args: P.args, **kwargs: P.kwargs) -> Awaitable[R]:
|
|
23
|
+
return fn(*args, **kwargs)
|
|
24
|
+
|
|
25
|
+
functools.update_wrapper(start, fn)
|
|
26
|
+
|
|
27
|
+
@functools.cache
|
|
28
|
+
def validator() -> tuple[inspect.Signature, Callable[..., Awaitable[R]]]:
|
|
29
|
+
signature = inspect.signature(fn)
|
|
30
|
+
start.__signature__ = signature.replace( # type: ignore[attr-defined]
|
|
31
|
+
parameters=[p.replace(annotation=_strict_bytes(p.annotation)) for p in signature.parameters.values()]
|
|
32
|
+
)
|
|
33
|
+
start.__annotations__ = {name: _strict_bytes(hint) for name, hint in fn.__annotations__.items()}
|
|
34
|
+
return signature, validate_call(config=ConfigDict(arbitrary_types_allowed=True))(start)
|
|
35
|
+
|
|
36
|
+
@functools.wraps(fn)
|
|
37
|
+
async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
|
|
38
|
+
signature, validated = validator()
|
|
39
|
+
try:
|
|
40
|
+
pending = validated(**signature.bind(*args, **kwargs).arguments)
|
|
41
|
+
except TypeError as error:
|
|
42
|
+
raise WflowError(f"{fn.__name__}: invalid arguments. {error}") from None
|
|
43
|
+
except ValidationError as error:
|
|
44
|
+
raise WflowError(f"{fn.__name__}: invalid arguments. {_problems(error)}") from None
|
|
45
|
+
try:
|
|
46
|
+
return await pending
|
|
47
|
+
except ValidationError as error:
|
|
48
|
+
raise WflowError(f"{fn.__name__}: wflow answered in an unexpected shape. {_problems(error)}") from error
|
|
49
|
+
|
|
50
|
+
return wrapper
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"""One module per API area. operations() lists every operation those modules define."""
|
|
2
|
+
|
|
3
|
+
import inspect
|
|
4
|
+
import pkgutil
|
|
5
|
+
from collections.abc import Awaitable, Callable
|
|
6
|
+
from importlib import import_module
|
|
7
|
+
from typing import Any
|
|
8
|
+
|
|
9
|
+
Operation = Callable[..., Awaitable[Any]]
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def operations() -> list[tuple[str, Operation]]:
|
|
13
|
+
found: list[tuple[str, Operation]] = []
|
|
14
|
+
for info in sorted(pkgutil.iter_modules(__path__), key=lambda module: module.name):
|
|
15
|
+
module = import_module(f"{__name__}.{info.name}")
|
|
16
|
+
for name, value in sorted(vars(module).items()):
|
|
17
|
+
if name.startswith("_") or not inspect.iscoroutinefunction(value):
|
|
18
|
+
continue
|
|
19
|
+
if value.__module__ == module.__name__:
|
|
20
|
+
found.append((info.name, value))
|
|
21
|
+
return found
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"""Account: who the caller is, and which workspaces they can reach."""
|
|
2
|
+
|
|
3
|
+
from wflow_api.client import WflowClient
|
|
4
|
+
from wflow_api.guards import current_account, ensure_list
|
|
5
|
+
from wflow_api.models import Account, OrganizationDomain, OrgSlug
|
|
6
|
+
from wflow_api.operation import operation
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@operation
|
|
10
|
+
async def get_me(client: WflowClient, organization: OrgSlug) -> Account:
|
|
11
|
+
"""Return the profile of the currently authenticated user in one organization.
|
|
12
|
+
|
|
13
|
+
Fields:
|
|
14
|
+
|
|
15
|
+
- `id` — the user's identifier in this organization
|
|
16
|
+
- `identity` — login, first/last/full name, and ISO 639-1 language
|
|
17
|
+
- `created` — when the account was created
|
|
18
|
+
- `hasFullAccess` — full-access role indicator, which overrides the detail below
|
|
19
|
+
- `roles` — role memberships (id, name, description)
|
|
20
|
+
- `teams` — team memberships; `system` marks a built-in team
|
|
21
|
+
- `documentTypes` — per document type access: the type (with its `kind`) and
|
|
22
|
+
whether the user sees All, OnlyAssigned or FullAccess
|
|
23
|
+
- `rights` — named rights held here, e.g. CanApprove, CanCreateDocument
|
|
24
|
+
"""
|
|
25
|
+
return await current_account(client, organization)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
@operation
|
|
29
|
+
async def list_organizations(client: WflowClient) -> list[OrganizationDomain]:
|
|
30
|
+
"""List the wflow organizations the signed-in user can access.
|
|
31
|
+
|
|
32
|
+
One entry per organization workspace:
|
|
33
|
+
|
|
34
|
+
Fields:
|
|
35
|
+
|
|
36
|
+
- `subdomain` — the workspace slug, e.g. "nonameorg". This is the value to pass
|
|
37
|
+
as the `organization` argument of other operations.
|
|
38
|
+
- `name` — display name, e.g. "Noname Ltd."
|
|
39
|
+
- `baseURL` — workspace host, e.g. "nonameorg.wflow.com"
|
|
40
|
+
- `trialExpiration` — trial end date, or null when not on a trial
|
|
41
|
+
|
|
42
|
+
Takes no arguments — start here when you do not know which workspace the user means.
|
|
43
|
+
"""
|
|
44
|
+
path = "/api/user/myorganizations"
|
|
45
|
+
payload = await client.request("GET", path) or []
|
|
46
|
+
return [OrganizationDomain.model_validate(item) for item in ensure_list(path, payload)]
|