Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Jan 6, 2024. It is now read-only.

Commit 76dae8b

Browse files
feat(v3): added TelephonyTransferCall in response message (#216)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 414026488 Source-Link: googleapis/googleapis@26ab5dd Source-Link: https://github.com/googleapis/googleapis-gen/commit/d4c1a646b4056e598eba01213af350bd8f6a6952 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDRjMWE2NDZiNDA1NmU1OThlYmEwMTIxM2FmMzUwYmQ4ZjZhNjk1MiJ9 docs: reformat comments
1 parent 8f3dc03 commit 76dae8b

File tree

7 files changed

+66
-38
lines changed

7 files changed

+66
-38
lines changed

google/cloud/dialogflowcx_v3/services/versions/async_client.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ async def list_versions(
187187
parent (:class:`str`):
188188
Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow]
189189
to list all versions for. Format:
190-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>``.
190+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.
191191
192192
This corresponds to the ``parent`` field
193193
on the ``request`` instance; if ``request`` is provided, this
@@ -201,7 +201,7 @@ async def list_versions(
201201
Returns:
202202
google.cloud.dialogflowcx_v3.services.versions.pagers.ListVersionsAsyncPager:
203203
The response message for
204-
[Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
204+
[Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
205205
206206
Iterating over this object will yield results and
207207
resolve additional pages automatically.
@@ -270,7 +270,7 @@ async def get_version(
270270
Required. The name of the
271271
[Version][google.cloud.dialogflow.cx.v3.Version].
272272
Format:
273-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
273+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
274274
275275
This corresponds to the ``name`` field
276276
on the ``request`` instance; if ``request`` is provided, this
@@ -354,7 +354,7 @@ async def create_version(
354354
to create an
355355
[Version][google.cloud.dialogflow.cx.v3.Version] for.
356356
Format:
357-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>``.
357+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.
358358
359359
This corresponds to the ``parent`` field
360360
on the ``request`` instance; if ``request`` is provided, this
@@ -527,7 +527,7 @@ async def delete_version(
527527
Required. The name of the
528528
[Version][google.cloud.dialogflow.cx.v3.Version] to
529529
delete. Format:
530-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
530+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
531531
532532
This corresponds to the ``name`` field
533533
on the ``request`` instance; if ``request`` is provided, this
@@ -603,7 +603,7 @@ async def load_version(
603603
Required. The
604604
[Version][google.cloud.dialogflow.cx.v3.Version] to be
605605
loaded to draft flow. Format:
606-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
606+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
607607
608608
This corresponds to the ``name`` field
609609
on the ``request`` instance; if ``request`` is provided, this
@@ -700,7 +700,7 @@ async def compare_versions(
700700
draft version of the specified flow.
701701
702702
Format:
703-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
703+
``projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
704704
705705
This corresponds to the ``base_version`` field
706706
on the ``request`` instance; if ``request`` is provided, this
@@ -714,7 +714,7 @@ async def compare_versions(
714714
Returns:
715715
google.cloud.dialogflowcx_v3.types.CompareVersionsResponse:
716716
The response message for
717-
[Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
717+
[Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
718718
719719
"""
720720
# Create or coerce a protobuf request object.

google/cloud/dialogflowcx_v3/services/versions/client.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ def list_versions(
387387
parent (str):
388388
Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow]
389389
to list all versions for. Format:
390-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>``.
390+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.
391391
392392
This corresponds to the ``parent`` field
393393
on the ``request`` instance; if ``request`` is provided, this
@@ -401,7 +401,7 @@ def list_versions(
401401
Returns:
402402
google.cloud.dialogflowcx_v3.services.versions.pagers.ListVersionsPager:
403403
The response message for
404-
[Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
404+
[Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
405405
406406
Iterating over this object will yield results and
407407
resolve additional pages automatically.
@@ -470,7 +470,7 @@ def get_version(
470470
Required. The name of the
471471
[Version][google.cloud.dialogflow.cx.v3.Version].
472472
Format:
473-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
473+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
474474
475475
This corresponds to the ``name`` field
476476
on the ``request`` instance; if ``request`` is provided, this
@@ -554,7 +554,7 @@ def create_version(
554554
to create an
555555
[Version][google.cloud.dialogflow.cx.v3.Version] for.
556556
Format:
557-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>``.
557+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.
558558
559559
This corresponds to the ``parent`` field
560560
on the ``request`` instance; if ``request`` is provided, this
@@ -727,7 +727,7 @@ def delete_version(
727727
Required. The name of the
728728
[Version][google.cloud.dialogflow.cx.v3.Version] to
729729
delete. Format:
730-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
730+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
731731
732732
This corresponds to the ``name`` field
733733
on the ``request`` instance; if ``request`` is provided, this
@@ -803,7 +803,7 @@ def load_version(
803803
Required. The
804804
[Version][google.cloud.dialogflow.cx.v3.Version] to be
805805
loaded to draft flow. Format:
806-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
806+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
807807
808808
This corresponds to the ``name`` field
809809
on the ``request`` instance; if ``request`` is provided, this
@@ -900,7 +900,7 @@ def compare_versions(
900900
draft version of the specified flow.
901901
902902
Format:
903-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
903+
``projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
904904
905905
This corresponds to the ``base_version`` field
906906
on the ``request`` instance; if ``request`` is provided, this
@@ -914,7 +914,7 @@ def compare_versions(
914914
Returns:
915915
google.cloud.dialogflowcx_v3.types.CompareVersionsResponse:
916916
The response message for
917-
[Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
917+
[Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
918918
919919
"""
920920
# Create or coerce a protobuf request object.

google/cloud/dialogflowcx_v3/services/webhooks/async_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ async def list_webhooks(
197197
Returns:
198198
google.cloud.dialogflowcx_v3.services.webhooks.pagers.ListWebhooksAsyncPager:
199199
The response message for
200-
[Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].
200+
[Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].
201201
202202
Iterating over this object will yield results and
203203
resolve additional pages automatically.

google/cloud/dialogflowcx_v3/services/webhooks/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ def list_webhooks(
409409
Returns:
410410
google.cloud.dialogflowcx_v3.services.webhooks.pagers.ListWebhooksPager:
411411
The response message for
412-
[Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].
412+
[Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].
413413
414414
Iterating over this object will yield results and
415415
resolve additional pages automatically.

google/cloud/dialogflowcx_v3/types/response_message.py

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ class ResponseMessage(proto.Message):
104104
This message is generated by Dialogflow only and not
105105
supposed to be defined by the user.
106106
107+
This field is a member of `oneof`_ ``message``.
108+
telephony_transfer_call (google.cloud.dialogflowcx_v3.types.ResponseMessage.TelephonyTransferCall):
109+
A signal that the client should transfer the
110+
phone call connected to this agent to a third-
111+
party endpoint.
112+
107113
This field is a member of `oneof`_ ``message``.
108114
"""
109115

@@ -288,6 +294,23 @@ class Segment(proto.Message):
288294
proto.MESSAGE, number=1, message="ResponseMessage.MixedAudio.Segment",
289295
)
290296

297+
class TelephonyTransferCall(proto.Message):
298+
r"""Represents the signal that telles the client to transfer the
299+
phone call connected to the agent to a third-party endpoint.
300+
301+
302+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
303+
304+
Attributes:
305+
phone_number (str):
306+
Transfer the call to a phone number in `E.164
307+
format <https://en.wikipedia.org/wiki/E.164>`__.
308+
309+
This field is a member of `oneof`_ ``endpoint``.
310+
"""
311+
312+
phone_number = proto.Field(proto.STRING, number=1, oneof="endpoint",)
313+
291314
text = proto.Field(proto.MESSAGE, number=1, oneof="message", message=Text,)
292315
payload = proto.Field(
293316
proto.MESSAGE, number=2, oneof="message", message=struct_pb2.Struct,
@@ -310,6 +333,9 @@ class Segment(proto.Message):
310333
mixed_audio = proto.Field(
311334
proto.MESSAGE, number=13, oneof="message", message=MixedAudio,
312335
)
336+
telephony_transfer_call = proto.Field(
337+
proto.MESSAGE, number=18, oneof="message", message=TelephonyTransferCall,
338+
)
313339

314340

315341
__all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/dialogflowcx_v3/types/version.py

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class CreateVersionOperationMetadata(proto.Message):
4545
Attributes:
4646
version (str):
4747
Name of the created version. Format:
48-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
48+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
4949
"""
5050

5151
version = proto.Field(proto.STRING, number=1,)
@@ -56,10 +56,11 @@ class Version(proto.Message):
5656
5757
Attributes:
5858
name (str):
59-
Format:
60-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
61-
Version ID is a self-increasing number generated by
62-
Dialogflow upon version creation.
59+
Format: projects/<Project
60+
ID>/locations/<Location ID>/agents/<Agent
61+
ID>/flows/<Flow ID>/versions/<Version ID>.
62+
Version ID is a self-increasing number generated
63+
by Dialogflow upon version creation.
6364
display_name (str):
6465
Required. The human-readable name of the
6566
version. Limit of 64 characters.
@@ -101,7 +102,7 @@ class ListVersionsRequest(proto.Message):
101102
parent (str):
102103
Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to
103104
list all versions for. Format:
104-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>``.
105+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.
105106
page_size (int):
106107
The maximum number of items to return in a
107108
single page. By default 20 and at most 100.
@@ -147,7 +148,7 @@ class GetVersionRequest(proto.Message):
147148
name (str):
148149
Required. The name of the
149150
[Version][google.cloud.dialogflow.cx.v3.Version]. Format:
150-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
151+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
151152
"""
152153

153154
name = proto.Field(proto.STRING, number=1,)
@@ -162,7 +163,7 @@ class CreateVersionRequest(proto.Message):
162163
Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to
163164
create an [Version][google.cloud.dialogflow.cx.v3.Version]
164165
for. Format:
165-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>``.
166+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.
166167
version (google.cloud.dialogflowcx_v3.types.Version):
167168
Required. The version to create.
168169
"""
@@ -199,7 +200,7 @@ class DeleteVersionRequest(proto.Message):
199200
Required. The name of the
200201
[Version][google.cloud.dialogflow.cx.v3.Version] to delete.
201202
Format:
202-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
203+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
203204
"""
204205

205206
name = proto.Field(proto.STRING, number=1,)
@@ -214,7 +215,7 @@ class LoadVersionRequest(proto.Message):
214215
Required. The
215216
[Version][google.cloud.dialogflow.cx.v3.Version] to be
216217
loaded to draft flow. Format:
217-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
218+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
218219
allow_override_agent_resources (bool):
219220
This field is used to prevent accidental overwrite of other
220221
agent resources, which can potentially impact other flow's
@@ -238,12 +239,12 @@ class CompareVersionsRequest(proto.Message):
238239
version of the specified flow.
239240
240241
Format:
241-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
242+
``projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
242243
target_version (str):
243244
Required. Name of the target flow version to compare with
244245
the base version. Use version ID ``0`` to indicate the draft
245246
version of the specified flow. Format:
246-
``projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>``.
247+
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
247248
language_code (str):
248249
The language to compare the flow versions for.
249250

google/cloud/dialogflowcx_v3/types/webhook.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,16 @@ class GenericWebService(proto.Message):
104104
verification. This overrides the default SSL
105105
trust store. If this is empty or unspecified,
106106
Dialogflow will use Google's default trust store
107-
to verify certificates. N.B. Make sure the HTTPS
108-
server certificates are signed with "subject alt
109-
name". For instance a certificate can be self-
110-
signed using the following command,
111-
openssl x509 -req -days 200 -in
112-
example.com.csr \ -signkey example.com.key
107+
to verify certificates.
108+
N.B. Make sure the HTTPS server certificates are
109+
signed with "subject alt name". For instance a
110+
certificate can be self-signed using the
111+
following command,
112+
openssl x509 -req -days 200 -in
113+
example.com.csr \ -signkey example.com.key
113114
\
114-
-out example.com.crt \
115-
-extfile <(printf
115+
-out example.com.crt \
116+
-extfile <(printf
116117
"\nsubjectAltName='DNS:www.example.com'")
117118
"""
118119

0 commit comments

Comments
 (0)