googleapis
Version:
Google APIs Client Library for Node.js
1,078 lines (1,077 loc) • 45.1 kB
TypeScript
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
* Google Mirror API
*
* Interacts with Glass users via the timeline.
*
* @example
* const google = require('googleapis');
* const mirror = google.mirror('v1');
*
* @namespace mirror
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Mirror
*/
export declare class Mirror {
_options: GlobalOptions;
google: GoogleApis;
root: this;
accounts: Resource$Accounts;
contacts: Resource$Contacts;
locations: Resource$Locations;
settings: Resource$Settings;
subscriptions: Resource$Subscriptions;
timeline: Resource$Timeline;
constructor(options: GlobalOptions, google: GoogleApis);
getRoot(): this;
}
/**
* Represents an account passed into the Account Manager on Glass.
*/
export interface Schema$Account {
authTokens: Schema$AuthToken[];
features: string[];
password: string;
userData: Schema$UserData[];
}
/**
* Represents media content, such as a photo, that can be attached to a timeline
* item.
*/
export interface Schema$Attachment {
/**
* The MIME type of the attachment.
*/
contentType: string;
/**
* The URL for the content.
*/
contentUrl: string;
/**
* The ID of the attachment.
*/
id: string;
/**
* Indicates that the contentUrl is not available because the attachment
* content is still being processed. If the caller wishes to retrieve the
* content, it should try again later.
*/
isProcessingContent: boolean;
}
/**
* A list of Attachments. This is the response from the server to GET requests
* on the attachments collection.
*/
export interface Schema$AttachmentsListResponse {
/**
* The list of attachments.
*/
items: Schema$Attachment[];
/**
* The type of resource. This is always mirror#attachmentsList.
*/
kind: string;
}
export interface Schema$AuthToken {
authToken: string;
type: string;
}
/**
* A single menu command that is part of a Contact.
*/
export interface Schema$Command {
/**
* The type of operation this command corresponds to. Allowed values are: -
* TAKE_A_NOTE - Shares a timeline item with the transcription of user speech
* from the "Take a note" voice menu command. - POST_AN_UPDATE -
* Shares a timeline item with the transcription of user speech from the
* "Post an update" voice menu command.
*/
type: string;
}
/**
* A person or group that can be used as a creator or a contact.
*/
export interface Schema$Contact {
/**
* A list of voice menu commands that a contact can handle. Glass shows up to
* three contacts for each voice menu command. If there are more than that,
* the three contacts with the highest priority are shown for that particular
* command.
*/
acceptCommands: Schema$Command[];
/**
* A list of MIME types that a contact supports. The contact will be shown to
* the user if any of its acceptTypes matches any of the types of the
* attachments on the item. If no acceptTypes are given, the contact will be
* shown for all items.
*/
acceptTypes: string[];
/**
* The name to display for this contact.
*/
displayName: string;
/**
* An ID for this contact. This is generated by the application and is treated
* as an opaque token.
*/
id: string;
/**
* Set of image URLs to display for a contact. Most contacts will have a
* single image, but a "group" contact may include up to 8 image
* URLs and they will be resized and cropped into a mosaic on the client.
*/
imageUrls: string[];
/**
* The type of resource. This is always mirror#contact.
*/
kind: string;
/**
* Primary phone number for the contact. This can be a fully-qualified number,
* with country calling code and area code, or a local number.
*/
phoneNumber: string;
/**
* Priority for the contact to determine ordering in a list of contacts.
* Contacts with higher priorities will be shown before ones with lower
* priorities.
*/
priority: number;
/**
* A list of sharing features that a contact can handle. Allowed values are:
* - ADD_CAPTION
*/
sharingFeatures: string[];
/**
* The ID of the application that created this contact. This is populated by
* the API
*/
source: string;
/**
* Name of this contact as it should be pronounced. If this contact's name
* must be spoken as part of a voice disambiguation menu, this name is used as
* the expected pronunciation. This is useful for contact names with
* unpronounceable characters or whose display spelling is otherwise not
* phonetic.
*/
speakableName: string;
/**
* The type for this contact. This is used for sorting in UIs. Allowed values
* are: - INDIVIDUAL - Represents a single person. This is the default. -
* GROUP - Represents more than a single person.
*/
type: string;
}
/**
* A list of Contacts representing contacts. This is the response from the
* server to GET requests on the contacts collection.
*/
export interface Schema$ContactsListResponse {
/**
* Contact list.
*/
items: Schema$Contact[];
/**
* The type of resource. This is always mirror#contacts.
*/
kind: string;
}
/**
* A geographic location that can be associated with a timeline item.
*/
export interface Schema$Location {
/**
* The accuracy of the location fix in meters.
*/
accuracy: number;
/**
* The full address of the location.
*/
address: string;
/**
* The name to be displayed. This may be a business name or a user-defined
* place, such as "Home".
*/
displayName: string;
/**
* The ID of the location.
*/
id: string;
/**
* The type of resource. This is always mirror#location.
*/
kind: string;
/**
* The latitude, in degrees.
*/
latitude: number;
/**
* The longitude, in degrees.
*/
longitude: number;
/**
* The time at which this location was captured, formatted according to RFC
* 3339.
*/
timestamp: string;
}
/**
* A list of Locations. This is the response from the server to GET requests on
* the locations collection.
*/
export interface Schema$LocationsListResponse {
/**
* The list of locations.
*/
items: Schema$Location[];
/**
* The type of resource. This is always mirror#locationsList.
*/
kind: string;
}
/**
* A custom menu item that can be presented to the user by a timeline item.
*/
export interface Schema$MenuItem {
/**
* Controls the behavior when the user picks the menu option. Allowed values
* are: - CUSTOM - Custom action set by the service. When the user selects
* this menuItem, the API triggers a notification to your callbackUrl with the
* userActions.type set to CUSTOM and the userActions.payload set to the ID of
* this menu item. This is the default value. - Built-in actions: - REPLY -
* Initiate a reply to the timeline item using the voice recording UI. The
* creator attribute must be set in the timeline item for this menu to be
* available. - REPLY_ALL - Same behavior as REPLY. The original timeline
* item's recipients will be added to the reply item. - DELETE - Delete
* the timeline item. - SHARE - Share the timeline item with the available
* contacts. - READ_ALOUD - Read the timeline item's speakableText aloud;
* if this field is not set, read the text field; if none of those fields are
* set, this menu item is ignored. - GET_MEDIA_INPUT - Allow users to provide
* media payloads to Glassware from a menu item (currently, only transcribed
* text from voice input is supported). Subscribe to notifications when users
* invoke this menu item to receive the timeline item ID. Retrieve the media
* from the timeline item in the payload property. - VOICE_CALL - Initiate a
* phone call using the timeline item's creator.phoneNumber attribute as
* recipient. - NAVIGATE - Navigate to the timeline item's location. -
* TOGGLE_PINNED - Toggle the isPinned state of the timeline item. - OPEN_URI
* - Open the payload of the menu item in the browser. - PLAY_VIDEO - Open
* the payload of the menu item in the Glass video player. - SEND_MESSAGE -
* Initiate sending a message to the timeline item's creator: - If the
* creator.phoneNumber is set and Glass is connected to an Android phone, the
* message is an SMS. - Otherwise, if the creator.email is set, the message
* is an email.
*/
action: string;
/**
* The ContextualMenus.Command associated with this MenuItem (e.g.
* READ_ALOUD). The voice label for this command will be displayed in the
* voice menu and the touch label will be displayed in the touch menu. Note
* that the default menu value's display name will be overriden if you
* specify this property. Values that do not correspond to a
* ContextualMenus.Command name will be ignored.
*/
contextual_command: string;
/**
* The ID for this menu item. This is generated by the application and is
* treated as an opaque token.
*/
id: string;
/**
* A generic payload whose meaning changes depending on this MenuItem's
* action. - When the action is OPEN_URI, the payload is the URL of the
* website to view. - When the action is PLAY_VIDEO, the payload is the
* streaming URL of the video - When the action is GET_MEDIA_INPUT, the
* payload is the text transcription of a user's speech input
*/
payload: string;
/**
* If set to true on a CUSTOM menu item, that item will be removed from the
* menu after it is selected.
*/
removeWhenSelected: boolean;
/**
* For CUSTOM items, a list of values controlling the appearance of the menu
* item in each of its states. A value for the DEFAULT state must be provided.
* If the PENDING or CONFIRMED states are missing, they will not be shown.
*/
values: Schema$MenuValue[];
}
/**
* A single value that is part of a MenuItem.
*/
export interface Schema$MenuValue {
/**
* The name to display for the menu item. If you specify this property for a
* built-in menu item, the default contextual voice command for that menu item
* is not shown.
*/
displayName: string;
/**
* URL of an icon to display with the menu item.
*/
iconUrl: string;
/**
* The state that this value applies to. Allowed values are: - DEFAULT -
* Default value shown when displayed in the menuItems list. - PENDING -
* Value shown when the menuItem has been selected by the user but can still
* be cancelled. - CONFIRMED - Value shown when the menuItem has been
* selected by the user and can no longer be cancelled.
*/
state: string;
}
/**
* A notification delivered by the API.
*/
export interface Schema$Notification {
/**
* The collection that generated the notification.
*/
collection: string;
/**
* The ID of the item that generated the notification.
*/
itemId: string;
/**
* The type of operation that generated the notification.
*/
operation: string;
/**
* A list of actions taken by the user that triggered the notification.
*/
userActions: Schema$UserAction[];
/**
* The user token provided by the service when it subscribed for
* notifications.
*/
userToken: string;
/**
* The secret verify token provided by the service when it subscribed for
* notifications.
*/
verifyToken: string;
}
/**
* Controls how notifications for a timeline item are presented to the user.
*/
export interface Schema$NotificationConfig {
/**
* The time at which the notification should be delivered.
*/
deliveryTime: string;
/**
* Describes how important the notification is. Allowed values are: -
* DEFAULT - Notifications of default importance. A chime will be played to
* alert users.
*/
level: string;
}
/**
* A setting for Glass.
*/
export interface Schema$Setting {
/**
* The setting's ID. The following IDs are valid: - locale - The key to
* the user’s language/locale (BCP 47 identifier) that Glassware should use to
* render localized content. - timezone - The key to the user’s current time
* zone region as defined in the tz database. Example: America/Los_Angeles.
*/
id: string;
/**
* The type of resource. This is always mirror#setting.
*/
kind: string;
/**
* The setting value, as a string.
*/
value: string;
}
/**
* A subscription to events on a collection.
*/
export interface Schema$Subscription {
/**
* The URL where notifications should be delivered (must start with https://).
*/
callbackUrl: string;
/**
* The collection to subscribe to. Allowed values are: - timeline - Changes
* in the timeline including insertion, deletion, and updates. - locations -
* Location updates. - settings - Settings updates.
*/
collection: string;
/**
* The ID of the subscription.
*/
id: string;
/**
* The type of resource. This is always mirror#subscription.
*/
kind: string;
/**
* Container object for notifications. This is not populated in the
* Subscription resource.
*/
notification: Schema$Notification;
/**
* A list of operations that should be subscribed to. An empty list indicates
* that all operations on the collection should be subscribed to. Allowed
* values are: - UPDATE - The item has been updated. - INSERT - A new item
* has been inserted. - DELETE - The item has been deleted. - MENU_ACTION -
* A custom menu item has been triggered by the user.
*/
operation: string[];
/**
* The time at which this subscription was last modified, formatted according
* to RFC 3339.
*/
updated: string;
/**
* An opaque token sent to the subscriber in notifications so that it can
* determine the ID of the user.
*/
userToken: string;
/**
* A secret token sent to the subscriber in notifications so that it can
* verify that the notification was generated by Google.
*/
verifyToken: string;
}
/**
* A list of Subscriptions. This is the response from the server to GET requests
* on the subscription collection.
*/
export interface Schema$SubscriptionsListResponse {
/**
* The list of subscriptions.
*/
items: Schema$Subscription[];
/**
* The type of resource. This is always mirror#subscriptionsList.
*/
kind: string;
}
/**
* Each item in the user's timeline is represented as a TimelineItem JSON
* structure, described below.
*/
export interface Schema$TimelineItem {
/**
* A list of media attachments associated with this item. As a convenience,
* you can refer to attachments in your HTML payloads with the attachment or
* cid scheme. For example: - attachment: <img
* src="attachment:attachment_index"> where attachment_index is
* the 0-based index of this array. - cid: <img
* src="cid:attachment_id"> where attachment_id is the ID of the
* attachment.
*/
attachments: Schema$Attachment[];
/**
* The bundle ID for this item. Services can specify a bundleId to group many
* items together. They appear under a single top-level item on the device.
*/
bundleId: string;
/**
* A canonical URL pointing to the canonical/high quality version of the data
* represented by the timeline item.
*/
canonicalUrl: string;
/**
* The time at which this item was created, formatted according to RFC 3339.
*/
created: string;
/**
* The user or group that created this item.
*/
creator: Schema$Contact;
/**
* The time that should be displayed when this item is viewed in the timeline,
* formatted according to RFC 3339. This user's timeline is sorted
* chronologically on display time, so this will also determine where the item
* is displayed in the timeline. If not set by the service, the display time
* defaults to the updated time.
*/
displayTime: string;
/**
* ETag for this item.
*/
etag: string;
/**
* HTML content for this item. If both text and html are provided for an item,
* the html will be rendered in the timeline. Allowed HTML elements - You can
* use these elements in your timeline cards. - Headers: h1, h2, h3, h4, h5,
* h6 - Images: img - Lists: li, ol, ul - HTML5 semantics: article, aside,
* details, figure, figcaption, footer, header, nav, section, summary, time -
* Structural: blockquote, br, div, hr, p, span - Style: b, big, center, em,
* i, u, s, small, strike, strong, style, sub, sup - Tables: table, tbody,
* td, tfoot, th, thead, tr Blocked HTML elements: These elements and their
* contents are removed from HTML payloads. - Document headers: head, title
* - Embeds: audio, embed, object, source, video - Frames: frame, frameset -
* Scripting: applet, script Other elements: Any elements that aren't
* listed are removed, but their contents are preserved.
*/
html: string;
/**
* The ID of the timeline item. This is unique within a user's timeline.
*/
id: string;
/**
* If this item was generated as a reply to another item, this field will be
* set to the ID of the item being replied to. This can be used to attach a
* reply to the appropriate conversation or post.
*/
inReplyTo: string;
/**
* Whether this item is a bundle cover. If an item is marked as a bundle
* cover, it will be the entry point to the bundle of items that have the same
* bundleId as that item. It will be shown only on the main timeline — not
* within the opened bundle. On the main timeline, items that are shown are:
* - Items that have isBundleCover set to true - Items that do not have a
* bundleId In a bundle sub-timeline, items that are shown are: - Items
* that have the bundleId in question AND isBundleCover set to false
*/
isBundleCover: boolean;
/**
* When true, indicates this item is deleted, and only the ID property is set.
*/
isDeleted: boolean;
/**
* When true, indicates this item is pinned, which means it's grouped
* alongside "active" items like navigation and hangouts, on the
* opposite side of the home screen from historical (non-pinned) timeline
* items. You can allow the user to toggle the value of this property with the
* TOGGLE_PINNED built-in menu item.
*/
isPinned: boolean;
/**
* The type of resource. This is always mirror#timelineItem.
*/
kind: string;
/**
* The geographic location associated with this item.
*/
location: Schema$Location;
/**
* A list of menu items that will be presented to the user when this item is
* selected in the timeline.
*/
menuItems: Schema$MenuItem[];
/**
* Controls how notifications for this item are presented on the device. If
* this is missing, no notification will be generated.
*/
notification: Schema$NotificationConfig;
/**
* For pinned items, this determines the order in which the item is displayed
* in the timeline, with a higher score appearing closer to the clock. Note:
* setting this field is currently not supported.
*/
pinScore: number;
/**
* A list of users or groups that this item has been shared with.
*/
recipients: Schema$Contact[];
/**
* A URL that can be used to retrieve this item.
*/
selfLink: string;
/**
* Opaque string you can use to map a timeline item to data in your own
* service.
*/
sourceItemId: string;
/**
* The speakable version of the content of this item. Along with the
* READ_ALOUD menu item, use this field to provide text that would be clearer
* when read aloud, or to provide extended information to what is displayed
* visually on Glass. Glassware should also specify the speakableType field,
* which will be spoken before this text in cases where the additional context
* is useful, for example when the user requests that the item be read aloud
* following a notification.
*/
speakableText: string;
/**
* A speakable description of the type of this item. This will be announced to
* the user prior to reading the content of the item in cases where the
* additional context is useful, for example when the user requests that the
* item be read aloud following a notification. This should be a short,
* simple noun phrase such as "Email", "Text message", or
* "Daily Planet News Update". Glassware are encouraged to populate
* this field for every timeline item, even if the item does not contain
* speakableText or text so that the user can learn the type of the item
* without looking at the screen.
*/
speakableType: string;
/**
* Text content of this item.
*/
text: string;
/**
* The title of this item.
*/
title: string;
/**
* The time at which this item was last modified, formatted according to RFC
* 3339.
*/
updated: string;
}
/**
* A list of timeline items. This is the response from the server to GET
* requests on the timeline collection.
*/
export interface Schema$TimelineListResponse {
/**
* Items in the timeline.
*/
items: Schema$TimelineItem[];
/**
* The type of resource. This is always mirror#timeline.
*/
kind: string;
/**
* The next page token. Provide this as the pageToken parameter in the request
* to retrieve the next page of results.
*/
nextPageToken: string;
}
/**
* Represents an action taken by the user that triggered a notification.
*/
export interface Schema$UserAction {
/**
* An optional payload for the action. For actions of type CUSTOM, this is
* the ID of the custom menu item that was selected.
*/
payload: string;
/**
* The type of action. The value of this can be: - SHARE - the user shared
* an item. - REPLY - the user replied to an item. - REPLY_ALL - the user
* replied to all recipients of an item. - CUSTOM - the user selected a
* custom menu item on the timeline item. - DELETE - the user deleted the
* item. - PIN - the user pinned the item. - UNPIN - the user unpinned the
* item. - LAUNCH - the user initiated a voice command. In the future,
* additional types may be added. UserActions with unrecognized types should
* be ignored.
*/
type: string;
}
export interface Schema$UserData {
key: string;
value: string;
}
export declare class Resource$Accounts {
root: Mirror;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.accounts.insert
* @desc Inserts a new account for a user
* @alias mirror.accounts.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountName The name of the account to be passed to the Android Account Manager.
* @param {string} params.accountType Account type to be passed to Android Account Manager.
* @param {string} params.userToken The ID for the user.
* @param {().Account} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$Account>;
insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Account>, callback?: BodyResponseCallback<Schema$Account>): void;
}
export declare class Resource$Contacts {
root: Mirror;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.contacts.delete
* @desc Deletes a contact.
* @alias mirror.contacts.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the contact.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
/**
* mirror.contacts.get
* @desc Gets a single contact by ID.
* @alias mirror.contacts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the contact.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Contact>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Contact>, callback?: BodyResponseCallback<Schema$Contact>): void;
/**
* mirror.contacts.insert
* @desc Inserts a new contact.
* @alias mirror.contacts.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Contact} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$Contact>;
insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Contact>, callback?: BodyResponseCallback<Schema$Contact>): void;
/**
* mirror.contacts.list
* @desc Retrieves a list of contacts for the authenticated user.
* @alias mirror.contacts.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: any, options?: MethodOptions): AxiosPromise<Schema$ContactsListResponse>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$ContactsListResponse>, callback?: BodyResponseCallback<Schema$ContactsListResponse>): void;
/**
* mirror.contacts.patch
* @desc Updates a contact in place. This method supports patch semantics.
* @alias mirror.contacts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the contact.
* @param {().Contact} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: any, options?: MethodOptions): AxiosPromise<Schema$Contact>;
patch(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Contact>, callback?: BodyResponseCallback<Schema$Contact>): void;
/**
* mirror.contacts.update
* @desc Updates a contact in place.
* @alias mirror.contacts.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the contact.
* @param {().Contact} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: any, options?: MethodOptions): AxiosPromise<Schema$Contact>;
update(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Contact>, callback?: BodyResponseCallback<Schema$Contact>): void;
}
export declare class Resource$Locations {
root: Mirror;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.locations.get
* @desc Gets a single location by ID.
* @alias mirror.locations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the location or latest for the last known location.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Location>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Location>, callback?: BodyResponseCallback<Schema$Location>): void;
/**
* mirror.locations.list
* @desc Retrieves a list of locations for the user.
* @alias mirror.locations.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: any, options?: MethodOptions): AxiosPromise<Schema$LocationsListResponse>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$LocationsListResponse>, callback?: BodyResponseCallback<Schema$LocationsListResponse>): void;
}
export declare class Resource$Settings {
root: Mirror;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.settings.get
* @desc Gets a single setting by ID.
* @alias mirror.settings.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the setting. The following IDs are valid: - locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. - timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Setting>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Setting>, callback?: BodyResponseCallback<Schema$Setting>): void;
}
export declare class Resource$Subscriptions {
root: Mirror;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.subscriptions.delete
* @desc Deletes a subscription.
* @alias mirror.subscriptions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the subscription.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
/**
* mirror.subscriptions.insert
* @desc Creates a new subscription.
* @alias mirror.subscriptions.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Subscription} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$Subscription>;
insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback?: BodyResponseCallback<Schema$Subscription>): void;
/**
* mirror.subscriptions.list
* @desc Retrieves a list of subscriptions for the authenticated user and
* service.
* @alias mirror.subscriptions.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: any, options?: MethodOptions): AxiosPromise<Schema$SubscriptionsListResponse>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$SubscriptionsListResponse>, callback?: BodyResponseCallback<Schema$SubscriptionsListResponse>): void;
/**
* mirror.subscriptions.update
* @desc Updates an existing subscription in place.
* @alias mirror.subscriptions.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the subscription.
* @param {().Subscription} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: any, options?: MethodOptions): AxiosPromise<Schema$Subscription>;
update(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback?: BodyResponseCallback<Schema$Subscription>): void;
}
export declare class Resource$Timeline {
root: Mirror;
attachments: Resource$Timeline$Attachments;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.timeline.delete
* @desc Deletes a timeline item.
* @alias mirror.timeline.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the timeline item.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
/**
* mirror.timeline.get
* @desc Gets a single timeline item by ID.
* @alias mirror.timeline.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the timeline item.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$TimelineItem>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$TimelineItem>, callback?: BodyResponseCallback<Schema$TimelineItem>): void;
/**
* mirror.timeline.insert
* @desc Inserts a new item into the timeline.
* @alias mirror.timeline.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$TimelineItem>;
insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$TimelineItem>, callback?: BodyResponseCallback<Schema$TimelineItem>): void;
/**
* mirror.timeline.list
* @desc Retrieves a list of timeline items for the authenticated user.
* @alias mirror.timeline.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.bundleId If provided, only items with the given bundleId will be returned.
* @param {boolean=} params.includeDeleted If true, tombstone records for deleted items will be returned.
* @param {integer=} params.maxResults The maximum number of items to include in the response, used for paging.
* @param {string=} params.orderBy Controls the order in which timeline items are returned.
* @param {string=} params.pageToken Token for the page of results to return.
* @param {boolean=} params.pinnedOnly If true, only pinned items will be returned.
* @param {string=} params.sourceItemId If provided, only items with the given sourceItemId will be returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: any, options?: MethodOptions): AxiosPromise<Schema$TimelineListResponse>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$TimelineListResponse>, callback?: BodyResponseCallback<Schema$TimelineListResponse>): void;
/**
* mirror.timeline.patch
* @desc Updates a timeline item in place. This method supports patch
* semantics.
* @alias mirror.timeline.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the timeline item.
* @param {().TimelineItem} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: any, options?: MethodOptions): AxiosPromise<Schema$TimelineItem>;
patch(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$TimelineItem>, callback?: BodyResponseCallback<Schema$TimelineItem>): void;
/**
* mirror.timeline.update
* @desc Updates a timeline item in place.
* @alias mirror.timeline.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the timeline item.
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: any, options?: MethodOptions): AxiosPromise<Schema$TimelineItem>;
update(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$TimelineItem>, callback?: BodyResponseCallback<Schema$TimelineItem>): void;
}
export declare class Resource$Timeline$Attachments {
root: Mirror;
constructor(root: Mirror);
getRoot(): Mirror;
/**
* mirror.timeline.attachments.delete
* @desc Deletes an attachment from a timeline item.
* @alias mirror.timeline.attachments.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.attachmentId The ID of the attachment.
* @param {string} params.itemId The ID of the timeline item the attachment belongs to.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
/**
* mirror.timeline.attachments.get
* @desc Retrieves an attachment on a timeline item by item ID and attachment
* ID.
* @alias mirror.timeline.attachments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.attachmentId The ID of the attachment.
* @param {string} params.itemId The ID of the timeline item the attachment belongs to.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Attachment>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Attachment>, callback?: BodyResponseCallback<Schema$Attachment>): void;
/**
* mirror.timeline.attachments.insert
* @desc Adds a new attachment to a timeline item.
* @alias mirror.timeline.attachments.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.itemId The ID of the timeline item the attachment belongs to.
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$Attachment>;
insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Attachment>, callback?: BodyResponseCallback<Schema$Attachment>): void;
/**
* mirror.timeline.attachments.list
* @desc Returns a list of attachments for a timeline item.
* @alias mirror.timeline.attachments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.itemId The ID of the timeline item whose attachments should be listed.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: any, options?: MethodOptions): AxiosPromise<Schema$AttachmentsListResponse>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$AttachmentsListResponse>, callback?: BodyResponseCallback<Schema$AttachmentsListResponse>): void;
}