Skip to content

Commit 2245736

Browse files
author
docsreference@microsoft.com
committed
CI Update
 Build.Reason:Manual by azure-sdk-internal-msdocs-apidrop-connection Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=499639&view=results
1 parent d6b4644 commit 2245736

File tree

76 files changed

+1700
-655
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1700
-655
lines changed

‎docs-ref-autogen/azure-communication-phonenumbers/azure.communication.phonenumbers.OperatorInformation.yml

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
### YamlMime:PythonClass
2+
uid: azure.communication.phonenumbers.OperatorInformation
3+
name: OperatorInformation
4+
fullName: azure.communication.phonenumbers.OperatorInformation
5+
module: azure.communication.phonenumbers
6+
inheritances:
7+
- azure.communication.phonenumbers._generated._serialization.Model
8+
summary: 'Represents metadata about a phone number that is controlled/provided by
9+
that phone number''s
10+
11+
operator.
12+
13+
14+
All required parameters must be populated in order to send to server.'
15+
constructor:
16+
syntax: 'OperatorInformation(*, phone_number: str, national_format: str | None =
17+
None, international_format: str | None = None, iso_country_code: str | None =
18+
None, number_type: str | _models.OperatorNumberType | None = None, operator_details:
19+
_models.OperatorDetails | None = None, **kwargs: Any)'
20+
keywordOnlyParameters:
21+
- name: phone_number
22+
description: E.164 formatted string representation of the phone number. Required.
23+
types:
24+
- <xref:str>
25+
- name: national_format
26+
description: National format of the phone number.
27+
types:
28+
- <xref:str>
29+
- name: international_format
30+
description: International format of the phone number.
31+
types:
32+
- <xref:str>
33+
- name: iso_country_code
34+
description: 'ISO 3166-1 two character (''alpha-2'') code associated with the
35+
phone
36+
37+
number.'
38+
types:
39+
- <xref:str>
40+
- name: number_type
41+
description: 'Type of service associated with the phone number. Known values are:
42+
43+
"unknown", "other", "geographic", and "mobile".'
44+
types:
45+
- <xref:str>
46+
- <xref:azure.communication.phonenumbers.models.OperatorNumberType>
47+
- name: operator_details
48+
description: Represents metadata describing the operator of a phone number.
49+
types:
50+
- <xref:azure.communication.phonenumbers.models.OperatorDetails>
51+
variables:
52+
- description: E.164 formatted string representation of the phone number. Required.
53+
name: phone_number
54+
types:
55+
- <xref:str>
56+
- description: National format of the phone number.
57+
name: national_format
58+
types:
59+
- <xref:str>
60+
- description: International format of the phone number.
61+
name: international_format
62+
types:
63+
- <xref:str>
64+
- description: 'ISO 3166-1 two character (''alpha-2'') code associated with the phone
65+
66+
number.'
67+
name: iso_country_code
68+
types:
69+
- <xref:str>
70+
- description: 'Type of service associated with the phone number. Known values are:
71+
72+
"unknown", "other", "geographic", and "mobile".'
73+
name: number_type
74+
types:
75+
- <xref:str>
76+
- <xref:azure.communication.phonenumbers.models.OperatorNumberType>
77+
- description: Represents metadata describing the operator of a phone number.
78+
name: operator_details
79+
types:
80+
- <xref:azure.communication.phonenumbers.models.OperatorDetails>
81+
methods:
82+
- uid: azure.communication.phonenumbers.OperatorInformation.as_dict
83+
name: as_dict
84+
summary: "Return a dict that can be serialized using json.dump.\n\nAdvanced usage\
85+
\ might optionally use a callback as parameter:\n\nKey is the attribute name used\
86+
\ in Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with\
87+
\ the\nmsrest type and 'key' with the RestAPI encoded key.\nValue is the current\
88+
\ value in this object.\n\nThe string returned will be used to serialize the key.\n\
89+
If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
90+
See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
91+
\ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
92+
\ pass the kwargs is_xml=True."
93+
signature: 'as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str,
94+
~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>,
95+
**kwargs: ~typing.Any) -> MutableMapping[str, Any]'
96+
parameters:
97+
- name: keep_readonly
98+
description: If you want to serialize the readonly attributes
99+
defaultValue: 'True'
100+
types:
101+
- <xref:bool>
102+
- name: key_transformer
103+
description: A key transformer function.
104+
types:
105+
- <xref:function>
106+
return:
107+
description: A dict JSON compatible object
108+
types:
109+
- <xref:dict>
110+
- uid: azure.communication.phonenumbers.OperatorInformation.deserialize
111+
name: deserialize
112+
summary: Parse a str using the RestAPI syntax and return a model.
113+
signature: 'deserialize(data: Any, content_type: str | None = None) -> ModelType'
114+
parameters:
115+
- name: data
116+
description: A str using RestAPI structure. JSON by default.
117+
isRequired: true
118+
types:
119+
- <xref:str>
120+
- name: content_type
121+
description: JSON by default, set application/xml if XML.
122+
defaultValue: None
123+
types:
124+
- <xref:str>
125+
return:
126+
description: An instance of this model
127+
types:
128+
- <xref:ModelType>
129+
exceptions:
130+
- type: DeserializationError if something went wrong
131+
- uid: azure.communication.phonenumbers.OperatorInformation.enable_additional_properties_sending
132+
name: enable_additional_properties_sending
133+
signature: enable_additional_properties_sending() -> None
134+
- uid: azure.communication.phonenumbers.OperatorInformation.from_dict
135+
name: from_dict
136+
summary: 'Parse a dict using given key extractor return a model.
137+
138+
139+
By default consider key
140+
141+
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
142+
143+
and last_rest_key_case_insensitive_extractor)'
144+
signature: 'from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any],
145+
Any], Any] | None = None, content_type: str | None = None) -> ModelType'
146+
parameters:
147+
- name: data
148+
description: A dict using RestAPI structure
149+
isRequired: true
150+
types:
151+
- <xref:dict>
152+
- name: key_extractors
153+
description: A key extractor function.
154+
defaultValue: None
155+
types:
156+
- <xref:function>
157+
- name: content_type
158+
description: JSON by default, set application/xml if XML.
159+
defaultValue: None
160+
types:
161+
- <xref:str>
162+
return:
163+
description: An instance of this model
164+
types:
165+
- <xref:ModelType>
166+
exceptions:
167+
- type: DeserializationError if something went wrong
168+
- uid: azure.communication.phonenumbers.OperatorInformation.is_xml_model
169+
name: is_xml_model
170+
signature: is_xml_model() -> bool
171+
- uid: azure.communication.phonenumbers.OperatorInformation.serialize
172+
name: serialize
173+
summary: 'Return the JSON that would be sent to server from this model.
174+
175+
176+
This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.
177+
178+
179+
If you want XML serialization, you can pass the kwargs is_xml=True.'
180+
signature: 'serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str,
181+
Any]'
182+
parameters:
183+
- name: keep_readonly
184+
description: If you want to serialize the readonly attributes
185+
defaultValue: 'False'
186+
types:
187+
- <xref:bool>
188+
return:
189+
description: A dict JSON compatible object
190+
types:
191+
- <xref:dict>

‎docs-ref-autogen/azure-communication-phonenumbers/azure.communication.phonenumbers.OperatorInformationOptions.yml

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
### YamlMime:PythonClass
2+
uid: azure.communication.phonenumbers.OperatorInformationOptions
3+
name: OperatorInformationOptions
4+
fullName: azure.communication.phonenumbers.OperatorInformationOptions
5+
module: azure.communication.phonenumbers
6+
inheritances:
7+
- azure.communication.phonenumbers._generated._serialization.Model
8+
summary: Represents options to modify a search request for operator information.
9+
constructor:
10+
syntax: 'OperatorInformationOptions(*, include_additional_operator_details: bool
11+
| None = None, **kwargs: Any)'
12+
keywordOnlyParameters:
13+
- name: include_additional_operator_details
14+
description: 'Includes the fields operatorDetails, numberType,
15+
16+
and isoCountryCode in the response. Please note: use of this option will result
17+
in additional
18+
19+
costs.'
20+
types:
21+
- <xref:bool>
22+
variables:
23+
- description: 'Includes the fields operatorDetails, numberType, and
24+
25+
isoCountryCode in the response. Please note: use of this option will result in
26+
additional
27+
28+
costs.'
29+
name: include_additional_operator_details
30+
types:
31+
- <xref:bool>
32+
methods:
33+
- uid: azure.communication.phonenumbers.OperatorInformationOptions.as_dict
34+
name: as_dict
35+
summary: "Return a dict that can be serialized using json.dump.\n\nAdvanced usage\
36+
\ might optionally use a callback as parameter:\n\nKey is the attribute name used\
37+
\ in Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with\
38+
\ the\nmsrest type and 'key' with the RestAPI encoded key.\nValue is the current\
39+
\ value in this object.\n\nThe string returned will be used to serialize the key.\n\
40+
If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
41+
See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
42+
\ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
43+
\ pass the kwargs is_xml=True."
44+
signature: 'as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str,
45+
~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>,
46+
**kwargs: ~typing.Any) -> MutableMapping[str, Any]'
47+
parameters:
48+
- name: keep_readonly
49+
description: If you want to serialize the readonly attributes
50+
defaultValue: 'True'
51+
types:
52+
- <xref:bool>
53+
- name: key_transformer
54+
description: A key transformer function.
55+
types:
56+
- <xref:function>
57+
return:
58+
description: A dict JSON compatible object
59+
types:
60+
- <xref:dict>
61+
- uid: azure.communication.phonenumbers.OperatorInformationOptions.deserialize
62+
name: deserialize
63+
summary: Parse a str using the RestAPI syntax and return a model.
64+
signature: 'deserialize(data: Any, content_type: str | None = None) -> ModelType'
65+
parameters:
66+
- name: data
67+
description: A str using RestAPI structure. JSON by default.
68+
isRequired: true
69+
types:
70+
- <xref:str>
71+
- name: content_type
72+
description: JSON by default, set application/xml if XML.
73+
defaultValue: None
74+
types:
75+
- <xref:str>
76+
return:
77+
description: An instance of this model
78+
types:
79+
- <xref:ModelType>
80+
exceptions:
81+
- type: DeserializationError if something went wrong
82+
- uid: azure.communication.phonenumbers.OperatorInformationOptions.enable_additional_properties_sending
83+
name: enable_additional_properties_sending
84+
signature: enable_additional_properties_sending() -> None
85+
- uid: azure.communication.phonenumbers.OperatorInformationOptions.from_dict
86+
name: from_dict
87+
summary: 'Parse a dict using given key extractor return a model.
88+
89+
90+
By default consider key
91+
92+
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
93+
94+
and last_rest_key_case_insensitive_extractor)'
95+
signature: 'from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any],
96+
Any], Any] | None = None, content_type: str | None = None) -> ModelType'
97+
parameters:
98+
- name: data
99+
description: A dict using RestAPI structure
100+
isRequired: true
101+
types:
102+
- <xref:dict>
103+
- name: key_extractors
104+
description: A key extractor function.
105+
defaultValue: None
106+
types:
107+
- <xref:function>
108+
- name: content_type
109+
description: JSON by default, set application/xml if XML.
110+
defaultValue: None
111+
types:
112+
- <xref:str>
113+
return:
114+
description: An instance of this model
115+
types:
116+
- <xref:ModelType>
117+
exceptions:
118+
- type: DeserializationError if something went wrong
119+
- uid: azure.communication.phonenumbers.OperatorInformationOptions.is_xml_model
120+
name: is_xml_model
121+
signature: is_xml_model() -> bool
122+
- uid: azure.communication.phonenumbers.OperatorInformationOptions.serialize
123+
name: serialize
124+
summary: 'Return the JSON that would be sent to server from this model.
125+
126+
127+
This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.
128+
129+
130+
If you want XML serialization, you can pass the kwargs is_xml=True.'
131+
signature: 'serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str,
132+
Any]'
133+
parameters:
134+
- name: keep_readonly
135+
description: If you want to serialize the readonly attributes
136+
defaultValue: 'False'
137+
types:
138+
- <xref:bool>
139+
return:
140+
description: A dict JSON compatible object
141+
types:
142+
- <xref:dict>

0 commit comments

Comments
 (0)