File tree Expand file tree Collapse file tree 4 files changed +60
-0
lines changed
Expand file tree Collapse file tree 4 files changed +60
-0
lines changed Original file line number Diff line number Diff line change @@ -80,6 +80,21 @@ A typical `BaseField` object will have the following attributes:
8080Aside from the previous attributes, all basic fields have access to a custom ` __str__ ` method that can be used to print their value as a string.
8181
8282
83+ ### AddressField
84+ Aside from the basic ` BaseField ` attributes, the address field ` AddressField ` also implements the following:
85+
86+ * ** street_number** (` str ` ): String representation of the string number. Can be ` None ` .
87+ * ** street_name** (` str ` ): Name of the street. Can be ` None ` .
88+ * ** po_box** (` str ` ): String representation of the PO Box number. Can be ` None ` .
89+ * ** address_complement** (` str ` ): Address complement. Can be ` None ` .
90+ * ** city** (` str ` ): City name. Can be ` None ` .
91+ * ** postal_code** (` str ` ): String representation of the postal code. Can be ` None ` .
92+ * ** state** (` str ` ): State name. Can be ` None ` .
93+ * ** country** (` str ` ): Country name. Can be ` None ` .
94+
95+ Note: The ` value ` field of an AddressField should be a concatenation of the rest of the values.
96+
97+
8398### AmountField
8499The amount field ` AmountField ` only has one constraint: its ** value** is an ` Optional[float] ` .
85100
Original file line number Diff line number Diff line change @@ -165,6 +165,21 @@ A typical `BaseField` object will have the following attributes:
165165Aside from the previous attributes, all basic fields have access to a custom ` __str__ ` method that can be used to print their value as a string.
166166
167167
168+ ### AddressField
169+ Aside from the basic ` BaseField ` attributes, the address field ` AddressField ` also implements the following:
170+
171+ * ** street_number** (` str ` ): String representation of the string number. Can be ` None ` .
172+ * ** street_name** (` str ` ): Name of the street. Can be ` None ` .
173+ * ** po_box** (` str ` ): String representation of the PO Box number. Can be ` None ` .
174+ * ** address_complement** (` str ` ): Address complement. Can be ` None ` .
175+ * ** city** (` str ` ): City name. Can be ` None ` .
176+ * ** postal_code** (` str ` ): String representation of the postal code. Can be ` None ` .
177+ * ** state** (` str ` ): State name. Can be ` None ` .
178+ * ** country** (` str ` ): Country name. Can be ` None ` .
179+
180+ Note: The ` value ` field of an AddressField should be a concatenation of the rest of the values.
181+
182+
168183### AmountField
169184The amount field ` AmountField ` only has one constraint: its ** value** is an ` Optional[float] ` .
170185
Original file line number Diff line number Diff line change @@ -203,6 +203,21 @@ A typical `BaseField` object will have the following attributes:
203203Aside from the previous attributes, all basic fields have access to a custom ` __str__ ` method that can be used to print their value as a string.
204204
205205
206+ ### AddressField
207+ Aside from the basic ` BaseField ` attributes, the address field ` AddressField ` also implements the following:
208+
209+ * ** street_number** (` str ` ): String representation of the string number. Can be ` None ` .
210+ * ** street_name** (` str ` ): Name of the street. Can be ` None ` .
211+ * ** po_box** (` str ` ): String representation of the PO Box number. Can be ` None ` .
212+ * ** address_complement** (` str ` ): Address complement. Can be ` None ` .
213+ * ** city** (` str ` ): City name. Can be ` None ` .
214+ * ** postal_code** (` str ` ): String representation of the postal code. Can be ` None ` .
215+ * ** state** (` str ` ): State name. Can be ` None ` .
216+ * ** country** (` str ` ): Country name. Can be ` None ` .
217+
218+ Note: The ` value ` field of an AddressField should be a concatenation of the rest of the values.
219+
220+
206221### AmountField
207222The amount field ` AmountField ` only has one constraint: its ** value** is an ` Optional[float] ` .
208223
Original file line number Diff line number Diff line change @@ -195,6 +195,21 @@ A typical `BaseField` object will have the following attributes:
195195Aside from the previous attributes, all basic fields have access to a custom ` __str__ ` method that can be used to print their value as a string.
196196
197197
198+ ### AddressField
199+ Aside from the basic ` BaseField ` attributes, the address field ` AddressField ` also implements the following:
200+
201+ * ** street_number** (` str ` ): String representation of the string number. Can be ` None ` .
202+ * ** street_name** (` str ` ): Name of the street. Can be ` None ` .
203+ * ** po_box** (` str ` ): String representation of the PO Box number. Can be ` None ` .
204+ * ** address_complement** (` str ` ): Address complement. Can be ` None ` .
205+ * ** city** (` str ` ): City name. Can be ` None ` .
206+ * ** postal_code** (` str ` ): String representation of the postal code. Can be ` None ` .
207+ * ** state** (` str ` ): State name. Can be ` None ` .
208+ * ** country** (` str ` ): Country name. Can be ` None ` .
209+
210+ Note: The ` value ` field of an AddressField should be a concatenation of the rest of the values.
211+
212+
198213### AmountField
199214The amount field ` AmountField ` only has one constraint: its ** value** is an ` Optional[float] ` .
200215
You can’t perform that action at this time.
0 commit comments