-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathcode_request.py
More file actions
126 lines (100 loc) · 5.18 KB
/
code_request.py
File metadata and controls
126 lines (100 loc) · 5.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# coding: utf-8
"""
Bandwidth
Bandwidth's Communication APIs
The version of the OpenAPI document: 1.0.0
Contact: letstalk@bandwidth.com
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, field_validator
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from typing import Optional, Set
from typing_extensions import Self
class CodeRequest(BaseModel):
"""
CodeRequest
""" # noqa: E501
to: Annotated[str, Field(strict=True)] = Field(description="The phone number to send the mfa code to.")
var_from: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The application phone number, the sender of the mfa code.", alias="from")
application_id: Annotated[str, Field(strict=True, max_length=50)] = Field(description="The application unique ID, obtained from Bandwidth.", alias="applicationId")
scope: Optional[Annotated[str, Field(strict=True, max_length=25)]] = Field(default=None, description="An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".")
message: Annotated[str, Field(strict=True, max_length=2048)] = Field(description="The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server.")
digits: Annotated[int, Field(le=8, strict=True, ge=4)] = Field(description="The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively.")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["to", "from", "applicationId", "scope", "message", "digits"]
@field_validator('to')
def to_validate_regular_expression(cls, value):
"""Validates the regular expression"""
if not re.match(r"^\+[1-9]\d{1,14}$", value):
raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/")
return value
@field_validator('var_from')
def var_from_validate_regular_expression(cls, value):
"""Validates the regular expression"""
if not re.match(r"^\+[1-9]\d{1,14}$", value):
raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/")
return value
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 CodeRequest 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.
* Fields in `self.additional_properties` are added to the output dict.
"""
excluded_fields: Set[str] = set([
"additional_properties",
])
_dict = self.model_dump(
by_alias=True,
exclude=excluded_fields,
exclude_none=True,
)
# puts key-value pairs in additional_properties in the top level
if self.additional_properties is not None:
for _key, _value in self.additional_properties.items():
_dict[_key] = _value
return _dict
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of CodeRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate({
"to": obj.get("to"),
"from": obj.get("from"),
"applicationId": obj.get("applicationId"),
"scope": obj.get("scope"),
"message": obj.get("message"),
"digits": obj.get("digits")
})
# store additional fields in additional_properties
for _key in obj.keys():
if _key not in cls.__properties:
_obj.additional_properties[_key] = obj.get(_key)
return _obj