google-apis-dialogflow_v3 0.21.0 → 0.25.0

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.
@@ -450,6 +450,87 @@ module Google
450
450
  execute_or_queue_command(command, &block)
451
451
  end
452
452
 
453
+ # Retrieves the specified Changelog.
454
+ # @param [String] name
455
+ # Required. The name of the changelog to get. Format: `projects//locations//
456
+ # agents//changelogs/`.
457
+ # @param [String] fields
458
+ # Selector specifying which fields to include in a partial response.
459
+ # @param [String] quota_user
460
+ # Available to use for quota purposes for server-side applications. Can be any
461
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
462
+ # @param [Google::Apis::RequestOptions] options
463
+ # Request-specific options
464
+ #
465
+ # @yield [result, err] Result & error if block supplied
466
+ # @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog] parsed result object
467
+ # @yieldparam err [StandardError] error object if request failed
468
+ #
469
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog]
470
+ #
471
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
472
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
473
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
474
+ def get_project_location_agent_changelog(name, fields: nil, quota_user: nil, options: nil, &block)
475
+ command = make_simple_command(:get, 'v3/{+name}', options)
476
+ command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog::Representation
477
+ command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog
478
+ command.params['name'] = name unless name.nil?
479
+ command.query['fields'] = fields unless fields.nil?
480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
481
+ execute_or_queue_command(command, &block)
482
+ end
483
+
484
+ # Returns the list of Changelogs.
485
+ # @param [String] parent
486
+ # Required. The agent containing the changelogs. Format: `projects//locations//
487
+ # agents/`.
488
+ # @param [String] filter
489
+ # The filter string. Supports filter by user_email, resource, type and
490
+ # create_time. Some examples: 1. By user email: user_email = "someone@google.com"
491
+ # 2. By resource name: resource = "projects/123/locations/global/agents/456/
492
+ # flows/789" 3. By resource display name: display_name = "my agent" 4. By action:
493
+ # action = "Create" 5. By type: type = "flows" 6. By create time. Currently
494
+ # predicates on `create_time` and `create_time_epoch_seconds` are supported:
495
+ # create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.
496
+ # 01Z 7. Combination of above filters: resource = "projects/123/locations/global/
497
+ # agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <=
498
+ # 2017-01-15T01:30:15.01Z
499
+ # @param [Fixnum] page_size
500
+ # The maximum number of items to return in a single page. By default 100 and at
501
+ # most 1000.
502
+ # @param [String] page_token
503
+ # The next_page_token value returned from a previous list request.
504
+ # @param [String] fields
505
+ # Selector specifying which fields to include in a partial response.
506
+ # @param [String] quota_user
507
+ # Available to use for quota purposes for server-side applications. Can be any
508
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
509
+ # @param [Google::Apis::RequestOptions] options
510
+ # Request-specific options
511
+ #
512
+ # @yield [result, err] Result & error if block supplied
513
+ # @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse] parsed result object
514
+ # @yieldparam err [StandardError] error object if request failed
515
+ #
516
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse]
517
+ #
518
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
519
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
520
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
521
+ def list_project_location_agent_changelogs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
522
+ command = make_simple_command(:get, 'v3/{+parent}/changelogs', options)
523
+ command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse::Representation
524
+ command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse
525
+ command.params['parent'] = parent unless parent.nil?
526
+ command.query['filter'] = filter unless filter.nil?
527
+ command.query['pageSize'] = page_size unless page_size.nil?
528
+ command.query['pageToken'] = page_token unless page_token.nil?
529
+ command.query['fields'] = fields unless fields.nil?
530
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
531
+ execute_or_queue_command(command, &block)
532
+ end
533
+
453
534
  # Creates an entity type in the specified agent. Note: You should always train a
454
535
  # flow prior to sending it queries. See the [training documentation](https://
455
536
  # cloud.google.com/dialogflow/cx/docs/concept/training).
@@ -735,6 +816,43 @@ module Google
735
816
  execute_or_queue_command(command, &block)
736
817
  end
737
818
 
819
+ # Deploys a flow to the specified Environment. This method is a [long-running
820
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
821
+ # operation). The returned `Operation` type has the following method-specific
822
+ # fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse
823
+ # @param [String] environment
824
+ # Required. The environment to deploy the flow to. Format: `projects//locations//
825
+ # agents// environments/`.
826
+ # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest] google_cloud_dialogflow_cx_v3_deploy_flow_request_object
827
+ # @param [String] fields
828
+ # Selector specifying which fields to include in a partial response.
829
+ # @param [String] quota_user
830
+ # Available to use for quota purposes for server-side applications. Can be any
831
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
832
+ # @param [Google::Apis::RequestOptions] options
833
+ # Request-specific options
834
+ #
835
+ # @yield [result, err] Result & error if block supplied
836
+ # @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
837
+ # @yieldparam err [StandardError] error object if request failed
838
+ #
839
+ # @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
840
+ #
841
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
842
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
843
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
844
+ def deploy_project_location_agent_environment_flow(environment, google_cloud_dialogflow_cx_v3_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
845
+ command = make_simple_command(:post, 'v3/{+environment}:deployFlow', options)
846
+ command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest::Representation
847
+ command.request_object = google_cloud_dialogflow_cx_v3_deploy_flow_request_object
848
+ command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
849
+ command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
850
+ command.params['environment'] = environment unless environment.nil?
851
+ command.query['fields'] = fields unless fields.nil?
852
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
853
+ execute_or_queue_command(command, &block)
854
+ end
855
+
738
856
  # Retrieves the specified Environment.
739
857
  # @param [String] name
740
858
  # Required. The name of the Environment. Format: `projects//locations//agents//
@@ -958,6 +1076,75 @@ module Google
958
1076
  execute_or_queue_command(command, &block)
959
1077
  end
960
1078
 
1079
+ # Retrieves the specified Deployment.
1080
+ # @param [String] name
1081
+ # Required. The name of the Deployment. Format: `projects//locations//agents//
1082
+ # environments//deployments/`.
1083
+ # @param [String] fields
1084
+ # Selector specifying which fields to include in a partial response.
1085
+ # @param [String] quota_user
1086
+ # Available to use for quota purposes for server-side applications. Can be any
1087
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1088
+ # @param [Google::Apis::RequestOptions] options
1089
+ # Request-specific options
1090
+ #
1091
+ # @yield [result, err] Result & error if block supplied
1092
+ # @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment] parsed result object
1093
+ # @yieldparam err [StandardError] error object if request failed
1094
+ #
1095
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment]
1096
+ #
1097
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1098
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1099
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1100
+ def get_project_location_agent_environment_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
1101
+ command = make_simple_command(:get, 'v3/{+name}', options)
1102
+ command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment::Representation
1103
+ command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment
1104
+ command.params['name'] = name unless name.nil?
1105
+ command.query['fields'] = fields unless fields.nil?
1106
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1107
+ execute_or_queue_command(command, &block)
1108
+ end
1109
+
1110
+ # Returns the list of all deployments in the specified Environment.
1111
+ # @param [String] parent
1112
+ # Required. The Environment to list all environments for. Format: `projects//
1113
+ # locations//agents//environments/`.
1114
+ # @param [Fixnum] page_size
1115
+ # The maximum number of items to return in a single page. By default 20 and at
1116
+ # most 100.
1117
+ # @param [String] page_token
1118
+ # The next_page_token value returned from a previous list request.
1119
+ # @param [String] fields
1120
+ # Selector specifying which fields to include in a partial response.
1121
+ # @param [String] quota_user
1122
+ # Available to use for quota purposes for server-side applications. Can be any
1123
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1124
+ # @param [Google::Apis::RequestOptions] options
1125
+ # Request-specific options
1126
+ #
1127
+ # @yield [result, err] Result & error if block supplied
1128
+ # @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse] parsed result object
1129
+ # @yieldparam err [StandardError] error object if request failed
1130
+ #
1131
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse]
1132
+ #
1133
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1134
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1135
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1136
+ def list_project_location_agent_environment_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1137
+ command = make_simple_command(:get, 'v3/{+parent}/deployments', options)
1138
+ command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse::Representation
1139
+ command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse
1140
+ command.params['parent'] = parent unless parent.nil?
1141
+ command.query['pageSize'] = page_size unless page_size.nil?
1142
+ command.query['pageToken'] = page_token unless page_token.nil?
1143
+ command.query['fields'] = fields unless fields.nil?
1144
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1145
+ execute_or_queue_command(command, &block)
1146
+ end
1147
+
961
1148
  # Creates an Experiment in the specified Environment.
962
1149
  # @param [String] parent
963
1150
  # Required. The Agent to create an Environment for. Format: `projects//locations/
@@ -2388,6 +2575,41 @@ module Google
2388
2575
  execute_or_queue_command(command, &block)
2389
2576
  end
2390
2577
 
2578
+ # Compares the specified base version with target version.
2579
+ # @param [String] base_version
2580
+ # Required. Name of the base flow version to compare with the target version.
2581
+ # Use version ID `0` to indicate the draft version of the specified flow. Format:
2582
+ # `projects//locations//agents/ /flows//versions/`.
2583
+ # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest] google_cloud_dialogflow_cx_v3_compare_versions_request_object
2584
+ # @param [String] fields
2585
+ # Selector specifying which fields to include in a partial response.
2586
+ # @param [String] quota_user
2587
+ # Available to use for quota purposes for server-side applications. Can be any
2588
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2589
+ # @param [Google::Apis::RequestOptions] options
2590
+ # Request-specific options
2591
+ #
2592
+ # @yield [result, err] Result & error if block supplied
2593
+ # @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse] parsed result object
2594
+ # @yieldparam err [StandardError] error object if request failed
2595
+ #
2596
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse]
2597
+ #
2598
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2599
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2600
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2601
+ def compare_project_location_agent_flow_version_versions(base_version, google_cloud_dialogflow_cx_v3_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2602
+ command = make_simple_command(:post, 'v3/{+baseVersion}:compareVersions', options)
2603
+ command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest::Representation
2604
+ command.request_object = google_cloud_dialogflow_cx_v3_compare_versions_request_object
2605
+ command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse::Representation
2606
+ command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse
2607
+ command.params['baseVersion'] = base_version unless base_version.nil?
2608
+ command.query['fields'] = fields unless fields.nil?
2609
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2610
+ execute_or_queue_command(command, &block)
2611
+ end
2612
+
2391
2613
  # Creates a Version in the specified Flow. This method is a [long-running
2392
2614
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
2393
2615
  # operation). The returned `Operation` type has the following method-specific
@@ -4004,7 +4226,9 @@ module Google
4004
4226
 
4005
4227
  # Updates the specified SecuritySettings.
4006
4228
  # @param [String] name
4007
- # Required. Resource name of the settings. Format: `projects//locations//
4229
+ # Resource name of the settings. Required for the SecuritySettingsService.
4230
+ # UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
4231
+ # populates the name automatically. Format: `projects//locations//
4008
4232
  # securitySettings/`.
4009
4233
  # @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] google_cloud_dialogflow_cx_v3_security_settings_object
4010
4234
  # @param [String] update_mask
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dialogflow_v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.21.0
4
+ version: 0.25.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-09-06 00:00:00.000000000 Z
11
+ date: 2022-01-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-dialogflow_v3/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3/v0.21.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-dialogflow_v3
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3/v0.25.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.4
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Dialogflow API V3