From cb6ed54c12478472e3802552e13e0441ae32a18a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 9 Dec 2020 01:54:06 -0800 Subject: [PATCH] feat: Automated regeneration of admin directory_v1 client (#1675) This PR was generated using Autosynth. :rainbow:
Log from Synthtool ``` 2020-12-09 01:30:44,515 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py. On branch autosynth-admin-directory_v1 nothing to commit, working tree clean 2020-12-09 01:30:44,544 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth admin directory_v1 DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth admin directory_v1 bundle install Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will break this application for all non-root users on this machine. The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`. Fetching gem metadata from https://rubygems.org/......... Fetching gem metadata from https://rubygems.org/. Resolving dependencies... Fetching rake 11.3.0 Installing rake 11.3.0 Fetching concurrent-ruby 1.1.7 Installing concurrent-ruby 1.1.7 Fetching i18n 1.8.5 Installing i18n 1.8.5 Fetching minitest 5.14.2 Installing minitest 5.14.2 Fetching thread_safe 0.3.6 Installing thread_safe 0.3.6 Fetching tzinfo 1.2.8 Installing tzinfo 1.2.8 Fetching activesupport 5.0.7.2 Installing activesupport 5.0.7.2 Fetching public_suffix 4.0.6 Installing public_suffix 4.0.6 Fetching addressable 2.7.0 Installing addressable 2.7.0 Fetching ast 2.4.1 Installing ast 2.4.1 Using bundler 2.1.4 Fetching byebug 11.1.3 Installing byebug 11.1.3 with native extensions Fetching coderay 1.1.3 Installing coderay 1.1.3 Fetching json 2.3.1 Installing json 2.3.1 with native extensions Fetching docile 1.3.2 Installing docile 1.3.2 Fetching simplecov-html 0.10.2 Installing simplecov-html 0.10.2 Fetching simplecov 0.16.1 Installing simplecov 0.16.1 Using sync 0.5.0 Fetching tins 1.26.0 Installing tins 1.26.0 Fetching term-ansicolor 1.7.1 Installing term-ansicolor 1.7.1 Fetching thor 0.20.3 Installing thor 0.20.3 Fetching coveralls 0.8.23 Installing coveralls 0.8.23 Fetching crack 0.4.4 Installing crack 0.4.4 Fetching declarative 0.0.20 Installing declarative 0.0.20 Fetching declarative-option 0.1.0 Installing declarative-option 0.1.0 Fetching diff-lcs 1.4.4 Installing diff-lcs 1.4.4 Fetching dotenv 2.7.6 Installing dotenv 2.7.6 Fetching fakefs 0.20.1 Installing fakefs 0.20.1 Fetching multipart-post 2.1.1 Installing multipart-post 2.1.1 Fetching ruby2_keywords 0.0.2 Installing ruby2_keywords 0.0.2 Fetching faraday 1.1.0 Installing faraday 1.1.0 Fetching gems 1.2.0 Installing gems 1.2.0 Fetching github-markup 1.7.0 Installing github-markup 1.7.0 Fetching jwt 2.2.2 Installing jwt 2.2.2 Fetching memoist 0.16.2 Installing memoist 0.16.2 Fetching multi_json 1.15.0 Installing multi_json 1.15.0 Fetching os 0.9.6 Installing os 0.9.6 Fetching signet 0.14.0 Installing signet 0.14.0 Fetching googleauth 0.14.0 Installing googleauth 0.14.0 Fetching httpclient 2.8.3 Installing httpclient 2.8.3 Fetching mini_mime 1.0.2 Installing mini_mime 1.0.2 Fetching uber 0.1.0 Installing uber 0.1.0 Fetching representable 3.0.4 Installing representable 3.0.4 Fetching retriable 3.1.2 Installing retriable 3.1.2 Fetching rexml 3.2.4 Installing rexml 3.2.4 Using google-api-client 0.51.0 from source at `.` Fetching google-id-token 1.4.2 Installing google-id-token 1.4.2 Fetching hashdiff 1.0.1 Installing hashdiff 1.0.1 Fetching mime-types-data 3.2020.1104 Installing mime-types-data 3.2020.1104 Fetching mime-types 3.3.1 Installing mime-types 3.3.1 Fetching multi_xml 0.6.0 Installing multi_xml 0.6.0 Fetching httparty 0.18.1 Installing httparty 0.18.1 Fetching rspec-support 3.10.0 Installing rspec-support 3.10.0 Fetching rspec-core 3.10.0 Installing rspec-core 3.10.0 Fetching rspec-expectations 3.10.0 Installing rspec-expectations 3.10.0 Fetching rspec-mocks 3.10.0 Installing rspec-mocks 3.10.0 Fetching rspec 3.10.0 Installing rspec 3.10.0 Fetching json_spec 1.1.5 Installing json_spec 1.1.5 Fetching launchy 2.5.0 Installing launchy 2.5.0 Fetching little-plugger 1.1.4 Installing little-plugger 1.1.4 Fetching logging 2.3.0 Installing logging 2.3.0 Fetching method_source 1.0.0 Installing method_source 1.0.0 Fetching opencensus 0.5.0 Installing opencensus 0.5.0 Fetching parallel 1.20.1 Installing parallel 1.20.1 Fetching parser 2.7.2.0 Installing parser 2.7.2.0 Fetching powerpack 0.1.3 Installing powerpack 0.1.3 Fetching pry 0.13.1 Installing pry 0.13.1 Fetching pry-byebug 3.9.0 Installing pry-byebug 3.9.0 Fetching yard 0.9.25 Installing yard 0.9.25 Fetching pry-doc 0.13.5 Installing pry-doc 0.13.5 Fetching rainbow 2.2.2 Installing rainbow 2.2.2 with native extensions Fetching redcarpet 3.5.0 Installing redcarpet 3.5.0 with native extensions Fetching redis 3.3.5 Installing redis 3.3.5 Fetching rmail 1.1.4 Installing rmail 1.1.4 Fetching ruby-progressbar 1.10.1 Installing ruby-progressbar 1.10.1 Fetching unicode-display_width 1.7.0 Installing unicode-display_width 1.7.0 Fetching rubocop 0.49.1 Installing rubocop 0.49.1 Fetching webmock 2.3.2 Installing webmock 2.3.2 Bundle complete! 31 Gemfile dependencies, 78 gems now installed. Use `bundle info [gemname]` to see where a bundled gem is installed. Post-install message from i18n: HEADS UP! i18n 1.1 changed fallbacks to exclude default locale. But that may break your application. If you are upgrading your Rails application from an older version of Rails: Please check your Rails app for 'config.i18n.fallbacks = true'. If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be 'config.i18n.fallbacks = [I18n.default_locale]'. If not, fallbacks will be broken in your app by I18n 1.1.x. If you are starting a NEW Rails application, you can ignore this notice. For more info see: https://github.com/svenfuchs/i18n/releases/tag/v1.1.0 Post-install message from httparty: When you HTTParty, you must party hard! echo a | bundle exec bin/generate-api gen generated --api=admin.directory_v1 --names-out=/workspace/api_names_out.yaml Loading admin, version directory_v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/admin.directory_v1.json W, [2020-12-09T09:31:06.303552 #241] WARN -- : Found reserved keyword 'alias' W, [2020-12-09T09:31:06.303609 #241] WARN -- : Changed to 'alias_' W, [2020-12-09T09:31:06.342907 #241] WARN -- : Found reserved keyword 'alias' W, [2020-12-09T09:31:06.342954 #241] WARN -- : Changed to 'alias_' conflict google/apis/admin_directory_v1.rb Wrote metadata to generated/google/apis/admin_directory_v1/synth.metadata. DEBUG:synthtool:Wrote metadata to generated/google/apis/admin_directory_v1/synth.metadata. ```
Full log will be available here: https://source.cloud.google.com/results/invocations/13e6b812-a54d-4bbb-9ab8-105f680377a2/targets - [ ] To automatically regenerate this PR, check this box. --- api_names_out.yaml | 3 + generated/google/apis/admin_directory_v1.rb | 4 +- .../google/apis/admin_directory_v1/classes.rb | 774 ++++++++++-------- .../admin_directory_v1/representations.rb | 30 +- .../google/apis/admin_directory_v1/service.rb | 506 +++++++----- .../apis/admin_directory_v1/synth.metadata | 11 + 6 files changed, 807 insertions(+), 521 deletions(-) create mode 100644 generated/google/apis/admin_directory_v1/synth.metadata diff --git a/api_names_out.yaml b/api_names_out.yaml index 62077c8e9..6eee9b901 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -3550,6 +3550,9 @@ "/admin:directory_v1/Privileges/items": items "/admin:directory_v1/Privileges/items/item": item "/admin:directory_v1/Privileges/kind": kind +"/admin:directory_v1/RecentUsers": recent_users +"/admin:directory_v1/RecentUsers/email": email +"/admin:directory_v1/RecentUsers/type": type "/admin:directory_v1/Role": role "/admin:directory_v1/Role/etag": etag "/admin:directory_v1/Role/isSuperAdminRole": is_super_admin_role diff --git a/generated/google/apis/admin_directory_v1.rb b/generated/google/apis/admin_directory_v1.rb index 1fb01ca18..c832a44a9 100644 --- a/generated/google/apis/admin_directory_v1.rb +++ b/generated/google/apis/admin_directory_v1.rb @@ -18,7 +18,7 @@ require 'google/apis/admin_directory_v1/representations.rb' module Google module Apis - # Admin SDK + # Admin SDK API # # Admin SDK lets administrators of enterprise domains to view and manage # resources like user, groups etc. It also provides audit and usage reports of @@ -27,7 +27,7 @@ module Google # @see http://developers.google.com/admin-sdk/ module AdminDirectoryV1 VERSION = 'DirectoryV1' - REVISION = '20201013' + REVISION = '20201124' # View and manage customer related information AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' diff --git a/generated/google/apis/admin_directory_v1/classes.rb b/generated/google/apis/admin_directory_v1/classes.rb index 1589fade9..9412ce0d4 100644 --- a/generated/google/apis/admin_directory_v1/classes.rb +++ b/generated/google/apis/admin_directory_v1/classes.rb @@ -96,10 +96,12 @@ module Google end end - # The template that returns individual ASP (Access Code) data. STEPLADDER: - # Generated unstable field number for field 'kind'. (See http://go/stepladder- - # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. - # (See http://go/stepladder-help#fieldNumber) + # An application-specific password (ASP) is used with applications that do not + # accept a verification code when logging into the application on certain + # devices. The ASP access code is used instead of the login and password you + # commonly use when accessing an application through a browser. For more + # information about ASPs and how to create one, see the [help center](//http:// + # support.google.com/a/bin/answer.py?amp;answer=1032419). class Asp include Google::Apis::Core::Hashable @@ -108,7 +110,8 @@ module Google # @return [Fixnum] attr_accessor :code_id - # The time when the ASP was created. Expressed in Unix time format. + # The time when the ASP was created. Expressed in [Unix time](http://en. + # wikipedia.org/wiki/Epoch_time) format. # Corresponds to the JSON property `creationTime` # @return [Fixnum] attr_accessor :creation_time @@ -118,17 +121,18 @@ module Google # @return [String] attr_accessor :etag - # The type of the API resource. This is always admin#directory#asp. + # The type of the API resource. This is always `admin#directory#asp`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The time when the ASP was last used. Expressed in Unix time format. + # The time when the ASP was last used. Expressed in [Unix time](http://en. + # wikipedia.org/wiki/Epoch_time) format. # Corresponds to the JSON property `lastTimeUsed` # @return [Fixnum] attr_accessor :last_time_used - # The name of the application that the user, represented by their userId, + # The name of the application that the user, represented by their `userId`, # entered when the ASP was created. # Corresponds to the JSON property `name` # @return [String] @@ -155,9 +159,7 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class Asps include Google::Apis::Core::Hashable @@ -171,7 +173,7 @@ module Google # @return [Array] attr_accessor :items - # The type of the API resource. This is always admin#directory#aspList. + # The type of the API resource. This is always `admin#directory#aspList`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -415,8 +417,8 @@ module Google # @return [String] attr_accessor :generated_resource_name - # The type of the resource. For calendar resources, the value is admin#directory# - # resources#calendars#CalendarResource. + # The type of the resource. For calendar resources, the value is `admin# + # directory#resources#calendars#CalendarResource`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -496,8 +498,8 @@ module Google # @return [Array] attr_accessor :items - # Identifies this as a collection of CalendarResources. This is always admin# - # directory#resources#calendars#calendarResourcesList. + # Identifies this as a collection of CalendarResources. This is always `admin# + # directory#resources#calendars#calendarResourcesList`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -542,7 +544,7 @@ module Google attr_accessor :id # Identifies this as a notification channel used to watch for changes to a - # resource, which is "api#channel". + # resource, which is `api#channel`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -599,28 +601,31 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # Google Chrome devices run on the [Chrome OS](http://support.google.com/ + # chromeos). For more information about common API tasks, see the [Developer's + # Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). class ChromeOsDevice include Google::Apis::Core::Hashable - # List of active time ranges (Read-only) + # List of active time ranges (Read-only). # Corresponds to the JSON property `activeTimeRanges` # @return [Array] attr_accessor :active_time_ranges - # AssetId specified during enrollment or through later annotation + # The asset identifier as noted by an administrator or specified during + # enrollment. # Corresponds to the JSON property `annotatedAssetId` # @return [String] attr_accessor :annotated_asset_id - # Address or location of the device as noted by the administrator + # The address or location of the device as noted by the administrator. Maximum + # length is `200` characters. Empty values are allowed. # Corresponds to the JSON property `annotatedLocation` # @return [String] attr_accessor :annotated_location - # User of the device + # The user of the device as noted by the administrator. Maximum length is 100 + # characters. Empty values are allowed. # Corresponds to the JSON property `annotatedUser` # @return [String] attr_accessor :annotated_user @@ -631,7 +636,13 @@ module Google # @return [Fixnum] attr_accessor :auto_update_expiration - # Chromebook boot mode (Read-only) + # The boot mode for the device. The possible values are: * `Verified`: The + # device is running a valid version of the Chrome OS. * `Dev`: The devices's + # developer hardware switch is enabled. When booted, the device has a command + # line shell. For an example of a developer switch, see the [Chromebook + # developer information](http://www.chromium.org/chromium-os/developer- + # information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer- + # switch). # Corresponds to the JSON property `bootMode` # @return [String] attr_accessor :boot_mode @@ -646,7 +657,7 @@ module Google # @return [Array] attr_accessor :device_files - # Unique identifier of Chrome OS Device (Read-only) + # The unique ID of the Chrome device. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -670,7 +681,7 @@ module Google # @return [String] attr_accessor :etag - # Chromebook Mac Address on ethernet network interface (Read-only) + # The device's MAC address on the ethernet network interface. # Corresponds to the JSON property `ethernetMacAddress` # @return [String] attr_accessor :ethernet_mac_address @@ -683,12 +694,13 @@ module Google # @return [String] attr_accessor :ethernet_mac_address0 - # Chromebook firmware version (Read-only) + # The Chrome device's firmware version. # Corresponds to the JSON property `firmwareVersion` # @return [String] attr_accessor :firmware_version - # Kind of resource this is. + # The type of resource. For the Chromeosdevices resource, the value is `admin# + # directory#chromeosdevice`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -709,7 +721,8 @@ module Google # @return [DateTime] attr_accessor :last_sync - # Chromebook Mac Address on wifi network interface (Read-only) + # The device's wireless MAC address. If the device does not have this + # information, it is not included in the response. # Corresponds to the JSON property `macAddress` # @return [String] attr_accessor :mac_address @@ -719,54 +732,72 @@ module Google # @return [String] attr_accessor :manufacture_date - # Contains either the Mobile Equipment identifier (MEID) or the International - # Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook ( - # Read-only) + # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment + # Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is + # typically used when adding a device to a wireless carrier's post-pay service + # plan. If the device does not have this information, this property is not + # included in the response. For more information on how to export a MEID/IMEI + # list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome- + # devices.html#export_meid). # Corresponds to the JSON property `meid` # @return [String] attr_accessor :meid - # Chromebook Model (Read-only) + # The device's model information. If the device does not have this information, + # this property is not included in the response. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Notes added by the administrator + # Notes about this device added by the administrator. This property can be [ + # searched](http://support.google.com/chromeos/a/bin/answer.py?answer=1698333) + # with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method' + # s `query` parameter. Maximum length is 500 characters. Empty values are + # allowed. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # Chromebook order number (Read-only) + # The device's order number. Only devices directly purchased from Google have an + # order number. # Corresponds to the JSON property `orderNumber` # @return [String] attr_accessor :order_number - # OrgUnit of the device + # The full parent path with the organizational unit's name associated with the + # device. Path names are case insensitive. If the parent organizational unit is + # the top-level organization, it is represented as a forward slash, `/`. This + # property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices# + # update_chrome_device) using the API. For more information about how to create + # an organizational structure for your device, see the [administration help + # center](http://support.google.com/a/bin/answer.py?answer=182433). # Corresponds to the JSON property `orgUnitPath` # @return [String] attr_accessor :org_unit_path - # Chromebook Os Version (Read-only) + # The Chrome device's operating system version. # Corresponds to the JSON property `osVersion` # @return [String] attr_accessor :os_version - # Chromebook platform version (Read-only) + # The Chrome device's platform version. # Corresponds to the JSON property `platformVersion` # @return [String] attr_accessor :platform_version - # List of recent device users, in descending order by last login time (Read-only) + # List of recent device users, in descending order, by last login time. # Corresponds to the JSON property `recentUsers` - # @return [Array] + # @return [Array] attr_accessor :recent_users - # Chromebook serial number (Read-only) + # The Chrome device serial number entered when the device was enabled. This + # value is the same as the Admin console's *Serial Number* in the *Chrome OS + # Devices* tab. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number - # status of the device (Read-only) + # The status of the device. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -791,7 +822,8 @@ module Google # @return [Google::Apis::AdminDirectoryV1::ChromeOsDevice::TpmVersionInfo] attr_accessor :tpm_version_info - # Will Chromebook auto renew after support end date (Read-only) + # Determines if the device will auto renew its support after the support end + # date. This is a read-only property. # Corresponds to the JSON property `willAutoRenew` # @return [Boolean] attr_accessor :will_auto_renew @@ -845,7 +877,7 @@ module Google class ActiveTimeRange include Google::Apis::Core::Hashable - # Duration in milliseconds + # Duration of usage in milliseconds. # Corresponds to the JSON property `activeTime` # @return [Fixnum] attr_accessor :active_time @@ -1034,31 +1066,6 @@ module Google end end - # - class RecentUser - include Google::Apis::Core::Hashable - - # Email address of the user. Present only if the user type is managed - # Corresponds to the JSON property `email` - # @return [String] - attr_accessor :email - - # The type of the user - # 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) - @email = args[:email] if args.key?(:email) - @type = args[:type] if args.key?(:type) - end - end - # class SystemRamFreeReport include Google::Apis::Core::Hashable @@ -1088,7 +1095,8 @@ module Google class TpmVersionInfo include Google::Apis::Core::Hashable - # TPM family. + # TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> + # 312e3200 TPM 2.0: "2.0" -> 322e3000 # Corresponds to the JSON property `family` # @return [String] attr_accessor :family @@ -1103,7 +1111,8 @@ module Google # @return [String] attr_accessor :manufacturer - # TPM specification level. + # TPM specification level. See Library Specification for TPM 2.0 and Main + # Specification for TPM 1.2. # Corresponds to the JSON property `specLevel` # @return [String] attr_accessor :spec_level @@ -1138,12 +1147,14 @@ module Google class ChromeOsDeviceAction include Google::Apis::Core::Hashable - # Action to be taken on the ChromeOs Device + # Action to be taken on the Chrome OS device. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # + # Only used when the action is `deprovision`. With the `deprovision` action, + # this field is required. *Note*: The deprovision reason is audited because it + # might have implications on licenses for perpetual subscription customers. # Corresponds to the JSON property `deprovisionReason` # @return [String] attr_accessor :deprovision_reason @@ -1159,9 +1170,7 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class ChromeOsDevices include Google::Apis::Core::Hashable @@ -1180,7 +1189,8 @@ module Google # @return [String] attr_accessor :kind - # Token used to access next page of this result. + # Token used to access the next page of this result. To access the next page, + # use this token's value in the `pageToken` query string of this request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1202,7 +1212,7 @@ module Google class ChromeOsMoveDevicesToOu include Google::Apis::Core::Hashable - # ChromeOs Devices to be moved to OU + # Chrome OS devices to be moved to OU # Corresponds to the JSON property `deviceIds` # @return [Array] attr_accessor :device_ids @@ -1217,14 +1227,12 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class Customer include Google::Apis::Core::Hashable # The customer's secondary contact email address. This email address cannot be - # on the same domain as the customerDomain + # on the same domain as the `customerDomain` # Corresponds to the JSON property `alternateEmail` # @return [String] attr_accessor :alternate_email @@ -1234,8 +1242,8 @@ module Google # @return [DateTime] attr_accessor :customer_creation_time - # The customer's primary domain name string. Do not include the www prefix when - # creating a new customer. + # The customer's primary domain name string. Do not include the `www` prefix + # when creating a new customer. # Corresponds to the JSON property `customerDomain` # @return [String] attr_accessor :customer_domain @@ -1250,25 +1258,26 @@ module Google # @return [String] attr_accessor :id - # Identifies the resource as a customer. Value: admin#directory#customer + # Identifies the resource as a customer. Value: `admin#directory#customer` # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The customer's ISO 639-2 language code. The default value is en-US + # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/ + # directory/v1/languages) page for the list of supported codes. Valid language + # codes outside the supported set will be accepted by the API but may lead to + # unexpected behavior. The default value is `en`. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # The customer's contact phone number in E.164 format. + # The customer's contact phone number in [E.164](http://en.wikipedia.org/wiki/E. + # 164) format. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number - # STEPLADDER: Generated unstable field number for field 'address_line2' to avoid - # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated - # unstable field number for field 'address_line3' to avoid collision. (See http:/ - # /go/stepladder-help#fieldNumber) + # The customer's postal address information. # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::AdminDirectoryV1::CustomerPostalAddress] attr_accessor :postal_address @@ -1291,10 +1300,7 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'address_line2' to avoid - # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated - # unstable field number for field 'address_line3' to avoid collision. (See http:/ - # /go/stepladder-help#fieldNumber) + # class CustomerPostalAddress include Google::Apis::Core::Hashable @@ -1319,14 +1325,14 @@ module Google # @return [String] attr_accessor :contact_name - # This is a required property. For countryCode information see the ISO 3166 - # country code elements. + # This is a required property. For `countryCode` information see the [ISO 3166 + # country code elements](http://www.iso.org/iso/country_codes.htm). # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code - # Name of the locality. An example of a locality value is the city of San - # Francisco. + # Name of the locality. An example of a locality value is the city of `San + # Francisco`. # Corresponds to the JSON property `locality` # @return [String] attr_accessor :locality @@ -1336,14 +1342,14 @@ module Google # @return [String] attr_accessor :organization_name - # The postal code. A postalCode example is a postal zip code such as 10009. This - # is in accordance with - http: //portablecontacts.net/draft-spec.html# + # The postal code. A postalCode example is a postal zip code such as `10009`. + # This is in accordance with - http: //portablecontacts.net/draft-spec.html# # address_element. # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code - # Name of the region. An example of a region value is NY for the state of New + # Name of the region. An example of a region value is `NY` for the state of New # York. # Corresponds to the JSON property `region` # @return [String] @@ -1465,9 +1471,9 @@ module Google attr_accessor :command_type # The payload for the command, provide it only if command supports it. The - # following commands support adding payload: - SET_VOLUME: Payload is a JSON - # object in the form: ` "volume": 50 `. The volume has to be an integer in the - # range [0,100]. + # following commands support adding payload: - SET_VOLUME: Payload is a + # stringified JSON object in the form: ` "volume": 50 `. The volume has to be an + # integer in the range [0,100]. # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload @@ -1588,7 +1594,8 @@ module Google class Domains include Google::Apis::Core::Hashable - # Creation time of the domain. (Read-only). + # Creation time of the domain. Expressed in [Unix time](http://en.wikipedia.org/ + # wiki/Epoch_time) format. (Read-only). # Corresponds to the JSON property `creationTime` # @return [Fixnum] attr_accessor :creation_time @@ -1779,34 +1786,46 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # Google Groups provide your users the ability to send messages to groups of + # people using the group's email address. For more information about common + # tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage- + # groups). class Group include Google::Apis::Core::Hashable - # Is the group created by admin (Read-only) * + # Value is `true` if this group was created by an administrator rather than a + # user. # Corresponds to the JSON property `adminCreated` # @return [Boolean] attr_accessor :admin_created alias_method :admin_created?, :admin_created - # List of aliases (Read-only) + # List of a group's alias email addresses. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Description of the group + # An extended description to help users determine the purpose of a group. For + # example, you can include information about who should join the group, the + # types of messages to send to the group, links to FAQs about the group, or + # related groups. Maximum length is `4,096` characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Group direct members count + # The number of users that are direct members of the group. If a group is a + # member (child) of this group (the parent), members of the child group are not + # counted in the `directMembersCount` property of the parent group. # Corresponds to the JSON property `directMembersCount` # @return [Fixnum] attr_accessor :direct_members_count - # Email of Group + # The group's email address. If your account has multiple domains, select the + # appropriate domain for the email address. The `email` must be unique. This + # property is required when creating a group. Group email addresses are subject + # to the same character usage rules as usernames, see the [administration help + # center](http://support.google.com/a/bin/answer.py?answer=33386) for the + # details. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email @@ -1816,22 +1835,28 @@ module Google # @return [String] attr_accessor :etag - # Unique identifier of Group (Read-only) + # The unique ID of a group. A group `id` can be used as a group request URI's ` + # groupKey`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Kind of resource this is. + # The type of the API resource. For Groups resources, the value is `admin# + # directory#group`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Group name + # The group's display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # List of non editable aliases (Read-only) + # List of the group's non-editable alias email addresses that are outside of the + # account's primary domain or subdomains. These are functioning email addresses + # used by the group. This is a read-only property returned in the API's response + # for a group. If edited in a group's POST or PUT request, the edit is ignored + # by the API service. # Corresponds to the JSON property `nonEditableAliases` # @return [Array] attr_accessor :non_editable_aliases @@ -1855,9 +1880,7 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class Groups include Google::Apis::Core::Hashable @@ -1894,16 +1917,23 @@ module Google end end - # + # A Google Groups member can be a user or another group. This member can be + # inside or outside of your account's domains. For more information about common + # group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/ + # manage-group-members). class Member include Google::Apis::Core::Hashable - # Delivery settings of member + # Defines mail delivery preferences of member. This is only supported by create/ + # update/get. # Corresponds to the JSON property `delivery_settings` # @return [String] attr_accessor :delivery_settings - # Email of member (Read-only) + # The member's email address. A member can be a user or another group. This + # property is required when adding a member to a group. The `email` must be + # unique and cannot be an alias of another group. If the email address is + # changed, the API automatically reflects the email address changes. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email @@ -1913,19 +1943,23 @@ module Google # @return [String] attr_accessor :etag - # Unique identifier of group (Read-only) Unique identifier of member (Read-only) - # The unique ID of the group member. A member id can be used as a member request - # URI's memberKey. + # The unique ID of the group member. A member `id` can be used as a member + # request URI's `memberKey`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Kind of resource this is. + # The type of the API resource. For Members resources, the value is `admin# + # directory#member`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Role of member + # The member's role in a group. The API returns an error for cycles in group + # memberships. For example, if `group1` is a member of `group2`, `group2` cannot + # be a member of `group1`. For more information about a member's role, see the [ + # administration help center](http://support.google.com/a/bin/answer.py?answer= + # 167094). # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -1935,7 +1969,7 @@ module Google # @return [String] attr_accessor :status - # Type of member (Immutable) + # The type of group member. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2015,7 +2049,10 @@ module Google end end - # + # G Suite Mobile Management includes Android, [Google Sync](http://support. + # google.com/a/bin/answer.py?answer=135937), and iOS devices. For more + # information about common group mobile device API tasks, see the [Developer's + # Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices.html). class MobileDevice include Google::Apis::Core::Hashable @@ -2025,12 +2062,17 @@ module Google attr_accessor :adb_status alias_method :adb_status?, :adb_status - # List of applications installed on Mobile Device + # The list of applications installed on an Android mobile device. It is not + # applicable to Google Sync and iOS devices. The list includes any Android + # applications that access G Suite data. When updating an applications list, it + # is important to note that updates replace the existing list. If the Android + # device has two existing applications and the API updates the list with five + # applications, the is now the updated list of five applications. # Corresponds to the JSON property `applications` # @return [Array] attr_accessor :applications - # Mobile Device Baseband version (Read-only) + # The device's baseband version. # Corresponds to the JSON property `basebandVersion` # @return [String] attr_accessor :baseband_version @@ -2045,12 +2087,12 @@ module Google # @return [String] attr_accessor :brand - # Mobile Device Build number (Read-only) + # The device's operating system build number. # Corresponds to the JSON property `buildNumber` # @return [String] attr_accessor :build_number - # The default locale used on the Mobile Device (Read-only) + # The default locale used on the device. # Corresponds to the JSON property `defaultLanguage` # @return [String] attr_accessor :default_language @@ -2061,12 +2103,13 @@ module Google attr_accessor :developer_options_status alias_method :developer_options_status?, :developer_options_status - # Mobile Device compromised status (Read-only) + # The compromised device status. # Corresponds to the JSON property `deviceCompromisedStatus` # @return [String] attr_accessor :device_compromised_status - # Mobile Device serial number (Read-only) + # The serial number for a Google Sync mobile device. For Android and iOS devices, + # this is a software generated unique identifier. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -2076,7 +2119,10 @@ module Google # @return [String] attr_accessor :device_password_status - # List of owner user's email addresses (Read-only) + # List of owner's email addresses. If your application needs the current list of + # user emails, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get. + # html) method. For additional information, see the [retrieve a user](/admin-sdk/ + # directory/v1/guides/manage-users#get_user) method. # Corresponds to the JSON property `email` # @return [Array] attr_accessor :email @@ -2102,22 +2148,25 @@ module Google # @return [String] attr_accessor :hardware - # Mobile Device Hardware Id (Read-only) + # The IMEI/MEID unique identifier for Android hardware. It is not applicable to + # Google Sync devices. When adding an Android mobile device, this is an optional + # property. When updating one of these devices, this is a read-only property. # Corresponds to the JSON property `hardwareId` # @return [String] attr_accessor :hardware_id - # Mobile Device IMEI number (Read-only) + # The device's IMEI number. # Corresponds to the JSON property `imei` # @return [String] attr_accessor :imei - # Mobile Device Kernel version (Read-only) + # The device's kernel version. # Corresponds to the JSON property `kernelVersion` # @return [String] attr_accessor :kernel_version - # Kind of resource this is. + # The type of the API resource. For Mobiledevices resources, the value is `admin# + # directory#mobiledevice`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2128,8 +2177,7 @@ module Google # @return [DateTime] attr_accessor :last_sync - # Boolean indicating if this account is on owner/primary profile or not (Read- - # only) + # Boolean indicating if this account is on owner/primary profile or not. # Corresponds to the JSON property `managedAccountIsOnOwnerProfile` # @return [Boolean] attr_accessor :managed_account_is_on_owner_profile @@ -2140,17 +2188,24 @@ module Google # @return [String] attr_accessor :manufacturer - # Mobile Device MEID number (Read-only) + # The device's MEID number. # Corresponds to the JSON property `meid` # @return [String] attr_accessor :meid - # Name of the model of the device + # The mobile device's model name, for example Nexus S. This property can be [ + # updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For + # more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/ + # manage-mobile=devices#update_mobile_device). # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # List of owner user's names (Read-only) + # List of the owner's user names. If your application needs the current list of + # device owner names, use the [get](/admin-sdk/directory/v1/reference/ + # mobiledevices/get.html) method. For more information about retrieving mobile + # device user information, see the [Developer's Guide](/admin-sdk/directory/v1/ + # guides/manage-users#get_user). # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name @@ -2160,7 +2215,10 @@ module Google # @return [String] attr_accessor :network_operator - # Name of the mobile operating system + # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. + # This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/ + # update.html). For more information, see the [Developer's Guide](/admin-sdk/ + # directory/v1/guides/manage-mobile-devices#update_mobile_device). # Corresponds to the JSON property `os` # @return [String] attr_accessor :os @@ -2180,7 +2238,7 @@ module Google # @return [String] attr_accessor :release_version - # Unique identifier of Mobile Device (Read-only) + # The unique ID the API service uses to identify the mobile device. # Corresponds to the JSON property `resourceId` # @return [String] attr_accessor :resource_id @@ -2190,12 +2248,12 @@ module Google # @return [Fixnum] attr_accessor :security_patch_level - # Mobile Device SSN or Serial Number (Read-only) + # The device's serial number. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number - # Status of the device (Read-only) + # The device's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -2206,7 +2264,7 @@ module Google attr_accessor :supports_work_profile alias_method :supports_work_profile?, :supports_work_profile - # The type of device (Read-only) + # The type of mobile device. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2217,12 +2275,15 @@ module Google attr_accessor :unknown_sources_status alias_method :unknown_sources_status?, :unknown_sources_status - # Mobile Device user agent + # Gives information about the device such as `os` version. This property can be [ + # updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For + # more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/ + # manage-mobile-devices#update_mobile_device). # Corresponds to the JSON property `userAgent` # @return [String] attr_accessor :user_agent - # Mobile Device WiFi MAC address (Read-only) + # The device's MAC address on Wi-Fi networks. # Corresponds to the JSON property `wifiMacAddress` # @return [String] attr_accessor :wifi_mac_address @@ -2279,27 +2340,31 @@ module Google class Application include Google::Apis::Core::Hashable - # Display name of application + # The application's display name. An example is `Browser`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Package name of application + # The application's package name. An example is `com.android.browser`. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name - # List of Permissions for application + # The list of permissions of this application. These can be either a standard + # Android permission or one defined by the application, and are found in an + # application's [Android manifest](http://developer.android.com/guide/topics/ + # manifest/uses-permission-element.html). Examples of a Calendar application's + # permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission - # Version code of application + # The application's version code. An example is `13`. # Corresponds to the JSON property `versionCode` # @return [Fixnum] attr_accessor :version_code - # Version name of application + # The application's version name. An example is `3.2-140714`. # Corresponds to the JSON property `versionName` # @return [String] attr_accessor :version_name @@ -2323,7 +2388,7 @@ module Google class MobileDeviceAction include Google::Apis::Core::Hashable - # Action to be taken on the Mobile Device + # The action to be performed on the device. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action @@ -2375,20 +2440,25 @@ module Google end end - # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated - # unstable field number for field 'kind'. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( - # See http://go/stepladder-help#fieldNumber) + # Managing your account's organizational units allows you to configure your + # users' access to services and custom settings. For more information about + # common organizational unit tasks, see the [Developer's Guide](/admin-sdk/ + # directory/v1/guides/manage-org-units.html). class OrgUnit include Google::Apis::Core::Hashable - # Should block inheritance + # Determines if a sub-organizational unit can inherit the settings of the parent + # organization. The default value is `false`, meaning a sub-organizational unit + # inherits the settings of the nearest parent organizational unit. For more + # information on inheritance and users in an organization structure, see the [ + # administration help center](http://support.google.com/a/bin/answer.py?answer= + # 182442&topic=1227584&ctx=topic). # Corresponds to the JSON property `blockInheritance` # @return [Boolean] attr_accessor :block_inheritance alias_method :block_inheritance?, :block_inheritance - # Description of OrgUnit + # Description of the organizational unit. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2398,32 +2468,49 @@ module Google # @return [String] attr_accessor :etag - # Kind of resource this is. + # The type of the API resource. For Orgunits resources, the value is `admin# + # directory#orgUnit`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Name of OrgUnit + # The organizational unit's path name. For example, an organizational unit's + # name within the /corp/support/sales_support parent path is sales_support. + # Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Id of OrgUnit + # The unique ID of the organizational unit. # Corresponds to the JSON property `orgUnitId` # @return [String] attr_accessor :org_unit_id - # Path of OrgUnit + # The full path to the organizational unit. The `orgUnitPath` is a derived + # property. When listed, it is derived from `parentOrgunitPath` and + # organizational unit's `name`. For example, for an organizational unit named ' + # apps' under parent organization '/engineering', the orgUnitPath is '/ + # engineering/apps'. In order to edit an `orgUnitPath`, either update the name + # of the organization or the `parentOrgunitPath`. A user's organizational unit + # determines which G Suite services the user has access to. If the user is moved + # to a new organization, the user's access changes. For more information about + # organization structures, see the [administration help center](http://support. + # google.com/a/bin/answer.py?answer=182433&topic=1227584&ctx=topic). For more + # information about moving a user to a different organization, see [Update a + # user](/admin-sdk/directory/v1/guides/manage-users.html#update_user). # Corresponds to the JSON property `orgUnitPath` # @return [String] attr_accessor :org_unit_path - # Id of parent OrgUnit + # The unique ID of the parent organizational unit. Required, unless ` + # parentOrgUnitPath` is set. # Corresponds to the JSON property `parentOrgUnitId` # @return [String] attr_accessor :parent_org_unit_id - # Path of parent OrgUnit + # The organizational unit's parent path. For example, /corp/sales is the parent + # path for /corp/sales/sales_support organizational unit. Required, unless ` + # parentOrgUnitId` is set. # Corresponds to the JSON property `parentOrgUnitPath` # @return [String] attr_accessor :parent_org_unit_path @@ -2446,10 +2533,7 @@ module Google end end - # JSON response template for List Organization Units operation in Directory API. - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class OrgUnits include Google::Apis::Core::Hashable @@ -2458,12 +2542,13 @@ module Google # @return [String] attr_accessor :etag - # Kind of resource this is. + # The type of the API resource. For Org Unit resources, the type is `admin# + # directory#orgUnits`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # List of user objects. + # List of organizational unit objects. # Corresponds to the JSON property `organizationUnits` # @return [Array] attr_accessor :organization_units @@ -2502,7 +2587,7 @@ module Google attr_accessor :is_ou_scopable alias_method :is_ou_scopable?, :is_ou_scopable - # The type of the API resource. This is always admin#directory#privilege. + # The type of the API resource. This is always `admin#directory#privilege`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2513,7 +2598,7 @@ module Google attr_accessor :privilege_name # The obfuscated ID of the service this privilege is for. This value is returned - # with Privileges.list(). + # with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). # Corresponds to the JSON property `serviceId` # @return [String] attr_accessor :service_id @@ -2553,7 +2638,7 @@ module Google # @return [Array] attr_accessor :items - # The type of the API resource. This is always admin#directory#privileges. + # The type of the API resource. This is always `admin#directory#privileges`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2570,6 +2655,32 @@ module Google end end + # List of recent device users, in descending order, by last login time. + class RecentUsers + include Google::Apis::Core::Hashable + + # The user's email address. This is only present if the user type is ` + # USER_TYPE_MANAGED`. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # The type of the user. + # 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) + @email = args[:email] if args.key?(:email) + @type = args[:type] if args.key?(:type) + end + end + # class Role include Google::Apis::Core::Hashable @@ -2579,19 +2690,19 @@ module Google # @return [String] attr_accessor :etag - # Returns true if the role is a super admin role. + # Returns `true` if the role is a super admin role. # Corresponds to the JSON property `isSuperAdminRole` # @return [Boolean] attr_accessor :is_super_admin_role alias_method :is_super_admin_role?, :is_super_admin_role - # Returns true if this is a pre-defined system role. + # Returns `true` if this is a pre-defined system role. # Corresponds to the JSON property `isSystemRole` # @return [Boolean] attr_accessor :is_system_role alias_method :is_system_role?, :is_system_role - # The type of the API resource. This is always admin#directory#role. + # The type of the API resource. This is always `admin#directory#role`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2642,7 +2753,7 @@ module Google attr_accessor :privilege_name # The obfuscated ID of the service this privilege is for. This value is returned - # with Privileges.list(). + # with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). # Corresponds to the JSON property `serviceId` # @return [String] attr_accessor :service_id @@ -2673,7 +2784,7 @@ module Google # @return [String] attr_accessor :etag - # The type of the API resource. This is always admin#directory#roleAssignment. + # The type of the API resource. This is always `admin#directory#roleAssignment`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2694,8 +2805,7 @@ module Google # @return [Fixnum] attr_accessor :role_id - # The scope in which this role is assigned. Possible values are: - CUSTOMER - - # ORG_UNIT + # The scope in which this role is assigned. # Corresponds to the JSON property `scopeType` # @return [String] attr_accessor :scope_type @@ -2730,7 +2840,7 @@ module Google # @return [Array] attr_accessor :items - # The type of the API resource. This is always admin#directory#roleAssignments . + # The type of the API resource. This is always `admin#directory#roleAssignments`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2767,7 +2877,7 @@ module Google # @return [Array] attr_accessor :items - # The type of the API resource. This is always admin#directory#roles. + # The type of the API resource. This is always `admin#directory#roles`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2790,10 +2900,8 @@ module Google end end - # JSON template for Schema resource in Directory API. STEPLADDER: Generated - # unstable field number for field 'kind'. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( - # See http://go/stepladder-help#fieldNumber) + # The type of API resource. For Schema resources, this is always `admin# + # directory#schema`. class Schema include Google::Apis::Core::Hashable @@ -2802,12 +2910,12 @@ module Google # @return [String] attr_accessor :display_name - # ETag of the resource. + # The ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Fields of Schema + # A list of fields in the schema. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields @@ -2817,12 +2925,12 @@ module Google # @return [String] attr_accessor :kind - # Unique identifier of Schema (Read-only) + # The unique identifier of the schema (Read-only) # Corresponds to the JSON property `schemaId` # @return [String] attr_accessor :schema_id - # Schema name + # The schema's name. # Corresponds to the JSON property `schemaName` # @return [String] attr_accessor :schema_name @@ -2842,10 +2950,11 @@ module Google end end - # JSON template for FieldSpec resource for Schemas in Directory API. STEPLADDER: - # Generated unstable field number for field 'kind'. (See http://go/stepladder- - # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. - # (See http://go/stepladder-help#fieldNumber) + # You can use schemas to add custom fields to user profiles. You can use these + # fields to store information such as the projects your users work on, their + # physical locations, their hire dates, or whatever else fits your business + # needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/ + # guides/manage-schemas). class SchemaFieldSpec include Google::Apis::Core::Hashable @@ -2854,52 +2963,56 @@ module Google # @return [String] attr_accessor :display_name - # ETag of the resource. + # The ETag of the field. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Unique identifier of Field (Read-only) + # The unique identifier of the field (Read-only) # Corresponds to the JSON property `fieldId` # @return [String] attr_accessor :field_id - # Name of the field. + # The name of the field. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name - # Type of the field. + # The type of the field. # Corresponds to the JSON property `fieldType` # @return [String] attr_accessor :field_type - # Boolean specifying whether the field is indexed or not. + # Boolean specifying whether the field is indexed or not. Default: `true`. # Corresponds to the JSON property `indexed` # @return [Boolean] attr_accessor :indexed alias_method :indexed?, :indexed - # Kind of resource this is. + # The kind of resource this is. For schema fields this is always `admin# + # directory#schema#fieldspec`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Boolean specifying whether this is a multi-valued field or not. + # A boolean specifying whether this is a multi-valued field or not. Default: ` + # false`. # Corresponds to the JSON property `multiValued` # @return [Boolean] attr_accessor :multi_valued alias_method :multi_valued?, :multi_valued # Indexing spec for a numeric field. By default, only exact match queries will - # be supported for numeric fields. Setting the numericIndexingSpec allows range - # queries to be supported. + # be supported for numeric fields. Setting the `numericIndexingSpec` allows + # range queries to be supported. # Corresponds to the JSON property `numericIndexingSpec` # @return [Google::Apis::AdminDirectoryV1::SchemaFieldSpec::NumericIndexingSpec] attr_accessor :numeric_indexing_spec - # Read ACLs on the field specifying who can view values of this field. Valid - # values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". + # Specifies who can view values of this field. See [Retrieve users as a non- + # administrator](/admin-sdk/directory/v1/guides/manage-users# + # retrieve_users_non_admin) for more information. Note: It may take up to 24 + # hours for changes to this field to be reflected. # Corresponds to the JSON property `readAccessType` # @return [String] attr_accessor :read_access_type @@ -2923,8 +3036,8 @@ module Google end # Indexing spec for a numeric field. By default, only exact match queries will - # be supported for numeric fields. Setting the numericIndexingSpec allows range - # queries to be supported. + # be supported for numeric fields. Setting the `numericIndexingSpec` allows + # range queries to be supported. class NumericIndexingSpec include Google::Apis::Core::Hashable @@ -2954,10 +3067,7 @@ module Google end end - # JSON response template for List Schema operation in Directory API. STEPLADDER: - # Generated unstable field number for field 'kind'. (See http://go/stepladder- - # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. - # (See http://go/stepladder-help#fieldNumber) + # JSON response template for List Schema operation in Directory API. class Schemas include Google::Apis::Core::Hashable @@ -2988,14 +3098,11 @@ module Google end end - # JSON template for token resource in Directory API. STEPLADDER: Generated - # unstable field number for field 'kind'. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( - # See http://go/stepladder-help#fieldNumber) + # JSON template for token resource in Directory API. class Token include Google::Apis::Core::Hashable - # Whether the application is registered with Google. The value is true if the + # Whether the application is registered with Google. The value is `true` if the # application has an anonymous Client ID. # Corresponds to the JSON property `anonymous` # @return [Boolean] @@ -3017,13 +3124,13 @@ module Google # @return [String] attr_accessor :etag - # The type of the API resource. This is always admin#directory#token. + # The type of the API resource. This is always `admin#directory#token`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Whether the token is issued to an installed application. The value is true if - # the application is installed to a desktop or mobile device. + # Whether the token is issued to an installed application. The value is `true` + # if the application is installed to a desktop or mobile device. # Corresponds to the JSON property `nativeApp` # @return [Boolean] attr_accessor :native_app @@ -3056,10 +3163,7 @@ module Google end end - # JSON response template for List tokens operation in Directory API. STEPLADDER: - # Generated unstable field number for field 'kind'. (See http://go/stepladder- - # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. - # (See http://go/stepladder-help#fieldNumber) + # JSON response template for List tokens operation in Directory API. class Tokens include Google::Apis::Core::Hashable @@ -3073,7 +3177,7 @@ module Google # @return [Array] attr_accessor :items - # The type of the API resource. This is always admin#directory#tokenList. + # The type of the API resource. This is always `admin#directory#tokenList`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3090,49 +3194,28 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: - # Generated unstable field number for field 'external_ids' to avoid collision. ( - # See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable - # field number for field 'relations' to avoid collision. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'addresses' to avoid collision. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field ' - # organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) - # STEPLADDER: Generated unstable field number for field 'phones' to avoid - # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated - # unstable field number for field 'languages' to avoid collision. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'posix_accounts' to avoid collision. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field ' - # ssh_public_keys' to avoid collision. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to - # avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: - # Generated unstable field number for field 'websites' to avoid collision. (See - # http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field - # number for field 'locations' to avoid collision. (See http://go/stepladder- - # help#fieldNumber) STEPLADDER: Generated unstable field number for field ' - # keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) - # STEPLADDER: Generated unstable field number for field 'gender' to avoid - # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated - # unstable field number for field 'thumbnail_photo_etag' to avoid collision. ( - # See http://go/stepladder-help#fieldNumber) + # The Directory API allows you to create and manage your account's users, user + # aliases, and user Gmail chat profile photos. For more information about common + # tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/ + # guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/ + # directory/v1/guides/manage-user-aliases.html). class User include Google::Apis::Core::Hashable - # Addresses of User + # A list of the user's addresses. The maximum allowed data size for this field + # is 10Kb. # Corresponds to the JSON property `addresses` # @return [Object] attr_accessor :addresses - # Output only. Indicates if user has agreed to terms (Read-only) + # Output only. This property is `true` if the user has completed an initial + # login and accepted the Terms of Service agreement. # Corresponds to the JSON property `agreedToTerms` # @return [Boolean] attr_accessor :agreed_to_terms alias_method :agreed_to_terms?, :agreed_to_terms - # Output only. List of aliases (Read-only) + # Output only. List of the user's alias email addresses. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases @@ -3143,7 +3226,9 @@ module Google attr_accessor :archived alias_method :archived?, :archived - # Boolean indicating if the user should change password in next login + # Indicates if the user is forced to change their password at next login. This + # setting doesn't apply when [the user signs in via a third-party identity + # provider](https://support.google.com/a/answer/60224). # Corresponds to the JSON property `changePasswordAtNextLogin` # @return [Boolean] attr_accessor :change_password_at_next_login @@ -3159,7 +3244,12 @@ module Google # @return [Hash>] attr_accessor :custom_schemas - # Output only. CustomerId of User (Read-only) + # Output only. The customer ID to [retrieve all account users](/admin-sdk/ + # directory/v1/guides/manage-users.html#get_all_users). You can use the alias ` + # my_customer` to represent your account's `customerId`. As a reseller + # administrator, you can use the resold customer account's `customerId`. To get + # a `customerId`, use the account's primary domain in the `domain` parameter of + # a [users.list](/admin-sdk/directory/v1/reference/users/list) request. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id @@ -3169,7 +3259,8 @@ module Google # @return [DateTime] attr_accessor :deletion_time - # Emails of User + # A list of the user's email addresses. The maximum allowed data size for this + # field is 10Kb. # Corresponds to the JSON property `emails` # @return [Object] attr_accessor :emails @@ -3179,50 +3270,72 @@ module Google # @return [String] attr_accessor :etag - # The external Ids of User * + # A list of external IDs for the user, such as an employee or network ID. The + # maximum allowed data size for this field is 2Kb. # Corresponds to the JSON property `externalIds` # @return [Object] attr_accessor :external_ids - # Gender of User + # The user's gender. The maximum allowed data size for this field is 1Kb. # Corresponds to the JSON property `gender` # @return [Object] attr_accessor :gender - # Hash function name for password. Supported are MD5, SHA-1 and crypt + # Stores the hash format of the password property. We recommend sending the ` + # password` property value as a base 16 bit hexadecimal-encoded hash value. Set + # the `hashFunction` values as either the [SHA-1](http://wikipedia.org/wiki/SHA- + # 1), [MD5](http://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/ + # wiki/Crypt_(C)) hash format. # Corresponds to the JSON property `hashFunction` # @return [String] attr_accessor :hash_function - # Unique identifier of User (Read-only) + # The unique ID for the user. A user `id` can be used as a user request URI's ` + # userKey`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # User's Instant Messenger + # The user's Instant Messenger (IM) accounts. A user account can have multiple + # ims properties. But, only one of these ims properties can be the primary IM + # contact. The maximum allowed data size for this field is 2Kb. # Corresponds to the JSON property `ims` # @return [Object] attr_accessor :ims - # Boolean indicating if user is included in Global Address List + # Indicates if the user's profile is visible in the G Suite global address list + # when the contact sharing feature is enabled for the domain. For more + # information about excluding user profiles, see the [administration help center] + # (http://support.google.com/a/bin/answer.py?answer=1285988). # Corresponds to the JSON property `includeInGlobalAddressList` # @return [Boolean] attr_accessor :include_in_global_address_list alias_method :include_in_global_address_list?, :include_in_global_address_list - # Boolean indicating if ip is whitelisted + # If `true`, the user's IP address is [white listed](http://support.google.com/a/ + # bin/answer.py?answer=60752). # Corresponds to the JSON property `ipWhitelisted` # @return [Boolean] attr_accessor :ip_whitelisted alias_method :ip_whitelisted?, :ip_whitelisted - # Output only. Boolean indicating if the user is admin (Read-only) + # Output only. Indicates a user with super admininistrator privileges. The ` + # isAdmin` property can only be edited in the [Make a user an administrator](/ + # admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [ + # makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If + # edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert. + # html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, + # the edit is ignored by the API service. # Corresponds to the JSON property `isAdmin` # @return [Boolean] attr_accessor :is_admin alias_method :is_admin?, :is_admin - # Output only. Boolean indicating if the user is delegated admin (Read-only) + # Output only. Indicates if the user is a delegated administrator. Delegated + # administrators are supported by the API but cannot create or undelete users, + # or make users administrators. These requests are ignored by the API service. + # Roles and privileges for administrators are assigned using the [Admin console]( + # http://support.google.com/a/bin/answer.py?answer=33325). # Corresponds to the JSON property `isDelegatedAdmin` # @return [Boolean] attr_accessor :is_delegated_admin @@ -3240,23 +3353,25 @@ module Google attr_accessor :is_enrolled_in2_sv alias_method :is_enrolled_in2_sv?, :is_enrolled_in2_sv - # Output only. Is mailbox setup (Read-only) + # Output only. Indicates if the user's Google mailbox is created. This property + # is only applicable if the user has been assigned a Gmail license. # Corresponds to the JSON property `isMailboxSetup` # @return [Boolean] attr_accessor :is_mailbox_setup alias_method :is_mailbox_setup?, :is_mailbox_setup - # Keywords of User + # The user's keywords. The maximum allowed data size for this field is 1Kb. # Corresponds to the JSON property `keywords` # @return [Object] attr_accessor :keywords - # Output only. Kind of resource this is. + # Output only. The type of the API resource. For Users resources, the value is ` + # admin#directory#user`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Languages of User + # The user's languages. The maximum allowed data size for this field is 1Kb. # Corresponds to the JSON property `languages` # @return [Object] attr_accessor :languages @@ -3266,32 +3381,42 @@ module Google # @return [DateTime] attr_accessor :last_login_time - # Locations of User + # The user's locations. The maximum allowed data size for this field is 10Kb. # Corresponds to the JSON property `locations` # @return [Object] attr_accessor :locations - # User's name + # Holds the given and family names of the user, and the read-only `fullName` + # value. The maximum number of characters in the `givenName` and in the ` + # familyName` values is 60. In addition, name values support unicode/UTF-8 + # characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), + # forward slashes (/), and periods (.). For more information about character + # usage rules, see the [administration help center](http://support.google.com/a/ + # bin/answer.py?answer=33386). Maximum allowed data size for this field is 1Kb. # Corresponds to the JSON property `name` # @return [Google::Apis::AdminDirectoryV1::UserName] attr_accessor :name - # Output only. List of non editable aliases (Read-only) + # Output only. List of the user's non-editable alias email addresses. These are + # typically outside the account's primary domain or sub-domain. # Corresponds to the JSON property `nonEditableAliases` # @return [Array] attr_accessor :non_editable_aliases - # Notes of User + # Notes for the user. # Corresponds to the JSON property `notes` # @return [Object] attr_accessor :notes - # OrgUnit of User + # The full path of the parent organization associated with the user. If the + # parent organization is the top-level, it is represented as a forward slash (`/` + # ). # Corresponds to the JSON property `orgUnitPath` # @return [String] attr_accessor :org_unit_path - # Organizations of User + # A list of organizations the user belongs to. The maximum allowed data size for + # this field is 10Kb. # Corresponds to the JSON property `organizations` # @return [Object] attr_accessor :organizations @@ -3301,17 +3426,21 @@ module Google # @return [String] attr_accessor :password - # Phone numbers of User + # A list of the user's phone numbers. The maximum allowed data size for this + # field is 1Kb. # Corresponds to the JSON property `phones` # @return [Object] attr_accessor :phones - # The POSIX accounts of User + # A list of [POSIX](http://www.opengroup.org/austin/papers/posix_faq.html) + # account information for the user. # Corresponds to the JSON property `posixAccounts` # @return [Object] attr_accessor :posix_accounts - # username of User + # The user's primary email address. This property is required in a request to + # create a user account. The `primaryEmail` must be unique and cannot be an + # alias of another user. # Corresponds to the JSON property `primaryEmail` # @return [String] attr_accessor :primary_email @@ -3327,12 +3456,13 @@ module Google # @return [String] attr_accessor :recovery_phone - # The Relations of User * + # A list of the user's relationships to other users. The maximum allowed data + # size for this field is 2Kb. # Corresponds to the JSON property `relations` # @return [Object] attr_accessor :relations - # The SSH public keys of User + # A list of SSH public keys. # Corresponds to the JSON property `sshPublicKeys` # @return [Object] attr_accessor :ssh_public_keys @@ -3343,7 +3473,9 @@ module Google attr_accessor :suspended alias_method :suspended?, :suspended - # Output only. Suspension reason if user is suspended (Read-only) + # Output only. Has the reason a user account is suspended either by the + # administrator or by Google at the time of suspension. The property is returned + # only if the `suspended` property is `true`. # Corresponds to the JSON property `suspensionReason` # @return [String] attr_accessor :suspension_reason @@ -3358,7 +3490,7 @@ module Google # @return [String] attr_accessor :thumbnail_photo_url - # Websites of User + # The user's websites. The maximum allowed data size for this field is 2Kb. # Corresponds to the JSON property `websites` # @return [Object] attr_accessor :websites @@ -3829,7 +3961,7 @@ module Google class UserMakeAdmin include Google::Apis::Core::Hashable - # Boolean indicating new admin status of the user + # Indicates the administrator status of the user. # Corresponds to the JSON property `status` # @return [Boolean] attr_accessor :status @@ -3849,17 +3981,17 @@ module Google class UserName include Google::Apis::Core::Hashable - # Last Name + # The user's last name. Required when creating a user account. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name - # Full Name + # The user's full name formed by concatenating the first and last name values. # Corresponds to the JSON property `fullName` # @return [String] attr_accessor :full_name - # First Name + # The user's first name. Required when creating a user account. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name @@ -4006,9 +4138,7 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class UserPhoto include Google::Apis::Core::Hashable @@ -4017,38 +4147,47 @@ module Google # @return [String] attr_accessor :etag - # Height in pixels of the photo + # Height of the photo in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height - # Unique identifier of User (Read-only) + # The ID the API uses to uniquely identify the user. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Kind of resource this is. + # The type of the API resource. For Photo resources, this is `admin#directory# + # user#photo`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Mime Type of the photo + # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, ` + # TIFF`, and web-safe base64 encoding. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # Base64 encoded photo data + # The user photo's upload data in [web-safe Base64](https://code.google.com/p/ + # stringencoders/wiki/WebSafeBase64) format in bytes. This means: * The slash (/) + # character is replaced with the underscore (_) character. * The plus sign (+) + # character is replaced with the hyphen (-) character. * The equals sign (=) + # character is replaced with the asterisk (*). * For padding, the period (.) + # character is used instead of the RFC-4648 baseURL definition which uses the + # equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever + # the size of the photo being uploaded, the API downsizes it to 96x96 pixels. # Corresponds to the JSON property `photoData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :photo_data - # Primary email of User (Read-only) + # The user's primary email address. # Corresponds to the JSON property `primaryEmail` # @return [String] attr_accessor :primary_email - # Width in pixels of the photo + # Width of the photo in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -4070,8 +4209,7 @@ module Google end end - # JSON template for a POSIX account entry. Description of the field family: go/ - # fbs-posix. + # JSON template for a POSIX account entry. class UserPosixAccount include Google::Apis::Core::Hashable @@ -4268,9 +4406,7 @@ module Google end end - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) + # class Users include Google::Apis::Core::Hashable @@ -4313,10 +4449,8 @@ module Google end end - # JSON template for verification codes in Directory API. STEPLADDER: Generated - # unstable field number for field 'kind'. (See http://go/stepladder-help# - # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( - # See http://go/stepladder-help#fieldNumber) + # The Directory API allows you to view, generate, and invalidate backup + # verification codes for a user. class VerificationCode include Google::Apis::Core::Hashable @@ -4325,7 +4459,7 @@ module Google # @return [String] attr_accessor :etag - # The type of the resource. This is always admin#directory#verificationCode. + # The type of the resource. This is always `admin#directory#verificationCode`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4355,9 +4489,6 @@ module Google end # JSON response template for List verification codes operation in Directory API. - # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ - # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for - # field 'etag'. (See http://go/stepladder-help#fieldNumber) class VerificationCodes include Google::Apis::Core::Hashable @@ -4371,7 +4502,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the resource. This is always admin#directory#verificationCodesList. + # The type of the resource. This is always `admin#directory# + # verificationCodesList`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/admin_directory_v1/representations.rb b/generated/google/apis/admin_directory_v1/representations.rb index a45ac357e..25e1b45f9 100644 --- a/generated/google/apis/admin_directory_v1/representations.rb +++ b/generated/google/apis/admin_directory_v1/representations.rb @@ -133,12 +133,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class RecentUser - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class SystemRamFreeReport class Representation < Google::Apis::Core::JsonRepresentation; end @@ -334,6 +328,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RecentUsers + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Role class Representation < Google::Apis::Core::JsonRepresentation; end @@ -715,7 +715,7 @@ module Google property :org_unit_path, as: 'orgUnitPath' property :os_version, as: 'osVersion' property :platform_version, as: 'platformVersion' - collection :recent_users, as: 'recentUsers', class: Google::Apis::AdminDirectoryV1::ChromeOsDevice::RecentUser, decorator: Google::Apis::AdminDirectoryV1::ChromeOsDevice::RecentUser::Representation + collection :recent_users, as: 'recentUsers', class: Google::Apis::AdminDirectoryV1::RecentUsers, decorator: Google::Apis::AdminDirectoryV1::RecentUsers::Representation property :serial_number, as: 'serialNumber' property :status, as: 'status' @@ -793,14 +793,6 @@ module Google end end - class RecentUser - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :email, as: 'email' - property :type, as: 'type' - end - end - class SystemRamFreeReport # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1186,6 +1178,14 @@ module Google end end + class RecentUsers + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email, as: 'email' + property :type, as: 'type' + end + end + class Role # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/admin_directory_v1/service.rb b/generated/google/apis/admin_directory_v1/service.rb index 2362f9185..cecb181f7 100644 --- a/generated/google/apis/admin_directory_v1/service.rb +++ b/generated/google/apis/admin_directory_v1/service.rb @@ -20,7 +20,7 @@ require 'google/apis/errors' module Google module Apis module AdminDirectoryV1 - # Admin SDK + # Admin SDK API # # Admin SDK lets administrators of enterprise domains to view and manage # resources like user, groups etc. It also provides audit and usage reports of @@ -45,8 +45,8 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/admin/directory_v1' + super('https://admin.googleapis.com/', '') + @batch_path = 'batch' end # Delete an ASP issued by a user. @@ -174,11 +174,24 @@ module Google execute_or_queue_command(command, &block) end - # Take action on Chrome OS Device + # Takes an action that affects a Chrome OS Device. This includes deprovisioning, + # disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will + # stop device policy syncing and remove device-level printers. After a device is + # deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen + # devices should use the disable action. * Re-enabling a disabled device will + # consume a device license. If you do not have sufficient licenses available + # when completing the re-enable action, you will receive an error. For more + # information about deprovisioning and disabling devices, visit the [help center] + # (https://support.google.com/chrome/a/answer/3523633). # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] resource_id - # Immutable ID of Chrome OS Device + # The unique ID of the device. The `resourceId`s are returned in the response + # from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/ + # chromeosdevices/list) method. # @param [Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction] chrome_os_device_action_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -208,13 +221,19 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve Chrome OS Device + # Retrieves a Chrome OS device's properties. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] device_id - # Immutable ID of Chrome OS Device + # The unique ID of the device. The `deviceId`s are returned in the response from + # the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/ + # list) method. # @param [String] projection - # Restrict information returned to a set of selected fields. + # Determines whether the response contains the full list of properties or only a + # subset. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -244,25 +263,30 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve all Chrome OS Devices of a customer (paginated) + # Retrieves a paginated list of Chrome OS devices within an account. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] order_by - # Column to use for sorting results + # Device property to use for sorting results. # @param [String] org_unit_path - # Full path of the organizational unit or its ID + # The full path of the organizational unit or its unique ID. # @param [String] page_token - # Token to specify next page in the list + # The `pageToken` query parameter is used to request the next page of query + # results. The follow-on request's `pageToken` query parameter is the ` + # nextPageToken` from your previous response. # @param [String] projection # Restrict information returned to a set of selected fields. # @param [String] query # Search string in the format given at http://support.google.com/chromeos/a/bin/ # answer.py?answer=1698333 # @param [String] sort_order - # Whether to return results in ascending or descending order. Only of use when - # orderBy is also used + # Whether to return results in ascending or descending order. Must be used with + # the `orderBy` parameter. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -297,7 +321,8 @@ module Google execute_or_queue_command(command, &block) end - # Move or insert multiple Chrome OS Devices to organizational unit + # Move or insert multiple Chrome OS devices to an organizational unit. You can + # move up to 50 devices at once. # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] org_unit_path @@ -331,11 +356,18 @@ module Google execute_or_queue_command(command, &block) end - # Patch Chrome OS Device + # Updates a device's updatable properties, such as `annotatedUser`, ` + # annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method + # supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] device_id - # Immutable ID of Chrome OS Device + # The unique ID of the device. The `deviceId`s are returned in the response from + # the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) + # method. # @param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object # @param [String] projection # Restrict information returned to a set of selected fields. @@ -370,11 +402,17 @@ module Google execute_or_queue_command(command, &block) end - # Update Chrome OS Device + # Updates a device's updatable properties, such as `annotatedUser`, ` + # annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] device_id - # Immutable ID of Chrome OS Device + # The unique ID of the device. The `deviceId`s are returned in the response from + # the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) + # method. # @param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object # @param [String] projection # Restrict information returned to a set of selected fields. @@ -834,9 +872,10 @@ module Google execute_or_queue_command(command, &block) end - # Delete Group + # Deletes a group. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -862,9 +901,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve Group + # Retrieves a group's properties. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -892,7 +932,7 @@ module Google execute_or_queue_command(command, &block) end - # Create Group + # Creates a group. # @param [Google::Apis::AdminDirectoryV1::Group] group_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -924,11 +964,14 @@ module Google # Retrieve all groups of a domain or of a user given a userKey (paginated) # @param [String] customer - # Immutable ID of the G Suite account. In case of multi-domain, to fetch all - # groups for a customer, fill this field instead of domain. + # The unique ID for the customer's G Suite account. In case of a multi-domain + # account, to fetch all groups for a customer, fill this field instead of domain. + # As an account administrator, you can also use the `my_customer` alias to + # represent your account's `customerId`. The `customerId` is also returned as + # part of the [Users](/admin-sdk/directory/v1/reference/users) # @param [String] domain - # Name of the domain. Fill this field to get groups from only this domain. To - # return all groups in a multi-domain fill customer field instead. + # The domain name. Use this field to get fields from only one domain. To return + # all domains for a customer account, use the `customer` query parameter instead. # @param [Fixnum] max_results # Maximum number of results to return. Max allowed value is 200. # @param [String] order_by @@ -979,10 +1022,11 @@ module Google execute_or_queue_command(command, &block) end - # Patch Groups via Apiary Patch Orchestration + # Updates a group's properties. This method supports [patch semantics](/admin- + # sdk/directory/v1/guides/performance#patch). # @param [String] group_key - # Email or immutable ID of the group. If ID, it should match with id of group - # object + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [Google::Apis::AdminDirectoryV1::Group] group_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1013,10 +1057,10 @@ module Google execute_or_queue_command(command, &block) end - # Update Group + # Updates a group's properties. # @param [String] group_key - # Email or immutable ID of the group. If ID, it should match with id of group - # object + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [Google::Apis::AdminDirectoryV1::Group] group_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1047,9 +1091,10 @@ module Google execute_or_queue_command(command, &block) end - # Remove a alias for the group + # Removes an alias. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] group_alias # The alias to be removed # @param [String] fields @@ -1078,9 +1123,10 @@ module Google execute_or_queue_command(command, &block) end - # Add a alias for the group + # Adds an alias for the group. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1111,9 +1157,10 @@ module Google execute_or_queue_command(command, &block) end - # List all aliases for a group + # Lists all aliases for a group. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1141,11 +1188,14 @@ module Google execute_or_queue_command(command, &block) end - # Remove membership. + # Removes a member from a group. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] member_key - # Email or immutable ID of the member + # Identifies the group member in the API request. A group member can be a user + # or another group. The value can be the member's (group or user) primary email + # address, alias, or unique ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1172,11 +1222,14 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve Group Member + # Retrieves a group member's properties. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] member_key - # Email or immutable ID of the member + # Identifies the group member in the API request. A group member can be a user + # or another group. The value can be the member's (group or user) primary email + # address, alias, or unique ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1241,9 +1294,10 @@ module Google execute_or_queue_command(command, &block) end - # Add user to the specified group. + # Adds a user to the specified group. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [Google::Apis::AdminDirectoryV1::Member] member_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1274,17 +1328,19 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve all members in a group (paginated) + # Retrieves a paginated list of all members in a group. # @param [String] group_key - # Email or immutable ID of the group + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [Boolean] include_derived_membership # Whether to list indirect memberships. Default: false. # @param [Fixnum] max_results # Maximum number of results to return. Max allowed value is 200. # @param [String] page_token - # Token to specify next page in the list + # Token to specify next page in the list. # @param [String] roles - # Comma separated role values to filter list results on. + # The `roles` query parameter allows you to retrieve group members by role. + # Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1316,13 +1372,16 @@ module Google execute_or_queue_command(command, &block) end - # Patch Member via Apiary Patch Orchestration + # Updates the membership properties of a user in the specified group. This + # method supports [patch semantics](/admin-sdk/directory/v1/guides/performance# + # patch). # @param [String] group_key - # Email or immutable ID of the group. If ID, it should match with id of group - # object + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] member_key - # Email or immutable ID of the user. If ID, it should match with id of member - # object + # Identifies the group member in the API request. A group member can be a user + # or another group. The value can be the member's (group or user) primary email + # address, alias, or unique ID. # @param [Google::Apis::AdminDirectoryV1::Member] member_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1354,13 +1413,14 @@ module Google execute_or_queue_command(command, &block) end - # Update membership of a user in the specified group. + # Updates the membership of a user in the specified group. # @param [String] group_key - # Email or immutable ID of the group. If ID, it should match with id of group - # object + # Identifies the group in the API request. The value can be the group's email + # address, group alias, or the unique group ID. # @param [String] member_key - # Email or immutable ID of the user. If ID, it should match with id of member - # object + # Identifies the group member in the API request. A group member can be a user + # or another group. The value can be the member's (group or user) primary email + # address, alias, or unique ID. # @param [Google::Apis::AdminDirectoryV1::Member] member_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1392,11 +1452,15 @@ module Google execute_or_queue_command(command, &block) end - # Take action on Mobile Device + # Takes an action that affects a mobile device. For example, remotely wiping a + # device. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] resource_id - # Immutable ID of Mobile Device + # The unique ID the API service uses to identify the mobile device. # @param [Google::Apis::AdminDirectoryV1::MobileDeviceAction] mobile_device_action_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1426,11 +1490,14 @@ module Google execute_or_queue_command(command, &block) end - # Delete Mobile Device + # Removes a mobile device. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] resource_id - # Immutable ID of Mobile Device + # The unique ID the API service uses to identify the mobile device. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1457,11 +1524,14 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve Mobile Device + # Retrieves a mobile device's properties. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] resource_id - # Immutable ID of Mobile Device + # The unique ID the API service uses to identify the mobile device. # @param [String] projection # Restrict information returned to a set of selected fields. # @param [String] fields @@ -1493,13 +1563,16 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve all Mobile Devices of a customer (paginated) + # Retrieves a paginated list of all mobile devices for an account. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [Fixnum] max_results # Maximum number of results to return. Max allowed value is 100. # @param [String] order_by - # Column to use for sorting results + # Device property to use for sorting results. # @param [String] page_token # Token to specify next page in the list # @param [String] projection @@ -1508,8 +1581,8 @@ module Google # Search string in the format given at http://support.google.com/a/bin/answer.py? # answer=1408863#search # @param [String] sort_order - # Whether to return results in ascending or descending order. Only of use when - # orderBy is also used + # Whether to return results in ascending or descending order. Must be used with + # the `orderBy` parameter. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1543,11 +1616,14 @@ module Google execute_or_queue_command(command, &block) end - # Remove organizational unit + # Removes an organizational unit. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] org_unit_path - # Full path of the organizational unit or its ID + # The full path of the organizational unit or its unique ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1574,11 +1650,14 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve organizational unit + # Retrieves an organizational unit. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] org_unit_path - # Full path of the organizational unit or its ID + # The full path of the organizational unit or its unique ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1607,9 +1686,12 @@ module Google execute_or_queue_command(command, &block) end - # Add organizational unit + # Adds an organizational unit. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1640,13 +1722,17 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve all organizational units + # Retrieves a list of all organizational units for an account. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] org_unit_path - # the URL-encoded organizational unit's path or its ID + # The full path to the organizational unit or its unique ID. Returns the + # children of the specified organizational unit. # @param [String] type - # Whether to return all sub-organizations or just immediate children + # Whether to return all sub-organizations or just immediate children. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1676,11 +1762,15 @@ module Google execute_or_queue_command(command, &block) end - # Patch organization unit via Apiary Patch Orchestration + # Updates an organizational unit. This method supports [patch semantics](/admin- + # sdk/directory/v1/guides/performance#patch) # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] org_unit_path - # Full path of the organizational unit or its ID + # The full path of the organizational unit or its unique ID. # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1712,11 +1802,14 @@ module Google execute_or_queue_command(command, &block) end - # Update organizational unit + # Updates an organizational unit. # @param [String] customer_id - # Immutable ID of the G Suite account + # The unique ID for the customer's G Suite account. As an account administrator, + # you can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). # @param [String] org_unit_path - # Full path of the organizational unit or its ID + # The full path of the organizational unit or its unique ID. # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1781,7 +1874,8 @@ module Google # Deletes a building. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] building_id # The id of the building to delete. # @param [String] fields @@ -1813,7 +1907,8 @@ module Google # Retrieves a building. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] building_id # The unique ID of the building to retrieve. # @param [String] fields @@ -1847,7 +1942,8 @@ module Google # Inserts a building. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [Google::Apis::AdminDirectoryV1::Building] building_object # @param [String] coordinates_source # Source from which Building.coordinates are derived. @@ -1884,7 +1980,8 @@ module Google # Retrieves a list of buildings for an account. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token @@ -1921,7 +2018,8 @@ module Google # Patches a building via Apiary Patch Orchestration. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] building_id # The id of the building to update. # @param [Google::Apis::AdminDirectoryV1::Building] building_object @@ -1961,7 +2059,8 @@ module Google # Updates a building. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] building_id # The id of the building to update. # @param [Google::Apis::AdminDirectoryV1::Building] building_object @@ -2001,7 +2100,8 @@ module Google # Deletes a calendar resource. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] calendar_resource_id # The unique ID of the calendar resource to delete. # @param [String] fields @@ -2033,7 +2133,8 @@ module Google # Retrieves a calendar resource. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] calendar_resource_id # The unique ID of the calendar resource to retrieve. # @param [String] fields @@ -2067,7 +2168,8 @@ module Google # Inserts a calendar resource. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2101,16 +2203,17 @@ module Google # Retrieves a list of calendar resources for an account. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] order_by # Field(s) to sort results by in either ascending or descending order. Supported - # fields include resourceId, resourceName, capacity, buildingId, and floorName. - # If no order is specified, defaults to ascending. Should be of the form "field [ - # asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would - # return results sorted first by buildingId in ascending order then by capacity - # in descending order. + # fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and ` + # floorName`. If no order is specified, defaults to ascending. Should be of the + # form "field [asc|desc], field [asc|desc], ...". For example `buildingId, + # capacity desc` would return results sorted first by `buildingId` in ascending + # order then by `capacity` in descending order. # @param [String] page_token # Token to specify the next page in the list. # @param [String] query @@ -2119,10 +2222,10 @@ module Google # supported operations. Operators include '=' for exact match, '!=' for mismatch # and ':' for prefix match or HAS match where applicable. For prefix match, the # value should always be followed by a *. Logical operators NOT and AND are - # supported (in this order of precedence). Supported fields include - # generatedResourceName, name, buildingId, floor_name, capacity, - # featureInstances.feature.name. For example buildingId=US-NYC-9TH AND - # featureInstances.feature.name:Phone. + # supported (in this order of precedence). Supported fields include ` + # generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, ` + # featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For + # example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2157,7 +2260,8 @@ module Google # Patches a calendar resource via Apiary Patch Orchestration. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] calendar_resource_id # The unique ID of the calendar resource to update. # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object @@ -2196,7 +2300,8 @@ module Google # present in the request will be preserved. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] calendar_resource_id # The unique ID of the calendar resource to update. # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object @@ -2233,7 +2338,8 @@ module Google # Deletes a feature. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] feature_key # The unique ID of the feature to delete. # @param [String] fields @@ -2265,7 +2371,8 @@ module Google # Retrieves a feature. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] feature_key # The unique ID of the feature to retrieve. # @param [String] fields @@ -2299,7 +2406,8 @@ module Google # Inserts a feature. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [Google::Apis::AdminDirectoryV1::Feature] feature_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2333,7 +2441,8 @@ module Google # Retrieves a list of features for an account. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token @@ -2370,7 +2479,8 @@ module Google # Patches a feature via Apiary Patch Orchestration. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] feature_key # The unique ID of the feature to update. # @param [Google::Apis::AdminDirectoryV1::Feature] feature_object @@ -2407,7 +2517,8 @@ module Google # Renames a feature. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] old_name # The unique ID of the feature to rename. # @param [Google::Apis::AdminDirectoryV1::FeatureRename] feature_rename_object @@ -2442,7 +2553,8 @@ module Google # Updates a feature. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, - # you can also use the my_customer alias to represent your account's customer ID. + # you can also use the `my_customer` alias to represent your account's customer + # ID. # @param [String] feature_key # The unique ID of the feature to update. # @param [Google::Apis::AdminDirectoryV1::Feature] feature_object @@ -2824,9 +2936,9 @@ module Google # Delete schema # @param [String] customer_id - # Immutable ID of the G Suite account + # Immutable ID of the G Suite account. # @param [String] schema_key - # Name or immutable ID of the schema + # Name or immutable ID of the schema. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2855,9 +2967,9 @@ module Google # Retrieve schema # @param [String] customer_id - # Immutable ID of the G Suite account + # Immutable ID of the G Suite account. # @param [String] schema_key - # Name or immutable ID of the schema + # Name or immutable ID of the schema. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2888,7 +3000,7 @@ module Google # Create schema. # @param [String] customer_id - # Immutable ID of the G Suite account + # Immutable ID of the G Suite account. # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2921,7 +3033,7 @@ module Google # Retrieve all schemas for a customer # @param [String] customer_id - # Immutable ID of the G Suite account + # Immutable ID of the G Suite account. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2951,7 +3063,7 @@ module Google # Patch Schema via Apiary Patch Orchestration # @param [String] customer_id - # Immutable ID of the G Suite account + # Immutable ID of the G Suite account. # @param [String] schema_key # Name or immutable ID of the schema. # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object @@ -2987,7 +3099,7 @@ module Google # Update schema # @param [String] customer_id - # Immutable ID of the G Suite account + # Immutable ID of the G Suite account. # @param [String] schema_key # Name or immutable ID of the schema. # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object @@ -3147,9 +3259,10 @@ module Google execute_or_queue_command(command, &block) end - # Delete user + # Deletes a user. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3175,16 +3288,19 @@ module Google execute_or_queue_command(command, &block) end - # retrieve user + # Retrieves a user. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [String] custom_field_mask - # Comma-separated list of schema names. All fields from these schemas are - # fetched. This should only be set when projection=custom. + # A comma-separated list of schema names. All fields from these schemas are + # fetched. This should only be set when `projection=custom`. # @param [String] projection # What subset of fields to fetch for this user. # @param [String] view_type - # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. + # Whether to fetch the administrator-only or domain-wide public view of the user. + # For more information, see [Retrieve a user as a non-administrator](/admin-sdk/ + # directory/v1/guides/manage-users#retrieve_users_non_admin). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3215,7 +3331,7 @@ module Google execute_or_queue_command(command, &block) end - # create user. + # Creates a user. # @param [Google::Apis::AdminDirectoryV1::User] user_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3245,33 +3361,41 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve either deleted users or all users in a domain (paginated) + # Retrieves a paginated list of either deleted users or all users in a domain. # @param [String] custom_field_mask - # Comma-separated list of schema names. All fields from these schemas are - # fetched. This should only be set when projection=custom. + # A comma-separated list of schema names. All fields from these schemas are + # fetched. This should only be set when `projection=custom`. # @param [String] customer - # Immutable ID of the G Suite account. In case of multi-domain, to fetch all - # users for a customer, fill this field instead of domain. + # The unique ID for the customer's G Suite account. In case of a multi-domain + # account, to fetch all groups for a customer, fill this field instead of domain. + # You can also use the `my_customer` alias to represent your account's ` + # customerId`. The `customerId` is also returned as part of the [Users resource]( + # /admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain` + # parameter must be provided. # @param [String] domain - # Name of the domain. Fill this field to get users from only this domain. To - # return all users in a multi-domain fill customer field instead. + # The domain name. Use this field to get fields from only one domain. To return + # all domains for a customer account, use the `customer` query parameter instead. + # Either the `customer` or the `domain` parameter must be provided. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] order_by - # Column to use for sorting results + # Property to use for sorting results. # @param [String] page_token # Token to specify next page in the list # @param [String] projection # What subset of fields to fetch for this user. # @param [String] query - # Query string search. Should be of the form "". Complete documentation is at - # https: //developers.google.com/admin-sdk/directory/v1/guides/search-users + # Query string for searching user fields. For more information on constructing + # user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search- + # users). # @param [String] show_deleted - # If set to true, retrieves the list of deleted users. (Default: false) + # If set to `true`, retrieves the list of deleted users. (Default: `false`) # @param [String] sort_order # Whether to return results in ascending or descending order. # @param [String] view_type - # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. + # Whether to fetch the administrator-only or domain-wide public view of the user. + # For more information, see [Retrieve a user as a non-administrator](/admin-sdk/ + # directory/v1/guides/manage-users#retrieve_users_non_admin). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3309,9 +3433,10 @@ module Google execute_or_queue_command(command, &block) end - # change admin status of a user + # Makes a user a super administrator. # @param [String] user_key - # Email or immutable ID of the user as admin + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [Google::Apis::AdminDirectoryV1::UserMakeAdmin] user_make_admin_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3340,10 +3465,13 @@ module Google execute_or_queue_command(command, &block) end - # Patch Users via Apiary Patch Orchestration + # Updates a user using patch semantics. The update method should be used instead, + # since it also supports patch semantics and has better performance. This + # method is unable to clear fields that contain repeated objects (`addresses`, ` + # phones`, etc). Use the update method instead. # @param [String] user_key - # Email or immutable ID of the user. If ID, it should match with id of user - # object + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [Google::Apis::AdminDirectoryV1::User] user_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3404,7 +3532,7 @@ module Google execute_or_queue_command(command, &block) end - # Undelete a deleted user + # Undeletes a deleted user. # @param [String] user_key # The immutable id of the user # @param [Google::Apis::AdminDirectoryV1::UserUndelete] user_undelete_object @@ -3435,10 +3563,12 @@ module Google execute_or_queue_command(command, &block) end - # update user + # Updates a user. This method supports patch semantics, meaning you only need to + # include the fields you wish to update. Fields that are not present in the + # request will be preserved, and fields set to `null` will be cleared. # @param [String] user_key - # Email or immutable ID of the user. If ID, it should match with id of user - # object + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [Google::Apis::AdminDirectoryV1::User] user_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3481,7 +3611,7 @@ module Google # Name of the domain. Fill this field to get users from only this domain. To # return all users in a multi-domain fill customer field instead." # @param [String] event - # Event on which subscription is intended + # Events to watch for. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] order_by @@ -3498,7 +3628,9 @@ module Google # @param [String] sort_order # Whether to return results in ascending or descending order. # @param [String] view_type - # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. + # Whether to fetch the administrator-only or domain-wide public view of the user. + # For more information, see [Retrieve a user as a non-administrator](/admin-sdk/ + # directory/v1/guides/manage-users#retrieve_users_non_admin). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3539,11 +3671,12 @@ module Google execute_or_queue_command(command, &block) end - # Remove a alias for the user + # Removes an alias. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [String] user_alias - # The alias to be removed + # The alias to be removed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3570,9 +3703,10 @@ module Google execute_or_queue_command(command, &block) end - # Add a alias for the user + # Adds an alias. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3603,9 +3737,10 @@ module Google execute_or_queue_command(command, &block) end - # List all aliases for a user + # Lists all aliases for a user. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3633,12 +3768,12 @@ module Google execute_or_queue_command(command, &block) end - # Watch for changes in users list + # Watch for changes in users list. # @param [String] user_key # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object # @param [String] event - # Event on which subscription is intended (if subscribing) + # Events to watch for. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3669,9 +3804,10 @@ module Google execute_or_queue_command(command, &block) end - # Remove photos for the user + # Removes the user's photo. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3697,9 +3833,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve photo of a user + # Retrieves the user's photo. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3727,9 +3864,11 @@ module Google execute_or_queue_command(command, &block) end - # Patch Photo via Apiary Patch Orchestration + # Adds a photo for the user. This method supports [patch semantics](/admin-sdk/ + # directory/v1/guides/performance#patch). # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3760,9 +3899,10 @@ module Google execute_or_queue_command(command, &block) end - # Add a photo for the user + # Adds a photo for the user. # @param [String] user_key - # Email or immutable ID of the user + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/admin_directory_v1/synth.metadata b/generated/google/apis/admin_directory_v1/synth.metadata new file mode 100644 index 000000000..0aebac036 --- /dev/null +++ b/generated/google/apis/admin_directory_v1/synth.metadata @@ -0,0 +1,11 @@ +{ + "sources": [ + { + "git": { + "name": ".", + "remote": "https://github.com/googleapis/google-api-ruby-client.git", + "sha": "4a08e0b2fde874551723ca843986ed92d354daf1" + } + } + ] +} \ No newline at end of file