From 65a6a9fe465a5f3cfac3f634398d8fcc183c2a00 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Thu, 18 Oct 2018 00:36:35 +0000 Subject: [PATCH] Autogenerated update (2018-10-18) Delete: - content_v2sandbox Update: - abusiveexperiencereport_v1 - adexperiencereport_v1 - appengine_v1 - appengine_v1alpha - appengine_v1beta - appengine_v1beta4 - appengine_v1beta5 - cloudbuild_v1 - cloudfunctions_v1beta2 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - content_v2 - dialogflow_v2beta1 - genomics_v1 - genomics_v1alpha2 - genomics_v2alpha1 - logging_v2 - logging_v2beta1 --- api_names_out.yaml | 19 + .../google/apis/abusiveexperiencereport_v1.rb | 4 +- .../abusiveexperiencereport_v1/classes.rb | 1 - .../abusiveexperiencereport_v1/service.rb | 2 +- .../google/apis/adexperiencereport_v1.rb | 4 +- .../apis/adexperiencereport_v1/service.rb | 2 +- generated/google/apis/appengine_v1.rb | 5 +- generated/google/apis/appengine_v1/service.rb | 3 +- generated/google/apis/appengine_v1alpha.rb | 5 +- .../google/apis/appengine_v1alpha/service.rb | 3 +- generated/google/apis/appengine_v1beta.rb | 5 +- .../google/apis/appengine_v1beta/service.rb | 3 +- generated/google/apis/appengine_v1beta4.rb | 5 +- .../google/apis/appengine_v1beta4/service.rb | 3 +- generated/google/apis/appengine_v1beta5.rb | 5 +- .../google/apis/appengine_v1beta5/service.rb | 3 +- generated/google/apis/cloudbuild_v1.rb | 2 +- .../google/apis/cloudbuild_v1/classes.rb | 8 + .../apis/cloudbuild_v1/representations.rb | 1 + .../google/apis/cloudfunctions_v1beta2.rb | 2 +- .../apis/cloudfunctions_v1beta2/classes.rb | 16 + .../cloudfunctions_v1beta2/representations.rb | 1 + .../google/apis/cloudresourcemanager_v1.rb | 6 +- .../apis/cloudresourcemanager_v1/classes.rb | 3 +- .../apis/cloudresourcemanager_v1/service.rb | 4 +- .../apis/cloudresourcemanager_v1beta1.rb | 6 +- .../cloudresourcemanager_v1beta1/classes.rb | 3 +- .../cloudresourcemanager_v1beta1/service.rb | 4 +- .../google/apis/cloudresourcemanager_v2.rb | 6 +- .../apis/cloudresourcemanager_v2/service.rb | 4 +- .../apis/cloudresourcemanager_v2beta1.rb | 6 +- .../cloudresourcemanager_v2beta1/service.rb | 4 +- generated/google/apis/content_v2.rb | 2 +- generated/google/apis/content_v2/classes.rb | 79 +- .../google/apis/content_v2/representations.rb | 10 + generated/google/apis/content_v2/service.rb | 2 +- generated/google/apis/content_v2sandbox.rb | 35 - .../google/apis/content_v2sandbox/classes.rb | 4436 ----------------- .../apis/content_v2sandbox/representations.rb | 1956 -------- .../google/apis/content_v2sandbox/service.rb | 1296 ----- generated/google/apis/dialogflow_v2beta1.rb | 9 +- .../google/apis/dialogflow_v2beta1/classes.rb | 1393 +----- .../dialogflow_v2beta1/representations.rb | 629 +-- .../google/apis/dialogflow_v2beta1/service.rb | 1180 +---- generated/google/apis/genomics_v1.rb | 4 +- generated/google/apis/genomics_v1/service.rb | 2 +- generated/google/apis/genomics_v1alpha2.rb | 4 +- .../google/apis/genomics_v1alpha2/service.rb | 2 +- generated/google/apis/genomics_v2alpha1.rb | 4 +- .../google/apis/genomics_v2alpha1/service.rb | 2 +- generated/google/apis/logging_v2.rb | 2 +- generated/google/apis/logging_v2/classes.rb | 3 +- generated/google/apis/logging_v2beta1.rb | 2 +- .../google/apis/logging_v2beta1/classes.rb | 31 +- .../apis/logging_v2beta1/representations.rb | 14 - .../google/apis/logging_v2beta1/service.rb | 255 - 56 files changed, 297 insertions(+), 11203 deletions(-) delete mode 100644 generated/google/apis/content_v2sandbox.rb delete mode 100644 generated/google/apis/content_v2sandbox/classes.rb delete mode 100644 generated/google/apis/content_v2sandbox/representations.rb delete mode 100644 generated/google/apis/content_v2sandbox/service.rb diff --git a/api_names_out.yaml b/api_names_out.yaml index b263c7eb5..ae6698d5f 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -14597,6 +14597,7 @@ "/cloudbuild:v1/BuildOptions/substitutionOption": substitution_option "/cloudbuild:v1/BuildOptions/volumes": volumes "/cloudbuild:v1/BuildOptions/volumes/volume": volume +"/cloudbuild:v1/BuildOptions/workerPool": worker_pool "/cloudbuild:v1/BuildStep": build_step "/cloudbuild:v1/BuildStep/args": args "/cloudbuild:v1/BuildStep/args/arg": arg @@ -15172,6 +15173,7 @@ "/cloudfunctions:v1beta2/CloudFunction/timeout": timeout "/cloudfunctions:v1beta2/CloudFunction/updateTime": update_time "/cloudfunctions:v1beta2/CloudFunction/versionId": version_id +"/cloudfunctions:v1beta2/CloudFunction/vpcConnector": vpc_connector "/cloudfunctions:v1beta2/EventTrigger": event_trigger "/cloudfunctions:v1beta2/EventTrigger/eventType": event_type "/cloudfunctions:v1beta2/EventTrigger/failurePolicy": failure_policy @@ -36804,6 +36806,11 @@ "/content:v2/Installment/months": months "/content:v2/Inventory": inventory "/content:v2/Inventory/availability": availability +"/content:v2/Inventory/customLabel0": custom_label0 +"/content:v2/Inventory/customLabel1": custom_label1 +"/content:v2/Inventory/customLabel2": custom_label2 +"/content:v2/Inventory/customLabel3": custom_label3 +"/content:v2/Inventory/customLabel4": custom_label4 "/content:v2/Inventory/installment": installment "/content:v2/Inventory/kind": kind "/content:v2/Inventory/loyaltyPoints": loyalty_points @@ -36835,6 +36842,11 @@ "/content:v2/InventoryPickup/pickupSla": pickup_sla "/content:v2/InventorySetRequest": set_inventory_request "/content:v2/InventorySetRequest/availability": availability +"/content:v2/InventorySetRequest/customLabel0": custom_label0 +"/content:v2/InventorySetRequest/customLabel1": custom_label1 +"/content:v2/InventorySetRequest/customLabel2": custom_label2 +"/content:v2/InventorySetRequest/customLabel3": custom_label3 +"/content:v2/InventorySetRequest/customLabel4": custom_label4 "/content:v2/InventorySetRequest/installment": installment "/content:v2/InventorySetRequest/loyaltyPoints": loyalty_points "/content:v2/InventorySetRequest/pickup": pickup @@ -57223,6 +57235,10 @@ "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1Conversation/name": name "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1Conversation/phoneNumber": phone_number "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1Conversation/startTime": start_time +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationEvent": google_cloud_dialogflow_v2beta1_conversation_event +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationEvent/conversation": conversation +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationEvent/errorStatus": error_status +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationEvent/type": type "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationPhoneNumber": google_cloud_dialogflow_v2beta1_conversation_phone_number "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationPhoneNumber/phoneNumber": phone_number "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ConversationProfile": google_cloud_dialogflow_v2beta1_conversation_profile @@ -57288,6 +57304,9 @@ "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig": google_cloud_dialogflow_v2beta1_human_agent_assistant_config "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig/name": name "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig/notificationConfig": notification_config +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": google_cloud_dialogflow_v2beta1_human_agent_assistant_event +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent/conversation": conversation +"/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent/type": type "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ImportAgentRequest": google_cloud_dialogflow_v2beta1_import_agent_request "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ImportAgentRequest/agentContent": agent_content "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1ImportAgentRequest/agentUri": agent_uri diff --git a/generated/google/apis/abusiveexperiencereport_v1.rb b/generated/google/apis/abusiveexperiencereport_v1.rb index 18bc12cf4..1398b3880 100644 --- a/generated/google/apis/abusiveexperiencereport_v1.rb +++ b/generated/google/apis/abusiveexperiencereport_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Abusive Experience Report API # - # View Abusive Experience Report data, and get a list of sites that have a + # Views Abusive Experience Report data, and gets a list of sites that have a # significant number of abusive experiences. # # @see https://developers.google.com/abusive-experience-report/ module AbusiveexperiencereportV1 VERSION = 'V1' - REVISION = '20180807' + REVISION = '20181017' # Test scope for access to the Zoo service AUTH_XAPI_ZOO = 'https://www.googleapis.com/auth/xapi.zoo' diff --git a/generated/google/apis/abusiveexperiencereport_v1/classes.rb b/generated/google/apis/abusiveexperiencereport_v1/classes.rb index 7ec831718..1e6d02bba 100644 --- a/generated/google/apis/abusiveexperiencereport_v1/classes.rb +++ b/generated/google/apis/abusiveexperiencereport_v1/classes.rb @@ -23,7 +23,6 @@ module Google module AbusiveexperiencereportV1 # Response message for GetSiteSummary. - # Do not confuse with same message in google.ads.experiencereport.v1 class SiteSummaryResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/abusiveexperiencereport_v1/service.rb b/generated/google/apis/abusiveexperiencereport_v1/service.rb index f313a97af..a32a0a6c8 100644 --- a/generated/google/apis/abusiveexperiencereport_v1/service.rb +++ b/generated/google/apis/abusiveexperiencereport_v1/service.rb @@ -22,7 +22,7 @@ module Google module AbusiveexperiencereportV1 # Abusive Experience Report API # - # View Abusive Experience Report data, and get a list of sites that have a + # Views Abusive Experience Report data, and gets a list of sites that have a # significant number of abusive experiences. # # @example diff --git a/generated/google/apis/adexperiencereport_v1.rb b/generated/google/apis/adexperiencereport_v1.rb index 2aa8ab526..575a85f26 100644 --- a/generated/google/apis/adexperiencereport_v1.rb +++ b/generated/google/apis/adexperiencereport_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Ad Experience Report API # - # View Ad Experience Report data, and get a list of sites that have a + # Views Ad Experience Report data, and gets a list of sites that have a # significant number of annoying ads. # # @see https://developers.google.com/ad-experience-report/ module AdexperiencereportV1 VERSION = 'V1' - REVISION = '20180911' + REVISION = '20181017' # Test scope for access to the Zoo service AUTH_XAPI_ZOO = 'https://www.googleapis.com/auth/xapi.zoo' diff --git a/generated/google/apis/adexperiencereport_v1/service.rb b/generated/google/apis/adexperiencereport_v1/service.rb index 00cf89c58..ed9c9a871 100644 --- a/generated/google/apis/adexperiencereport_v1/service.rb +++ b/generated/google/apis/adexperiencereport_v1/service.rb @@ -22,7 +22,7 @@ module Google module AdexperiencereportV1 # Ad Experience Report API # - # View Ad Experience Report data, and get a list of sites that have a + # Views Ad Experience Report data, and gets a list of sites that have a # significant number of annoying ads. # # @example diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index a409017c6..cf95da215 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -20,12 +20,13 @@ module Google module Apis # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20181011' + REVISION = '20181017' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1/service.rb b/generated/google/apis/appengine_v1/service.rb index 514dffea1..e1707b100 100644 --- a/generated/google/apis/appengine_v1/service.rb +++ b/generated/google/apis/appengine_v1/service.rb @@ -22,7 +22,8 @@ module Google module AppengineV1 # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @example # require 'google/apis/appengine_v1' diff --git a/generated/google/apis/appengine_v1alpha.rb b/generated/google/apis/appengine_v1alpha.rb index e9e5d264b..1d8aac73a 100644 --- a/generated/google/apis/appengine_v1alpha.rb +++ b/generated/google/apis/appengine_v1alpha.rb @@ -20,12 +20,13 @@ module Google module Apis # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1alpha VERSION = 'V1alpha' - REVISION = '20181011' + REVISION = '20181017' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1alpha/service.rb b/generated/google/apis/appengine_v1alpha/service.rb index 0d342fef3..06e2660df 100644 --- a/generated/google/apis/appengine_v1alpha/service.rb +++ b/generated/google/apis/appengine_v1alpha/service.rb @@ -22,7 +22,8 @@ module Google module AppengineV1alpha # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @example # require 'google/apis/appengine_v1alpha' diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index 3a53ba4f3..d0ce7cc42 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -20,12 +20,13 @@ module Google module Apis # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20181011' + REVISION = '20181017' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta/service.rb b/generated/google/apis/appengine_v1beta/service.rb index ec4d2e9f0..e9a61d205 100644 --- a/generated/google/apis/appengine_v1beta/service.rb +++ b/generated/google/apis/appengine_v1beta/service.rb @@ -22,7 +22,8 @@ module Google module AppengineV1beta # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @example # require 'google/apis/appengine_v1beta' diff --git a/generated/google/apis/appengine_v1beta4.rb b/generated/google/apis/appengine_v1beta4.rb index 31330809c..a80fd24e5 100644 --- a/generated/google/apis/appengine_v1beta4.rb +++ b/generated/google/apis/appengine_v1beta4.rb @@ -20,12 +20,13 @@ module Google module Apis # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta4 VERSION = 'V1beta4' - REVISION = '20181011' + REVISION = '20181017' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta4/service.rb b/generated/google/apis/appengine_v1beta4/service.rb index f6f75c3c8..1f8d4a51a 100644 --- a/generated/google/apis/appengine_v1beta4/service.rb +++ b/generated/google/apis/appengine_v1beta4/service.rb @@ -22,7 +22,8 @@ module Google module AppengineV1beta4 # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @example # require 'google/apis/appengine_v1beta4' diff --git a/generated/google/apis/appengine_v1beta5.rb b/generated/google/apis/appengine_v1beta5.rb index d56a73a1b..b236983d9 100644 --- a/generated/google/apis/appengine_v1beta5.rb +++ b/generated/google/apis/appengine_v1beta5.rb @@ -20,12 +20,13 @@ module Google module Apis # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta5 VERSION = 'V1beta5' - REVISION = '20181011' + REVISION = '20181017' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta5/service.rb b/generated/google/apis/appengine_v1beta5/service.rb index 691d6d6f5..7afc2cef3 100644 --- a/generated/google/apis/appengine_v1beta5/service.rb +++ b/generated/google/apis/appengine_v1beta5/service.rb @@ -22,7 +22,8 @@ module Google module AppengineV1beta5 # App Engine Admin API # - # Provisions and manages developers' App Engine applications. + # The App Engine Admin API enables developers to provision and manage their App + # Engine applications. # # @example # require 'google/apis/appengine_v1beta5' diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index 2243ee69e..2cc6129f0 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20181009' + REVISION = '20181017' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/classes.rb b/generated/google/apis/cloudbuild_v1/classes.rb index 61515dce7..b9a4620f7 100644 --- a/generated/google/apis/cloudbuild_v1/classes.rb +++ b/generated/google/apis/cloudbuild_v1/classes.rb @@ -408,6 +408,13 @@ module Google # @return [Array] attr_accessor :volumes + # Option to specify a `WorkerPool` for the build. User specifies the pool + # with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". + # This is an experimental field. + # Corresponds to the JSON property `workerPool` + # @return [String] + attr_accessor :worker_pool + def initialize(**args) update!(**args) end @@ -424,6 +431,7 @@ module Google @source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash) @substitution_option = args[:substitution_option] if args.key?(:substitution_option) @volumes = args[:volumes] if args.key?(:volumes) + @worker_pool = args[:worker_pool] if args.key?(:worker_pool) end end diff --git a/generated/google/apis/cloudbuild_v1/representations.rb b/generated/google/apis/cloudbuild_v1/representations.rb index b63d6adb6..bbae62c06 100644 --- a/generated/google/apis/cloudbuild_v1/representations.rb +++ b/generated/google/apis/cloudbuild_v1/representations.rb @@ -276,6 +276,7 @@ module Google property :substitution_option, as: 'substitutionOption' collection :volumes, as: 'volumes', class: Google::Apis::CloudbuildV1::Volume, decorator: Google::Apis::CloudbuildV1::Volume::Representation + property :worker_pool, as: 'workerPool' end end diff --git a/generated/google/apis/cloudfunctions_v1beta2.rb b/generated/google/apis/cloudfunctions_v1beta2.rb index fd38dc91f..58ee6ee59 100644 --- a/generated/google/apis/cloudfunctions_v1beta2.rb +++ b/generated/google/apis/cloudfunctions_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1beta2 VERSION = 'V1beta2' - REVISION = '20180702' + REVISION = '20181010' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudfunctions_v1beta2/classes.rb b/generated/google/apis/cloudfunctions_v1beta2/classes.rb index 0e9ed3897..2fbb42524 100644 --- a/generated/google/apis/cloudfunctions_v1beta2/classes.rb +++ b/generated/google/apis/cloudfunctions_v1beta2/classes.rb @@ -145,6 +145,8 @@ module Google # `projects/`project`/global/networks/`network`` or ``network``, where # `project` is a project id where the network is defined, and `network` is # the short name of the network. + # This field is mutually exclusive with `vpc_connector` and will be replaced + # by it. # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for # more information on connecting Cloud projects. # This feature is currently in alpha, available only for whitelisted users. @@ -221,6 +223,19 @@ module Google # @return [Fixnum] attr_accessor :version_id + # The VPC Network Connector that this cloud function can connect to. It can + # be either the fully-qualified URI, or the short name of the network + # connector resource. The format of this field is + # `projects/*/locations/*/connectors/*` + # This field is mutually exclusive with `network` field and will eventually + # replace it. + # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for + # more information on connecting Cloud projects. + # This feature is currently in alpha, available only for whitelisted users. + # Corresponds to the JSON property `vpcConnector` + # @return [String] + attr_accessor :vpc_connector + def initialize(**args) update!(**args) end @@ -247,6 +262,7 @@ module Google @timeout = args[:timeout] if args.key?(:timeout) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) + @vpc_connector = args[:vpc_connector] if args.key?(:vpc_connector) end end diff --git a/generated/google/apis/cloudfunctions_v1beta2/representations.rb b/generated/google/apis/cloudfunctions_v1beta2/representations.rb index 20f5a9bbe..67a646f2c 100644 --- a/generated/google/apis/cloudfunctions_v1beta2/representations.rb +++ b/generated/google/apis/cloudfunctions_v1beta2/representations.rb @@ -184,6 +184,7 @@ module Google property :timeout, as: 'timeout' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' + property :vpc_connector, as: 'vpcConnector' end end diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index 201a173c6..3c6b2fa5b 100644 --- a/generated/google/apis/cloudresourcemanager_v1.rb +++ b/generated/google/apis/cloudresourcemanager_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1 VERSION = 'V1' - REVISION = '20180820' + REVISION = '20181015' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1/classes.rb b/generated/google/apis/cloudresourcemanager_v1/classes.rb index 607cd89a1..38e853d2c 100644 --- a/generated/google/apis/cloudresourcemanager_v1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1/classes.rb @@ -1393,7 +1393,8 @@ module Google # Label keys must be between 1 and 63 characters long and must conform # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. # Label values must be between 0 and 63 characters long and must conform - # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. + # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label + # value can be empty. # No more than 256 labels can be associated with a given resource. # Clients should store labels in a representation such as JSON that does not # depend on specific characters being disallowed. diff --git a/generated/google/apis/cloudresourcemanager_v1/service.rb b/generated/google/apis/cloudresourcemanager_v1/service.rb index dc00c29dd..fd4a6cbf4 100644 --- a/generated/google/apis/cloudresourcemanager_v1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1/service.rb @@ -22,8 +22,8 @@ module Google module CloudresourcemanagerV1 # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @example # require 'google/apis/cloudresourcemanager_v1' diff --git a/generated/google/apis/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index 088d095e3..0f54df76f 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1.rb @@ -20,13 +20,13 @@ module Google module Apis # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20180806' + REVISION = '20181015' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb index de5fd0485..284399d3c 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb @@ -632,7 +632,8 @@ module Google # Label keys must be between 1 and 63 characters long and must conform # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. # Label values must be between 0 and 63 characters long and must conform - # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. + # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label + # value can be empty. # No more than 256 labels can be associated with a given resource. # Clients should store labels in a representation such as JSON that does not # depend on specific characters being disallowed. diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb index 233bf3036..5c344c95d 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb @@ -22,8 +22,8 @@ module Google module CloudresourcemanagerV1beta1 # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @example # require 'google/apis/cloudresourcemanager_v1beta1' diff --git a/generated/google/apis/cloudresourcemanager_v2.rb b/generated/google/apis/cloudresourcemanager_v2.rb index 428dff56f..4f9921c67 100644 --- a/generated/google/apis/cloudresourcemanager_v2.rb +++ b/generated/google/apis/cloudresourcemanager_v2.rb @@ -20,13 +20,13 @@ module Google module Apis # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2 VERSION = 'V2' - REVISION = '20180815' + REVISION = '20181015' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v2/service.rb b/generated/google/apis/cloudresourcemanager_v2/service.rb index 63050d0b5..18067894a 100644 --- a/generated/google/apis/cloudresourcemanager_v2/service.rb +++ b/generated/google/apis/cloudresourcemanager_v2/service.rb @@ -22,8 +22,8 @@ module Google module CloudresourcemanagerV2 # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @example # require 'google/apis/cloudresourcemanager_v2' diff --git a/generated/google/apis/cloudresourcemanager_v2beta1.rb b/generated/google/apis/cloudresourcemanager_v2beta1.rb index 736e2fd84..c1f6a01d6 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1.rb @@ -20,13 +20,13 @@ module Google module Apis # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2beta1 VERSION = 'V2beta1' - REVISION = '20180815' + REVISION = '20181015' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v2beta1/service.rb b/generated/google/apis/cloudresourcemanager_v2beta1/service.rb index ff2d4de6f..13098ec70 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1/service.rb @@ -22,8 +22,8 @@ module Google module CloudresourcemanagerV2beta1 # Cloud Resource Manager API # - # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating project metadata. + # Creates, reads, and updates metadata for Google Cloud Platform resource + # containers. # # @example # require 'google/apis/cloudresourcemanager_v2beta1' diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index b0c6ee09c..1b43721aa 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20181009' + REVISION = '20181016' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index 188bb08a1..b99a746d1 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -22,7 +22,8 @@ module Google module Apis module ContentV2 - # Account data. + # Account data. After the creation of a new account it may take a few minutes + # before it is fully operational. class Account include Google::Apis::Core::Hashable @@ -896,7 +897,8 @@ module Google class AccountsBatchRequestEntry include Google::Apis::Core::Hashable - # Account data. + # Account data. After the creation of a new account it may take a few minutes + # before it is fully operational. # Corresponds to the JSON property `account` # @return [Google::Apis::ContentV2::Account] attr_accessor :account @@ -1019,7 +1021,8 @@ module Google class AccountsBatchResponseEntry include Google::Apis::Core::Hashable - # Account data. + # Account data. After the creation of a new account it may take a few minutes + # before it is fully operational. # Corresponds to the JSON property `account` # @return [Google::Apis::ContentV2::Account] attr_accessor :account @@ -2726,6 +2729,36 @@ module Google # @return [String] attr_accessor :availability + # Custom label 0 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel0` + # @return [String] + attr_accessor :custom_label0 + + # Custom label 1 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel1` + # @return [String] + attr_accessor :custom_label1 + + # Custom label 2 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel2` + # @return [String] + attr_accessor :custom_label2 + + # Custom label 3 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel3` + # @return [String] + attr_accessor :custom_label3 + + # Custom label 3 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel4` + # @return [String] + attr_accessor :custom_label4 + # Number and amount of installments to pay for an item. Brazil only. # Corresponds to the JSON property `installment` # @return [Google::Apis::ContentV2::Installment] @@ -2786,6 +2819,11 @@ module Google # Update properties of this object def update!(**args) @availability = args[:availability] if args.key?(:availability) + @custom_label0 = args[:custom_label0] if args.key?(:custom_label0) + @custom_label1 = args[:custom_label1] if args.key?(:custom_label1) + @custom_label2 = args[:custom_label2] if args.key?(:custom_label2) + @custom_label3 = args[:custom_label3] if args.key?(:custom_label3) + @custom_label4 = args[:custom_label4] if args.key?(:custom_label4) @installment = args[:installment] if args.key?(:installment) @kind = args[:kind] if args.key?(:kind) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @@ -2958,6 +2996,36 @@ module Google # @return [String] attr_accessor :availability + # Custom label 0 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel0` + # @return [String] + attr_accessor :custom_label0 + + # Custom label 1 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel1` + # @return [String] + attr_accessor :custom_label1 + + # Custom label 2 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel2` + # @return [String] + attr_accessor :custom_label2 + + # Custom label 3 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel3` + # @return [String] + attr_accessor :custom_label3 + + # Custom label 3 for custom grouping of items in a Shopping campaign. Only + # supported for online products. + # Corresponds to the JSON property `customLabel4` + # @return [String] + attr_accessor :custom_label4 + # Number and amount of installments to pay for an item. Brazil only. # Corresponds to the JSON property `installment` # @return [Google::Apis::ContentV2::Installment] @@ -3012,6 +3080,11 @@ module Google # Update properties of this object def update!(**args) @availability = args[:availability] if args.key?(:availability) + @custom_label0 = args[:custom_label0] if args.key?(:custom_label0) + @custom_label1 = args[:custom_label1] if args.key?(:custom_label1) + @custom_label2 = args[:custom_label2] if args.key?(:custom_label2) + @custom_label3 = args[:custom_label3] if args.key?(:custom_label3) + @custom_label4 = args[:custom_label4] if args.key?(:custom_label4) @installment = args[:installment] if args.key?(:installment) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @pickup = args[:pickup] if args.key?(:pickup) diff --git a/generated/google/apis/content_v2/representations.rb b/generated/google/apis/content_v2/representations.rb index 28ea2b78a..87c64f0d7 100644 --- a/generated/google/apis/content_v2/representations.rb +++ b/generated/google/apis/content_v2/representations.rb @@ -2363,6 +2363,11 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability, as: 'availability' + property :custom_label0, as: 'customLabel0' + property :custom_label1, as: 'customLabel1' + property :custom_label2, as: 'customLabel2' + property :custom_label3, as: 'customLabel3' + property :custom_label4, as: 'customLabel4' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation property :kind, as: 'kind' @@ -2431,6 +2436,11 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability, as: 'availability' + property :custom_label0, as: 'customLabel0' + property :custom_label1, as: 'customLabel1' + property :custom_label2, as: 'customLabel2' + property :custom_label3, as: 'customLabel3' + property :custom_label4, as: 'customLabel4' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation property :loyalty_points, as: 'loyaltyPoints', class: Google::Apis::ContentV2::LoyaltyPoints, decorator: Google::Apis::ContentV2::LoyaltyPoints::Representation diff --git a/generated/google/apis/content_v2/service.rb b/generated/google/apis/content_v2/service.rb index 9c492064d..76cf8e5d0 100644 --- a/generated/google/apis/content_v2/service.rb +++ b/generated/google/apis/content_v2/service.rb @@ -2039,7 +2039,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a list of transactions for an disbursement from your Merchant Center + # Retrieves a list of transactions for a disbursement from your Merchant Center # account. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client diff --git a/generated/google/apis/content_v2sandbox.rb b/generated/google/apis/content_v2sandbox.rb deleted file mode 100644 index 475723259..000000000 --- a/generated/google/apis/content_v2sandbox.rb +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/content_v2sandbox/service.rb' -require 'google/apis/content_v2sandbox/classes.rb' -require 'google/apis/content_v2sandbox/representations.rb' - -module Google - module Apis - # Content API for Shopping - # - # Manages product items, inventory, and Merchant Center accounts for Google - # Shopping. - # - # @see https://developers.google.com/shopping-content - module ContentV2sandbox - VERSION = 'V2sandbox' - REVISION = '20181002' - - # Manage your product listings and accounts for Google Shopping - AUTH_CONTENT = 'https://www.googleapis.com/auth/content' - end - end -end diff --git a/generated/google/apis/content_v2sandbox/classes.rb b/generated/google/apis/content_v2sandbox/classes.rb deleted file mode 100644 index 7c668cd9c..000000000 --- a/generated/google/apis/content_v2sandbox/classes.rb +++ /dev/null @@ -1,4436 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module ContentV2sandbox - - # - class Amount - include Google::Apis::Core::Hashable - - # [required] Value before taxes. - # Corresponds to the JSON property `pretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :pretax - - # [required] Tax value. - # Corresponds to the JSON property `tax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :tax - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pretax = args[:pretax] if args.key?(:pretax) - @tax = args[:tax] if args.key?(:tax) - end - end - - # - class CustomerReturnReason - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # - # Corresponds to the JSON property `reasonCode` - # @return [String] - attr_accessor :reason_code - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @reason_code = args[:reason_code] if args.key?(:reason_code) - end - end - - # An error returned by the API. - class Error - include Google::Apis::Core::Hashable - - # The domain of the error. - # Corresponds to the JSON property `domain` - # @return [String] - attr_accessor :domain - - # A description of the error. - # Corresponds to the JSON property `message` - # @return [String] - attr_accessor :message - - # The error code. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @domain = args[:domain] if args.key?(:domain) - @message = args[:message] if args.key?(:message) - @reason = args[:reason] if args.key?(:reason) - end - end - - # A list of errors returned by a failed batch entry. - class Errors - include Google::Apis::Core::Hashable - - # The HTTP status of the first error in errors. - # Corresponds to the JSON property `code` - # @return [Fixnum] - attr_accessor :code - - # A list of errors. - # Corresponds to the JSON property `errors` - # @return [Array] - attr_accessor :errors - - # The message of the first error in errors. - # Corresponds to the JSON property `message` - # @return [String] - attr_accessor :message - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @errors = args[:errors] if args.key?(:errors) - @message = args[:message] if args.key?(:message) - end - end - - # - class InvoiceSummary - include Google::Apis::Core::Hashable - - # Summary of the total amounts of the additional charges. - # Corresponds to the JSON property `additionalChargeSummaries` - # @return [Array] - attr_accessor :additional_charge_summaries - - # [required] Customer balance on this invoice. A negative amount means the - # customer is paying, a positive one means the customer is receiving money. Note: - # the sum of merchant_balance, customer_balance and google_balance must always - # be zero. - # Furthermore the absolute value of this amount is expected to be equal to the - # sum of product amount and additional charges, minus promotions. - # Corresponds to the JSON property `customerBalance` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :customer_balance - - # [required] Google balance on this invoice. A negative amount means Google is - # paying, a positive one means Google is receiving money. Note: the sum of - # merchant_balance, customer_balance and google_balance must always be zero. - # Corresponds to the JSON property `googleBalance` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :google_balance - - # [required] Merchant balance on this invoice. A negative amount means the - # merchant is paying, a positive one means the merchant is receiving money. Note: - # the sum of merchant_balance, customer_balance and google_balance must always - # be zero. - # Corresponds to the JSON property `merchantBalance` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :merchant_balance - - # [required] Total price for the product. - # Corresponds to the JSON property `productTotal` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :product_total - - # Summary for each promotion. - # Corresponds to the JSON property `promotionSummaries` - # @return [Array] - attr_accessor :promotion_summaries - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @additional_charge_summaries = args[:additional_charge_summaries] if args.key?(:additional_charge_summaries) - @customer_balance = args[:customer_balance] if args.key?(:customer_balance) - @google_balance = args[:google_balance] if args.key?(:google_balance) - @merchant_balance = args[:merchant_balance] if args.key?(:merchant_balance) - @product_total = args[:product_total] if args.key?(:product_total) - @promotion_summaries = args[:promotion_summaries] if args.key?(:promotion_summaries) - end - end - - # - class InvoiceSummaryAdditionalChargeSummary - include Google::Apis::Core::Hashable - - # [required] Total additional charge for this type. - # Corresponds to the JSON property `totalAmount` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :total_amount - - # [required] Type of the additional charge. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @total_amount = args[:total_amount] if args.key?(:total_amount) - @type = args[:type] if args.key?(:type) - end - end - - # - class MerchantOrderReturn - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `creationDate` - # @return [String] - attr_accessor :creation_date - - # - # Corresponds to the JSON property `merchantOrderId` - # @return [String] - attr_accessor :merchant_order_id - - # - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - # - # Corresponds to the JSON property `orderReturnId` - # @return [String] - attr_accessor :order_return_id - - # - # Corresponds to the JSON property `returnItems` - # @return [Array] - attr_accessor :return_items - - # - # Corresponds to the JSON property `returnShipments` - # @return [Array] - attr_accessor :return_shipments - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @creation_date = args[:creation_date] if args.key?(:creation_date) - @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) - @order_id = args[:order_id] if args.key?(:order_id) - @order_return_id = args[:order_return_id] if args.key?(:order_return_id) - @return_items = args[:return_items] if args.key?(:return_items) - @return_shipments = args[:return_shipments] if args.key?(:return_shipments) - end - end - - # - class MerchantOrderReturnItem - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `customerReturnReason` - # @return [Google::Apis::ContentV2sandbox::CustomerReturnReason] - attr_accessor :customer_return_reason - - # - # Corresponds to the JSON property `itemId` - # @return [String] - attr_accessor :item_id - - # - # Corresponds to the JSON property `merchantReturnReason` - # @return [Google::Apis::ContentV2sandbox::RefundReason] - attr_accessor :merchant_return_reason - - # - # Corresponds to the JSON property `product` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemProduct] - attr_accessor :product - - # - # Corresponds to the JSON property `returnShipmentIds` - # @return [Array] - attr_accessor :return_shipment_ids - - # - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @customer_return_reason = args[:customer_return_reason] if args.key?(:customer_return_reason) - @item_id = args[:item_id] if args.key?(:item_id) - @merchant_return_reason = args[:merchant_return_reason] if args.key?(:merchant_return_reason) - @product = args[:product] if args.key?(:product) - @return_shipment_ids = args[:return_shipment_ids] if args.key?(:return_shipment_ids) - @state = args[:state] if args.key?(:state) - end - end - - # - class Order - include Google::Apis::Core::Hashable - - # Whether the order was acknowledged. - # Corresponds to the JSON property `acknowledged` - # @return [Boolean] - attr_accessor :acknowledged - alias_method :acknowledged?, :acknowledged - - # The channel type of the order: "purchaseOnGoogle" or "googleExpress". - # Corresponds to the JSON property `channelType` - # @return [String] - attr_accessor :channel_type - - # The details of the customer who placed the order. - # Corresponds to the JSON property `customer` - # @return [Google::Apis::ContentV2sandbox::OrderCustomer] - attr_accessor :customer - - # The details for the delivery. - # Corresponds to the JSON property `deliveryDetails` - # @return [Google::Apis::ContentV2sandbox::OrderDeliveryDetails] - attr_accessor :delivery_details - - # The REST id of the order. Globally unique. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies what kind of resource this is. Value: the fixed string "content# - # order". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Line items that are ordered. - # Corresponds to the JSON property `lineItems` - # @return [Array] - attr_accessor :line_items - - # - # Corresponds to the JSON property `merchantId` - # @return [Fixnum] - attr_accessor :merchant_id - - # Merchant-provided id of the order. - # Corresponds to the JSON property `merchantOrderId` - # @return [String] - attr_accessor :merchant_order_id - - # The net amount for the order. For example, if an order was originally for a - # grand total of $100 and a refund was issued for $20, the net amount will be $ - # 80. - # Corresponds to the JSON property `netAmount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :net_amount - - # The details of the payment method. - # Corresponds to the JSON property `paymentMethod` - # @return [Google::Apis::ContentV2sandbox::OrderPaymentMethod] - attr_accessor :payment_method - - # The status of the payment. - # Corresponds to the JSON property `paymentStatus` - # @return [String] - attr_accessor :payment_status - - # The date when the order was placed, in ISO 8601 format. - # Corresponds to the JSON property `placedDate` - # @return [String] - attr_accessor :placed_date - - # Deprecated. The details of the merchant provided promotions applied to the - # order. More details about the program are here. - # Corresponds to the JSON property `promotions` - # @return [Array] - attr_accessor :promotions - - # Refunds for the order. - # Corresponds to the JSON property `refunds` - # @return [Array] - attr_accessor :refunds - - # Shipments of the order. - # Corresponds to the JSON property `shipments` - # @return [Array] - attr_accessor :shipments - - # The total cost of shipping for all items. - # Corresponds to the JSON property `shippingCost` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :shipping_cost - - # The tax for the total shipping cost. - # Corresponds to the JSON property `shippingCostTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :shipping_cost_tax - - # The requested shipping option. - # Corresponds to the JSON property `shippingOption` - # @return [String] - attr_accessor :shipping_option - - # The status of the order. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @acknowledged = args[:acknowledged] if args.key?(:acknowledged) - @channel_type = args[:channel_type] if args.key?(:channel_type) - @customer = args[:customer] if args.key?(:customer) - @delivery_details = args[:delivery_details] if args.key?(:delivery_details) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @line_items = args[:line_items] if args.key?(:line_items) - @merchant_id = args[:merchant_id] if args.key?(:merchant_id) - @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) - @net_amount = args[:net_amount] if args.key?(:net_amount) - @payment_method = args[:payment_method] if args.key?(:payment_method) - @payment_status = args[:payment_status] if args.key?(:payment_status) - @placed_date = args[:placed_date] if args.key?(:placed_date) - @promotions = args[:promotions] if args.key?(:promotions) - @refunds = args[:refunds] if args.key?(:refunds) - @shipments = args[:shipments] if args.key?(:shipments) - @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost) - @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax) - @shipping_option = args[:shipping_option] if args.key?(:shipping_option) - @status = args[:status] if args.key?(:status) - end - end - - # - class OrderAddress - include Google::Apis::Core::Hashable - - # CLDR country code (e.g. "US"). - # Corresponds to the JSON property `country` - # @return [String] - attr_accessor :country - - # Strings representing the lines of the printed label for mailing the order, for - # example: - # John Smith - # 1600 Amphitheatre Parkway - # Mountain View, CA, 94043 - # United States - # Corresponds to the JSON property `fullAddress` - # @return [Array] - attr_accessor :full_address - - # Whether the address is a post office box. - # Corresponds to the JSON property `isPostOfficeBox` - # @return [Boolean] - attr_accessor :is_post_office_box - alias_method :is_post_office_box?, :is_post_office_box - - # City, town or commune. May also include dependent localities or sublocalities ( - # e.g. neighborhoods or suburbs). - # Corresponds to the JSON property `locality` - # @return [String] - attr_accessor :locality - - # Postal Code or ZIP (e.g. "94043"). - # Corresponds to the JSON property `postalCode` - # @return [String] - attr_accessor :postal_code - - # Name of the recipient. - # Corresponds to the JSON property `recipientName` - # @return [String] - attr_accessor :recipient_name - - # Top-level administrative subdivision of the country. For example, a state like - # California ("CA") or a province like Quebec ("QC"). - # Corresponds to the JSON property `region` - # @return [String] - attr_accessor :region - - # Street-level part of the address. - # Corresponds to the JSON property `streetAddress` - # @return [Array] - attr_accessor :street_address - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @country = args[:country] if args.key?(:country) - @full_address = args[:full_address] if args.key?(:full_address) - @is_post_office_box = args[:is_post_office_box] if args.key?(:is_post_office_box) - @locality = args[:locality] if args.key?(:locality) - @postal_code = args[:postal_code] if args.key?(:postal_code) - @recipient_name = args[:recipient_name] if args.key?(:recipient_name) - @region = args[:region] if args.key?(:region) - @street_address = args[:street_address] if args.key?(:street_address) - end - end - - # - class OrderCancellation - include Google::Apis::Core::Hashable - - # The actor that created the cancellation. - # Corresponds to the JSON property `actor` - # @return [String] - attr_accessor :actor - - # Date on which the cancellation has been created, in ISO 8601 format. - # Corresponds to the JSON property `creationDate` - # @return [String] - attr_accessor :creation_date - - # The quantity that was canceled. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the cancellation. Orders that are cancelled with a noInventory - # reason will lead to the removal of the product from Shopping Actions until you - # make an update to that product. This will not affect your Shopping ads. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @actor = args[:actor] if args.key?(:actor) - @creation_date = args[:creation_date] if args.key?(:creation_date) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrderCustomer - include Google::Apis::Core::Hashable - - # Deprecated. - # Corresponds to the JSON property `email` - # @return [String] - attr_accessor :email - - # Deprecated. Please use marketingRightsInfo instead. - # Corresponds to the JSON property `explicitMarketingPreference` - # @return [Boolean] - attr_accessor :explicit_marketing_preference - alias_method :explicit_marketing_preference?, :explicit_marketing_preference - - # Full name of the customer. - # Corresponds to the JSON property `fullName` - # @return [String] - attr_accessor :full_name - - # Customer's marketing preferences. - # Corresponds to the JSON property `marketingRightsInfo` - # @return [Google::Apis::ContentV2sandbox::OrderCustomerMarketingRightsInfo] - attr_accessor :marketing_rights_info - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @email = args[:email] if args.key?(:email) - @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference) - @full_name = args[:full_name] if args.key?(:full_name) - @marketing_rights_info = args[:marketing_rights_info] if args.key?(:marketing_rights_info) - end - end - - # - class OrderCustomerMarketingRightsInfo - include Google::Apis::Core::Hashable - - # Last known user selection regarding marketing preferences. In certain cases - # this selection might not be known, so this field would be empty. - # Corresponds to the JSON property `explicitMarketingPreference` - # @return [String] - attr_accessor :explicit_marketing_preference - - # Timestamp when last time marketing preference was updated. Could be empty, if - # user wasn't offered a selection yet. - # Corresponds to the JSON property `lastUpdatedTimestamp` - # @return [String] - attr_accessor :last_updated_timestamp - - # Email address that can be used for marketing purposes. This field is only - # filled when explicitMarketingPreference is equal to 'granted'. - # Corresponds to the JSON property `marketingEmailAddress` - # @return [String] - attr_accessor :marketing_email_address - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference) - @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp) - @marketing_email_address = args[:marketing_email_address] if args.key?(:marketing_email_address) - end - end - - # - class OrderDeliveryDetails - include Google::Apis::Core::Hashable - - # The delivery address - # Corresponds to the JSON property `address` - # @return [Google::Apis::ContentV2sandbox::OrderAddress] - attr_accessor :address - - # The phone number of the person receiving the delivery. - # Corresponds to the JSON property `phoneNumber` - # @return [String] - attr_accessor :phone_number - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @address = args[:address] if args.key?(:address) - @phone_number = args[:phone_number] if args.key?(:phone_number) - end - end - - # - class OrderLegacyPromotion - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `benefits` - # @return [Array] - attr_accessor :benefits - - # The date and time frame when the promotion is active and ready for validation - # review. Note that the promotion live time may be delayed for a few hours due - # to the validation review. - # Start date and end date are separated by a forward slash (/). The start date - # is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time - # of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an - # expression of the time zone for the sale. The end date is in the same format. - # Corresponds to the JSON property `effectiveDates` - # @return [String] - attr_accessor :effective_dates - - # Optional. The text code that corresponds to the promotion when applied on the - # retailer?s website. - # Corresponds to the JSON property `genericRedemptionCode` - # @return [String] - attr_accessor :generic_redemption_code - - # The unique ID of the promotion. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # The full title of the promotion. - # Corresponds to the JSON property `longTitle` - # @return [String] - attr_accessor :long_title - - # Whether the promotion is applicable to all products or only specific products. - # Corresponds to the JSON property `productApplicability` - # @return [String] - attr_accessor :product_applicability - - # Indicates that the promotion is valid online. - # Corresponds to the JSON property `redemptionChannel` - # @return [String] - attr_accessor :redemption_channel - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @benefits = args[:benefits] if args.key?(:benefits) - @effective_dates = args[:effective_dates] if args.key?(:effective_dates) - @generic_redemption_code = args[:generic_redemption_code] if args.key?(:generic_redemption_code) - @id = args[:id] if args.key?(:id) - @long_title = args[:long_title] if args.key?(:long_title) - @product_applicability = args[:product_applicability] if args.key?(:product_applicability) - @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel) - end - end - - # - class OrderLegacyPromotionBenefit - include Google::Apis::Core::Hashable - - # The discount in the order price when the promotion is applied. - # Corresponds to the JSON property `discount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :discount - - # The OfferId(s) that were purchased in this order and map to this specific - # benefit of the promotion. - # Corresponds to the JSON property `offerIds` - # @return [Array] - attr_accessor :offer_ids - - # Further describes the benefit of the promotion. Note that we will expand on - # this enumeration as we support new promotion sub-types. - # Corresponds to the JSON property `subType` - # @return [String] - attr_accessor :sub_type - - # The impact on tax when the promotion is applied. - # Corresponds to the JSON property `taxImpact` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :tax_impact - - # Describes whether the promotion applies to products (e.g. 20% off) or to - # shipping (e.g. Free Shipping). - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @discount = args[:discount] if args.key?(:discount) - @offer_ids = args[:offer_ids] if args.key?(:offer_ids) - @sub_type = args[:sub_type] if args.key?(:sub_type) - @tax_impact = args[:tax_impact] if args.key?(:tax_impact) - @type = args[:type] if args.key?(:type) - end - end - - # - class OrderLineItem - include Google::Apis::Core::Hashable - - # Annotations that are attached to the line item. - # Corresponds to the JSON property `annotations` - # @return [Array] - attr_accessor :annotations - - # Cancellations of the line item. - # Corresponds to the JSON property `cancellations` - # @return [Array] - attr_accessor :cancellations - - # The id of the line item. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Total price for the line item. For example, if two items for $10 are purchased, - # the total price will be $20. - # Corresponds to the JSON property `price` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :price - - # Product data from the time of the order placement. - # Corresponds to the JSON property `product` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemProduct] - attr_accessor :product - - # Number of items canceled. - # Corresponds to the JSON property `quantityCanceled` - # @return [Fixnum] - attr_accessor :quantity_canceled - - # Number of items delivered. - # Corresponds to the JSON property `quantityDelivered` - # @return [Fixnum] - attr_accessor :quantity_delivered - - # Number of items ordered. - # Corresponds to the JSON property `quantityOrdered` - # @return [Fixnum] - attr_accessor :quantity_ordered - - # Number of items pending. - # Corresponds to the JSON property `quantityPending` - # @return [Fixnum] - attr_accessor :quantity_pending - - # Number of items returned. - # Corresponds to the JSON property `quantityReturned` - # @return [Fixnum] - attr_accessor :quantity_returned - - # Number of items shipped. - # Corresponds to the JSON property `quantityShipped` - # @return [Fixnum] - attr_accessor :quantity_shipped - - # Details of the return policy for the line item. - # Corresponds to the JSON property `returnInfo` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo] - attr_accessor :return_info - - # Returns of the line item. - # Corresponds to the JSON property `returns` - # @return [Array] - attr_accessor :returns - - # Details of the requested shipping for the line item. - # Corresponds to the JSON property `shippingDetails` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails] - attr_accessor :shipping_details - - # Total tax amount for the line item. For example, if two items are purchased, - # and each have a cost tax of $2, the total tax amount will be $4. - # Corresponds to the JSON property `tax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :tax - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @annotations = args[:annotations] if args.key?(:annotations) - @cancellations = args[:cancellations] if args.key?(:cancellations) - @id = args[:id] if args.key?(:id) - @price = args[:price] if args.key?(:price) - @product = args[:product] if args.key?(:product) - @quantity_canceled = args[:quantity_canceled] if args.key?(:quantity_canceled) - @quantity_delivered = args[:quantity_delivered] if args.key?(:quantity_delivered) - @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered) - @quantity_pending = args[:quantity_pending] if args.key?(:quantity_pending) - @quantity_returned = args[:quantity_returned] if args.key?(:quantity_returned) - @quantity_shipped = args[:quantity_shipped] if args.key?(:quantity_shipped) - @return_info = args[:return_info] if args.key?(:return_info) - @returns = args[:returns] if args.key?(:returns) - @shipping_details = args[:shipping_details] if args.key?(:shipping_details) - @tax = args[:tax] if args.key?(:tax) - end - end - - # - class OrderLineItemProduct - include Google::Apis::Core::Hashable - - # Brand of the item. - # Corresponds to the JSON property `brand` - # @return [String] - attr_accessor :brand - - # The item's channel (online or local). - # Corresponds to the JSON property `channel` - # @return [String] - attr_accessor :channel - - # Condition or state of the item. - # Corresponds to the JSON property `condition` - # @return [String] - attr_accessor :condition - - # The two-letter ISO 639-1 language code for the item. - # Corresponds to the JSON property `contentLanguage` - # @return [String] - attr_accessor :content_language - - # Global Trade Item Number (GTIN) of the item. - # Corresponds to the JSON property `gtin` - # @return [String] - attr_accessor :gtin - - # The REST id of the product. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # URL of an image of the item. - # Corresponds to the JSON property `imageLink` - # @return [String] - attr_accessor :image_link - - # Shared identifier for all variants of the same product. - # Corresponds to the JSON property `itemGroupId` - # @return [String] - attr_accessor :item_group_id - - # Manufacturer Part Number (MPN) of the item. - # Corresponds to the JSON property `mpn` - # @return [String] - attr_accessor :mpn - - # An identifier of the item. - # Corresponds to the JSON property `offerId` - # @return [String] - attr_accessor :offer_id - - # Price of the item. - # Corresponds to the JSON property `price` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :price - - # URL to the cached image shown to the user when order was placed. - # Corresponds to the JSON property `shownImage` - # @return [String] - attr_accessor :shown_image - - # The CLDR territory code of the target country of the product. - # Corresponds to the JSON property `targetCountry` - # @return [String] - attr_accessor :target_country - - # The title of the product. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # Variant attributes for the item. These are dimensions of the product, such as - # color, gender, material, pattern, and size. You can find a comprehensive list - # of variant attributes here. - # Corresponds to the JSON property `variantAttributes` - # @return [Array] - attr_accessor :variant_attributes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @brand = args[:brand] if args.key?(:brand) - @channel = args[:channel] if args.key?(:channel) - @condition = args[:condition] if args.key?(:condition) - @content_language = args[:content_language] if args.key?(:content_language) - @gtin = args[:gtin] if args.key?(:gtin) - @id = args[:id] if args.key?(:id) - @image_link = args[:image_link] if args.key?(:image_link) - @item_group_id = args[:item_group_id] if args.key?(:item_group_id) - @mpn = args[:mpn] if args.key?(:mpn) - @offer_id = args[:offer_id] if args.key?(:offer_id) - @price = args[:price] if args.key?(:price) - @shown_image = args[:shown_image] if args.key?(:shown_image) - @target_country = args[:target_country] if args.key?(:target_country) - @title = args[:title] if args.key?(:title) - @variant_attributes = args[:variant_attributes] if args.key?(:variant_attributes) - end - end - - # - class OrderLineItemProductVariantAttribute - include Google::Apis::Core::Hashable - - # The dimension of the variant. - # Corresponds to the JSON property `dimension` - # @return [String] - attr_accessor :dimension - - # The value for the dimension. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @dimension = args[:dimension] if args.key?(:dimension) - @value = args[:value] if args.key?(:value) - end - end - - # - class OrderLineItemReturnInfo - include Google::Apis::Core::Hashable - - # How many days later the item can be returned. - # Corresponds to the JSON property `daysToReturn` - # @return [Fixnum] - attr_accessor :days_to_return - - # Whether the item is returnable. - # Corresponds to the JSON property `isReturnable` - # @return [Boolean] - attr_accessor :is_returnable - alias_method :is_returnable?, :is_returnable - - # URL of the item return policy. - # Corresponds to the JSON property `policyUrl` - # @return [String] - attr_accessor :policy_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @days_to_return = args[:days_to_return] if args.key?(:days_to_return) - @is_returnable = args[:is_returnable] if args.key?(:is_returnable) - @policy_url = args[:policy_url] if args.key?(:policy_url) - end - end - - # - class OrderLineItemShippingDetails - include Google::Apis::Core::Hashable - - # The delivery by date, in ISO 8601 format. - # Corresponds to the JSON property `deliverByDate` - # @return [String] - attr_accessor :deliver_by_date - - # Details of the shipping method. - # Corresponds to the JSON property `method` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemShippingDetailsMethod] - attr_accessor :method_prop - - # The ship by date, in ISO 8601 format. - # Corresponds to the JSON property `shipByDate` - # @return [String] - attr_accessor :ship_by_date - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date) - end - end - - # - class OrderLineItemShippingDetailsMethod - include Google::Apis::Core::Hashable - - # The carrier for the shipping. Optional. See shipments[].carrier for a list of - # acceptable values. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # Maximum transit time. - # Corresponds to the JSON property `maxDaysInTransit` - # @return [Fixnum] - attr_accessor :max_days_in_transit - - # The name of the shipping method. - # Corresponds to the JSON property `methodName` - # @return [String] - attr_accessor :method_name - - # Minimum transit time. - # Corresponds to the JSON property `minDaysInTransit` - # @return [Fixnum] - attr_accessor :min_days_in_transit - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @max_days_in_transit = args[:max_days_in_transit] if args.key?(:max_days_in_transit) - @method_name = args[:method_name] if args.key?(:method_name) - @min_days_in_transit = args[:min_days_in_transit] if args.key?(:min_days_in_transit) - end - end - - # - class OrderMerchantProvidedAnnotation - include Google::Apis::Core::Hashable - - # Key for additional merchant provided (as key-value pairs) annotation about the - # line item. - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - - # Value for additional merchant provided (as key-value pairs) annotation about - # the line item. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @key = args[:key] if args.key?(:key) - @value = args[:value] if args.key?(:value) - end - end - - # - class OrderPaymentMethod - include Google::Apis::Core::Hashable - - # The billing address. - # Corresponds to the JSON property `billingAddress` - # @return [Google::Apis::ContentV2sandbox::OrderAddress] - attr_accessor :billing_address - - # The card expiration month (January = 1, February = 2 etc.). - # Corresponds to the JSON property `expirationMonth` - # @return [Fixnum] - attr_accessor :expiration_month - - # The card expiration year (4-digit, e.g. 2015). - # Corresponds to the JSON property `expirationYear` - # @return [Fixnum] - attr_accessor :expiration_year - - # The last four digits of the card number. - # Corresponds to the JSON property `lastFourDigits` - # @return [String] - attr_accessor :last_four_digits - - # The billing phone number. - # Corresponds to the JSON property `phoneNumber` - # @return [String] - attr_accessor :phone_number - - # The type of instrument. - # Acceptable values are: - # - "AMEX" - # - "DISCOVER" - # - "JCB" - # - "MASTERCARD" - # - "UNIONPAY" - # - "VISA" - # - "" - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @billing_address = args[:billing_address] if args.key?(:billing_address) - @expiration_month = args[:expiration_month] if args.key?(:expiration_month) - @expiration_year = args[:expiration_year] if args.key?(:expiration_year) - @last_four_digits = args[:last_four_digits] if args.key?(:last_four_digits) - @phone_number = args[:phone_number] if args.key?(:phone_number) - @type = args[:type] if args.key?(:type) - end - end - - # - class OrderRefund - include Google::Apis::Core::Hashable - - # The actor that created the refund. - # Corresponds to the JSON property `actor` - # @return [String] - attr_accessor :actor - - # The amount that is refunded. - # Corresponds to the JSON property `amount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount - - # Date on which the item has been created, in ISO 8601 format. - # Corresponds to the JSON property `creationDate` - # @return [String] - attr_accessor :creation_date - - # The reason for the refund. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @actor = args[:actor] if args.key?(:actor) - @amount = args[:amount] if args.key?(:amount) - @creation_date = args[:creation_date] if args.key?(:creation_date) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrderReturn - include Google::Apis::Core::Hashable - - # The actor that created the refund. - # Corresponds to the JSON property `actor` - # @return [String] - attr_accessor :actor - - # Date on which the item has been created, in ISO 8601 format. - # Corresponds to the JSON property `creationDate` - # @return [String] - attr_accessor :creation_date - - # Quantity that is returned. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @actor = args[:actor] if args.key?(:actor) - @creation_date = args[:creation_date] if args.key?(:creation_date) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrderShipment - include Google::Apis::Core::Hashable - - # The carrier handling the shipment. - # Acceptable values are: - # - "gsx" - # - "ups" - # - "usps" - # - "fedex" - # - "dhl" - # - "ecourier" - # - "cxt" - # - "google" - # - "ontrac" - # - "emsy" - # - "ont" - # - "deliv" - # - "dynamex" - # - "lasership" - # - "mpx" - # - "uds" - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # Date on which the shipment has been created, in ISO 8601 format. - # Corresponds to the JSON property `creationDate` - # @return [String] - attr_accessor :creation_date - - # Date on which the shipment has been delivered, in ISO 8601 format. Present - # only if status is delivered - # Corresponds to the JSON property `deliveryDate` - # @return [String] - attr_accessor :delivery_date - - # The id of the shipment. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # The line items that are shipped. - # Corresponds to the JSON property `lineItems` - # @return [Array] - attr_accessor :line_items - - # The status of the shipment. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The tracking id for the shipment. - # Corresponds to the JSON property `trackingId` - # @return [String] - attr_accessor :tracking_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @creation_date = args[:creation_date] if args.key?(:creation_date) - @delivery_date = args[:delivery_date] if args.key?(:delivery_date) - @id = args[:id] if args.key?(:id) - @line_items = args[:line_items] if args.key?(:line_items) - @status = args[:status] if args.key?(:status) - @tracking_id = args[:tracking_id] if args.key?(:tracking_id) - end - end - - # - class OrderShipmentLineItemShipment - include Google::Apis::Core::Hashable - - # The id of the line item that is shipped. Either lineItemId or productId is - # required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to ship. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity that is shipped. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - end - end - - # - class OrderinvoicesCreateChargeInvoiceRequest - include Google::Apis::Core::Hashable - - # [required] The ID of the invoice. - # Corresponds to the JSON property `invoiceId` - # @return [String] - attr_accessor :invoice_id - - # [required] Invoice summary. - # Corresponds to the JSON property `invoiceSummary` - # @return [Google::Apis::ContentV2sandbox::InvoiceSummary] - attr_accessor :invoice_summary - - # [required] Invoice details per line item. - # Corresponds to the JSON property `lineItemInvoices` - # @return [Array] - attr_accessor :line_item_invoices - - # [required] The ID of the operation, unique across all operations for a given - # order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # [required] ID of the shipment group. - # Corresponds to the JSON property `shipmentGroupId` - # @return [String] - attr_accessor :shipment_group_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @invoice_id = args[:invoice_id] if args.key?(:invoice_id) - @invoice_summary = args[:invoice_summary] if args.key?(:invoice_summary) - @line_item_invoices = args[:line_item_invoices] if args.key?(:line_item_invoices) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id) - end - end - - # - class OrderinvoicesCreateChargeInvoiceResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderinvoicesCreateChargeInvoiceResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrderinvoicesCreateRefundInvoiceRequest - include Google::Apis::Core::Hashable - - # [required] The ID of the invoice. - # Corresponds to the JSON property `invoiceId` - # @return [String] - attr_accessor :invoice_id - - # [required] The ID of the operation, unique across all operations for a given - # order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # Option to create a refund-only invoice. Exactly one of refundOnlyOption or - # returnOption must be provided. - # Corresponds to the JSON property `refundOnlyOption` - # @return [Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption] - attr_accessor :refund_only_option - - # Option to create an invoice for a refund and mark all items within the invoice - # as returned. Exactly one of refundOnlyOption or returnOption must be provided. - # Corresponds to the JSON property `returnOption` - # @return [Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption] - attr_accessor :return_option - - # Invoice details for different shipment groups. - # Corresponds to the JSON property `shipmentInvoices` - # @return [Array] - attr_accessor :shipment_invoices - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @invoice_id = args[:invoice_id] if args.key?(:invoice_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @refund_only_option = args[:refund_only_option] if args.key?(:refund_only_option) - @return_option = args[:return_option] if args.key?(:return_option) - @shipment_invoices = args[:shipment_invoices] if args.key?(:shipment_invoices) - end - end - - # - class OrderinvoicesCreateRefundInvoiceResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderinvoicesCreateRefundInvoiceResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption - include Google::Apis::Core::Hashable - - # Optional description of the refund reason. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # [required] Reason for the refund. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @reason = args[:reason] if args.key?(:reason) - end - end - - # - class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption - include Google::Apis::Core::Hashable - - # Optional description of the return reason. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # [required] Reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @reason = args[:reason] if args.key?(:reason) - end - end - - # - class OrderpaymentsNotifyAuthApprovedRequest - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `authAmountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :auth_amount_pretax - - # - # Corresponds to the JSON property `authAmountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :auth_amount_tax - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auth_amount_pretax = args[:auth_amount_pretax] if args.key?(:auth_amount_pretax) - @auth_amount_tax = args[:auth_amount_tax] if args.key?(:auth_amount_tax) - end - end - - # - class OrderpaymentsNotifyAuthApprovedResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderpaymentsNotifyAuthApprovedResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrderpaymentsNotifyAuthDeclinedRequest - include Google::Apis::Core::Hashable - - # Reason why payment authorization was declined. - # Corresponds to the JSON property `declineReason` - # @return [String] - attr_accessor :decline_reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @decline_reason = args[:decline_reason] if args.key?(:decline_reason) - end - end - - # - class OrderpaymentsNotifyAuthDeclinedResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderpaymentsNotifyAuthDeclinedResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrderpaymentsNotifyChargeRequest - include Google::Apis::Core::Hashable - - # Whether charge was successful. - # Corresponds to the JSON property `chargeState` - # @return [String] - attr_accessor :charge_state - - # Deprecated. Please use invoiceIds instead. - # Corresponds to the JSON property `invoiceId` - # @return [String] - attr_accessor :invoice_id - - # Invoice IDs from the orderinvoices service that correspond to the charge. - # Corresponds to the JSON property `invoiceIds` - # @return [Array] - attr_accessor :invoice_ids - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @charge_state = args[:charge_state] if args.key?(:charge_state) - @invoice_id = args[:invoice_id] if args.key?(:invoice_id) - @invoice_ids = args[:invoice_ids] if args.key?(:invoice_ids) - end - end - - # - class OrderpaymentsNotifyChargeResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderpaymentsNotifyChargeResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrderpaymentsNotifyRefundRequest - include Google::Apis::Core::Hashable - - # Deprecated. Please use invoiceIds instead. - # Corresponds to the JSON property `invoiceId` - # @return [String] - attr_accessor :invoice_id - - # Invoice IDs from the orderinvoices service that correspond to the refund. - # Corresponds to the JSON property `invoiceIds` - # @return [Array] - attr_accessor :invoice_ids - - # Whether refund was successful. - # Corresponds to the JSON property `refundState` - # @return [String] - attr_accessor :refund_state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @invoice_id = args[:invoice_id] if args.key?(:invoice_id) - @invoice_ids = args[:invoice_ids] if args.key?(:invoice_ids) - @refund_state = args[:refund_state] if args.key?(:refund_state) - end - end - - # - class OrderpaymentsNotifyRefundResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderpaymentsNotifyRefundResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrderreturnsListResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # orderreturnsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The token for the retrieval of the next page of returns. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # - # Corresponds to the JSON property `resources` - # @return [Array] - attr_accessor :resources - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @resources = args[:resources] if args.key?(:resources) - end - end - - # - class OrdersAcknowledgeRequest - include Google::Apis::Core::Hashable - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @operation_id = args[:operation_id] if args.key?(:operation_id) - end - end - - # - class OrdersAcknowledgeResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersAcknowledgeResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersAdvanceTestOrderResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersAdvanceTestOrderResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersCancelLineItemRequest - include Google::Apis::Core::Hashable - - # Deprecated. Please use amountPretax and amountTax instead. - # Corresponds to the JSON property `amount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount - - # Amount to refund for the cancelation. Optional. If not set, Google will - # calculate the default based on the price and tax of the items involved. The - # amount must not be larger than the net amount left on the order. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to cancellation amount in amountPretax. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the line item to cancel. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to cancel. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to cancel. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the cancellation. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount = args[:amount] if args.key?(:amount) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCancelLineItemResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCancelLineItemResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersCancelRequest - include Google::Apis::Core::Hashable - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The reason for the cancellation. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCancelResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCancelResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersCancelTestOrderByCustomerRequest - include Google::Apis::Core::Hashable - - # The reason for the cancellation. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @reason = args[:reason] if args.key?(:reason) - end - end - - # - class OrdersCancelTestOrderByCustomerResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCancelTestOrderByCustomerResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersCreateTestOrderRequest - include Google::Apis::Core::Hashable - - # The CLDR territory code of the country of the test order to create. Affects - # the currency and addresses of orders created via template_name, or the - # addresses of orders created via test_order. - # Acceptable values are: - # - "US" - # - "FR" Defaults to US. - # Corresponds to the JSON property `country` - # @return [String] - attr_accessor :country - - # The test order template to use. Specify as an alternative to testOrder as a - # shortcut for retrieving a template and then creating an order using that - # template. - # Corresponds to the JSON property `templateName` - # @return [String] - attr_accessor :template_name - - # The test order to create. - # Corresponds to the JSON property `testOrder` - # @return [Google::Apis::ContentV2sandbox::TestOrder] - attr_accessor :test_order - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @country = args[:country] if args.key?(:country) - @template_name = args[:template_name] if args.key?(:template_name) - @test_order = args[:test_order] if args.key?(:test_order) - end - end - - # - class OrdersCreateTestOrderResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCreateTestOrderResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The ID of the newly created test order. - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @order_id = args[:order_id] if args.key?(:order_id) - end - end - - # - class OrdersCreateTestReturnRequest - include Google::Apis::Core::Hashable - - # Returned items. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - end - end - - # - class OrdersCreateTestReturnResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCreateTestReturnResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The ID of the newly created test order return. - # Corresponds to the JSON property `returnId` - # @return [String] - attr_accessor :return_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @return_id = args[:return_id] if args.key?(:return_id) - end - end - - # - class OrdersCustomBatchRequest - include Google::Apis::Core::Hashable - - # The request entries to be processed in the batch. - # Corresponds to the JSON property `entries` - # @return [Array] - attr_accessor :entries - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @entries = args[:entries] if args.key?(:entries) - end - end - - # - class OrdersCustomBatchRequestEntry - include Google::Apis::Core::Hashable - - # An entry ID, unique within the batch request. - # Corresponds to the JSON property `batchId` - # @return [Fixnum] - attr_accessor :batch_id - - # Required for cancel method. - # Corresponds to the JSON property `cancel` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancel] - attr_accessor :cancel - - # Required for cancelLineItem method. - # Corresponds to the JSON property `cancelLineItem` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancelLineItem] - attr_accessor :cancel_line_item - - # Required for inStoreReturnLineItem method. - # Corresponds to the JSON property `inStoreRefundLineItem` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryInStoreRefundLineItem] - attr_accessor :in_store_refund_line_item - - # The ID of the managing account. - # Corresponds to the JSON property `merchantId` - # @return [Fixnum] - attr_accessor :merchant_id - - # The merchant order id. Required for updateMerchantOrderId and - # getByMerchantOrderId methods. - # Corresponds to the JSON property `merchantOrderId` - # @return [String] - attr_accessor :merchant_order_id - - # The method to apply. - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # The ID of the operation. Unique across all operations for a given order. - # Required for all methods beside get and getByMerchantOrderId. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the order. Required for all methods beside getByMerchantOrderId. - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - # Required for refund method. - # Corresponds to the JSON property `refund` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRefund] - attr_accessor :refund - - # Required for rejectReturnLineItem method. - # Corresponds to the JSON property `rejectReturnLineItem` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRejectReturnLineItem] - attr_accessor :reject_return_line_item - - # Required for returnLineItem method. - # Corresponds to the JSON property `returnLineItem` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnLineItem] - attr_accessor :return_line_item - - # Required for returnRefundLineItem method. - # Corresponds to the JSON property `returnRefundLineItem` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnRefundLineItem] - attr_accessor :return_refund_line_item - - # Required for setLineItemMetadata method. - # Corresponds to the JSON property `setLineItemMetadata` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntrySetLineItemMetadata] - attr_accessor :set_line_item_metadata - - # Required for shipLineItems method. - # Corresponds to the JSON property `shipLineItems` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItems] - attr_accessor :ship_line_items - - # Required for updateLineItemShippingDate method. - # Corresponds to the JSON property `updateLineItemShippingDetails` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails] - attr_accessor :update_line_item_shipping_details - - # Required for updateShipment method. - # Corresponds to the JSON property `updateShipment` - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateShipment] - attr_accessor :update_shipment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @batch_id = args[:batch_id] if args.key?(:batch_id) - @cancel = args[:cancel] if args.key?(:cancel) - @cancel_line_item = args[:cancel_line_item] if args.key?(:cancel_line_item) - @in_store_refund_line_item = args[:in_store_refund_line_item] if args.key?(:in_store_refund_line_item) - @merchant_id = args[:merchant_id] if args.key?(:merchant_id) - @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @order_id = args[:order_id] if args.key?(:order_id) - @refund = args[:refund] if args.key?(:refund) - @reject_return_line_item = args[:reject_return_line_item] if args.key?(:reject_return_line_item) - @return_line_item = args[:return_line_item] if args.key?(:return_line_item) - @return_refund_line_item = args[:return_refund_line_item] if args.key?(:return_refund_line_item) - @set_line_item_metadata = args[:set_line_item_metadata] if args.key?(:set_line_item_metadata) - @ship_line_items = args[:ship_line_items] if args.key?(:ship_line_items) - @update_line_item_shipping_details = args[:update_line_item_shipping_details] if args.key?(:update_line_item_shipping_details) - @update_shipment = args[:update_shipment] if args.key?(:update_shipment) - end - end - - # - class OrdersCustomBatchRequestEntryCancel - include Google::Apis::Core::Hashable - - # The reason for the cancellation. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntryCancelLineItem - include Google::Apis::Core::Hashable - - # Deprecated. Please use amountPretax and amountTax instead. - # Corresponds to the JSON property `amount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount - - # Amount to refund for the cancelation. Optional. If not set, Google will - # calculate the default based on the price and tax of the items involved. The - # amount must not be larger than the net amount left on the order. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to cancellation amount in amountPretax. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the line item to cancel. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to cancel. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to cancel. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the cancellation. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount = args[:amount] if args.key?(:amount) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntryCreateTestReturnReturnItem - include Google::Apis::Core::Hashable - - # The ID of the line item to return. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # Quantity that is returned. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @quantity = args[:quantity] if args.key?(:quantity) - end - end - - # - class OrdersCustomBatchRequestEntryInStoreRefundLineItem - include Google::Apis::Core::Hashable - - # The amount that is refunded. Required. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to refund amount in amountPretax. Required. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return and refund. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntryRefund - include Google::Apis::Core::Hashable - - # Deprecated. Please use amountPretax and amountTax instead. - # Corresponds to the JSON property `amount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount - - # The amount that is refunded. Either amount or amountPretax and amountTax - # should be filled. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to refund amount in amountPretax. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The reason for the refund. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount = args[:amount] if args.key?(:amount) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntryRejectReturnLineItem - include Google::Apis::Core::Hashable - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return and refund. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntryReturnLineItem - include Google::Apis::Core::Hashable - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntryReturnRefundLineItem - include Google::Apis::Core::Hashable - - # The amount that is refunded. If omitted, refundless return is assumed (same as - # calling returnLineItem method). Optional, but if filled then both amountPretax - # and amountTax must be set. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to refund amount in amountPretax. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return and refund. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersCustomBatchRequestEntrySetLineItemMetadata - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `annotations` - # @return [Array] - attr_accessor :annotations - - # The ID of the line item to set metadata. Either lineItemId or productId is - # required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to set metadata. This is the REST ID used in the - # products service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @annotations = args[:annotations] if args.key?(:annotations) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - end - end - - # - class OrdersCustomBatchRequestEntryShipLineItems - include Google::Apis::Core::Hashable - - # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. - # See shipments[].carrier in the Orders resource representation for a list of - # acceptable values. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # Line items to ship. - # Corresponds to the JSON property `lineItems` - # @return [Array] - attr_accessor :line_items - - # ID of the shipment group. Required for orders that use the orderinvoices - # service. - # Corresponds to the JSON property `shipmentGroupId` - # @return [String] - attr_accessor :shipment_group_id - - # Deprecated. Please use shipmentInfo instead. The ID of the shipment. - # Corresponds to the JSON property `shipmentId` - # @return [String] - attr_accessor :shipment_id - - # Shipment information. This field is repeated because a single line item can be - # shipped in several packages (and have several tracking IDs). - # Corresponds to the JSON property `shipmentInfos` - # @return [Array] - attr_accessor :shipment_infos - - # Deprecated. Please use shipmentInfo instead. The tracking id for the shipment. - # Corresponds to the JSON property `trackingId` - # @return [String] - attr_accessor :tracking_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @line_items = args[:line_items] if args.key?(:line_items) - @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id) - @shipment_id = args[:shipment_id] if args.key?(:shipment_id) - @shipment_infos = args[:shipment_infos] if args.key?(:shipment_infos) - @tracking_id = args[:tracking_id] if args.key?(:tracking_id) - end - end - - # - class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo - include Google::Apis::Core::Hashable - - # The carrier handling the shipment. See shipments[].carrier in the Orders - # resource representation for a list of acceptable values. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # The ID of the shipment. - # Corresponds to the JSON property `shipmentId` - # @return [String] - attr_accessor :shipment_id - - # The tracking id for the shipment. - # Corresponds to the JSON property `trackingId` - # @return [String] - attr_accessor :tracking_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @shipment_id = args[:shipment_id] if args.key?(:shipment_id) - @tracking_id = args[:tracking_id] if args.key?(:tracking_id) - end - end - - # - class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails - include Google::Apis::Core::Hashable - - # Updated delivery by date, in ISO 8601 format. If not specified only ship by - # date is updated. - # Corresponds to the JSON property `deliverByDate` - # @return [String] - attr_accessor :deliver_by_date - - # The ID of the line item to set metadata. Either lineItemId or productId is - # required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the product to set metadata. This is the REST ID used in the - # products service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # Updated ship by date, in ISO 8601 format. If not specified only deliver by - # date is updated. - # Corresponds to the JSON property `shipByDate` - # @return [String] - attr_accessor :ship_by_date - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date) - end - end - - # - class OrdersCustomBatchRequestEntryUpdateShipment - include Google::Apis::Core::Hashable - - # The carrier handling the shipment. Not updated if missing. See shipments[]. - # carrier in the Orders resource representation for a list of acceptable values. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # Date on which the shipment has been delivered, in ISO 8601 format. Optional - # and can be provided only if status is delivered. - # Corresponds to the JSON property `deliveryDate` - # @return [String] - attr_accessor :delivery_date - - # The ID of the shipment. - # Corresponds to the JSON property `shipmentId` - # @return [String] - attr_accessor :shipment_id - - # New status for the shipment. Not updated if missing. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The tracking id for the shipment. Not updated if missing. - # Corresponds to the JSON property `trackingId` - # @return [String] - attr_accessor :tracking_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @delivery_date = args[:delivery_date] if args.key?(:delivery_date) - @shipment_id = args[:shipment_id] if args.key?(:shipment_id) - @status = args[:status] if args.key?(:status) - @tracking_id = args[:tracking_id] if args.key?(:tracking_id) - end - end - - # - class OrdersCustomBatchResponse - include Google::Apis::Core::Hashable - - # The result of the execution of the batch requests. - # Corresponds to the JSON property `entries` - # @return [Array] - attr_accessor :entries - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCustomBatchResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @entries = args[:entries] if args.key?(:entries) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersCustomBatchResponseEntry - include Google::Apis::Core::Hashable - - # The ID of the request entry this entry responds to. - # Corresponds to the JSON property `batchId` - # @return [Fixnum] - attr_accessor :batch_id - - # A list of errors returned by a failed batch entry. - # Corresponds to the JSON property `errors` - # @return [Google::Apis::ContentV2sandbox::Errors] - attr_accessor :errors - - # The status of the execution. Only defined if - # - the request was successful; and - # - the method is not get, getByMerchantOrderId, or one of the test methods. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersCustomBatchResponseEntry". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The retrieved order. Only defined if the method is get and if the request was - # successful. - # Corresponds to the JSON property `order` - # @return [Google::Apis::ContentV2sandbox::Order] - attr_accessor :order - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @batch_id = args[:batch_id] if args.key?(:batch_id) - @errors = args[:errors] if args.key?(:errors) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - @order = args[:order] if args.key?(:order) - end - end - - # - class OrdersGetByMerchantOrderIdResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersGetByMerchantOrderIdResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The requested order. - # Corresponds to the JSON property `order` - # @return [Google::Apis::ContentV2sandbox::Order] - attr_accessor :order - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @order = args[:order] if args.key?(:order) - end - end - - # - class OrdersGetTestOrderTemplateResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersGetTestOrderTemplateResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The requested test order template. - # Corresponds to the JSON property `template` - # @return [Google::Apis::ContentV2sandbox::TestOrder] - attr_accessor :template - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @template = args[:template] if args.key?(:template) - end - end - - # - class OrdersInStoreRefundLineItemRequest - include Google::Apis::Core::Hashable - - # The amount that is refunded. Required. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to refund amount in amountPretax. Required. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return and refund. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersInStoreRefundLineItemResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersInStoreRefundLineItemResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersListResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The token for the retrieval of the next page of orders. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # - # Corresponds to the JSON property `resources` - # @return [Array] - attr_accessor :resources - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @resources = args[:resources] if args.key?(:resources) - end - end - - # - class OrdersRefundRequest - include Google::Apis::Core::Hashable - - # Deprecated. Please use amountPretax and amountTax instead. - # Corresponds to the JSON property `amount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount - - # The amount that is refunded. Either amount or amountPretax and amountTax - # should be filled. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to refund amount in amountPretax. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The reason for the refund. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount = args[:amount] if args.key?(:amount) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersRefundResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersRefundResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersRejectReturnLineItemRequest - include Google::Apis::Core::Hashable - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return and refund. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersRejectReturnLineItemResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersRejectReturnLineItemResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersReturnLineItemRequest - include Google::Apis::Core::Hashable - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersReturnLineItemResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersReturnLineItemResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersReturnRefundLineItemRequest - include Google::Apis::Core::Hashable - - # The amount that is refunded. If omitted, refundless return is assumed (same as - # calling returnLineItem method). Optional, but if filled then both amountPretax - # and amountTax must be set. - # Corresponds to the JSON property `amountPretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_pretax - - # Tax amount that correspond to refund amount in amountPretax. - # Corresponds to the JSON property `amountTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :amount_tax - - # The ID of the line item to return. Either lineItemId or productId is required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to return. This is the REST ID used in the products - # service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # The quantity to return and refund. - # Corresponds to the JSON property `quantity` - # @return [Fixnum] - attr_accessor :quantity - - # The reason for the return. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # The explanation of the reason. - # Corresponds to the JSON property `reasonText` - # @return [String] - attr_accessor :reason_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) - @amount_tax = args[:amount_tax] if args.key?(:amount_tax) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - @quantity = args[:quantity] if args.key?(:quantity) - @reason = args[:reason] if args.key?(:reason) - @reason_text = args[:reason_text] if args.key?(:reason_text) - end - end - - # - class OrdersReturnRefundLineItemResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersReturnRefundLineItemResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersSetLineItemMetadataRequest - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `annotations` - # @return [Array] - attr_accessor :annotations - - # The ID of the line item to set metadata. Either lineItemId or productId is - # required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to set metadata. This is the REST ID used in the - # products service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @annotations = args[:annotations] if args.key?(:annotations) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - end - end - - # - class OrdersSetLineItemMetadataResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersSetLineItemMetadataResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersShipLineItemsRequest - include Google::Apis::Core::Hashable - - # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. - # See shipments[].carrier in the Orders resource representation for a list of - # acceptable values. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # Line items to ship. - # Corresponds to the JSON property `lineItems` - # @return [Array] - attr_accessor :line_items - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # ID of the shipment group. Required for orders that use the orderinvoices - # service. - # Corresponds to the JSON property `shipmentGroupId` - # @return [String] - attr_accessor :shipment_group_id - - # Deprecated. Please use shipmentInfo instead. The ID of the shipment. - # Corresponds to the JSON property `shipmentId` - # @return [String] - attr_accessor :shipment_id - - # Shipment information. This field is repeated because a single line item can be - # shipped in several packages (and have several tracking IDs). - # Corresponds to the JSON property `shipmentInfos` - # @return [Array] - attr_accessor :shipment_infos - - # Deprecated. Please use shipmentInfo instead. The tracking id for the shipment. - # Corresponds to the JSON property `trackingId` - # @return [String] - attr_accessor :tracking_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @line_items = args[:line_items] if args.key?(:line_items) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id) - @shipment_id = args[:shipment_id] if args.key?(:shipment_id) - @shipment_infos = args[:shipment_infos] if args.key?(:shipment_infos) - @tracking_id = args[:tracking_id] if args.key?(:tracking_id) - end - end - - # - class OrdersShipLineItemsResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersShipLineItemsResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersUpdateLineItemShippingDetailsRequest - include Google::Apis::Core::Hashable - - # Updated delivery by date, in ISO 8601 format. If not specified only ship by - # date is updated. - # Corresponds to the JSON property `deliverByDate` - # @return [String] - attr_accessor :deliver_by_date - - # The ID of the line item to set metadata. Either lineItemId or productId is - # required. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the product to set metadata. This is the REST ID used in the - # products service. Either lineItemId or productId is required. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # Updated ship by date, in ISO 8601 format. If not specified only deliver by - # date is updated. - # Corresponds to the JSON property `shipByDate` - # @return [String] - attr_accessor :ship_by_date - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @product_id = args[:product_id] if args.key?(:product_id) - @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date) - end - end - - # - class OrdersUpdateLineItemShippingDetailsResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersUpdateLineItemShippingDetailsResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersUpdateMerchantOrderIdRequest - include Google::Apis::Core::Hashable - - # The merchant order id to be assigned to the order. Must be unique per merchant. - # Corresponds to the JSON property `merchantOrderId` - # @return [String] - attr_accessor :merchant_order_id - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) - @operation_id = args[:operation_id] if args.key?(:operation_id) - end - end - - # - class OrdersUpdateMerchantOrderIdResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersUpdateMerchantOrderIdResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class OrdersUpdateShipmentRequest - include Google::Apis::Core::Hashable - - # The carrier handling the shipment. Not updated if missing. See shipments[]. - # carrier in the Orders resource representation for a list of acceptable values. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # Date on which the shipment has been delivered, in ISO 8601 format. Optional - # and can be provided only if status is delivered. - # Corresponds to the JSON property `deliveryDate` - # @return [String] - attr_accessor :delivery_date - - # The ID of the operation. Unique across all operations for a given order. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # The ID of the shipment. - # Corresponds to the JSON property `shipmentId` - # @return [String] - attr_accessor :shipment_id - - # New status for the shipment. Not updated if missing. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The tracking id for the shipment. Not updated if missing. - # Corresponds to the JSON property `trackingId` - # @return [String] - attr_accessor :tracking_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @delivery_date = args[:delivery_date] if args.key?(:delivery_date) - @operation_id = args[:operation_id] if args.key?(:operation_id) - @shipment_id = args[:shipment_id] if args.key?(:shipment_id) - @status = args[:status] if args.key?(:status) - @tracking_id = args[:tracking_id] if args.key?(:tracking_id) - end - end - - # - class OrdersUpdateShipmentResponse - include Google::Apis::Core::Hashable - - # The status of the execution. - # Corresponds to the JSON property `executionStatus` - # @return [String] - attr_accessor :execution_status - - # Identifies what kind of resource this is. Value: the fixed string "content# - # ordersUpdateShipmentResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @execution_status = args[:execution_status] if args.key?(:execution_status) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class Price - include Google::Apis::Core::Hashable - - # The currency of the price. - # Corresponds to the JSON property `currency` - # @return [String] - attr_accessor :currency - - # The price represented as a number. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @currency = args[:currency] if args.key?(:currency) - @value = args[:value] if args.key?(:value) - end - end - - # - class Promotion - include Google::Apis::Core::Hashable - - # [required] Amount of the promotion. The values here are the promotion applied - # to the unit price pretax and to the total of the tax amounts. - # Corresponds to the JSON property `promotionAmount` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :promotion_amount - - # [required] ID of the promotion. - # Corresponds to the JSON property `promotionId` - # @return [String] - attr_accessor :promotion_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @promotion_amount = args[:promotion_amount] if args.key?(:promotion_amount) - @promotion_id = args[:promotion_id] if args.key?(:promotion_id) - end - end - - # - class RefundReason - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # - # Corresponds to the JSON property `reasonCode` - # @return [String] - attr_accessor :reason_code - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @reason_code = args[:reason_code] if args.key?(:reason_code) - end - end - - # - class ReturnShipment - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `creationDate` - # @return [String] - attr_accessor :creation_date - - # - # Corresponds to the JSON property `returnMethodType` - # @return [String] - attr_accessor :return_method_type - - # - # Corresponds to the JSON property `shipmentId` - # @return [String] - attr_accessor :shipment_id - - # - # Corresponds to the JSON property `shipmentTrackingInfos` - # @return [Array] - attr_accessor :shipment_tracking_infos - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @creation_date = args[:creation_date] if args.key?(:creation_date) - @return_method_type = args[:return_method_type] if args.key?(:return_method_type) - @shipment_id = args[:shipment_id] if args.key?(:shipment_id) - @shipment_tracking_infos = args[:shipment_tracking_infos] if args.key?(:shipment_tracking_infos) - end - end - - # - class ShipmentInvoice - include Google::Apis::Core::Hashable - - # [required] Invoice summary. - # Corresponds to the JSON property `invoiceSummary` - # @return [Google::Apis::ContentV2sandbox::InvoiceSummary] - attr_accessor :invoice_summary - - # [required] Invoice details per line item. - # Corresponds to the JSON property `lineItemInvoices` - # @return [Array] - attr_accessor :line_item_invoices - - # [required] ID of the shipment group. - # Corresponds to the JSON property `shipmentGroupId` - # @return [String] - attr_accessor :shipment_group_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @invoice_summary = args[:invoice_summary] if args.key?(:invoice_summary) - @line_item_invoices = args[:line_item_invoices] if args.key?(:line_item_invoices) - @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id) - end - end - - # - class ShipmentInvoiceLineItemInvoice - include Google::Apis::Core::Hashable - - # ID of the line item. Either lineItemId or productId must be set. - # Corresponds to the JSON property `lineItemId` - # @return [String] - attr_accessor :line_item_id - - # ID of the product. This is the REST ID used in the products service. Either - # lineItemId or productId must be set. - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # [required] Unit IDs to define specific units within the line item. - # Corresponds to the JSON property `shipmentUnitIds` - # @return [Array] - attr_accessor :shipment_unit_ids - - # [required] Invoice details for a single unit. - # Corresponds to the JSON property `unitInvoice` - # @return [Google::Apis::ContentV2sandbox::UnitInvoice] - attr_accessor :unit_invoice - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line_item_id = args[:line_item_id] if args.key?(:line_item_id) - @product_id = args[:product_id] if args.key?(:product_id) - @shipment_unit_ids = args[:shipment_unit_ids] if args.key?(:shipment_unit_ids) - @unit_invoice = args[:unit_invoice] if args.key?(:unit_invoice) - end - end - - # - class ShipmentTrackingInfo - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # - # Corresponds to the JSON property `trackingNumber` - # @return [String] - attr_accessor :tracking_number - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @tracking_number = args[:tracking_number] if args.key?(:tracking_number) - end - end - - # - class TestOrder - include Google::Apis::Core::Hashable - - # The details of the customer who placed the order. - # Corresponds to the JSON property `customer` - # @return [Google::Apis::ContentV2sandbox::TestOrderCustomer] - attr_accessor :customer - - # Whether the orderinvoices service should support this order. - # Corresponds to the JSON property `enableOrderinvoices` - # @return [Boolean] - attr_accessor :enable_orderinvoices - alias_method :enable_orderinvoices?, :enable_orderinvoices - - # Identifies what kind of resource this is. Value: the fixed string "content# - # testOrder". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Line items that are ordered. At least one line item must be provided. - # Corresponds to the JSON property `lineItems` - # @return [Array] - attr_accessor :line_items - - # Determines if test order must be pulled by merchant or pushed to merchant via - # push integration. - # Corresponds to the JSON property `notificationMode` - # @return [String] - attr_accessor :notification_mode - - # The details of the payment method. - # Corresponds to the JSON property `paymentMethod` - # @return [Google::Apis::ContentV2sandbox::TestOrderPaymentMethod] - attr_accessor :payment_method - - # Identifier of one of the predefined delivery addresses for the delivery. - # Corresponds to the JSON property `predefinedDeliveryAddress` - # @return [String] - attr_accessor :predefined_delivery_address - - # Deprecated. The details of the merchant provided promotions applied to the - # order. More details about the program are here. - # Corresponds to the JSON property `promotions` - # @return [Array] - attr_accessor :promotions - - # The total cost of shipping for all items. - # Corresponds to the JSON property `shippingCost` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :shipping_cost - - # The tax for the total shipping cost. - # Corresponds to the JSON property `shippingCostTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :shipping_cost_tax - - # The requested shipping option. - # Corresponds to the JSON property `shippingOption` - # @return [String] - attr_accessor :shipping_option - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @customer = args[:customer] if args.key?(:customer) - @enable_orderinvoices = args[:enable_orderinvoices] if args.key?(:enable_orderinvoices) - @kind = args[:kind] if args.key?(:kind) - @line_items = args[:line_items] if args.key?(:line_items) - @notification_mode = args[:notification_mode] if args.key?(:notification_mode) - @payment_method = args[:payment_method] if args.key?(:payment_method) - @predefined_delivery_address = args[:predefined_delivery_address] if args.key?(:predefined_delivery_address) - @promotions = args[:promotions] if args.key?(:promotions) - @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost) - @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax) - @shipping_option = args[:shipping_option] if args.key?(:shipping_option) - end - end - - # - class TestOrderCustomer - include Google::Apis::Core::Hashable - - # Deprecated. - # Corresponds to the JSON property `email` - # @return [String] - attr_accessor :email - - # Deprecated. Please use marketingRightsInfo instead. - # Corresponds to the JSON property `explicitMarketingPreference` - # @return [Boolean] - attr_accessor :explicit_marketing_preference - alias_method :explicit_marketing_preference?, :explicit_marketing_preference - - # Full name of the customer. - # Corresponds to the JSON property `fullName` - # @return [String] - attr_accessor :full_name - - # Customer's marketing preferences. - # Corresponds to the JSON property `marketingRightsInfo` - # @return [Google::Apis::ContentV2sandbox::TestOrderCustomerMarketingRightsInfo] - attr_accessor :marketing_rights_info - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @email = args[:email] if args.key?(:email) - @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference) - @full_name = args[:full_name] if args.key?(:full_name) - @marketing_rights_info = args[:marketing_rights_info] if args.key?(:marketing_rights_info) - end - end - - # - class TestOrderCustomerMarketingRightsInfo - include Google::Apis::Core::Hashable - - # Last know user use selection regards marketing preferences. In certain cases - # selection might not be known, so this field would be empty. - # Corresponds to the JSON property `explicitMarketingPreference` - # @return [String] - attr_accessor :explicit_marketing_preference - - # Timestamp when last time marketing preference was updated. Could be empty, if - # user wasn't offered a selection yet. - # Corresponds to the JSON property `lastUpdatedTimestamp` - # @return [String] - attr_accessor :last_updated_timestamp - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference) - @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp) - end - end - - # - class TestOrderLineItem - include Google::Apis::Core::Hashable - - # Product data from the time of the order placement. - # Corresponds to the JSON property `product` - # @return [Google::Apis::ContentV2sandbox::TestOrderLineItemProduct] - attr_accessor :product - - # Number of items ordered. - # Corresponds to the JSON property `quantityOrdered` - # @return [Fixnum] - attr_accessor :quantity_ordered - - # Details of the return policy for the line item. - # Corresponds to the JSON property `returnInfo` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo] - attr_accessor :return_info - - # Details of the requested shipping for the line item. - # Corresponds to the JSON property `shippingDetails` - # @return [Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails] - attr_accessor :shipping_details - - # Unit tax for the line item. - # Corresponds to the JSON property `unitTax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :unit_tax - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @product = args[:product] if args.key?(:product) - @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered) - @return_info = args[:return_info] if args.key?(:return_info) - @shipping_details = args[:shipping_details] if args.key?(:shipping_details) - @unit_tax = args[:unit_tax] if args.key?(:unit_tax) - end - end - - # - class TestOrderLineItemProduct - include Google::Apis::Core::Hashable - - # Brand of the item. - # Corresponds to the JSON property `brand` - # @return [String] - attr_accessor :brand - - # The item's channel. - # Corresponds to the JSON property `channel` - # @return [String] - attr_accessor :channel - - # Condition or state of the item. - # Corresponds to the JSON property `condition` - # @return [String] - attr_accessor :condition - - # The two-letter ISO 639-1 language code for the item. - # Corresponds to the JSON property `contentLanguage` - # @return [String] - attr_accessor :content_language - - # Global Trade Item Number (GTIN) of the item. Optional. - # Corresponds to the JSON property `gtin` - # @return [String] - attr_accessor :gtin - - # URL of an image of the item. - # Corresponds to the JSON property `imageLink` - # @return [String] - attr_accessor :image_link - - # Shared identifier for all variants of the same product. Optional. - # Corresponds to the JSON property `itemGroupId` - # @return [String] - attr_accessor :item_group_id - - # Manufacturer Part Number (MPN) of the item. Optional. - # Corresponds to the JSON property `mpn` - # @return [String] - attr_accessor :mpn - - # An identifier of the item. - # Corresponds to the JSON property `offerId` - # @return [String] - attr_accessor :offer_id - - # The price for the product. - # Corresponds to the JSON property `price` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :price - - # The CLDR territory code of the target country of the product. - # Corresponds to the JSON property `targetCountry` - # @return [String] - attr_accessor :target_country - - # The title of the product. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # Variant attributes for the item. Optional. - # Corresponds to the JSON property `variantAttributes` - # @return [Array] - attr_accessor :variant_attributes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @brand = args[:brand] if args.key?(:brand) - @channel = args[:channel] if args.key?(:channel) - @condition = args[:condition] if args.key?(:condition) - @content_language = args[:content_language] if args.key?(:content_language) - @gtin = args[:gtin] if args.key?(:gtin) - @image_link = args[:image_link] if args.key?(:image_link) - @item_group_id = args[:item_group_id] if args.key?(:item_group_id) - @mpn = args[:mpn] if args.key?(:mpn) - @offer_id = args[:offer_id] if args.key?(:offer_id) - @price = args[:price] if args.key?(:price) - @target_country = args[:target_country] if args.key?(:target_country) - @title = args[:title] if args.key?(:title) - @variant_attributes = args[:variant_attributes] if args.key?(:variant_attributes) - end - end - - # - class TestOrderPaymentMethod - include Google::Apis::Core::Hashable - - # The card expiration month (January = 1, February = 2 etc.). - # Corresponds to the JSON property `expirationMonth` - # @return [Fixnum] - attr_accessor :expiration_month - - # The card expiration year (4-digit, e.g. 2015). - # Corresponds to the JSON property `expirationYear` - # @return [Fixnum] - attr_accessor :expiration_year - - # The last four digits of the card number. - # Corresponds to the JSON property `lastFourDigits` - # @return [String] - attr_accessor :last_four_digits - - # The billing address. - # Corresponds to the JSON property `predefinedBillingAddress` - # @return [String] - attr_accessor :predefined_billing_address - - # The type of instrument. Note that real orders might have different values than - # the four values accepted by createTestOrder. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @expiration_month = args[:expiration_month] if args.key?(:expiration_month) - @expiration_year = args[:expiration_year] if args.key?(:expiration_year) - @last_four_digits = args[:last_four_digits] if args.key?(:last_four_digits) - @predefined_billing_address = args[:predefined_billing_address] if args.key?(:predefined_billing_address) - @type = args[:type] if args.key?(:type) - end - end - - # - class UnitInvoice - include Google::Apis::Core::Hashable - - # Additional charges for a unit, e.g. shipping costs. - # Corresponds to the JSON property `additionalCharges` - # @return [Array] - attr_accessor :additional_charges - - # Promotions applied to a unit. - # Corresponds to the JSON property `promotions` - # @return [Array] - attr_accessor :promotions - - # [required] Price of the unit, before applying taxes. - # Corresponds to the JSON property `unitPricePretax` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :unit_price_pretax - - # Tax amounts to apply to the unit price. - # Corresponds to the JSON property `unitPriceTaxes` - # @return [Array] - attr_accessor :unit_price_taxes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @additional_charges = args[:additional_charges] if args.key?(:additional_charges) - @promotions = args[:promotions] if args.key?(:promotions) - @unit_price_pretax = args[:unit_price_pretax] if args.key?(:unit_price_pretax) - @unit_price_taxes = args[:unit_price_taxes] if args.key?(:unit_price_taxes) - end - end - - # - class UnitInvoiceAdditionalCharge - include Google::Apis::Core::Hashable - - # [required] Amount of the additional charge. - # Corresponds to the JSON property `additionalChargeAmount` - # @return [Google::Apis::ContentV2sandbox::Amount] - attr_accessor :additional_charge_amount - - # Promotions applied to the additional charge. - # Corresponds to the JSON property `additionalChargePromotions` - # @return [Array] - attr_accessor :additional_charge_promotions - - # [required] Type of the additional charge. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @additional_charge_amount = args[:additional_charge_amount] if args.key?(:additional_charge_amount) - @additional_charge_promotions = args[:additional_charge_promotions] if args.key?(:additional_charge_promotions) - @type = args[:type] if args.key?(:type) - end - end - - # - class UnitInvoiceTaxLine - include Google::Apis::Core::Hashable - - # [required] Tax amount for the tax type. - # Corresponds to the JSON property `taxAmount` - # @return [Google::Apis::ContentV2sandbox::Price] - attr_accessor :tax_amount - - # Optional name of the tax type. This should only be provided if taxType is - # otherFeeTax. - # Corresponds to the JSON property `taxName` - # @return [String] - attr_accessor :tax_name - - # [required] Type of the tax. - # Corresponds to the JSON property `taxType` - # @return [String] - attr_accessor :tax_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @tax_amount = args[:tax_amount] if args.key?(:tax_amount) - @tax_name = args[:tax_name] if args.key?(:tax_name) - @tax_type = args[:tax_type] if args.key?(:tax_type) - end - end - end - end -end diff --git a/generated/google/apis/content_v2sandbox/representations.rb b/generated/google/apis/content_v2sandbox/representations.rb deleted file mode 100644 index 2836beb74..000000000 --- a/generated/google/apis/content_v2sandbox/representations.rb +++ /dev/null @@ -1,1956 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module ContentV2sandbox - - class Amount - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CustomerReturnReason - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Error - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Errors - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InvoiceSummary - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InvoiceSummaryAdditionalChargeSummary - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MerchantOrderReturn - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MerchantOrderReturnItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Order - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderAddress - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderCancellation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderCustomer - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderCustomerMarketingRightsInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderDeliveryDetails - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLegacyPromotion - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLegacyPromotionBenefit - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLineItemProduct - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLineItemProductVariantAttribute - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLineItemReturnInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLineItemShippingDetails - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderLineItemShippingDetailsMethod - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderMerchantProvidedAnnotation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderPaymentMethod - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderRefund - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderReturn - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderShipment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderShipmentLineItemShipment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderinvoicesCreateChargeInvoiceRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderinvoicesCreateChargeInvoiceResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderinvoicesCreateRefundInvoiceRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderinvoicesCreateRefundInvoiceResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyAuthApprovedRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyAuthApprovedResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyAuthDeclinedRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyAuthDeclinedResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyChargeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyChargeResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyRefundRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderpaymentsNotifyRefundResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrderreturnsListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersAcknowledgeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersAcknowledgeResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersAdvanceTestOrderResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCancelLineItemRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCancelLineItemResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCancelRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCancelResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCancelTestOrderByCustomerRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCancelTestOrderByCustomerResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCreateTestOrderRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCreateTestOrderResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCreateTestReturnRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCreateTestReturnResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntry - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryCancel - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryCancelLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryCreateTestReturnReturnItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryInStoreRefundLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryRefund - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryRejectReturnLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryReturnLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryReturnRefundLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntrySetLineItemMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryShipLineItems - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchRequestEntryUpdateShipment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersCustomBatchResponseEntry - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersGetByMerchantOrderIdResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersGetTestOrderTemplateResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersInStoreRefundLineItemRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersInStoreRefundLineItemResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersRefundRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersRefundResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersRejectReturnLineItemRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersRejectReturnLineItemResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersReturnLineItemRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersReturnLineItemResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersReturnRefundLineItemRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersReturnRefundLineItemResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersSetLineItemMetadataRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersSetLineItemMetadataResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersShipLineItemsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersShipLineItemsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersUpdateLineItemShippingDetailsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersUpdateLineItemShippingDetailsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersUpdateMerchantOrderIdRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersUpdateMerchantOrderIdResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersUpdateShipmentRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrdersUpdateShipmentResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Price - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Promotion - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RefundReason - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ReturnShipment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ShipmentInvoice - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ShipmentInvoiceLineItemInvoice - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ShipmentTrackingInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestOrder - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestOrderCustomer - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestOrderCustomerMarketingRightsInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestOrderLineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestOrderLineItemProduct - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestOrderPaymentMethod - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UnitInvoice - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UnitInvoiceAdditionalCharge - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UnitInvoiceTaxLine - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Amount - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pretax, as: 'pretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :tax, as: 'tax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - end - end - - class CustomerReturnReason - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :reason_code, as: 'reasonCode' - end - end - - class Error - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :domain, as: 'domain' - property :message, as: 'message' - property :reason, as: 'reason' - end - end - - class Errors - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - collection :errors, as: 'errors', class: Google::Apis::ContentV2sandbox::Error, decorator: Google::Apis::ContentV2sandbox::Error::Representation - - property :message, as: 'message' - end - end - - class InvoiceSummary - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :additional_charge_summaries, as: 'additionalChargeSummaries', class: Google::Apis::ContentV2sandbox::InvoiceSummaryAdditionalChargeSummary, decorator: Google::Apis::ContentV2sandbox::InvoiceSummaryAdditionalChargeSummary::Representation - - property :customer_balance, as: 'customerBalance', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - property :google_balance, as: 'googleBalance', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - property :merchant_balance, as: 'merchantBalance', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - property :product_total, as: 'productTotal', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - collection :promotion_summaries, as: 'promotionSummaries', class: Google::Apis::ContentV2sandbox::Promotion, decorator: Google::Apis::ContentV2sandbox::Promotion::Representation - - end - end - - class InvoiceSummaryAdditionalChargeSummary - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :total_amount, as: 'totalAmount', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - property :type, as: 'type' - end - end - - class MerchantOrderReturn - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :creation_date, as: 'creationDate' - property :merchant_order_id, as: 'merchantOrderId' - property :order_id, as: 'orderId' - property :order_return_id, as: 'orderReturnId' - collection :return_items, as: 'returnItems', class: Google::Apis::ContentV2sandbox::MerchantOrderReturnItem, decorator: Google::Apis::ContentV2sandbox::MerchantOrderReturnItem::Representation - - collection :return_shipments, as: 'returnShipments', class: Google::Apis::ContentV2sandbox::ReturnShipment, decorator: Google::Apis::ContentV2sandbox::ReturnShipment::Representation - - end - end - - class MerchantOrderReturnItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :customer_return_reason, as: 'customerReturnReason', class: Google::Apis::ContentV2sandbox::CustomerReturnReason, decorator: Google::Apis::ContentV2sandbox::CustomerReturnReason::Representation - - property :item_id, as: 'itemId' - property :merchant_return_reason, as: 'merchantReturnReason', class: Google::Apis::ContentV2sandbox::RefundReason, decorator: Google::Apis::ContentV2sandbox::RefundReason::Representation - - property :product, as: 'product', class: Google::Apis::ContentV2sandbox::OrderLineItemProduct, decorator: Google::Apis::ContentV2sandbox::OrderLineItemProduct::Representation - - collection :return_shipment_ids, as: 'returnShipmentIds' - property :state, as: 'state' - end - end - - class Order - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :acknowledged, as: 'acknowledged' - property :channel_type, as: 'channelType' - property :customer, as: 'customer', class: Google::Apis::ContentV2sandbox::OrderCustomer, decorator: Google::Apis::ContentV2sandbox::OrderCustomer::Representation - - property :delivery_details, as: 'deliveryDetails', class: Google::Apis::ContentV2sandbox::OrderDeliveryDetails, decorator: Google::Apis::ContentV2sandbox::OrderDeliveryDetails::Representation - - property :id, as: 'id' - property :kind, as: 'kind' - collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2sandbox::OrderLineItem, decorator: Google::Apis::ContentV2sandbox::OrderLineItem::Representation - - property :merchant_id, :numeric_string => true, as: 'merchantId' - property :merchant_order_id, as: 'merchantOrderId' - property :net_amount, as: 'netAmount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :payment_method, as: 'paymentMethod', class: Google::Apis::ContentV2sandbox::OrderPaymentMethod, decorator: Google::Apis::ContentV2sandbox::OrderPaymentMethod::Representation - - property :payment_status, as: 'paymentStatus' - property :placed_date, as: 'placedDate' - collection :promotions, as: 'promotions', class: Google::Apis::ContentV2sandbox::OrderLegacyPromotion, decorator: Google::Apis::ContentV2sandbox::OrderLegacyPromotion::Representation - - collection :refunds, as: 'refunds', class: Google::Apis::ContentV2sandbox::OrderRefund, decorator: Google::Apis::ContentV2sandbox::OrderRefund::Representation - - collection :shipments, as: 'shipments', class: Google::Apis::ContentV2sandbox::OrderShipment, decorator: Google::Apis::ContentV2sandbox::OrderShipment::Representation - - property :shipping_cost, as: 'shippingCost', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :shipping_cost_tax, as: 'shippingCostTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :shipping_option, as: 'shippingOption' - property :status, as: 'status' - end - end - - class OrderAddress - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :country, as: 'country' - collection :full_address, as: 'fullAddress' - property :is_post_office_box, as: 'isPostOfficeBox' - property :locality, as: 'locality' - property :postal_code, as: 'postalCode' - property :recipient_name, as: 'recipientName' - property :region, as: 'region' - collection :street_address, as: 'streetAddress' - end - end - - class OrderCancellation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :actor, as: 'actor' - property :creation_date, as: 'creationDate' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrderCustomer - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :email, as: 'email' - property :explicit_marketing_preference, as: 'explicitMarketingPreference' - property :full_name, as: 'fullName' - property :marketing_rights_info, as: 'marketingRightsInfo', class: Google::Apis::ContentV2sandbox::OrderCustomerMarketingRightsInfo, decorator: Google::Apis::ContentV2sandbox::OrderCustomerMarketingRightsInfo::Representation - - end - end - - class OrderCustomerMarketingRightsInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :explicit_marketing_preference, as: 'explicitMarketingPreference' - property :last_updated_timestamp, as: 'lastUpdatedTimestamp' - property :marketing_email_address, as: 'marketingEmailAddress' - end - end - - class OrderDeliveryDetails - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :address, as: 'address', class: Google::Apis::ContentV2sandbox::OrderAddress, decorator: Google::Apis::ContentV2sandbox::OrderAddress::Representation - - property :phone_number, as: 'phoneNumber' - end - end - - class OrderLegacyPromotion - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :benefits, as: 'benefits', class: Google::Apis::ContentV2sandbox::OrderLegacyPromotionBenefit, decorator: Google::Apis::ContentV2sandbox::OrderLegacyPromotionBenefit::Representation - - property :effective_dates, as: 'effectiveDates' - property :generic_redemption_code, as: 'genericRedemptionCode' - property :id, as: 'id' - property :long_title, as: 'longTitle' - property :product_applicability, as: 'productApplicability' - property :redemption_channel, as: 'redemptionChannel' - end - end - - class OrderLegacyPromotionBenefit - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :discount, as: 'discount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - collection :offer_ids, as: 'offerIds' - property :sub_type, as: 'subType' - property :tax_impact, as: 'taxImpact', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :type, as: 'type' - end - end - - class OrderLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :annotations, as: 'annotations', class: Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation, decorator: Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation::Representation - - collection :cancellations, as: 'cancellations', class: Google::Apis::ContentV2sandbox::OrderCancellation, decorator: Google::Apis::ContentV2sandbox::OrderCancellation::Representation - - property :id, as: 'id' - property :price, as: 'price', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :product, as: 'product', class: Google::Apis::ContentV2sandbox::OrderLineItemProduct, decorator: Google::Apis::ContentV2sandbox::OrderLineItemProduct::Representation - - property :quantity_canceled, as: 'quantityCanceled' - property :quantity_delivered, as: 'quantityDelivered' - property :quantity_ordered, as: 'quantityOrdered' - property :quantity_pending, as: 'quantityPending' - property :quantity_returned, as: 'quantityReturned' - property :quantity_shipped, as: 'quantityShipped' - property :return_info, as: 'returnInfo', class: Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo, decorator: Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo::Representation - - collection :returns, as: 'returns', class: Google::Apis::ContentV2sandbox::OrderReturn, decorator: Google::Apis::ContentV2sandbox::OrderReturn::Representation - - property :shipping_details, as: 'shippingDetails', class: Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails, decorator: Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails::Representation - - property :tax, as: 'tax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - end - end - - class OrderLineItemProduct - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :brand, as: 'brand' - property :channel, as: 'channel' - property :condition, as: 'condition' - property :content_language, as: 'contentLanguage' - property :gtin, as: 'gtin' - property :id, as: 'id' - property :image_link, as: 'imageLink' - property :item_group_id, as: 'itemGroupId' - property :mpn, as: 'mpn' - property :offer_id, as: 'offerId' - property :price, as: 'price', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :shown_image, as: 'shownImage' - property :target_country, as: 'targetCountry' - property :title, as: 'title' - collection :variant_attributes, as: 'variantAttributes', class: Google::Apis::ContentV2sandbox::OrderLineItemProductVariantAttribute, decorator: Google::Apis::ContentV2sandbox::OrderLineItemProductVariantAttribute::Representation - - end - end - - class OrderLineItemProductVariantAttribute - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :dimension, as: 'dimension' - property :value, as: 'value' - end - end - - class OrderLineItemReturnInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :days_to_return, as: 'daysToReturn' - property :is_returnable, as: 'isReturnable' - property :policy_url, as: 'policyUrl' - end - end - - class OrderLineItemShippingDetails - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :deliver_by_date, as: 'deliverByDate' - property :method_prop, as: 'method', class: Google::Apis::ContentV2sandbox::OrderLineItemShippingDetailsMethod, decorator: Google::Apis::ContentV2sandbox::OrderLineItemShippingDetailsMethod::Representation - - property :ship_by_date, as: 'shipByDate' - end - end - - class OrderLineItemShippingDetailsMethod - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :max_days_in_transit, as: 'maxDaysInTransit' - property :method_name, as: 'methodName' - property :min_days_in_transit, as: 'minDaysInTransit' - end - end - - class OrderMerchantProvidedAnnotation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :key, as: 'key' - property :value, as: 'value' - end - end - - class OrderPaymentMethod - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :billing_address, as: 'billingAddress', class: Google::Apis::ContentV2sandbox::OrderAddress, decorator: Google::Apis::ContentV2sandbox::OrderAddress::Representation - - property :expiration_month, as: 'expirationMonth' - property :expiration_year, as: 'expirationYear' - property :last_four_digits, as: 'lastFourDigits' - property :phone_number, as: 'phoneNumber' - property :type, as: 'type' - end - end - - class OrderRefund - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :actor, as: 'actor' - property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :creation_date, as: 'creationDate' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrderReturn - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :actor, as: 'actor' - property :creation_date, as: 'creationDate' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrderShipment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :creation_date, as: 'creationDate' - property :delivery_date, as: 'deliveryDate' - property :id, as: 'id' - collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment::Representation - - property :status, as: 'status' - property :tracking_id, as: 'trackingId' - end - end - - class OrderShipmentLineItemShipment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - end - end - - class OrderinvoicesCreateChargeInvoiceRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :invoice_id, as: 'invoiceId' - property :invoice_summary, as: 'invoiceSummary', class: Google::Apis::ContentV2sandbox::InvoiceSummary, decorator: Google::Apis::ContentV2sandbox::InvoiceSummary::Representation - - collection :line_item_invoices, as: 'lineItemInvoices', class: Google::Apis::ContentV2sandbox::ShipmentInvoiceLineItemInvoice, decorator: Google::Apis::ContentV2sandbox::ShipmentInvoiceLineItemInvoice::Representation - - property :operation_id, as: 'operationId' - property :shipment_group_id, as: 'shipmentGroupId' - end - end - - class OrderinvoicesCreateChargeInvoiceResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrderinvoicesCreateRefundInvoiceRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :invoice_id, as: 'invoiceId' - property :operation_id, as: 'operationId' - property :refund_only_option, as: 'refundOnlyOption', class: Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption, decorator: Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption::Representation - - property :return_option, as: 'returnOption', class: Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption, decorator: Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption::Representation - - collection :shipment_invoices, as: 'shipmentInvoices', class: Google::Apis::ContentV2sandbox::ShipmentInvoice, decorator: Google::Apis::ContentV2sandbox::ShipmentInvoice::Representation - - end - end - - class OrderinvoicesCreateRefundInvoiceResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :reason, as: 'reason' - end - end - - class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :reason, as: 'reason' - end - end - - class OrderpaymentsNotifyAuthApprovedRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auth_amount_pretax, as: 'authAmountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :auth_amount_tax, as: 'authAmountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - end - end - - class OrderpaymentsNotifyAuthApprovedResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrderpaymentsNotifyAuthDeclinedRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :decline_reason, as: 'declineReason' - end - end - - class OrderpaymentsNotifyAuthDeclinedResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrderpaymentsNotifyChargeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :charge_state, as: 'chargeState' - property :invoice_id, as: 'invoiceId' - collection :invoice_ids, as: 'invoiceIds' - end - end - - class OrderpaymentsNotifyChargeResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrderpaymentsNotifyRefundRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :invoice_id, as: 'invoiceId' - collection :invoice_ids, as: 'invoiceIds' - property :refund_state, as: 'refundState' - end - end - - class OrderpaymentsNotifyRefundResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrderreturnsListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - collection :resources, as: 'resources', class: Google::Apis::ContentV2sandbox::MerchantOrderReturn, decorator: Google::Apis::ContentV2sandbox::MerchantOrderReturn::Representation - - end - end - - class OrdersAcknowledgeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :operation_id, as: 'operationId' - end - end - - class OrdersAcknowledgeResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersAdvanceTestOrderResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class OrdersCancelLineItemRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCancelLineItemResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersCancelRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :operation_id, as: 'operationId' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCancelResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersCancelTestOrderByCustomerRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :reason, as: 'reason' - end - end - - class OrdersCancelTestOrderByCustomerResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class OrdersCreateTestOrderRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :country, as: 'country' - property :template_name, as: 'templateName' - property :test_order, as: 'testOrder', class: Google::Apis::ContentV2sandbox::TestOrder, decorator: Google::Apis::ContentV2sandbox::TestOrder::Representation - - end - end - - class OrdersCreateTestOrderResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :order_id, as: 'orderId' - end - end - - class OrdersCreateTestReturnRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCreateTestReturnReturnItem, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCreateTestReturnReturnItem::Representation - - end - end - - class OrdersCreateTestReturnResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :return_id, as: 'returnId' - end - end - - class OrdersCustomBatchRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :entries, as: 'entries', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntry, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntry::Representation - - end - end - - class OrdersCustomBatchRequestEntry - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :batch_id, as: 'batchId' - property :cancel, as: 'cancel', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancel, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancel::Representation - - property :cancel_line_item, as: 'cancelLineItem', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancelLineItem, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancelLineItem::Representation - - property :in_store_refund_line_item, as: 'inStoreRefundLineItem', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryInStoreRefundLineItem, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryInStoreRefundLineItem::Representation - - property :merchant_id, :numeric_string => true, as: 'merchantId' - property :merchant_order_id, as: 'merchantOrderId' - property :method_prop, as: 'method' - property :operation_id, as: 'operationId' - property :order_id, as: 'orderId' - property :refund, as: 'refund', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRefund, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRefund::Representation - - property :reject_return_line_item, as: 'rejectReturnLineItem', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRejectReturnLineItem, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRejectReturnLineItem::Representation - - property :return_line_item, as: 'returnLineItem', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnLineItem, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnLineItem::Representation - - property :return_refund_line_item, as: 'returnRefundLineItem', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnRefundLineItem, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnRefundLineItem::Representation - - property :set_line_item_metadata, as: 'setLineItemMetadata', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntrySetLineItemMetadata, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntrySetLineItemMetadata::Representation - - property :ship_line_items, as: 'shipLineItems', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItems, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItems::Representation - - property :update_line_item_shipping_details, as: 'updateLineItemShippingDetails', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails::Representation - - property :update_shipment, as: 'updateShipment', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateShipment, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateShipment::Representation - - end - end - - class OrdersCustomBatchRequestEntryCancel - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntryCancelLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntryCreateTestReturnReturnItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :quantity, as: 'quantity' - end - end - - class OrdersCustomBatchRequestEntryInStoreRefundLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntryRefund - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntryRejectReturnLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntryReturnLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntryReturnRefundLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersCustomBatchRequestEntrySetLineItemMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :annotations, as: 'annotations', class: Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation, decorator: Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation::Representation - - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - end - end - - class OrdersCustomBatchRequestEntryShipLineItems - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment::Representation - - property :shipment_group_id, as: 'shipmentGroupId' - property :shipment_id, as: 'shipmentId' - collection :shipment_infos, as: 'shipmentInfos', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo::Representation - - property :tracking_id, as: 'trackingId' - end - end - - class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :shipment_id, as: 'shipmentId' - property :tracking_id, as: 'trackingId' - end - end - - class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :deliver_by_date, as: 'deliverByDate' - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - property :ship_by_date, as: 'shipByDate' - end - end - - class OrdersCustomBatchRequestEntryUpdateShipment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :delivery_date, as: 'deliveryDate' - property :shipment_id, as: 'shipmentId' - property :status, as: 'status' - property :tracking_id, as: 'trackingId' - end - end - - class OrdersCustomBatchResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :entries, as: 'entries', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchResponseEntry, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchResponseEntry::Representation - - property :kind, as: 'kind' - end - end - - class OrdersCustomBatchResponseEntry - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :batch_id, as: 'batchId' - property :errors, as: 'errors', class: Google::Apis::ContentV2sandbox::Errors, decorator: Google::Apis::ContentV2sandbox::Errors::Representation - - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - property :order, as: 'order', class: Google::Apis::ContentV2sandbox::Order, decorator: Google::Apis::ContentV2sandbox::Order::Representation - - end - end - - class OrdersGetByMerchantOrderIdResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :order, as: 'order', class: Google::Apis::ContentV2sandbox::Order, decorator: Google::Apis::ContentV2sandbox::Order::Representation - - end - end - - class OrdersGetTestOrderTemplateResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :template, as: 'template', class: Google::Apis::ContentV2sandbox::TestOrder, decorator: Google::Apis::ContentV2sandbox::TestOrder::Representation - - end - end - - class OrdersInStoreRefundLineItemRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersInStoreRefundLineItemResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - collection :resources, as: 'resources', class: Google::Apis::ContentV2sandbox::Order, decorator: Google::Apis::ContentV2sandbox::Order::Representation - - end - end - - class OrdersRefundRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :operation_id, as: 'operationId' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersRefundResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersRejectReturnLineItemRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersRejectReturnLineItemResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersReturnLineItemRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersReturnLineItemResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersReturnRefundLineItemRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - property :quantity, as: 'quantity' - property :reason, as: 'reason' - property :reason_text, as: 'reasonText' - end - end - - class OrdersReturnRefundLineItemResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersSetLineItemMetadataRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :annotations, as: 'annotations', class: Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation, decorator: Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation::Representation - - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - end - end - - class OrdersSetLineItemMetadataResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersShipLineItemsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment::Representation - - property :operation_id, as: 'operationId' - property :shipment_group_id, as: 'shipmentGroupId' - property :shipment_id, as: 'shipmentId' - collection :shipment_infos, as: 'shipmentInfos', class: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo, decorator: Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo::Representation - - property :tracking_id, as: 'trackingId' - end - end - - class OrdersShipLineItemsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersUpdateLineItemShippingDetailsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :deliver_by_date, as: 'deliverByDate' - property :line_item_id, as: 'lineItemId' - property :operation_id, as: 'operationId' - property :product_id, as: 'productId' - property :ship_by_date, as: 'shipByDate' - end - end - - class OrdersUpdateLineItemShippingDetailsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersUpdateMerchantOrderIdRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :merchant_order_id, as: 'merchantOrderId' - property :operation_id, as: 'operationId' - end - end - - class OrdersUpdateMerchantOrderIdResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class OrdersUpdateShipmentRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :delivery_date, as: 'deliveryDate' - property :operation_id, as: 'operationId' - property :shipment_id, as: 'shipmentId' - property :status, as: 'status' - property :tracking_id, as: 'trackingId' - end - end - - class OrdersUpdateShipmentResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :execution_status, as: 'executionStatus' - property :kind, as: 'kind' - end - end - - class Price - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :currency, as: 'currency' - property :value, as: 'value' - end - end - - class Promotion - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :promotion_amount, as: 'promotionAmount', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - property :promotion_id, as: 'promotionId' - end - end - - class RefundReason - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :reason_code, as: 'reasonCode' - end - end - - class ReturnShipment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :creation_date, as: 'creationDate' - property :return_method_type, as: 'returnMethodType' - property :shipment_id, as: 'shipmentId' - collection :shipment_tracking_infos, as: 'shipmentTrackingInfos', class: Google::Apis::ContentV2sandbox::ShipmentTrackingInfo, decorator: Google::Apis::ContentV2sandbox::ShipmentTrackingInfo::Representation - - end - end - - class ShipmentInvoice - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :invoice_summary, as: 'invoiceSummary', class: Google::Apis::ContentV2sandbox::InvoiceSummary, decorator: Google::Apis::ContentV2sandbox::InvoiceSummary::Representation - - collection :line_item_invoices, as: 'lineItemInvoices', class: Google::Apis::ContentV2sandbox::ShipmentInvoiceLineItemInvoice, decorator: Google::Apis::ContentV2sandbox::ShipmentInvoiceLineItemInvoice::Representation - - property :shipment_group_id, as: 'shipmentGroupId' - end - end - - class ShipmentInvoiceLineItemInvoice - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line_item_id, as: 'lineItemId' - property :product_id, as: 'productId' - collection :shipment_unit_ids, as: 'shipmentUnitIds' - property :unit_invoice, as: 'unitInvoice', class: Google::Apis::ContentV2sandbox::UnitInvoice, decorator: Google::Apis::ContentV2sandbox::UnitInvoice::Representation - - end - end - - class ShipmentTrackingInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :tracking_number, as: 'trackingNumber' - end - end - - class TestOrder - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :customer, as: 'customer', class: Google::Apis::ContentV2sandbox::TestOrderCustomer, decorator: Google::Apis::ContentV2sandbox::TestOrderCustomer::Representation - - property :enable_orderinvoices, as: 'enableOrderinvoices' - property :kind, as: 'kind' - collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2sandbox::TestOrderLineItem, decorator: Google::Apis::ContentV2sandbox::TestOrderLineItem::Representation - - property :notification_mode, as: 'notificationMode' - property :payment_method, as: 'paymentMethod', class: Google::Apis::ContentV2sandbox::TestOrderPaymentMethod, decorator: Google::Apis::ContentV2sandbox::TestOrderPaymentMethod::Representation - - property :predefined_delivery_address, as: 'predefinedDeliveryAddress' - collection :promotions, as: 'promotions', class: Google::Apis::ContentV2sandbox::OrderLegacyPromotion, decorator: Google::Apis::ContentV2sandbox::OrderLegacyPromotion::Representation - - property :shipping_cost, as: 'shippingCost', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :shipping_cost_tax, as: 'shippingCostTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :shipping_option, as: 'shippingOption' - end - end - - class TestOrderCustomer - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :email, as: 'email' - property :explicit_marketing_preference, as: 'explicitMarketingPreference' - property :full_name, as: 'fullName' - property :marketing_rights_info, as: 'marketingRightsInfo', class: Google::Apis::ContentV2sandbox::TestOrderCustomerMarketingRightsInfo, decorator: Google::Apis::ContentV2sandbox::TestOrderCustomerMarketingRightsInfo::Representation - - end - end - - class TestOrderCustomerMarketingRightsInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :explicit_marketing_preference, as: 'explicitMarketingPreference' - property :last_updated_timestamp, as: 'lastUpdatedTimestamp' - end - end - - class TestOrderLineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :product, as: 'product', class: Google::Apis::ContentV2sandbox::TestOrderLineItemProduct, decorator: Google::Apis::ContentV2sandbox::TestOrderLineItemProduct::Representation - - property :quantity_ordered, as: 'quantityOrdered' - property :return_info, as: 'returnInfo', class: Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo, decorator: Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo::Representation - - property :shipping_details, as: 'shippingDetails', class: Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails, decorator: Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails::Representation - - property :unit_tax, as: 'unitTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - end - end - - class TestOrderLineItemProduct - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :brand, as: 'brand' - property :channel, as: 'channel' - property :condition, as: 'condition' - property :content_language, as: 'contentLanguage' - property :gtin, as: 'gtin' - property :image_link, as: 'imageLink' - property :item_group_id, as: 'itemGroupId' - property :mpn, as: 'mpn' - property :offer_id, as: 'offerId' - property :price, as: 'price', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :target_country, as: 'targetCountry' - property :title, as: 'title' - collection :variant_attributes, as: 'variantAttributes', class: Google::Apis::ContentV2sandbox::OrderLineItemProductVariantAttribute, decorator: Google::Apis::ContentV2sandbox::OrderLineItemProductVariantAttribute::Representation - - end - end - - class TestOrderPaymentMethod - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :expiration_month, as: 'expirationMonth' - property :expiration_year, as: 'expirationYear' - property :last_four_digits, as: 'lastFourDigits' - property :predefined_billing_address, as: 'predefinedBillingAddress' - property :type, as: 'type' - end - end - - class UnitInvoice - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :additional_charges, as: 'additionalCharges', class: Google::Apis::ContentV2sandbox::UnitInvoiceAdditionalCharge, decorator: Google::Apis::ContentV2sandbox::UnitInvoiceAdditionalCharge::Representation - - collection :promotions, as: 'promotions', class: Google::Apis::ContentV2sandbox::Promotion, decorator: Google::Apis::ContentV2sandbox::Promotion::Representation - - property :unit_price_pretax, as: 'unitPricePretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - collection :unit_price_taxes, as: 'unitPriceTaxes', class: Google::Apis::ContentV2sandbox::UnitInvoiceTaxLine, decorator: Google::Apis::ContentV2sandbox::UnitInvoiceTaxLine::Representation - - end - end - - class UnitInvoiceAdditionalCharge - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :additional_charge_amount, as: 'additionalChargeAmount', class: Google::Apis::ContentV2sandbox::Amount, decorator: Google::Apis::ContentV2sandbox::Amount::Representation - - collection :additional_charge_promotions, as: 'additionalChargePromotions', class: Google::Apis::ContentV2sandbox::Promotion, decorator: Google::Apis::ContentV2sandbox::Promotion::Representation - - property :type, as: 'type' - end - end - - class UnitInvoiceTaxLine - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :tax_amount, as: 'taxAmount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation - - property :tax_name, as: 'taxName' - property :tax_type, as: 'taxType' - end - end - end - end -end diff --git a/generated/google/apis/content_v2sandbox/service.rb b/generated/google/apis/content_v2sandbox/service.rb deleted file mode 100644 index 1373bf1f4..000000000 --- a/generated/google/apis/content_v2sandbox/service.rb +++ /dev/null @@ -1,1296 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module ContentV2sandbox - # Content API for Shopping - # - # Manages product items, inventory, and Merchant Center accounts for Google - # Shopping. - # - # @example - # require 'google/apis/content_v2sandbox' - # - # Content = Google::Apis::ContentV2sandbox # Alias the module - # service = Content::ShoppingContentService.new - # - # @see https://developers.google.com/shopping-content - class ShoppingContentService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', 'content/v2sandbox/') - @batch_path = 'batch/content/v2sandbox' - end - - # Creates a charge invoice for a shipment group, and triggers a charge capture - # for non-facilitated payment orders. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceRequest] orderinvoices_create_charge_invoice_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def createchargeinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_charge_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orderinvoices/{orderId}/createChargeInvoice', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceRequest::Representation - command.request_object = orderinvoices_create_charge_invoice_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderinvoicesCreateChargeInvoiceResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a refund invoice for one or more shipment groups, and triggers a - # refund for non-facilitated payment orders. This can only be used for line - # items that have previously been charged using createChargeInvoice. All amounts - # (except for the summary) are incremental with respect to the previous invoice. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceRequest] orderinvoices_create_refund_invoice_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def createrefundinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_refund_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orderinvoices/{orderId}/createRefundInvoice', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceRequest::Representation - command.request_object = orderinvoices_create_refund_invoice_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderinvoicesCreateRefundInvoiceResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Notify about successfully authorizing user's payment method for a given amount. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order for for which payment authorization is happening. - # @param [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedRequest] orderpayments_notify_auth_approved_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def notifyauthapproved_orderpayment(merchant_id, order_id, orderpayments_notify_auth_approved_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyAuthApproved', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedRequest::Representation - command.request_object = orderpayments_notify_auth_approved_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthApprovedResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Notify about failure to authorize user's payment method. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order for which payment authorization was declined. - # @param [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedRequest] orderpayments_notify_auth_declined_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def notifyauthdeclined_orderpayment(merchant_id, order_id, orderpayments_notify_auth_declined_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyAuthDeclined', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedRequest::Representation - command.request_object = orderpayments_notify_auth_declined_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyAuthDeclinedResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Notify about charge on user's selected payments method. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order for which charge is happening. - # @param [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeRequest] orderpayments_notify_charge_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def notifycharge_orderpayment(merchant_id, order_id, orderpayments_notify_charge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyCharge', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeRequest::Representation - command.request_object = orderpayments_notify_charge_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyChargeResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Notify about refund on user's selected payments method. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order for which charge is happening. - # @param [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundRequest] orderpayments_notify_refund_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def notifyrefund_orderpayment(merchant_id, order_id, orderpayments_notify_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyRefund', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundRequest::Representation - command.request_object = orderpayments_notify_refund_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderpaymentsNotifyRefundResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves an order return from your Merchant Center account. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] return_id - # Merchant order return ID generated by Google. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::MerchantOrderReturn] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::MerchantOrderReturn] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_orderreturn(merchant_id, return_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{merchantId}/orderreturns/{returnId}', options) - command.response_representation = Google::Apis::ContentV2sandbox::MerchantOrderReturn::Representation - command.response_class = Google::Apis::ContentV2sandbox::MerchantOrderReturn - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['returnId'] = return_id unless return_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists order returns in your Merchant Center account. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] created_end_date - # Obtains order returns created before this date (inclusively), in ISO 8601 - # format. - # @param [String] created_start_date - # Obtains order returns created after this date (inclusively), in ISO 8601 - # format. - # @param [Fixnum] max_results - # The maximum number of order returns to return in the response, used for paging. - # The default value is 25 returns per page, and the maximum allowed value is - # 250 returns per page. - # @param [String] order_by - # Return the results in the specified order. - # @param [String] page_token - # The token returned by the previous request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrderreturnsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrderreturnsListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_orderreturns(merchant_id, created_end_date: nil, created_start_date: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{merchantId}/orderreturns', options) - command.response_representation = Google::Apis::ContentV2sandbox::OrderreturnsListResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrderreturnsListResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.query['createdEndDate'] = created_end_date unless created_end_date.nil? - command.query['createdStartDate'] = created_start_date unless created_start_date.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Marks an order as acknowledged. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersAcknowledgeRequest] orders_acknowledge_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/acknowledge', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersAcknowledgeRequest::Representation - command.request_object = orders_acknowledge_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersAcknowledgeResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Sandbox only. Moves a test order from state "inProgress" to state " - # pendingShipment". - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the test order to modify. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/testorders/{orderId}/advance', options) - command.response_representation = Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersAdvanceTestOrderResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Cancels all line items in an order, making a full refund. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order to cancel. - # @param [Google::Apis::ContentV2sandbox::OrdersCancelRequest] orders_cancel_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersCancelResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersCancelResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/cancel', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersCancelRequest::Representation - command.request_object = orders_cancel_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersCancelResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersCancelResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Cancels a line item, making a full refund. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersCancelLineItemRequest] orders_cancel_line_item_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancellineitem_order(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/cancelLineItem', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersCancelLineItemRequest::Representation - command.request_object = orders_cancel_line_item_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersCancelLineItemResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Sandbox only. Cancels a test order for customer-initiated cancellation. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the test order to cancel. - # @param [Google::Apis::ContentV2sandbox::OrdersCancelTestOrderByCustomerRequest] orders_cancel_test_order_by_customer_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersCancelTestOrderByCustomerResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersCancelTestOrderByCustomerResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def canceltestorderbycustomer_order(merchant_id, order_id, orders_cancel_test_order_by_customer_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/testorders/{orderId}/cancelByCustomer', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersCancelTestOrderByCustomerRequest::Representation - command.request_object = orders_cancel_test_order_by_customer_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersCancelTestOrderByCustomerResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersCancelTestOrderByCustomerResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Sandbox only. Creates a test order. - # @param [Fixnum] merchant_id - # The ID of the account that should manage the order. This cannot be a multi- - # client account. - # @param [Google::Apis::ContentV2sandbox::OrdersCreateTestOrderRequest] orders_create_test_order_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/testorders', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersCreateTestOrderRequest::Representation - command.request_object = orders_create_test_order_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersCreateTestOrderResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Sandbox only. Creates a test return. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersCreateTestReturnRequest] orders_create_test_return_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersCreateTestReturnResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersCreateTestReturnResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def createtestreturn_order(merchant_id, order_id, orders_create_test_return_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/testreturn', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersCreateTestReturnRequest::Representation - command.request_object = orders_create_test_return_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersCreateTestReturnResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersCreateTestReturnResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves or modifies multiple orders in a single request. - # @param [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequest] orders_custom_batch_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def custombatch_order(orders_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'orders/batch', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersCustomBatchRequest::Representation - command.request_object = orders_custom_batch_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersCustomBatchResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves an order from your Merchant Center account. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::Order] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{merchantId}/orders/{orderId}', options) - command.response_representation = Google::Apis::ContentV2sandbox::Order::Representation - command.response_class = Google::Apis::ContentV2sandbox::Order - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves an order using merchant order id. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] merchant_order_id - # The merchant order id to be looked for. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{merchantId}/ordersbymerchantid/{merchantOrderId}', options) - command.response_representation = Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersGetByMerchantOrderIdResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['merchantOrderId'] = merchant_order_id unless merchant_order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Sandbox only. Retrieves an order template that can be used to quickly create a - # new order in sandbox. - # @param [Fixnum] merchant_id - # The ID of the account that should manage the order. This cannot be a multi- - # client account. - # @param [String] template_name - # The name of the template to retrieve. - # @param [String] country - # The country of the template to retrieve. Defaults to US. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def gettestordertemplate_order(merchant_id, template_name, country: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{merchantId}/testordertemplates/{templateName}', options) - command.response_representation = Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersGetTestOrderTemplateResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['templateName'] = template_name unless template_name.nil? - command.query['country'] = country unless country.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Notifies that item return and refund was handled directly by merchant outside - # of Google payments processing (e.g. cash refund done in store). - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemRequest] orders_in_store_refund_line_item_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/inStoreRefundLineItem', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemRequest::Representation - command.request_object = orders_in_store_refund_line_item_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersInStoreRefundLineItemResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists the orders in your Merchant Center account. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [Boolean] acknowledged - # Obtains orders that match the acknowledgement status. When set to true, - # obtains orders that have been acknowledged. When false, obtains orders that - # have not been acknowledged. - # We recommend using this filter set to false, in conjunction with the - # acknowledge call, such that only un-acknowledged orders are returned. - # @param [Fixnum] max_results - # The maximum number of orders to return in the response, used for paging. The - # default value is 25 orders per page, and the maximum allowed value is 250 - # orders per page. - # Known issue: All List calls will return all Orders without limit regardless of - # the value of this field. - # @param [String] order_by - # The ordering of the returned list. The only supported value are placedDate - # desc and placedDate asc for now, which returns orders sorted by placement date. - # "placedDate desc" stands for listing orders by placement date, from oldest to - # most recent. "placedDate asc" stands for listing orders by placement date, - # from most recent to oldest. In future releases we'll support other sorting - # criteria. - # @param [String] page_token - # The token returned by the previous request. - # @param [String] placed_date_end - # Obtains orders placed before this date (exclusively), in ISO 8601 format. - # @param [String] placed_date_start - # Obtains orders placed after this date (inclusively), in ISO 8601 format. - # @param [Array, String] statuses - # Obtains orders that match any of the specified statuses. Multiple values can - # be specified with comma separation. Additionally, please note that active is a - # shortcut for pendingShipment and partiallyShipped, and completed is a shortcut - # for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and - # canceled. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_orders(merchant_id, acknowledged: nil, max_results: nil, order_by: nil, page_token: nil, placed_date_end: nil, placed_date_start: nil, statuses: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{merchantId}/orders', options) - command.response_representation = Google::Apis::ContentV2sandbox::OrdersListResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersListResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.query['acknowledged'] = acknowledged unless acknowledged.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['placedDateEnd'] = placed_date_end unless placed_date_end.nil? - command.query['placedDateStart'] = placed_date_start unless placed_date_start.nil? - command.query['statuses'] = statuses unless statuses.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deprecated, please use returnRefundLineItem instead. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order to refund. - # @param [Google::Apis::ContentV2sandbox::OrdersRefundRequest] orders_refund_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersRefundResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersRefundResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def refund_order(merchant_id, order_id, orders_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/refund', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersRefundRequest::Representation - command.request_object = orders_refund_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersRefundResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersRefundResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Rejects return on an line item. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemRequest] orders_reject_return_line_item_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/rejectReturnLineItem', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemRequest::Representation - command.request_object = orders_reject_return_line_item_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersRejectReturnLineItemResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns a line item. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersReturnLineItemRequest] orders_return_line_item_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def returnlineitem_order(merchant_id, order_id, orders_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/returnLineItem', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersReturnLineItemRequest::Representation - command.request_object = orders_return_line_item_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersReturnLineItemResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns and refunds a line item. Note that this method can only be called on - # fully shipped orders. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemRequest] orders_return_refund_line_item_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def returnrefundlineitem_order(merchant_id, order_id, orders_return_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/returnRefundLineItem', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemRequest::Representation - command.request_object = orders_return_refund_line_item_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersReturnRefundLineItemResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Sets (overrides) merchant provided annotations on the line item. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataRequest] orders_set_line_item_metadata_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def setlineitemmetadata_order(merchant_id, order_id, orders_set_line_item_metadata_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/setLineItemMetadata', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataRequest::Representation - command.request_object = orders_set_line_item_metadata_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersSetLineItemMetadataResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Marks line item(s) as shipped. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersShipLineItemsRequest] orders_ship_line_items_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def shiplineitems_order(merchant_id, order_id, orders_ship_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/shipLineItems', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersShipLineItemsRequest::Representation - command.request_object = orders_ship_line_items_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersShipLineItemsResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates ship by and delivery by dates for a line item. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsRequest] orders_update_line_item_shipping_details_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateLineItemShippingDetails', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsRequest::Representation - command.request_object = orders_update_line_item_shipping_details_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersUpdateLineItemShippingDetailsResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates the merchant order ID for a given order. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdRequest] orders_update_merchant_order_id_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def updatemerchantorderid_order(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateMerchantOrderId', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdRequest::Representation - command.request_object = orders_update_merchant_order_id_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a shipment's status, carrier, and/or tracking ID. - # @param [Fixnum] merchant_id - # The ID of the account that manages the order. This cannot be a multi-client - # account. - # @param [String] order_id - # The ID of the order. - # @param [Google::Apis::ContentV2sandbox::OrdersUpdateShipmentRequest] orders_update_shipment_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def updateshipment_order(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateShipment', options) - command.request_representation = Google::Apis::ContentV2sandbox::OrdersUpdateShipmentRequest::Representation - command.request_object = orders_update_shipment_request_object - command.response_representation = Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse::Representation - command.response_class = Google::Apis::ContentV2sandbox::OrdersUpdateShipmentResponse - command.params['merchantId'] = merchant_id unless merchant_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - end - end - end - end -end diff --git a/generated/google/apis/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 4b599328c..5343e58e7 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -20,16 +20,19 @@ module Google module Apis # Dialogflow API # - # An end-to-end development suite for conversational interfaces (e.g., chatbots, - # voice-powered apps and devices). + # Builds conversational interfaces (for example, chatbots, and voice-powered + # apps and devices). # # @see https://cloud.google.com/dialogflow-enterprise/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20181009' + REVISION = '20181017' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + + # View, manage and query your Dialogflow agents + AUTH_DIALOGFLOW = 'https://www.googleapis.com/auth/dialogflow' end end end diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index f6c99e71a..1569fe2f1 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -1375,7 +1375,9 @@ module Google # The unique identifier of detectIntent request session. # Can be used to identify end-user inside webhook implementation. - # Format: `projects//agent/sessions/`. + # Format: `projects//agent/sessions/`, or + # `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -1470,19 +1472,6 @@ module Google end end - # The request message for Conversations.AddConversationPhoneNumber. - class GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - # Represents a conversational agent. class GoogleCloudDialogflowV2beta1Agent include Google::Apis::Core::Hashable @@ -1573,138 +1562,6 @@ module Google end end - # The request message for Conversations.AnalyzeContent. - class GoogleCloudDialogflowV2beta1AnalyzeContentRequest - include Google::Apis::Core::Hashable - - # Represents the natural language speech audio to be processed. - # Corresponds to the JSON property `audio` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudio] - attr_accessor :audio - - # Instructs the speech synthesizer how to generate the output audio content. - # Corresponds to the JSON property `replyAudioConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig] - attr_accessor :reply_audio_config - - # Represents the natural language text to be processed. - # Corresponds to the JSON property `text` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputText] - attr_accessor :text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audio = args[:audio] if args.key?(:audio) - @reply_audio_config = args[:reply_audio_config] if args.key?(:reply_audio_config) - @text = args[:text] if args.key?(:text) - end - end - - # The response message for Conversations.AnalyzeContent. - class GoogleCloudDialogflowV2beta1AnalyzeContentResponse - include Google::Apis::Core::Hashable - - # Represent a response from an automated agent. - # Corresponds to the JSON property `automatedAgentReply` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply] - attr_accessor :automated_agent_reply - - # Represents the natural language speech audio to be played to the end user. - # Corresponds to the JSON property `replyAudio` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudio] - attr_accessor :reply_audio - - # Output only. The output text content. - # This field is set if the automated agent responded with text to show to - # the user. - # Corresponds to the JSON property `replyText` - # @return [String] - attr_accessor :reply_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @automated_agent_reply = args[:automated_agent_reply] if args.key?(:automated_agent_reply) - @reply_audio = args[:reply_audio] if args.key?(:reply_audio) - @reply_text = args[:reply_text] if args.key?(:reply_text) - end - end - - # Defines article suggestions that a human agent assistant can provide. - class GoogleCloudDialogflowV2beta1ArticleSuggestionConfig - include Google::Apis::Core::Hashable - - # Required. Settings for knowledge base, Format: - # `projects//knowledgeBases/`. - # Corresponds to the JSON property `knowledgeBaseName` - # @return [String] - attr_accessor :knowledge_base_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @knowledge_base_name = args[:knowledge_base_name] if args.key?(:knowledge_base_name) - end - end - - # Defines the Automated Agent to connect to a conversation. - class GoogleCloudDialogflowV2beta1AutomatedAgentConfig - include Google::Apis::Core::Hashable - - # Required. ID of the Dialogflow agent environment to use. - # This project needs to either be the same project as the conversation or you - # need to grant `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API - # Service Agent` role in this project. - # Format: `projects//agent/environments/` - # If environment is not specified, the default `draft` environment is - # used. Refer to - # [DetectIntentRequest](/dialogflow-enterprise/docs/reference/rpc/google.cloud. - # dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) - # for more details. - # Corresponds to the JSON property `agent` - # @return [String] - attr_accessor :agent - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @agent = args[:agent] if args.key?(:agent) - end - end - - # Represent a response from an automated agent. - class GoogleCloudDialogflowV2beta1AutomatedAgentReply - include Google::Apis::Core::Hashable - - # The message returned from the DetectIntent method. - # Corresponds to the JSON property `detectIntentResponse` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse] - attr_accessor :detect_intent_response - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @detect_intent_response = args[:detect_intent_response] if args.key?(:detect_intent_response) - end - end - # The request message for EntityTypes.BatchCreateEntities. class GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest include Google::Apis::Core::Hashable @@ -1971,72 +1828,6 @@ module Google end end - # The request message for PhoneNumberOrders.CancelPhoneNumberOrder. - class GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # The request message for - # HumanAgentAssistants.RequestCompileSuggestions. - class GoogleCloudDialogflowV2beta1CompileSuggestionsRequest - include Google::Apis::Core::Hashable - - # Required. List of messages in a conversation in chronological order. - # Corresponds to the JSON property `messages` - # @return [Array] - attr_accessor :messages - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @messages = args[:messages] if args.key?(:messages) - end - end - - # The response message for - # HumanAgentAssistants.RequestCompileSuggestions - class GoogleCloudDialogflowV2beta1CompileSuggestionsResponse - include Google::Apis::Core::Hashable - - # Required. - # Corresponds to the JSON property `suggestions` - # @return [Array] - attr_accessor :suggestions - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @suggestions = args[:suggestions] if args.key?(:suggestions) - end - end - - # The request message for Conversations.CompleteConversation. - class GoogleCloudDialogflowV2beta1CompleteConversationRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - # Represents a context. class GoogleCloudDialogflowV2beta1Context include Google::Apis::Core::Hashable @@ -2079,49 +1870,64 @@ module Google end end - # Represents a conversation. - # A conversation is an interaction between an agent, including live agents - # and Dialogflow agents, and a support customer. Conversations can - # include phone calls and text-based chat sessions. - class GoogleCloudDialogflowV2beta1Conversation + # Represents a notification sent to Cloud Pub/Sub subscribers for conversation + # lifecycle events. + class GoogleCloudDialogflowV2beta1ConversationEvent include Google::Apis::Core::Hashable - # Required. The Conversation Profile to be used to configure this - # Conversation. This field cannot be updated. - # Format: `projects//conversationProfiles/`. - # Corresponds to the JSON property `conversationProfile` + # Required. The unique identifier of the conversation this notification + # refers to. Format: `projects//conversations/`. + # Corresponds to the JSON property `conversation` # @return [String] - attr_accessor :conversation_profile + attr_accessor :conversation - # Output only. The time the conversation was finished. - # Corresponds to the JSON property `endTime` + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `errorStatus` + # @return [Google::Apis::DialogflowV2beta1::GoogleRpcStatus] + attr_accessor :error_status + + # Required. The type of the event that this notification refers to. + # Corresponds to the JSON property `type` # @return [String] - attr_accessor :end_time - - # Output only. The current state of the Conversation. - # Corresponds to the JSON property `lifecycleState` - # @return [String] - attr_accessor :lifecycle_state - - # The unique identifier of this conversation. - # Required for all methods except `create` (`create` populates the name - # automatically). - # Format: `projects//conversations/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Represents a phone number for telephony integration. It allows for connecting - # a particular conversation over telephony. - # Corresponds to the JSON property `phoneNumber` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber] - attr_accessor :phone_number - - # Output only. The time the conversation was started. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time + attr_accessor :type def initialize(**args) update!(**args) @@ -2129,85 +1935,9 @@ module Google # Update properties of this object def update!(**args) - @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile) - @end_time = args[:end_time] if args.key?(:end_time) - @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state) - @name = args[:name] if args.key?(:name) - @phone_number = args[:phone_number] if args.key?(:phone_number) - @start_time = args[:start_time] if args.key?(:start_time) - end - end - - # Represents a phone number for telephony integration. It allows for connecting - # a particular conversation over telephony. - class GoogleCloudDialogflowV2beta1ConversationPhoneNumber - include Google::Apis::Core::Hashable - - # Output only. The phone number to connect to this conversation. - # Corresponds to the JSON property `phoneNumber` - # @return [String] - attr_accessor :phone_number - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @phone_number = args[:phone_number] if args.key?(:phone_number) - end - end - - # Defines the services to connect to incoming Dialogflow conversations. - class GoogleCloudDialogflowV2beta1ConversationProfile - include Google::Apis::Core::Hashable - - # Defines the Automated Agent to connect to a conversation. - # Corresponds to the JSON property `automatedAgentConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentConfig] - attr_accessor :automated_agent_config - - # Required. Human readable name for this profile. Max length 1024 bytes. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Defines the Human Agent Assistant to connect to a conversation. - # Corresponds to the JSON property `humanAgentAssistantConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig] - attr_accessor :human_agent_assistant_config - - # Defines logging behavior for conversation lifecycle events. - # Corresponds to the JSON property `loggingConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1LoggingConfig] - attr_accessor :logging_config - - # Required for all methods except `create` (`create` populates the name - # automatically). - # The unique identifier of this conversation profile. - # Format: `projects//conversationProfiles/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Defines notification behavior for conversation lifecycle events. - # Corresponds to the JSON property `notificationConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1NotificationConfig] - attr_accessor :notification_config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @automated_agent_config = args[:automated_agent_config] if args.key?(:automated_agent_config) - @display_name = args[:display_name] if args.key?(:display_name) - @human_agent_assistant_config = args[:human_agent_assistant_config] if args.key?(:human_agent_assistant_config) - @logging_config = args[:logging_config] if args.key?(:logging_config) - @name = args[:name] if args.key?(:name) - @notification_config = args[:notification_config] if args.key?(:notification_config) + @conversation = args[:conversation] if args.key?(:conversation) + @error_status = args[:error_status] if args.key?(:error_status) + @type = args[:type] if args.key?(:type) end end @@ -2623,20 +2353,21 @@ module Google end end - # Defines FAQ responses that a human agent assistant can provide. - class GoogleCloudDialogflowV2beta1FaqAnswersConfig + # Represents a notification sent to Cloud Pub/Sub subscribers for + # agent assistant events in a specific conversation. + class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent include Google::Apis::Core::Hashable - # Required. Settings for knowledge base, Format: - # `projects//knowledgeBases/`. - # Corresponds to the JSON property `knowledgeBaseName` + # Required. The conversation this notification refers to. + # Format: `projects//conversations/`. + # Corresponds to the JSON property `conversation` # @return [String] - attr_accessor :knowledge_base_name + attr_accessor :conversation - # Optional. Maximum number of results to return. If unset, defaults to 10. - # Corresponds to the JSON property `maxResults` - # @return [Fixnum] - attr_accessor :max_results + # Required. The type of the event that this notification refers to. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type def initialize(**args) update!(**args) @@ -2644,72 +2375,8 @@ module Google # Update properties of this object def update!(**args) - @knowledge_base_name = args[:knowledge_base_name] if args.key?(:knowledge_base_name) - @max_results = args[:max_results] if args.key?(:max_results) - end - end - - # Represents a human agent assistant that provides suggestions to help - # human agents to resolve customer issues. This defines the types of content - # that the human agent assistant can present to a human agent. - class GoogleCloudDialogflowV2beta1HumanAgentAssistant - include Google::Apis::Core::Hashable - - # Defines article suggestions that a human agent assistant can provide. - # Corresponds to the JSON property `articleSuggestionConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ArticleSuggestionConfig] - attr_accessor :article_suggestion_config - - # Defines FAQ responses that a human agent assistant can provide. - # Corresponds to the JSON property `faqAnswersConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1FaqAnswersConfig] - attr_accessor :faq_answers_config - - # Required for all methods except `create` (`create` populates the name - # automatically). - # The unique identifier of human agent assistant. - # Format: `projects//humanAgentAssistants/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @article_suggestion_config = args[:article_suggestion_config] if args.key?(:article_suggestion_config) - @faq_answers_config = args[:faq_answers_config] if args.key?(:faq_answers_config) - @name = args[:name] if args.key?(:name) - end - end - - # Defines the Human Agent Assistant to connect to a conversation. - class GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig - include Google::Apis::Core::Hashable - - # Required. ID of the agent assistant to use. - # Format: `projects//humanAgentAssistants/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Defines notification behavior for conversation lifecycle events. - # Corresponds to the JSON property `notificationConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1NotificationConfig] - attr_accessor :notification_config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @notification_config = args[:notification_config] if args.key?(:notification_config) + @conversation = args[:conversation] if args.key?(:conversation) + @type = args[:type] if args.key?(:type) end end @@ -2753,34 +2420,6 @@ module Google end end - # Represents the natural language speech audio to be processed. - class GoogleCloudDialogflowV2beta1InputAudio - include Google::Apis::Core::Hashable - - # Required. The natural language speech audio to be processed. - # A single request can contain up to 1 minute of speech audio data. - # The transcribed text cannot contain more than 256 bytes. - # Corresponds to the JSON property `audio` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :audio - - # Instructs the speech recognizer how to process the audio content. - # Corresponds to the JSON property `config` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudioConfig] - attr_accessor :config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audio = args[:audio] if args.key?(:audio) - @config = args[:config] if args.key?(:config) - end - end - # Instructs the speech recognizer how to process the audio content. class GoogleCloudDialogflowV2beta1InputAudioConfig include Google::Apis::Core::Hashable @@ -2849,55 +2488,6 @@ module Google end end - # Represents the natural language text to be processed. - class GoogleCloudDialogflowV2beta1InputText - include Google::Apis::Core::Hashable - - # Required. The language of this conversational query. See [Language - # Support](https://dialogflow.com/docs/languages) for a list of the - # currently supported language codes. - # Corresponds to the JSON property `languageCode` - # @return [String] - attr_accessor :language_code - - # Required. The UTF-8 encoded natural language text to be processed. - # Text length must not exceed 256 bytes. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @language_code = args[:language_code] if args.key?(:language_code) - @text = args[:text] if args.key?(:text) - end - end - - # Defines the language used in the input text. - class GoogleCloudDialogflowV2beta1InputTextConfig - include Google::Apis::Core::Hashable - - # Required. The language of this conversational query. See [Language - # Support](https://dialogflow.com/docs/languages) for a list of the - # currently supported language codes. - # Corresponds to the JSON property `languageCode` - # @return [String] - attr_accessor :language_code - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @language_code = args[:language_code] if args.key?(:language_code) - end - end - # Represents an intent. # Intents convert a number of user expressions or patterns into an action. An # action is an extraction of a user command or sentence semantics. @@ -4123,60 +3713,6 @@ module Google end end - # The response message for ConversationProfiles.ListConversationProfiles. - class GoogleCloudDialogflowV2beta1ListConversationProfilesResponse - include Google::Apis::Core::Hashable - - # The list of project conversation profiles. There is a maximum number - # of items returned based on the page_size field in the request. - # Corresponds to the JSON property `conversationProfiles` - # @return [Array] - attr_accessor :conversation_profiles - - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @conversation_profiles = args[:conversation_profiles] if args.key?(:conversation_profiles) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # The response message for Conversations.ListConversations. - class GoogleCloudDialogflowV2beta1ListConversationsResponse - include Google::Apis::Core::Hashable - - # The list of conversations. There will be a maximum number of items - # returned based on the page_size field in the request. - # Corresponds to the JSON property `conversations` - # @return [Array] - attr_accessor :conversations - - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @conversations = args[:conversations] if args.key?(:conversations) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - # Response message for Documents.ListDocuments. class GoogleCloudDialogflowV2beta1ListDocumentsResponse include Google::Apis::Core::Hashable @@ -4230,33 +3766,6 @@ module Google end end - # The response message for HumanAgentAssistants.ListHumanAgentAssistants. - class GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse - include Google::Apis::Core::Hashable - - # The list of project agent assistants. There is a maximum number of - # items returned based on the page_size field in the request. - # Corresponds to the JSON property `humanAgentAssistants` - # @return [Array] - attr_accessor :human_agent_assistants - - # Token to retrieve the next page of results or empty if there are no - # more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @human_agent_assistants = args[:human_agent_assistants] if args.key?(:human_agent_assistants) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - # The response message for Intents.ListIntents. class GoogleCloudDialogflowV2beta1ListIntentsResponse include Google::Apis::Core::Hashable @@ -4310,114 +3819,6 @@ module Google end end - # The response message for Conversations.ListMessages. - class GoogleCloudDialogflowV2beta1ListMessagesResponse - include Google::Apis::Core::Hashable - - # Required. The list of messages. There will be a maximum number of items - # returned based on the page_size field in the request. - # Corresponds to the JSON property `messages` - # @return [Array] - attr_accessor :messages - - # Optional. Token to retrieve the next page of results, or empty if there are - # no more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @messages = args[:messages] if args.key?(:messages) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # The response message for Conversations.ListParticipants. - class GoogleCloudDialogflowV2beta1ListParticipantsResponse - include Google::Apis::Core::Hashable - - # Token to retrieve the next page of results or empty if there are no - # more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The list of participants. There is a maximum number of items - # returned based on the page_size field in the request. - # Corresponds to the JSON property `participants` - # @return [Array] - attr_accessor :participants - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @participants = args[:participants] if args.key?(:participants) - end - end - - # The response message for PhoneNumberOrders.ListPhoneNumberOrders. - class GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse - include Google::Apis::Core::Hashable - - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The list of orders. There is a maximum number of items returned based - # on the page_size field in the request. - # Corresponds to the JSON property `phoneNumberOrders` - # @return [Array] - attr_accessor :phone_number_orders - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @phone_number_orders = args[:phone_number_orders] if args.key?(:phone_number_orders) - end - end - - # The response message for PhoneNumbers.ListPhoneNumbers. - class GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse - include Google::Apis::Core::Hashable - - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The list of `PhoneNumber` resources. There is a maximum number of items - # returned based on the page_size field in the request. - # Corresponds to the JSON property `phoneNumbers` - # @return [Array] - attr_accessor :phone_numbers - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @phone_numbers = args[:phone_numbers] if args.key?(:phone_numbers) - end - end - # The response message for SessionEntityTypes.ListSessionEntityTypes. class GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse include Google::Apis::Core::Hashable @@ -4445,128 +3846,6 @@ module Google end end - # The response message for [Conversations.ListSuggestions] - class GoogleCloudDialogflowV2beta1ListSuggestionsResponse - include Google::Apis::Core::Hashable - - # Optional. Token to retrieve the next page of results or empty if there are - # no more results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Required. - # Corresponds to the JSON property `suggestions` - # @return [Array] - attr_accessor :suggestions - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @suggestions = args[:suggestions] if args.key?(:suggestions) - end - end - - # Defines logging behavior for conversation lifecycle events. - class GoogleCloudDialogflowV2beta1LoggingConfig - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # Represents a message posted into a conversation. - class GoogleCloudDialogflowV2beta1Message - include Google::Apis::Core::Hashable - - # Required. The message content. - # Corresponds to the JSON property `content` - # @return [String] - attr_accessor :content - - # Optional. The time when the message was sent. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Required. The message language. - # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag. Example: "en-US". - # Corresponds to the JSON property `languageCode` - # @return [String] - attr_accessor :language_code - - # Required. The unique identifier of the message. - # Format: `projects//conversations//messages/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Required. The participant that said this message. - # Corresponds to the JSON property `participant` - # @return [String] - attr_accessor :participant - - # Optional. The role of the participant. - # Corresponds to the JSON property `participantRole` - # @return [String] - attr_accessor :participant_role - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @content = args[:content] if args.key?(:content) - @create_time = args[:create_time] if args.key?(:create_time) - @language_code = args[:language_code] if args.key?(:language_code) - @name = args[:name] if args.key?(:name) - @participant = args[:participant] if args.key?(:participant) - @participant_role = args[:participant_role] if args.key?(:participant_role) - end - end - - # Defines notification behavior for conversation lifecycle events. - class GoogleCloudDialogflowV2beta1NotificationConfig - include Google::Apis::Core::Hashable - - # Optional. Name of the Cloud Pub/Sub topic to publish conversation - # events like - # CONVERSATION_STARTED as - # serialized ConversationEvent protos. - # If enable_notifications is - # `true` and no topic is supplied, a new topic is created and listed - # here. - # Notification works for phone calls, if this topic either is in the same - # project as the conversation or you grant `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow Service - # Agent` role in the topic project. - # Format: `projects//topics/`. - # Corresponds to the JSON property `topic` - # @return [String] - attr_accessor :topic - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @topic = args[:topic] if args.key?(:topic) - end - end - # Represents the contents of the original request that was passed to # the `[Streaming]DetectIntent` call. class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest @@ -4612,32 +3891,6 @@ module Google end end - # Represents the natural language speech audio to be played to the end user. - class GoogleCloudDialogflowV2beta1OutputAudio - include Google::Apis::Core::Hashable - - # Required. The natural language speech audio. - # Corresponds to the JSON property `audio` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :audio - - # Instructs the speech synthesizer how to generate the output audio content. - # Corresponds to the JSON property `config` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig] - attr_accessor :config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audio = args[:audio] if args.key?(:audio) - @config = args[:config] if args.key?(:config) - end - end - # Instructs the speech synthesizer how to generate the output audio content. class GoogleCloudDialogflowV2beta1OutputAudioConfig include Google::Apis::Core::Hashable @@ -4673,170 +3926,6 @@ module Google end end - # Represents a single side of the conversation. - class GoogleCloudDialogflowV2beta1Participant - include Google::Apis::Core::Hashable - - # Required. The unique identifier of this participant. - # Format: `projects//conversations//participants/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Required. The role this participant plays in the conversation. - # Corresponds to the JSON property `role` - # @return [String] - attr_accessor :role - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @role = args[:role] if args.key?(:role) - end - end - - # Represents a phone number. - # `PhoneNumber` resources enable phone calls to be answered by Dialogflow - # services and are added to a project through a `PhoneNumberOrder`. - class GoogleCloudDialogflowV2beta1PhoneNumber - include Google::Apis::Core::Hashable - - # Optional. The conversation profile calls to this `PhoneNumber` should use. - # Format: `projects//conversationProfiles/`. - # Corresponds to the JSON property `conversationProfile` - # @return [String] - attr_accessor :conversation_profile - - # Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. - # `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming - # calls and can be removed completely within 30 days. - # Corresponds to the JSON property `lifecycleState` - # @return [String] - attr_accessor :lifecycle_state - - # Required. The unique identifier of this phone number. - # Format: `projects//phoneNumbers/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) - # format. An example of a correctly formatted phone number: +15556767888. - # Corresponds to the JSON property `phoneNumber` - # @return [String] - attr_accessor :phone_number - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile) - @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state) - @name = args[:name] if args.key?(:name) - @phone_number = args[:phone_number] if args.key?(:phone_number) - end - end - - # Represents a phone number order. - # Orders can assign phone numbers to projects. - class GoogleCloudDialogflowV2beta1PhoneNumberOrder - include Google::Apis::Core::Hashable - - # Output only. The time this order was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Optional. A description of the order, limit is 1024 bytes. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Output only. The current status of the order. - # Corresponds to the JSON property `lifecycleState` - # @return [String] - attr_accessor :lifecycle_state - - # Required. The unique identifier of this order. - # Format: `projects//phoneNumberOrders/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Request for new numbers fitting a set of parameters. - # The country code for newly requested numbers defaults to 1 (US) until the - # service is available in other regions. - # Corresponds to the JSON property `phoneNumberSpec` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberSpec] - attr_accessor :phone_number_spec - - # Output only. A map of ordered numbers filled so far, keyed by their - # resource name. Key format: - # `projects//phoneNumbers/`. - # Value format: E.164 phone number. Output only. - # Corresponds to the JSON property `phoneNumbers` - # @return [Hash] - attr_accessor :phone_numbers - - # Output only. The time this order was last updated. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @description = args[:description] if args.key?(:description) - @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state) - @name = args[:name] if args.key?(:name) - @phone_number_spec = args[:phone_number_spec] if args.key?(:phone_number_spec) - @phone_numbers = args[:phone_numbers] if args.key?(:phone_numbers) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # Request for new numbers fitting a set of parameters. - # The country code for newly requested numbers defaults to 1 (US) until the - # service is available in other regions. - class GoogleCloudDialogflowV2beta1PhoneNumberSpec - include Google::Apis::Core::Hashable - - # Required. Total numbers requested, between 1 and 10 inclusive. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # Optional. Area codes to use. An empty list means 'any code'. Each value - # is treated as equally preferred. Each entry has a limit of 10 bytes. - # "area code" corresponds to "National Destination Code" described in - # [E.164](https://en.wikipedia.org/wiki/E.164) standard. - # Corresponds to the JSON property `preferredAreaCodes` - # @return [Array] - attr_accessor :preferred_area_codes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @preferred_area_codes = args[:preferred_area_codes] if args.key?(:preferred_area_codes) - end - end - # Represents the query input. It can contain either: # 1. An audio config which # instructs the speech recognizer how to process the speech audio. @@ -5276,327 +4365,6 @@ module Google end end - # The top-level message sent by the client to the `StreamingAnalyzeContent` - # method. - # Multiple request messages must be sent in the following order: - # 1. The first message must contain `participant` and `config` fields. To - # receive an audio response, the first message must also contain the - # `reply_audio_config` field. The first message must not contain `input`. - # 2. All subsequent messages must contain only input data. Specifically: - # - If the `config` in the first message was set to `audio_config`, then - # all subsequent messages must contain only `input_audio`. It is a good - # practice to split the input audio into short chunks and deliver each - # chunk in a separate message. - # - If the `config` in the first message was set to `text_config`, then - # the second message must contain only `input_text`. Moreover, the - # `input_text` field can be only sent once. - # After all input is delivered, the client must half-close, or abort the - # request stream. - class GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest - include Google::Apis::Core::Hashable - - # Instructs the speech recognizer how to process the audio content. - # Corresponds to the JSON property `audioConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudioConfig] - attr_accessor :audio_config - - # The input audio content to be recognized. Must be sent if `audio_config` - # is set in the first message. The complete audio over all streaming - # messages must not exceed 1 minute. - # Corresponds to the JSON property `inputAudio` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :input_audio - - # The UTF-8 encoded natural language text to be processed. Must be sent if - # `text_config` is set in the first message. Text length must not exceed - # 256 bytes. The `input_text` field can be only sent once. - # Corresponds to the JSON property `inputText` - # @return [String] - attr_accessor :input_text - - # Instructs the speech synthesizer how to generate the output audio content. - # Corresponds to the JSON property `replyAudioConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig] - attr_accessor :reply_audio_config - - # Defines the language used in the input text. - # Corresponds to the JSON property `textConfig` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputTextConfig] - attr_accessor :text_config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audio_config = args[:audio_config] if args.key?(:audio_config) - @input_audio = args[:input_audio] if args.key?(:input_audio) - @input_text = args[:input_text] if args.key?(:input_text) - @reply_audio_config = args[:reply_audio_config] if args.key?(:reply_audio_config) - @text_config = args[:text_config] if args.key?(:text_config) - end - end - - # The top-level message returned from the `StreamingAnalyzeContent` method. - # Multiple response messages can be returned in order: - # 1. If the input was set to streaming audio, the first one or more messages - # contain `recognition_result`. Each `recognition_result` represents a more - # complete transcript of what the user said. The last `recognition_result` - # has `is_final` set to `true`. - # 2. The next message contains `reply_text` and optionally `reply_audio` - # returned by an agent. This message may also contain - # `automated_agent_reply`. - class GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse - include Google::Apis::Core::Hashable - - # Represent a response from an automated agent. - # Corresponds to the JSON property `automatedAgentReply` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply] - attr_accessor :automated_agent_reply - - # Contains a speech recognition result corresponding to a portion of the audio - # that is currently being processed or an indication that this is the end - # of the single requested utterance. - # Example: - # 1. transcript: "tube" - # 2. transcript: "to be a" - # 3. transcript: "to be" - # 4. transcript: "to be or not to be" - # is_final: true - # 5. transcript: " that's" - # 6. transcript: " that is" - # 7. recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE` - # 8. transcript: " that is the question" - # is_final: true - # Only two of the responses contain final results (#4 and #8 indicated by - # `is_final: true`). Concatenating these generates the full transcript: "to be - # or not to be that is the question". - # In each response we populate: - # * for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`. - # * for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`. - # Corresponds to the JSON property `recognitionResult` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingRecognitionResult] - attr_accessor :recognition_result - - # Represents the natural language speech audio to be played to the end user. - # Corresponds to the JSON property `replyAudio` - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudio] - attr_accessor :reply_audio - - # Optional. The output text content. - # This field is set if an automated agent responded with a text for the user. - # Corresponds to the JSON property `replyText` - # @return [String] - attr_accessor :reply_text - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @automated_agent_reply = args[:automated_agent_reply] if args.key?(:automated_agent_reply) - @recognition_result = args[:recognition_result] if args.key?(:recognition_result) - @reply_audio = args[:reply_audio] if args.key?(:reply_audio) - @reply_text = args[:reply_text] if args.key?(:reply_text) - end - end - - # Contains a speech recognition result corresponding to a portion of the audio - # that is currently being processed or an indication that this is the end - # of the single requested utterance. - # Example: - # 1. transcript: "tube" - # 2. transcript: "to be a" - # 3. transcript: "to be" - # 4. transcript: "to be or not to be" - # is_final: true - # 5. transcript: " that's" - # 6. transcript: " that is" - # 7. recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE` - # 8. transcript: " that is the question" - # is_final: true - # Only two of the responses contain final results (#4 and #8 indicated by - # `is_final: true`). Concatenating these generates the full transcript: "to be - # or not to be that is the question". - # In each response we populate: - # * for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`. - # * for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`. - class GoogleCloudDialogflowV2beta1StreamingRecognitionResult - include Google::Apis::Core::Hashable - - # The Speech confidence between 0.0 and 1.0 for the current portion of audio. - # A higher number indicates an estimated greater likelihood that the - # recognized words are correct. The default of 0.0 is a sentinel value - # indicating that confidence was not set. - # This field is typically only provided if `is_final` is true and you should - # not rely on it being accurate or even set. - # Corresponds to the JSON property `confidence` - # @return [Float] - attr_accessor :confidence - - # The default of 0.0 is a sentinel value indicating `confidence` was not set. - # If `false`, the `StreamingRecognitionResult` represents an - # interim result that may change. If `true`, the recognizer will not return - # any further hypotheses about this piece of the audio. May only be populated - # for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. - # Corresponds to the JSON property `isFinal` - # @return [Boolean] - attr_accessor :is_final - alias_method :is_final?, :is_final - - # Type of the result message. - # Corresponds to the JSON property `messageType` - # @return [String] - attr_accessor :message_type - - # Transcript text representing the words that the user spoke. - # Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. - # Corresponds to the JSON property `transcript` - # @return [String] - attr_accessor :transcript - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @confidence = args[:confidence] if args.key?(:confidence) - @is_final = args[:is_final] if args.key?(:is_final) - @message_type = args[:message_type] if args.key?(:message_type) - @transcript = args[:transcript] if args.key?(:transcript) - end - end - - # Represents a suggestion for a human agent. - class GoogleCloudDialogflowV2beta1Suggestion - include Google::Apis::Core::Hashable - - # Output only. Articles ordered by score in descending order. - # Corresponds to the JSON property `articles` - # @return [Array] - attr_accessor :articles - - # Output only. The time the suggestion was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Optional. Answers extracted from FAQ documents. - # Corresponds to the JSON property `faqAnswers` - # @return [Array] - attr_accessor :faq_answers - - # Output only. The name of this suggestion. Format: - # `projects//conversations//participants/*/suggestions/`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @articles = args[:articles] if args.key?(:articles) - @create_time = args[:create_time] if args.key?(:create_time) - @faq_answers = args[:faq_answers] if args.key?(:faq_answers) - @name = args[:name] if args.key?(:name) - end - end - - # Represents suggested article. - class GoogleCloudDialogflowV2beta1SuggestionArticle - include Google::Apis::Core::Hashable - - # Output only. A map that contains metadata about the answer and the - # document from which it originates. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # Output only. Article snippets. - # Corresponds to the JSON property `snippets` - # @return [Array] - attr_accessor :snippets - - # Output only. The article title. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # Output only. The article URI. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @metadata = args[:metadata] if args.key?(:metadata) - @snippets = args[:snippets] if args.key?(:snippets) - @title = args[:title] if args.key?(:title) - @uri = args[:uri] if args.key?(:uri) - end - end - - # Represents suggested answer from "frequently asked questions". - class GoogleCloudDialogflowV2beta1SuggestionFaqAnswer - include Google::Apis::Core::Hashable - - # Output only. The piece of text from the `source` knowledge base document. - # Corresponds to the JSON property `answer` - # @return [String] - attr_accessor :answer - - # The system's confidence score that this Knowledge answer is a good match - # for this conversational query, range from 0.0 (completely uncertain) - # to 1.0 (completely certain). - # Corresponds to the JSON property `confidence` - # @return [Float] - attr_accessor :confidence - - # Output only. A map that contains metadata about the answer and the - # document from which it originates. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # Output only. The corresponding FAQ question. - # Corresponds to the JSON property `question` - # @return [String] - attr_accessor :question - - # Output only. Indicates which Knowledge Document this answer was extracted - # from. - # Format: `projects//agent/knowledgeBases//documents/`. - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @answer = args[:answer] if args.key?(:answer) - @confidence = args[:confidence] if args.key?(:confidence) - @metadata = args[:metadata] if args.key?(:metadata) - @question = args[:question] if args.key?(:question) - @source = args[:source] if args.key?(:source) - end - end - # Configuration of how speech should be synthesized. class GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig include Google::Apis::Core::Hashable @@ -5696,19 +4464,6 @@ module Google end end - # The request message for PhoneNumbers.UndeletePhoneNumber. - class GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - # Description of which voice to use for speech synthesis. class GoogleCloudDialogflowV2beta1VoiceSelectionParams include Google::Apis::Core::Hashable @@ -5767,7 +4522,9 @@ module Google # The unique identifier of detectIntent request session. # Can be used to identify end-user inside webhook implementation. - # Format: `projects//agent/sessions/`. + # Format: `projects//agent/sessions/`, or + # `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session diff --git a/generated/google/apis/dialogflow_v2beta1/representations.rb b/generated/google/apis/dialogflow_v2beta1/representations.rb index 3a8bc1ed0..42555c170 100644 --- a/generated/google/apis/dialogflow_v2beta1/representations.rb +++ b/generated/google/apis/dialogflow_v2beta1/representations.rb @@ -232,48 +232,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1Agent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1AnalyzeContentRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1AnalyzeContentResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ArticleSuggestionConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1AutomatedAgentConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1AutomatedAgentReply - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -328,49 +292,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1CompileSuggestionsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1CompileSuggestionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1CompleteConversationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1Context class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1Conversation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ConversationPhoneNumber - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ConversationProfile + class GoogleCloudDialogflowV2beta1ConversationEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -430,19 +358,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1FaqAnswersConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1HumanAgentAssistant - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig + class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -454,30 +370,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1InputAudio - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1InputAudioConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1InputText - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1InputTextConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1Intent class Representation < Google::Apis::Core::JsonRepresentation; end @@ -676,18 +574,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1ListConversationProfilesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ListConversationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1ListDocumentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -700,12 +586,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1ListIntentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -718,102 +598,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1ListMessagesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ListParticipantsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1ListSuggestionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1LoggingConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1Message - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1NotificationConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1OutputAudio - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1OutputAudioConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1Participant - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1PhoneNumber - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1PhoneNumberOrder - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1PhoneNumberSpec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1QueryInput class Representation < Google::Apis::Core::JsonRepresentation; end @@ -868,42 +670,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1StreamingRecognitionResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1Suggestion - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1SuggestionArticle - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowV2beta1SuggestionFaqAnswer - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -922,12 +688,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowV2beta1VoiceSelectionParams class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1351,12 +1111,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - class GoogleCloudDialogflowV2beta1Agent # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1373,51 +1127,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1AnalyzeContentRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :audio, as: 'audio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudio::Representation - - property :reply_audio_config, as: 'replyAudioConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig::Representation - - property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputText, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputText::Representation - - end - end - - class GoogleCloudDialogflowV2beta1AnalyzeContentResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :automated_agent_reply, as: 'automatedAgentReply', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply::Representation - - property :reply_audio, as: 'replyAudio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudio::Representation - - property :reply_text, as: 'replyText' - end - end - - class GoogleCloudDialogflowV2beta1ArticleSuggestionConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :knowledge_base_name, as: 'knowledgeBaseName' - end - end - - class GoogleCloudDialogflowV2beta1AutomatedAgentConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :agent, as: 'agent' - end - end - - class GoogleCloudDialogflowV2beta1AutomatedAgentReply - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :detect_intent_response, as: 'detectIntentResponse', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse::Representation - - end - end - class GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1499,34 +1208,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleCloudDialogflowV2beta1CompileSuggestionsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Message, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Message::Representation - - end - end - - class GoogleCloudDialogflowV2beta1CompileSuggestionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Suggestion, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Suggestion::Representation - - end - end - - class GoogleCloudDialogflowV2beta1CompleteConversationRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - class GoogleCloudDialogflowV2beta1Context # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1536,39 +1217,13 @@ module Google end end - class GoogleCloudDialogflowV2beta1Conversation + class GoogleCloudDialogflowV2beta1ConversationEvent # @private class Representation < Google::Apis::Core::JsonRepresentation - property :conversation_profile, as: 'conversationProfile' - property :end_time, as: 'endTime' - property :lifecycle_state, as: 'lifecycleState' - property :name, as: 'name' - property :phone_number, as: 'phoneNumber', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber::Representation - - property :start_time, as: 'startTime' - end - end - - class GoogleCloudDialogflowV2beta1ConversationPhoneNumber - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :phone_number, as: 'phoneNumber' - end - end - - class GoogleCloudDialogflowV2beta1ConversationProfile - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :automated_agent_config, as: 'automatedAgentConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentConfig::Representation - - property :display_name, as: 'displayName' - property :human_agent_assistant_config, as: 'humanAgentAssistantConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig::Representation - - property :logging_config, as: 'loggingConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1LoggingConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1LoggingConfig::Representation - - property :name, as: 'name' - property :notification_config, as: 'notificationConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1NotificationConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1NotificationConfig::Representation + property :conversation, as: 'conversation' + property :error_status, as: 'errorStatus', class: Google::Apis::DialogflowV2beta1::GoogleRpcStatus, decorator: Google::Apis::DialogflowV2beta1::GoogleRpcStatus::Representation + property :type, as: 'type' end end @@ -1666,31 +1321,11 @@ module Google end end - class GoogleCloudDialogflowV2beta1FaqAnswersConfig + class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent # @private class Representation < Google::Apis::Core::JsonRepresentation - property :knowledge_base_name, as: 'knowledgeBaseName' - property :max_results, as: 'maxResults' - end - end - - class GoogleCloudDialogflowV2beta1HumanAgentAssistant - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :article_suggestion_config, as: 'articleSuggestionConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ArticleSuggestionConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ArticleSuggestionConfig::Representation - - property :faq_answers_config, as: 'faqAnswersConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1FaqAnswersConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1FaqAnswersConfig::Representation - - property :name, as: 'name' - end - end - - class GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :notification_config, as: 'notificationConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1NotificationConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1NotificationConfig::Representation - + property :conversation, as: 'conversation' + property :type, as: 'type' end end @@ -1702,15 +1337,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1InputAudio - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :audio, :base64 => true, as: 'audio' - property :config, as: 'config', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudioConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudioConfig::Representation - - end - end - class GoogleCloudDialogflowV2beta1InputAudioConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1722,21 +1348,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1InputText - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :language_code, as: 'languageCode' - property :text, as: 'text' - end - end - - class GoogleCloudDialogflowV2beta1InputTextConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :language_code, as: 'languageCode' - end - end - class GoogleCloudDialogflowV2beta1Intent # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2078,24 +1689,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1ListConversationProfilesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :conversation_profiles, as: 'conversationProfiles', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class GoogleCloudDialogflowV2beta1ListConversationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :conversations, as: 'conversations', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - class GoogleCloudDialogflowV2beta1ListDocumentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2114,15 +1707,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :human_agent_assistants, as: 'humanAgentAssistants', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - class GoogleCloudDialogflowV2beta1ListIntentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2141,42 +1725,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1ListMessagesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Message, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Message::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class GoogleCloudDialogflowV2beta1ListParticipantsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :participants, as: 'participants', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation - - end - end - - class GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :phone_number_orders, as: 'phoneNumberOrders', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder::Representation - - end - end - - class GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :phone_numbers, as: 'phoneNumbers', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber::Representation - - end - end - class GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2186,40 +1734,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1ListSuggestionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Suggestion, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Suggestion::Representation - - end - end - - class GoogleCloudDialogflowV2beta1LoggingConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleCloudDialogflowV2beta1Message - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :content, as: 'content' - property :create_time, as: 'createTime' - property :language_code, as: 'languageCode' - property :name, as: 'name' - property :participant, as: 'participant' - property :participant_role, as: 'participantRole' - end - end - - class GoogleCloudDialogflowV2beta1NotificationConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :topic, as: 'topic' - end - end - class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2229,15 +1743,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1OutputAudio - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :audio, :base64 => true, as: 'audio' - property :config, as: 'config', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig::Representation - - end - end - class GoogleCloudDialogflowV2beta1OutputAudioConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2248,46 +1753,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1Participant - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :role, as: 'role' - end - end - - class GoogleCloudDialogflowV2beta1PhoneNumber - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :conversation_profile, as: 'conversationProfile' - property :lifecycle_state, as: 'lifecycleState' - property :name, as: 'name' - property :phone_number, as: 'phoneNumber' - end - end - - class GoogleCloudDialogflowV2beta1PhoneNumberOrder - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :description, as: 'description' - property :lifecycle_state, as: 'lifecycleState' - property :name, as: 'name' - property :phone_number_spec, as: 'phoneNumberSpec', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberSpec, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberSpec::Representation - - hash :phone_numbers, as: 'phoneNumbers' - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudDialogflowV2beta1PhoneNumberSpec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, as: 'count' - collection :preferred_area_codes, as: 'preferredAreaCodes' - end - end - class GoogleCloudDialogflowV2beta1QueryInput # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2395,76 +1860,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :audio_config, as: 'audioConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudioConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputAudioConfig::Representation - - property :input_audio, :base64 => true, as: 'inputAudio' - property :input_text, as: 'inputText' - property :reply_audio_config, as: 'replyAudioConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig::Representation - - property :text_config, as: 'textConfig', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputTextConfig, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1InputTextConfig::Representation - - end - end - - class GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :automated_agent_reply, as: 'automatedAgentReply', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AutomatedAgentReply::Representation - - property :recognition_result, as: 'recognitionResult', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingRecognitionResult, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingRecognitionResult::Representation - - property :reply_audio, as: 'replyAudio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudio::Representation - - property :reply_text, as: 'replyText' - end - end - - class GoogleCloudDialogflowV2beta1StreamingRecognitionResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :confidence, as: 'confidence' - property :is_final, as: 'isFinal' - property :message_type, as: 'messageType' - property :transcript, as: 'transcript' - end - end - - class GoogleCloudDialogflowV2beta1Suggestion - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :articles, as: 'articles', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestionArticle, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestionArticle::Representation - - property :create_time, as: 'createTime' - collection :faq_answers, as: 'faqAnswers', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestionFaqAnswer, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestionFaqAnswer::Representation - - property :name, as: 'name' - end - end - - class GoogleCloudDialogflowV2beta1SuggestionArticle - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :metadata, as: 'metadata' - collection :snippets, as: 'snippets' - property :title, as: 'title' - property :uri, as: 'uri' - end - end - - class GoogleCloudDialogflowV2beta1SuggestionFaqAnswer - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :answer, as: 'answer' - property :confidence, as: 'confidence' - hash :metadata, as: 'metadata' - property :question, as: 'question' - property :source, as: 'source' - end - end - class GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2491,12 +1886,6 @@ module Google end end - class GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - class GoogleCloudDialogflowV2beta1VoiceSelectionParams # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dialogflow_v2beta1/service.rb b/generated/google/apis/dialogflow_v2beta1/service.rb index 4389e79e4..a05367a65 100644 --- a/generated/google/apis/dialogflow_v2beta1/service.rb +++ b/generated/google/apis/dialogflow_v2beta1/service.rb @@ -22,8 +22,8 @@ module Google module DialogflowV2beta1 # Dialogflow API # - # An end-to-end development suite for conversational interfaces (e.g., chatbots, - # voice-powered apps and devices). + # Builds conversational interfaces (for example, chatbots, and voice-powered + # apps and devices). # # @example # require 'google/apis/dialogflow_v2beta1' @@ -2150,637 +2150,6 @@ module Google execute_or_queue_command(command, &block) end - # Creates a conversation profile in the specified project. - # @param [String] parent - # Required. The project to create a conversation profile for. - # Format: `projects/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] google_cloud_dialogflow_v2beta1_conversation_profile_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_conversation_profile(parent, google_cloud_dialogflow_v2beta1_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+parent}/conversationProfiles', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation - command.request_object = google_cloud_dialogflow_v2beta1_conversation_profile_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the specified conversation profile. - # @param [String] name - # Required. The name of the conversation profile to delete. - # Format: `projects//conversationProfiles/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves the specified conversation profile. - # @param [String] name - # Required. The resource name of the conversation profile. - # Format: `projects//conversationProfiles/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the list of all conversation profiles in the specified project. - # @param [String] parent - # Required. The project to list all conversation profiles from. - # Format: `projects/`. - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_conversation_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/conversationProfiles', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the specified conversation profile. - # @param [String] name - # Required for all methods except `create` (`create` populates the name - # automatically). - # The unique identifier of this conversation profile. - # Format: `projects//conversationProfiles/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] google_cloud_dialogflow_v2beta1_conversation_profile_object - # @param [String] update_mask - # Required. The mask to control which fields to update. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_conversation_profile(name, google_cloud_dialogflow_v2beta1_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v2beta1/{+name}', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation - command.request_object = google_cloud_dialogflow_v2beta1_conversation_profile_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Sets a phone number for this converstion to connect to. - # @param [String] name - # The name of this conversation. - # Format: `projects//conversations/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest] google_cloud_dialogflow_v2beta1_add_conversation_phone_number_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def add_project_conversation_conversation_phone_number(name, google_cloud_dialogflow_v2beta1_add_conversation_phone_number_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+name}:addConversationPhoneNumber', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_add_conversation_phone_number_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationPhoneNumber - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Completes the specified conversation. Finished conversations are purged - # from the database after 30 days. - # @param [String] name - # Required. Resource identifier of the conversation to close. - # Format: `projects//conversations/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompleteConversationRequest] google_cloud_dialogflow_v2beta1_complete_conversation_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def complete_project_conversation(name, google_cloud_dialogflow_v2beta1_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+name}:complete', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompleteConversationRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_complete_conversation_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new conversation. Conversation are auto-completed after 24 hours. - # @param [String] parent - # Required. Resource identifier of the project creating the conversation. - # Format: `projects/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] google_cloud_dialogflow_v2beta1_conversation_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_conversation(parent, google_cloud_dialogflow_v2beta1_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+parent}/conversations', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation - command.request_object = google_cloud_dialogflow_v2beta1_conversation_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves the specific conversation. - # @param [String] name - # Required. The name of the conversation. Format: - # `projects//conversations/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_conversation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the list of all conversations in the specified project. - # @param [String] parent - # Required. The project from which to list all conversation. - # Format: `projects/`. - # @param [String] filter - # A filter expression that filters conversations listed in the response. In - # general, the expression must specify the field name, a comparison operator, - # and the value to use for filtering: - #
    - #
  • The value must be a string, a number, or a boolean.
    • - #
  • The comparison operator must be either `=`,`!=`, `>`, or `<`.
    • - #
  • To filter on multiple expressions, separate the - # expressions with `AND` or `OR` (omitting both implies `AND`).
    • - #
  • For clarity, expressions can be enclosed in parentheses.
    • - #
- # Only `lifecycle_state` can be filtered on in this way. For example, - # the following expression only returns `FINISHED` conversations: - # `lifecycle_state = "FINISHED"` - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/conversations', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse - command.params['parent'] = parent unless parent.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists messages that belong to a given conversation. - # @param [String] parent - # Required. The name of the conversation to list messages for. - # Format: `projects//conversations/` - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_conversation_messages(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/messages', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Adds a text (chat, for example), or audio (phone recording, for example) - # message from a participan into the conversation. - # @param [String] participant - # Required. The name of the participant this text comes from. - # Format: `projects//conversations//participants/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentRequest] google_cloud_dialogflow_v2beta1_analyze_content_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def analyze_project_conversation_participant_content(participant, google_cloud_dialogflow_v2beta1_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+participant}:analyzeContent', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_analyze_content_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse - command.params['participant'] = participant unless participant.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new participant in a conversation. - # @param [String] parent - # Required. Resource identifier of the conversation adding the participant. - # Format: `projects//conversations/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant] google_cloud_dialogflow_v2beta1_participant_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_conversation_participant(parent, google_cloud_dialogflow_v2beta1_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+parent}/participants', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation - command.request_object = google_cloud_dialogflow_v2beta1_participant_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a conversation participant. - # @param [String] name - # Required. The name of the participant. Format: - # `projects//conversations//participants/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_conversation_participant(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the list of all participants in the specified conversation. - # @param [String] parent - # Required. The conversation to list all contexts from. - # Format: `projects//conversations/`. - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_conversation_participants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/participants', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Adds a text (chat, for example), or audio (phone recording, for example) - # message from a participan into the conversation. - # Note: This method is only available through the gRPC API (not REST). - # The top-level message sent to the client by the server is - # `StreamingAnalyzeContentResponse`. Multiple response messages can be - # returned in order. The first one or more messages contain the - # `recognition_result` field. Each result represents a more complete - # transcript of what the user said. The next message contains the - # `reply_text` field and potentially the `reply_audio` field. The message can - # also contain the `automated_agent_reply` field. - # @param [String] participant - # Required. The name of the participant this text comes from. - # Format: `projects//conversations//participants/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest] google_cloud_dialogflow_v2beta1_streaming_analyze_content_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def streaming_project_conversation_participant_analyze_content(participant, google_cloud_dialogflow_v2beta1_streaming_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+participant}:streamingAnalyzeContent', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_streaming_analyze_content_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse - command.params['participant'] = participant unless participant.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves suggestions for live agents. - # This method should be used by human agent client software to fetch - # suggestions in real-time, while the conversation with an end user is in - # progress. The functionality is implemented in terms of the - # [list pagination](/apis/design/design_patterns#list_pagination) - # design pattern. The client app should use the `next_page_token` field - # to fetch the next batch of suggestions. - # @param [String] parent - # Required. The name of the conversation participant for whom to fetch - # suggestions. - # Format: `projects//conversations//participants/`. - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. The - # default value is 100; the maximum value is 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_conversation_participant_suggestions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/suggestions', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Deletes all active contexts in the specified session. # @param [String] parent # Required. The name of the session to delete all contexts from. Format: @@ -3008,218 +2377,6 @@ module Google execute_or_queue_command(command, &block) end - # Uses the specified human agent assistant to come up with suggestions - # (relevant articles and FAQs) on how to respond to a given conversation. - # @param [String] name - # Required. The resource name of the agent assistant. - # Format: `projects//humanAgentAssistants/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionsRequest] google_cloud_dialogflow_v2beta1_compile_suggestions_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def compile_project_human_agent_assistant_suggestions(name, google_cloud_dialogflow_v2beta1_compile_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+name}:compileSuggestions', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionsRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_compile_suggestions_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionsResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionsResponse - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a human agent assistant. - # @param [String] parent - # Required. The project to create a agent assistant for. - # Format: `projects/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] google_cloud_dialogflow_v2beta1_human_agent_assistant_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_human_agent_assistant(parent, google_cloud_dialogflow_v2beta1_human_agent_assistant_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+parent}/humanAgentAssistants', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant::Representation - command.request_object = google_cloud_dialogflow_v2beta1_human_agent_assistant_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the specified human agent assistant. - # @param [String] name - # Required. The resource name of the agent assistant. - # Format: `projects//humanAgentAssistants/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_human_agent_assistant(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a human agent assistant. - # @param [String] name - # Required. The resource name of the agent assistant. - # Format: `projects//humanAgentAssistants/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_human_agent_assistant(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the list of all human agent assistants. - # @param [String] parent - # Required. The project to list all agent assistants from. - # Format: `projects/`. - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. - # The default value is 100; the maximum value is 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_human_agent_assistants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/humanAgentAssistants', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the specified human agent assistant. - # @param [String] name - # Required for all methods except `create` (`create` populates the name - # automatically). - # The unique identifier of human agent assistant. - # Format: `projects//humanAgentAssistants/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] google_cloud_dialogflow_v2beta1_human_agent_assistant_object - # @param [String] update_mask - # Optional. The mask to specify which fields to update. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_human_agent_assistant(name, google_cloud_dialogflow_v2beta1_human_agent_assistant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v2beta1/{+name}', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant::Representation - command.request_object = google_cloud_dialogflow_v2beta1_human_agent_assistant_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistant - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Creates a knowledge base. # @param [String] parent # Required. The project to create a knowledge base for. @@ -3529,339 +2686,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - - # Cancels an `PhoneNumberOrder`. - # Returns an error if the order is in state - # IN_PROGRESS or - # COMPLETED. - # @param [String] name - # Required. The unique identifier of the order to delete. - # Format: `projects//phoneNumberOrders/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest] google_cloud_dialogflow_v2beta1_cancel_phone_number_order_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_project_phone_number_order(name, google_cloud_dialogflow_v2beta1_cancel_phone_number_order_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+name}:cancel', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_cancel_phone_number_order_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates an order to request phone numbers be added to a project. - # The initial `LifecycleState` of a newly created order is - # PENDING. - # @param [String] parent - # Required. Resource identifier of the project requesting the orders. - # Format: `projects/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] google_cloud_dialogflow_v2beta1_phone_number_order_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_phone_number_order(parent, google_cloud_dialogflow_v2beta1_phone_number_order_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+parent}/phoneNumberOrders', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder::Representation - command.request_object = google_cloud_dialogflow_v2beta1_phone_number_order_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns a specific `PhoneNumberOrder`. - # @param [String] name - # Required. The unique identifier of the order to retrieve. - # Format: `projects//phoneNumberOrders/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_phone_number_order(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists of all `PhoneNumberOrder` resources in the specified project. - # @param [String] parent - # Required. The project to list all orders from. - # Format: `projects/`. - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. - # The default value is 100. The maximum value is 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_phone_number_orders(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/phoneNumberOrders', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the specified `PhoneNumberOrder` resource. - # Returns an error if the order is in state - # IN_PROGRESS or - # COMPLETED. - # @param [String] name - # Required. The unique identifier of this order. - # Format: `projects//phoneNumberOrders/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] google_cloud_dialogflow_v2beta1_phone_number_order_object - # @param [String] update_mask - # Optional. The mask to control which fields get updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_phone_number_order(name, google_cloud_dialogflow_v2beta1_phone_number_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v2beta1/{+name}', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder::Representation - command.request_object = google_cloud_dialogflow_v2beta1_phone_number_order_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumberOrder - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the - # DELETE_REQUESTED state - # immediately, and is deleted approximately 30 days later. This method may - # only be called on a `PhoneNumber` in the - # ACTIVE state. - # @param [String] name - # Required. The unique identifier of the `PhoneNumber` to delete. - # Format: `projects//phoneNumbers/`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_phone_number(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+name}', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the list of all phone numbers in the specified project. - # @param [String] parent - # Required. The project to list all `PhoneNumber` resources from. - # Format: `projects/`. - # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. - # The default value is 100. The maximum value is 1000. - # @param [String] page_token - # Optional. The next_page_token value returned from a previous list request. - # @param [Boolean] show_deleted - # Optional. Controls whether `PhoneNumber` resources in the - # DELETE_REQUESTED - # state should be returned. Defaults to false. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_phone_numbers(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/phoneNumbers', options) - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['showDeleted'] = show_deleted unless show_deleted.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the specified `PhoneNumber`. - # @param [String] name - # Required. The unique identifier of this phone number. - # Format: `projects//phoneNumbers/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] google_cloud_dialogflow_v2beta1_phone_number_object - # @param [String] update_mask - # Optional. The mask to control which fields get updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_phone_number(name, google_cloud_dialogflow_v2beta1_phone_number_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v2beta1/{+name}', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber::Representation - command.request_object = google_cloud_dialogflow_v2beta1_phone_number_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Cancels the deletion request for a `PhoneNumber`. This method may only be - # called on a `PhoneNumber` in the - # DELETE_REQUESTED state. - # @param [String] name - # Required. The unique identifier of the `PhoneNumber` to delete. - # Format: `projects//phoneNumbers/`. - # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest] google_cloud_dialogflow_v2beta1_undelete_phone_number_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def undelete_project_phone_number(name, google_cloud_dialogflow_v2beta1_undelete_phone_number_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/{+name}:undelete', options) - command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest::Representation - command.request_object = google_cloud_dialogflow_v2beta1_undelete_phone_number_request_object - command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber::Representation - command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1PhoneNumber - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end protected diff --git a/generated/google/apis/genomics_v1.rb b/generated/google/apis/genomics_v1.rb index 73ee434e6..8202dd6b5 100644 --- a/generated/google/apis/genomics_v1.rb +++ b/generated/google/apis/genomics_v1.rb @@ -20,12 +20,12 @@ module Google module Apis # Genomics API # - # Upload, process, query, and search Genomics data in the cloud. + # Uploads, processes, queries, and searches Genomics data in the cloud. # # @see https://cloud.google.com/genomics module GenomicsV1 VERSION = 'V1' - REVISION = '20180919' + REVISION = '20181017' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/genomics_v1/service.rb b/generated/google/apis/genomics_v1/service.rb index d8b5f07ba..a7affe812 100644 --- a/generated/google/apis/genomics_v1/service.rb +++ b/generated/google/apis/genomics_v1/service.rb @@ -22,7 +22,7 @@ module Google module GenomicsV1 # Genomics API # - # Upload, process, query, and search Genomics data in the cloud. + # Uploads, processes, queries, and searches Genomics data in the cloud. # # @example # require 'google/apis/genomics_v1' diff --git a/generated/google/apis/genomics_v1alpha2.rb b/generated/google/apis/genomics_v1alpha2.rb index 380b28004..7275712e1 100644 --- a/generated/google/apis/genomics_v1alpha2.rb +++ b/generated/google/apis/genomics_v1alpha2.rb @@ -20,12 +20,12 @@ module Google module Apis # Genomics API # - # Upload, process, query, and search Genomics data in the cloud. + # Uploads, processes, queries, and searches Genomics data in the cloud. # # @see https://cloud.google.com/genomics module GenomicsV1alpha2 VERSION = 'V1alpha2' - REVISION = '20180919' + REVISION = '20181017' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/genomics_v1alpha2/service.rb b/generated/google/apis/genomics_v1alpha2/service.rb index bd298b0a2..b4bd6c8b7 100644 --- a/generated/google/apis/genomics_v1alpha2/service.rb +++ b/generated/google/apis/genomics_v1alpha2/service.rb @@ -22,7 +22,7 @@ module Google module GenomicsV1alpha2 # Genomics API # - # Upload, process, query, and search Genomics data in the cloud. + # Uploads, processes, queries, and searches Genomics data in the cloud. # # @example # require 'google/apis/genomics_v1alpha2' diff --git a/generated/google/apis/genomics_v2alpha1.rb b/generated/google/apis/genomics_v2alpha1.rb index 8b566fbc2..fc11203a3 100644 --- a/generated/google/apis/genomics_v2alpha1.rb +++ b/generated/google/apis/genomics_v2alpha1.rb @@ -20,12 +20,12 @@ module Google module Apis # Genomics API # - # Upload, process, query, and search Genomics data in the cloud. + # Uploads, processes, queries, and searches Genomics data in the cloud. # # @see https://cloud.google.com/genomics module GenomicsV2alpha1 VERSION = 'V2alpha1' - REVISION = '20180919' + REVISION = '20181017' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/genomics_v2alpha1/service.rb b/generated/google/apis/genomics_v2alpha1/service.rb index 8846417e7..c539b45d7 100644 --- a/generated/google/apis/genomics_v2alpha1/service.rb +++ b/generated/google/apis/genomics_v2alpha1/service.rb @@ -22,7 +22,7 @@ module Google module GenomicsV2alpha1 # Genomics API # - # Upload, process, query, and search Genomics data in the cloud. + # Uploads, processes, queries, and searches Genomics data in the cloud. # # @example # require 'google/apis/genomics_v2alpha1' diff --git a/generated/google/apis/logging_v2.rb b/generated/google/apis/logging_v2.rb index 74d78112c..2de3b7c7c 100644 --- a/generated/google/apis/logging_v2.rb +++ b/generated/google/apis/logging_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/logging/docs/ module LoggingV2 VERSION = 'V2' - REVISION = '20180922' + REVISION = '20181013' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/logging_v2/classes.rb b/generated/google/apis/logging_v2/classes.rb index 347c30985..ea8848317 100644 --- a/generated/google/apis/logging_v2/classes.rb +++ b/generated/google/apis/logging_v2/classes.rb @@ -959,7 +959,8 @@ module Google # @return [Google::Apis::LoggingV2::BucketOptions] attr_accessor :bucket_options - # Optional. A description of this metric, which is used in documentation. + # Optional. A description of this metric, which is used in documentation. The + # maximum length of the description is 8000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description diff --git a/generated/google/apis/logging_v2beta1.rb b/generated/google/apis/logging_v2beta1.rb index cd96299b3..9cf85e8a2 100644 --- a/generated/google/apis/logging_v2beta1.rb +++ b/generated/google/apis/logging_v2beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/logging/docs/ module LoggingV2beta1 VERSION = 'V2beta1' - REVISION = '20180922' + REVISION = '20181013' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/logging_v2beta1/classes.rb b/generated/google/apis/logging_v2beta1/classes.rb index 9a6eb230d..cc018e9e2 100644 --- a/generated/google/apis/logging_v2beta1/classes.rb +++ b/generated/google/apis/logging_v2beta1/classes.rb @@ -478,34 +478,6 @@ module Google end end - # Result returned from ListLogs. - class ListLogsResponse - include Google::Apis::Core::Hashable - - # A list of log names. For example, "projects/my-project/syslog" or " - # organizations/123/cloudresourcemanager.googleapis.com%2Factivity". - # Corresponds to the JSON property `logNames` - # @return [Array] - attr_accessor :log_names - - # If there might be more results than those appearing in this response, then - # nextPageToken is included. To get the next set of results, call this method - # again using the value of nextPageToken as pageToken. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @log_names = args[:log_names] if args.key?(:log_names) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - # Result returned from ListMonitoredResourceDescriptors. class ListMonitoredResourceDescriptorsResponse include Google::Apis::Core::Hashable @@ -882,7 +854,8 @@ module Google # @return [Google::Apis::LoggingV2beta1::BucketOptions] attr_accessor :bucket_options - # Optional. A description of this metric, which is used in documentation. + # Optional. A description of this metric, which is used in documentation. The + # maximum length of the description is 8000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description diff --git a/generated/google/apis/logging_v2beta1/representations.rb b/generated/google/apis/logging_v2beta1/representations.rb index ab27044a1..fd2ff9678 100644 --- a/generated/google/apis/logging_v2beta1/representations.rb +++ b/generated/google/apis/logging_v2beta1/representations.rb @@ -82,12 +82,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ListLogsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ListMonitoredResourceDescriptorsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -299,14 +293,6 @@ module Google end end - class ListLogsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :log_names, as: 'logNames' - property :next_page_token, as: 'nextPageToken' - end - end - class ListMonitoredResourceDescriptorsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/logging_v2beta1/service.rb b/generated/google/apis/logging_v2beta1/service.rb index 39723fd3d..3d46b9615 100644 --- a/generated/google/apis/logging_v2beta1/service.rb +++ b/generated/google/apis/logging_v2beta1/service.rb @@ -47,91 +47,6 @@ module Google @batch_path = 'batch' end - # Deletes all the log entries in a log. The log reappears if it receives new - # entries. Log entries written shortly before the delete operation might not be - # deleted. - # @param [String] log_name - # Required. The resource name of the log to delete: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - # "folders/[FOLDER_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" - # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% - # 2Factivity". For more information about log names, see LogEntry. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_billing_account_log(log_name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+logName}', options) - command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation - command.response_class = Google::Apis::LoggingV2beta1::Empty - command.params['logName'] = log_name unless log_name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists the logs in projects, organizations, folders, or billing accounts. Only - # logs that have entries are listed. - # @param [String] parent - # Required. The resource name that owns the logs: - # "projects/[PROJECT_ID]" - # "organizations/[ORGANIZATION_ID]" - # "billingAccounts/[BILLING_ACCOUNT_ID]" - # "folders/[FOLDER_ID]" - # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive values are ignored. The presence of nextPageToken in the response - # indicates that more results might be available. - # @param [String] page_token - # Optional. If present, then retrieve the next batch of results from the - # preceding call to this method. pageToken must be the value of nextPageToken - # from the previous response. The values of other method parameters should be - # identical to those in the previous call. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_billing_account_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) - command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation - command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Lists log entries. Use this method to retrieve log entries from Logging. For # ways to export log entries, see Exporting Logs. # @param [Google::Apis::LoggingV2beta1::ListLogEntriesRequest] list_log_entries_request_object @@ -235,176 +150,6 @@ module Google execute_or_queue_command(command, &block) end - # Deletes all the log entries in a log. The log reappears if it receives new - # entries. Log entries written shortly before the delete operation might not be - # deleted. - # @param [String] log_name - # Required. The resource name of the log to delete: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - # "folders/[FOLDER_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" - # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% - # 2Factivity". For more information about log names, see LogEntry. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_organization_log(log_name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+logName}', options) - command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation - command.response_class = Google::Apis::LoggingV2beta1::Empty - command.params['logName'] = log_name unless log_name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists the logs in projects, organizations, folders, or billing accounts. Only - # logs that have entries are listed. - # @param [String] parent - # Required. The resource name that owns the logs: - # "projects/[PROJECT_ID]" - # "organizations/[ORGANIZATION_ID]" - # "billingAccounts/[BILLING_ACCOUNT_ID]" - # "folders/[FOLDER_ID]" - # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive values are ignored. The presence of nextPageToken in the response - # indicates that more results might be available. - # @param [String] page_token - # Optional. If present, then retrieve the next batch of results from the - # preceding call to this method. pageToken must be the value of nextPageToken - # from the previous response. The values of other method parameters should be - # identical to those in the previous call. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) - command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation - command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes all the log entries in a log. The log reappears if it receives new - # entries. Log entries written shortly before the delete operation might not be - # deleted. - # @param [String] log_name - # Required. The resource name of the log to delete: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - # "folders/[FOLDER_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" - # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% - # 2Factivity". For more information about log names, see LogEntry. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_log(log_name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+logName}', options) - command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation - command.response_class = Google::Apis::LoggingV2beta1::Empty - command.params['logName'] = log_name unless log_name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists the logs in projects, organizations, folders, or billing accounts. Only - # logs that have entries are listed. - # @param [String] parent - # Required. The resource name that owns the logs: - # "projects/[PROJECT_ID]" - # "organizations/[ORGANIZATION_ID]" - # "billingAccounts/[BILLING_ACCOUNT_ID]" - # "folders/[FOLDER_ID]" - # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive values are ignored. The presence of nextPageToken in the response - # indicates that more results might be available. - # @param [String] page_token - # Optional. If present, then retrieve the next batch of results from the - # preceding call to this method. pageToken must be the value of nextPageToken - # from the previous response. The values of other method parameters should be - # identical to those in the previous call. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) - command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation - command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Creates a logs-based metric. # @param [String] parent # The resource name of the project in which to create the metric: