google-apis-admin_directory_v1 0.47.0 → 0.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a156a6848eaaa224a2cd3953b93252ca3472e69af7975170620daccb74b13d0
-  data.tar.gz: 54d68f29e8c111432478f61bbc9f61856dc33cc981640fab4e4d2e43c3279776
+  metadata.gz: 3e8c6a78194c7833c2513429342dab38c682597d3da229b7de9e53a006189b99
+  data.tar.gz: 5f70969fad2dbb74bcee72cbc7ebfff631e42b4ac6ec4b2a4d373a9477ed6a47
 SHA512:
-  metadata.gz: c41bc479916b8f425ae8deeb338a44f8474932c375ca7556c63f6486cfff4a403437da42135a1308427acabf20893133d9fd0348708db1023357dbbf017aa80a
-  data.tar.gz: '08a8b1f200420d3efe1fc9ed4e6d459ac29b740c61cff28594575ae2dcfc90e518d8b4700b6e93c6067e8ffc42b0c88e07c411f7e81ea1ed727189f13c3c0f34'
+  metadata.gz: 0b4b7427ad837261080c1223b5da1cb74c0ca68b16371cef7a7df3e54a282068cdd1ae03899f1dcc62fc47c9a99a5f13e7d7c49169588e10aaaba352014aa0f7
+  data.tar.gz: a1a46ea8c4149c9bbd5bf12d8aa0ef39394a8245988009bb361b5853012bc86530b787acf837a2218e5fac3f469dd7aa9d4aca56fc080c576d7fc81a2babc3d9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-admin_directory_v1
 
+### v0.49.0 (2024-01-07)
+
+* Regenerated from discovery document revision 20240102
+
+### v0.48.0 (2023-12-24)
+
+* Regenerated from discovery document revision 20231219
+
 ### v0.47.0 (2023-11-19)
 
 * Regenerated from discovery document revision 20231113

data/lib/google/apis/admin_directory_v1/classes.rb

@@ -224,6 +224,59 @@ module Google
         end
       end
       
+      # A request for changing the status of a batch of ChromeOS devices.
+      class BatchChangeChromeOsDeviceStatusRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The action to take on the ChromeOS device in order to change its
+        # status.
+        # Corresponds to the JSON property `changeChromeOsDeviceStatusAction`
+        # @return [String]
+        attr_accessor :change_chrome_os_device_status_action
+      
+        # Optional. The reason behind a device deprovision. Must be provided if '
+        # changeChromeOsDeviceStatusAction' is set to '
+        # CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. Otherwise, omit this field.
+        # Corresponds to the JSON property `deprovisionReason`
+        # @return [String]
+        attr_accessor :deprovision_reason
+      
+        # Required. List of the IDs of the ChromeOS devices to change. Maximum 50.
+        # Corresponds to the JSON property `deviceIds`
+        # @return [Array<String>]
+        attr_accessor :device_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @change_chrome_os_device_status_action = args[:change_chrome_os_device_status_action] if args.key?(:change_chrome_os_device_status_action)
+          @deprovision_reason = args[:deprovision_reason] if args.key?(:deprovision_reason)
+          @device_ids = args[:device_ids] if args.key?(:device_ids)
+        end
+      end
+      
+      # The response of changing the status of a batch of ChromeOS devices.
+      class BatchChangeChromeOsDeviceStatusResponse
+        include Google::Apis::Core::Hashable
+      
+        # The results for each of the ChromeOS devices provided in the request.
+        # Corresponds to the JSON property `changeChromeOsDeviceStatusResults`
+        # @return [Array<Google::Apis::AdminDirectoryV1::ChangeChromeOsDeviceStatusResult>]
+        attr_accessor :change_chrome_os_device_status_results
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @change_chrome_os_device_status_results = args[:change_chrome_os_device_status_results] if args.key?(:change_chrome_os_device_status_results)
+        end
+      end
+      
       # Request to add multiple new print servers in a batch.
       class BatchCreatePrintServersRequest
         include Google::Apis::Core::Hashable
@@ -735,6 +788,55 @@ module Google
         end
       end
       
+      # The result of a single ChromeOS device for a Change state operation.
+      class ChangeChromeOsDeviceStatusResult
+        include Google::Apis::Core::Hashable
+      
+        # The unique ID of the ChromeOS device.
+        # Corresponds to the JSON property `deviceId`
+        # @return [String]
+        attr_accessor :device_id
+      
+        # The `Status` type defines a logical error model that is suitable for different
+        # programming environments, including REST APIs and RPC APIs. It is used by [
+        # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
+        # data: error code, error message, and error details. You can find out more
+        # about this error model and how to work with it in the [API Design Guide](https:
+        # //cloud.google.com/apis/design/errors).
+        # Corresponds to the JSON property `error`
+        # @return [Google::Apis::AdminDirectoryV1::Status]
+        attr_accessor :error
+      
+        # Response for a successful ChromeOS device status change.
+        # Corresponds to the JSON property `response`
+        # @return [Google::Apis::AdminDirectoryV1::ChangeChromeOsDeviceStatusSucceeded]
+        attr_accessor :response
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @device_id = args[:device_id] if args.key?(:device_id)
+          @error = args[:error] if args.key?(:error)
+          @response = args[:response] if args.key?(:response)
+        end
+      end
+      
+      # Response for a successful ChromeOS device status change.
+      class ChangeChromeOsDeviceStatusSucceeded
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # An notification channel used to watch for resource changes.
       class Channel
         include Google::Apis::Core::Hashable
@@ -4027,6 +4129,45 @@ module Google
         end
       end
       
+      # The `Status` type defines a logical error model that is suitable for different
+      # programming environments, including REST APIs and RPC APIs. It is used by [
+      # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
+      # data: error code, error message, and error details. You can find out more
+      # about this error model and how to work with it in the [API Design Guide](https:
+      # //cloud.google.com/apis/design/errors).
+      class Status
+        include Google::Apis::Core::Hashable
+      
+        # The status code, which should be an enum value of google.rpc.Code.
+        # Corresponds to the JSON property `code`
+        # @return [Fixnum]
+        attr_accessor :code
+      
+        # A list of messages that carry the error details. There is a common set of
+        # message types for APIs to use.
+        # Corresponds to the JSON property `details`
+        # @return [Array<Hash<String,Object>>]
+        attr_accessor :details
+      
+        # A developer-facing error message, which should be in English. Any user-facing
+        # error message should be localized and sent in the google.rpc.Status.details
+        # field, or localized by the client.
+        # Corresponds to the JSON property `message`
+        # @return [String]
+        attr_accessor :message
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @code = args[:code] if args.key?(:code)
+          @details = args[:details] if args.key?(:details)
+          @message = args[:message] if args.key?(:message)
+        end
+      end
+      
       # JSON template for token resource in Directory API.
       class Token
         include Google::Apis::Core::Hashable

data/lib/google/apis/admin_directory_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AdminDirectoryV1
       # Version of the google-apis-admin_directory_v1 gem
-      GEM_VERSION = "0.47.0"
+      GEM_VERSION = "0.49.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231113"
+      REVISION = "20240102"
     end
   end
 end

data/lib/google/apis/admin_directory_v1/representations.rb

@@ -52,6 +52,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class BatchChangeChromeOsDeviceStatusRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class BatchChangeChromeOsDeviceStatusResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class BatchCreatePrintServersRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -136,6 +148,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ChangeChromeOsDeviceStatusResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ChangeChromeOsDeviceStatusSucceeded
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Channel
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -544,6 +568,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Status
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Token
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -758,6 +788,23 @@ module Google
         end
       end
       
+      class BatchChangeChromeOsDeviceStatusRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :change_chrome_os_device_status_action, as: 'changeChromeOsDeviceStatusAction'
+          property :deprovision_reason, as: 'deprovisionReason'
+          collection :device_ids, as: 'deviceIds'
+        end
+      end
+      
+      class BatchChangeChromeOsDeviceStatusResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :change_chrome_os_device_status_results, as: 'changeChromeOsDeviceStatusResults', class: Google::Apis::AdminDirectoryV1::ChangeChromeOsDeviceStatusResult, decorator: Google::Apis::AdminDirectoryV1::ChangeChromeOsDeviceStatusResult::Representation
+      
+        end
+      end
+      
       class BatchCreatePrintServersRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -906,6 +953,23 @@ module Google
         end
       end
       
+      class ChangeChromeOsDeviceStatusResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :device_id, as: 'deviceId'
+          property :error, as: 'error', class: Google::Apis::AdminDirectoryV1::Status, decorator: Google::Apis::AdminDirectoryV1::Status::Representation
+      
+          property :response, as: 'response', class: Google::Apis::AdminDirectoryV1::ChangeChromeOsDeviceStatusSucceeded, decorator: Google::Apis::AdminDirectoryV1::ChangeChromeOsDeviceStatusSucceeded::Representation
+      
+        end
+      end
+      
+      class ChangeChromeOsDeviceStatusSucceeded
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class Channel
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1726,6 +1790,15 @@ module Google
         end
       end
       
+      class Status
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :code, as: 'code'
+          collection :details, as: 'details'
+          property :message, as: 'message'
+        end
+      end
+      
       class Token
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/admin_directory_v1/service.rb

@@ -176,15 +176,17 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # 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).
+        # Use [BatchChangeChromeOsDeviceStatus](/admin-sdk/directory/reference/rest/v1/
+        # customer.devices.chromeos/batchChangeStatus) instead. 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
         #   The unique ID for the customer's Google Workspace account. As an account
         #   administrator, you can also use the `my_customer` alias to represent your
@@ -454,6 +456,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Changes the status of a batch of ChromeOS devices. For more information about
+        # changing a ChromeOS device state [Repair, repurpose, or retire ChromeOS
+        # devices](https://support.google.com/chrome/a/answer/3523633).
+        # @param [String] customer_id
+        #   Required. Immutable ID of the Google Workspace account.
+        # @param [Google::Apis::AdminDirectoryV1::BatchChangeChromeOsDeviceStatusRequest] batch_change_chrome_os_device_status_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AdminDirectoryV1::BatchChangeChromeOsDeviceStatusResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdminDirectoryV1::BatchChangeChromeOsDeviceStatusResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def batch_customer_device_chromeo_change_status(customer_id, batch_change_chrome_os_device_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus', options)
+          command.request_representation = Google::Apis::AdminDirectoryV1::BatchChangeChromeOsDeviceStatusRequest::Representation
+          command.request_object = batch_change_chrome_os_device_status_request_object
+          command.response_representation = Google::Apis::AdminDirectoryV1::BatchChangeChromeOsDeviceStatusResponse::Representation
+          command.response_class = Google::Apis::AdminDirectoryV1::BatchChangeChromeOsDeviceStatusResponse
+          command.params['customerId'] = customer_id unless customer_id.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Issues a command for the device to execute.
         # @param [String] customer_id
         #   Immutable. ID of the Google Workspace account.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-admin_directory_v1
 version: !ruby/object:Gem::Version
-  version: 0.47.0
+  version: 0.49.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-19 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-admin_directory_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-admin_directory_v1/v0.47.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-admin_directory_v1/v0.49.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-admin_directory_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Admin SDK API DirectoryV1