generated/googleapis/lib/smartdevicemanagement/v1.dart

// Copyright 2021 Google LLC
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd

// This is a generated file (see the discoveryapis_generator project).

// ignore_for_file: camel_case_types
// ignore_for_file: comment_references
// ignore_for_file: deprecated_member_use_from_same_package
// ignore_for_file: doc_directive_unknown
// ignore_for_file: lines_longer_than_80_chars
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: prefer_interpolation_to_compose_strings
// ignore_for_file: unintended_html_in_doc_comment
// ignore_for_file: unnecessary_brace_in_string_interps
// ignore_for_file: unnecessary_lambdas
// ignore_for_file: unnecessary_string_interpolations

/// Smart Device Management API - v1
///
/// Allow select enterprise partners to access, control, and manage Google and
/// Nest devices programmatically.
///
/// For more information, see <https://developers.google.com/nest/device-access>
///
/// Create an instance of [SmartDeviceManagementApi] to access these resources:
///
/// - [EnterprisesResource]
///   - [EnterprisesDevicesResource]
///   - [EnterprisesStructuresResource]
///     - [EnterprisesStructuresRoomsResource]
library;

import 'dart:async' as async;
import 'dart:convert' as convert;
import 'dart:core' as core;

import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;

import '../src/user_agent.dart';

export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
    show ApiRequestError, DetailedApiRequestError;

/// Allow select enterprise partners to access, control, and manage Google and
/// Nest devices programmatically.
class SmartDeviceManagementApi {
  /// See and/or control the devices that you selected
  static const sdmServiceScope = 'https://www.googleapis.com/auth/sdm.service';

  final commons.ApiRequester _requester;

  EnterprisesResource get enterprises => EnterprisesResource(_requester);

  SmartDeviceManagementApi(
    http.Client client, {
    core.String rootUrl = 'https://smartdevicemanagement.googleapis.com/',
    core.String servicePath = '',
  }) : _requester = commons.ApiRequester(
         client,
         rootUrl,
         servicePath,
         requestHeaders,
       );
}

class EnterprisesResource {
  final commons.ApiRequester _requester;

  EnterprisesDevicesResource get devices =>
      EnterprisesDevicesResource(_requester);
  EnterprisesStructuresResource get structures =>
      EnterprisesStructuresResource(_requester);

  EnterprisesResource(commons.ApiRequester client) : _requester = client;
}

class EnterprisesDevicesResource {
  final commons.ApiRequester _requester;

  EnterprisesDevicesResource(commons.ApiRequester client) : _requester = client;

  /// Executes a command to device managed by the enterprise.
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [name] - The name of the device requested. For example:
  /// "enterprises/XYZ/devices/123"
  /// Value must have pattern `^enterprises/\[^/\]+/devices/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse>
  executeCommand(
    GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest request,
    core.String name, {
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':executeCommand';

    final response_ = await _requester.request(
      url_,
      'POST',
      body: body_,
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Gets a device managed by the enterprise.
  ///
  /// Request parameters:
  ///
  /// [name] - The name of the device requested. For example:
  /// "enterprises/XYZ/devices/123"
  /// Value must have pattern `^enterprises/\[^/\]+/devices/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1Device].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1Device> get(
    core.String name, {
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1Device.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Lists devices managed by the enterprise.
  ///
  /// Request parameters:
  ///
  /// [parent] - The parent enterprise to list devices under. E.g.
  /// "enterprises/XYZ".
  /// Value must have pattern `^enterprises/\[^/\]+$`.
  ///
  /// [filter] - Optional filter to list devices. Filters can be done on: Device
  /// custom name (substring match): 'customName=wing'
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1ListDevicesResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1ListDevicesResponse> list(
    core.String parent, {
    core.String? filter,
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'filter': ?filter == null ? null : [filter],
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/devices';

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1ListDevicesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }
}

class EnterprisesStructuresResource {
  final commons.ApiRequester _requester;

  EnterprisesStructuresRoomsResource get rooms =>
      EnterprisesStructuresRoomsResource(_requester);

  EnterprisesStructuresResource(commons.ApiRequester client)
    : _requester = client;

  /// Gets a structure managed by the enterprise.
  ///
  /// Request parameters:
  ///
  /// [name] - The name of the structure requested. For example:
  /// "enterprises/XYZ/structures/ABC".
  /// Value must have pattern `^enterprises/\[^/\]+/structures/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1Structure].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1Structure> get(
    core.String name, {
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1Structure.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Lists structures managed by the enterprise.
  ///
  /// Request parameters:
  ///
  /// [parent] - The parent enterprise to list structures under. E.g.
  /// "enterprises/XYZ".
  /// Value must have pattern `^enterprises/\[^/\]+$`.
  ///
  /// [filter] - Optional filter to list structures.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1ListStructuresResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1ListStructuresResponse> list(
    core.String parent, {
    core.String? filter,
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'filter': ?filter == null ? null : [filter],
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/structures';

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1ListStructuresResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }
}

class EnterprisesStructuresRoomsResource {
  final commons.ApiRequester _requester;

  EnterprisesStructuresRoomsResource(commons.ApiRequester client)
    : _requester = client;

  /// Gets a room managed by the enterprise.
  ///
  /// Request parameters:
  ///
  /// [name] - The name of the room requested. For example:
  /// "enterprises/XYZ/structures/ABC/rooms/123".
  /// Value must have pattern
  /// `^enterprises/\[^/\]+/structures/\[^/\]+/rooms/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1Room].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1Room> get(
    core.String name, {
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1Room.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Lists rooms managed by the enterprise.
  ///
  /// Request parameters:
  ///
  /// [parent] - The parent resource name of the rooms requested. For example:
  /// "enterprises/XYZ/structures/ABC".
  /// Value must have pattern `^enterprises/\[^/\]+/structures/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [GoogleHomeEnterpriseSdmV1ListRoomsResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<GoogleHomeEnterpriseSdmV1ListRoomsResponse> list(
    core.String parent, {
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/rooms';

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return GoogleHomeEnterpriseSdmV1ListRoomsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }
}

/// Device resource represents an instance of enterprise managed device in the
/// property.
class GoogleHomeEnterpriseSdmV1Device {
  /// The GHP device ID of the device.
  ///
  /// Output only.
  core.String? ghpName;

  /// The resource name of the device.
  ///
  /// For example: "enterprises/XYZ/devices/123".
  ///
  /// Required.
  core.String? name;

  /// Assignee details of the device.
  core.List<GoogleHomeEnterpriseSdmV1ParentRelation>? parentRelations;

  /// Device traits.
  ///
  /// Output only.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? traits;

  /// Type of the device for general display purposes.
  ///
  /// For example: "THERMOSTAT". The device type should not be used to deduce or
  /// infer functionality of the actual device it is assigned to. Instead, use
  /// the returned traits for the device.
  ///
  /// Output only.
  core.String? type;

  GoogleHomeEnterpriseSdmV1Device({
    this.ghpName,
    this.name,
    this.parentRelations,
    this.traits,
    this.type,
  });

  GoogleHomeEnterpriseSdmV1Device.fromJson(core.Map json_)
    : this(
        ghpName: json_['ghpName'] as core.String?,
        name: json_['name'] as core.String?,
        parentRelations: (json_['parentRelations'] as core.List?)
            ?.map(
              (value) => GoogleHomeEnterpriseSdmV1ParentRelation.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        traits: json_.containsKey('traits')
            ? json_['traits'] as core.Map<core.String, core.dynamic>
            : null,
        type: json_['type'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final ghpName = this.ghpName;
    final name = this.name;
    final parentRelations = this.parentRelations;
    final traits = this.traits;
    final type = this.type;
    return {
      'ghpName': ?ghpName,
      'name': ?name,
      'parentRelations': ?parentRelations,
      'traits': ?traits,
      'type': ?type,
    };
  }
}

/// Request message for SmartDeviceManagementService.ExecuteDeviceCommand
class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest {
  /// The command name to execute, represented by the fully qualified protobuf
  /// message name.
  core.String? command;

  /// The command message to execute, represented as a Struct.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? params;

  GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest({
    this.command,
    this.params,
  });

  GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest.fromJson(core.Map json_)
    : this(
        command: json_['command'] as core.String?,
        params: json_.containsKey('params')
            ? json_['params'] as core.Map<core.String, core.dynamic>
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final command = this.command;
    final params = this.params;
    return {'command': ?command, 'params': ?params};
  }
}

/// Response message for SmartDeviceManagementService.ExecuteDeviceCommand
class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse {
  /// The results of executing the command.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? results;

  GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse({this.results});

  GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse.fromJson(core.Map json_)
    : this(
        results: json_.containsKey('results')
            ? json_['results'] as core.Map<core.String, core.dynamic>
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final results = this.results;
    return {'results': ?results};
  }
}

/// Response message for SmartDeviceManagementService.ListDevices
class GoogleHomeEnterpriseSdmV1ListDevicesResponse {
  /// The list of devices.
  core.List<GoogleHomeEnterpriseSdmV1Device>? devices;

  GoogleHomeEnterpriseSdmV1ListDevicesResponse({this.devices});

  GoogleHomeEnterpriseSdmV1ListDevicesResponse.fromJson(core.Map json_)
    : this(
        devices: (json_['devices'] as core.List?)
            ?.map(
              (value) => GoogleHomeEnterpriseSdmV1Device.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final devices = this.devices;
    return {'devices': ?devices};
  }
}

/// Response message for SmartDeviceManagementService.ListRooms
class GoogleHomeEnterpriseSdmV1ListRoomsResponse {
  /// The list of rooms.
  core.List<GoogleHomeEnterpriseSdmV1Room>? rooms;

  GoogleHomeEnterpriseSdmV1ListRoomsResponse({this.rooms});

  GoogleHomeEnterpriseSdmV1ListRoomsResponse.fromJson(core.Map json_)
    : this(
        rooms: (json_['rooms'] as core.List?)
            ?.map(
              (value) => GoogleHomeEnterpriseSdmV1Room.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final rooms = this.rooms;
    return {'rooms': ?rooms};
  }
}

/// Response message for SmartDeviceManagementService.ListStructures
class GoogleHomeEnterpriseSdmV1ListStructuresResponse {
  /// The list of structures.
  core.List<GoogleHomeEnterpriseSdmV1Structure>? structures;

  GoogleHomeEnterpriseSdmV1ListStructuresResponse({this.structures});

  GoogleHomeEnterpriseSdmV1ListStructuresResponse.fromJson(core.Map json_)
    : this(
        structures: (json_['structures'] as core.List?)
            ?.map(
              (value) => GoogleHomeEnterpriseSdmV1Structure.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final structures = this.structures;
    return {'structures': ?structures};
  }
}

/// Represents device relationships, for instance, structure/room to which the
/// device is assigned to.
class GoogleHomeEnterpriseSdmV1ParentRelation {
  /// The custom name of the relation -- e.g., structure/room where the device
  /// is assigned to.
  ///
  /// Output only.
  core.String? displayName;

  /// The GHP name of the relation -- e.g., structure/room where the device is
  /// assigned to.
  ///
  /// For example: "homegraph.googleapis.com/Structure/ABC" or
  /// "homegraph.googleapis.com/Room/ABC"
  ///
  /// Output only.
  core.String? ghpParent;

  /// The name of the relation -- e.g., structure/room where the device is
  /// assigned to.
  ///
  /// For example: "enterprises/XYZ/structures/ABC" or
  /// "enterprises/XYZ/structures/ABC/rooms/123"
  ///
  /// Output only.
  core.String? parent;

  GoogleHomeEnterpriseSdmV1ParentRelation({
    this.displayName,
    this.ghpParent,
    this.parent,
  });

  GoogleHomeEnterpriseSdmV1ParentRelation.fromJson(core.Map json_)
    : this(
        displayName: json_['displayName'] as core.String?,
        ghpParent: json_['ghpParent'] as core.String?,
        parent: json_['parent'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final displayName = this.displayName;
    final ghpParent = this.ghpParent;
    final parent = this.parent;
    return {
      'displayName': ?displayName,
      'ghpParent': ?ghpParent,
      'parent': ?parent,
    };
  }
}

/// Room resource represents an instance of sub-space within a structure such as
/// rooms in a hotel suite or rental apartment.
class GoogleHomeEnterpriseSdmV1Room {
  /// The resource name of the room.
  ///
  /// For example: "enterprises/XYZ/structures/ABC/rooms/123".
  ///
  /// Output only.
  core.String? name;

  /// Room traits.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? traits;

  GoogleHomeEnterpriseSdmV1Room({this.name, this.traits});

  GoogleHomeEnterpriseSdmV1Room.fromJson(core.Map json_)
    : this(
        name: json_['name'] as core.String?,
        traits: json_.containsKey('traits')
            ? json_['traits'] as core.Map<core.String, core.dynamic>
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final name = this.name;
    final traits = this.traits;
    return {'name': ?name, 'traits': ?traits};
  }
}

/// Structure resource represents an instance of enterprise managed home or
/// hotel room.
class GoogleHomeEnterpriseSdmV1Structure {
  /// The unique identifier for the structure in Google Home Platform.
  ///
  /// Format: homegraph.googleapis.com/Structure/{structure_id}
  ///
  /// Output only.
  core.String? ghpName;

  /// The resource name of the structure.
  ///
  /// For example: "enterprises/XYZ/structures/ABC".
  ///
  /// Output only.
  core.String? name;

  /// Structure traits.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? traits;

  GoogleHomeEnterpriseSdmV1Structure({this.ghpName, this.name, this.traits});

  GoogleHomeEnterpriseSdmV1Structure.fromJson(core.Map json_)
    : this(
        ghpName: json_['ghpName'] as core.String?,
        name: json_['name'] as core.String?,
        traits: json_.containsKey('traits')
            ? json_['traits'] as core.Map<core.String, core.dynamic>
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final ghpName = this.ghpName;
    final name = this.name;
    final traits = this.traits;
    return {'ghpName': ?ghpName, 'name': ?name, 'traits': ?traits};
  }
}