@animeapis/identity
Version:
Identity client for Node.js
600 lines (599 loc) • 40.1 kB
TypeScript
/// <reference types="node" />
import * as gax from 'google-gax';
import { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* @class
* @memberof v1alpha1
*/
export declare class IdentityClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
identityStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of IdentityClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
* In fallback mode, a special browser-compatible transport implementation is used
* instead of gRPC transport. In browser context (if the `window` object is defined)
* the fallback mode is enabled automatically; set `options.fallback` to `false`
* if you need to override this behavior.
*/
constructor(opts?: ClientOptions);
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath(),
* exists for compatibility reasons.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): never[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the user to retrieve the profile from.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [UserProfile]{@link animeshon.identity.v1alpha1.UserProfile}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.get_user_profile.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_GetUserProfile_async
*/
getUserProfile(request?: protos.animeshon.identity.v1alpha1.IGetUserProfileRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUserProfile,
protos.animeshon.identity.v1alpha1.IGetUserProfileRequest | undefined,
{} | undefined
]>;
getUserProfile(request: protos.animeshon.identity.v1alpha1.IGetUserProfileRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUserProfile, protos.animeshon.identity.v1alpha1.IGetUserProfileRequest | null | undefined, {} | null | undefined>): void;
getUserProfile(request: protos.animeshon.identity.v1alpha1.IGetUserProfileRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUserProfile, protos.animeshon.identity.v1alpha1.IGetUserProfileRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the user to retrieve.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [User]{@link animeshon.identity.v1alpha1.User}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.get_user.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_GetUser_async
*/
getUser(request?: protos.animeshon.identity.v1alpha1.IGetUserRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUser,
protos.animeshon.identity.v1alpha1.IGetUserRequest | undefined,
{} | undefined
]>;
getUser(request: protos.animeshon.identity.v1alpha1.IGetUserRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUser, protos.animeshon.identity.v1alpha1.IGetUserRequest | null | undefined, {} | null | undefined>): void;
getUser(request: protos.animeshon.identity.v1alpha1.IGetUserRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUser, protos.animeshon.identity.v1alpha1.IGetUserRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {animeshon.identity.v1alpha1.User} request.user
* The user to create.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [User]{@link animeshon.identity.v1alpha1.User}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.create_user.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_CreateUser_async
*/
createUser(request?: protos.animeshon.identity.v1alpha1.ICreateUserRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUser,
protos.animeshon.identity.v1alpha1.ICreateUserRequest | undefined,
{} | undefined
]>;
createUser(request: protos.animeshon.identity.v1alpha1.ICreateUserRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUser, protos.animeshon.identity.v1alpha1.ICreateUserRequest | null | undefined, {} | null | undefined>): void;
createUser(request: protos.animeshon.identity.v1alpha1.ICreateUserRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUser, protos.animeshon.identity.v1alpha1.ICreateUserRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {animeshon.identity.v1alpha1.User} request.user
* The user to update.
* @param {google.protobuf.FieldMask} request.updateMask
* The field mask to determine which fields are to be updated. If empty, the
* server will assume all fields are to be updated.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [User]{@link animeshon.identity.v1alpha1.User}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.update_user.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_UpdateUser_async
*/
updateUser(request?: protos.animeshon.identity.v1alpha1.IUpdateUserRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUser,
protos.animeshon.identity.v1alpha1.IUpdateUserRequest | undefined,
{} | undefined
]>;
updateUser(request: protos.animeshon.identity.v1alpha1.IUpdateUserRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUser, protos.animeshon.identity.v1alpha1.IUpdateUserRequest | null | undefined, {} | null | undefined>): void;
updateUser(request: protos.animeshon.identity.v1alpha1.IUpdateUserRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUser, protos.animeshon.identity.v1alpha1.IUpdateUserRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the user to delete.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.delete_user.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_DeleteUser_async
*/
deleteUser(request?: protos.animeshon.identity.v1alpha1.IDeleteUserRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.animeshon.identity.v1alpha1.IDeleteUserRequest | undefined,
{} | undefined
]>;
deleteUser(request: protos.animeshon.identity.v1alpha1.IDeleteUserRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.animeshon.identity.v1alpha1.IDeleteUserRequest | null | undefined, {} | null | undefined>): void;
deleteUser(request: protos.animeshon.identity.v1alpha1.IDeleteUserRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.animeshon.identity.v1alpha1.IDeleteUserRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the user to retrieve the settings from.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [UserSettings]{@link animeshon.identity.v1alpha1.UserSettings}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.get_user_settings.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_GetUserSettings_async
*/
getUserSettings(request?: protos.animeshon.identity.v1alpha1.IGetUserSettingsRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUserSettings,
protos.animeshon.identity.v1alpha1.IGetUserSettingsRequest | undefined,
{} | undefined
]>;
getUserSettings(request: protos.animeshon.identity.v1alpha1.IGetUserSettingsRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUserSettings, protos.animeshon.identity.v1alpha1.IGetUserSettingsRequest | null | undefined, {} | null | undefined>): void;
getUserSettings(request: protos.animeshon.identity.v1alpha1.IGetUserSettingsRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUserSettings, protos.animeshon.identity.v1alpha1.IGetUserSettingsRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {animeshon.identity.v1alpha1.UserSettings} request.settings
* The user settings to update.
* @param {google.protobuf.FieldMask} request.updateMask
* The field mask to determine which fields are to be updated. If empty, the
* server will assume all fields are to be updated.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [UserSettings]{@link animeshon.identity.v1alpha1.UserSettings}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.update_user_settings.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_UpdateUserSettings_async
*/
updateUserSettings(request?: protos.animeshon.identity.v1alpha1.IUpdateUserSettingsRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUserSettings,
protos.animeshon.identity.v1alpha1.IUpdateUserSettingsRequest | undefined,
{} | undefined
]>;
updateUserSettings(request: protos.animeshon.identity.v1alpha1.IUpdateUserSettingsRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUserSettings, protos.animeshon.identity.v1alpha1.IUpdateUserSettingsRequest | null | undefined, {} | null | undefined>): void;
updateUserSettings(request: protos.animeshon.identity.v1alpha1.IUpdateUserSettingsRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUserSettings, protos.animeshon.identity.v1alpha1.IUpdateUserSettingsRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the user to retrieve the notifications from.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [UserNotifications]{@link animeshon.identity.v1alpha1.UserNotifications}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.get_user_notifications.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_GetUserNotifications_async
*/
getUserNotifications(request?: protos.animeshon.identity.v1alpha1.IGetUserNotificationsRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUserNotifications,
protos.animeshon.identity.v1alpha1.IGetUserNotificationsRequest | undefined,
{} | undefined
]>;
getUserNotifications(request: protos.animeshon.identity.v1alpha1.IGetUserNotificationsRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUserNotifications, protos.animeshon.identity.v1alpha1.IGetUserNotificationsRequest | null | undefined, {} | null | undefined>): void;
getUserNotifications(request: protos.animeshon.identity.v1alpha1.IGetUserNotificationsRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUserNotifications, protos.animeshon.identity.v1alpha1.IGetUserNotificationsRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {animeshon.identity.v1alpha1.UserNotifications} request.notifications
* The user notifications to update.
* @param {google.protobuf.FieldMask} request.updateMask
* The field mask to determine which fields are to be updated. If empty, the
* server will assume all fields are to be updated.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [UserNotifications]{@link animeshon.identity.v1alpha1.UserNotifications}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.update_user_notifications.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_UpdateUserNotifications_async
*/
updateUserNotifications(request?: protos.animeshon.identity.v1alpha1.IUpdateUserNotificationsRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUserNotifications,
protos.animeshon.identity.v1alpha1.IUpdateUserNotificationsRequest | undefined,
{} | undefined
]>;
updateUserNotifications(request: protos.animeshon.identity.v1alpha1.IUpdateUserNotificationsRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUserNotifications, protos.animeshon.identity.v1alpha1.IUpdateUserNotificationsRequest | null | undefined, {} | null | undefined>): void;
updateUserNotifications(request: protos.animeshon.identity.v1alpha1.IUpdateUserNotificationsRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUserNotifications, protos.animeshon.identity.v1alpha1.IUpdateUserNotificationsRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the user to retrieve the defaults from.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [UserDefaults]{@link animeshon.identity.v1alpha1.UserDefaults}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.get_user_defaults.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_GetUserDefaults_async
*/
getUserDefaults(request?: protos.animeshon.identity.v1alpha1.IGetUserDefaultsRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUserDefaults,
protos.animeshon.identity.v1alpha1.IGetUserDefaultsRequest | undefined,
{} | undefined
]>;
getUserDefaults(request: protos.animeshon.identity.v1alpha1.IGetUserDefaultsRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IUserDefaults, protos.animeshon.identity.v1alpha1.IGetUserDefaultsRequest | null | undefined, {} | null | undefined>): void;
getUserDefaults(request: protos.animeshon.identity.v1alpha1.IGetUserDefaultsRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IUserDefaults, protos.animeshon.identity.v1alpha1.IGetUserDefaultsRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the group to retrieve.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Group]{@link animeshon.identity.v1alpha1.Group}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.get_group.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_GetGroup_async
*/
getGroup(request?: protos.animeshon.identity.v1alpha1.IGetGroupRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IGroup,
protos.animeshon.identity.v1alpha1.IGetGroupRequest | undefined,
{} | undefined
]>;
getGroup(request: protos.animeshon.identity.v1alpha1.IGetGroupRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IGroup, protos.animeshon.identity.v1alpha1.IGetGroupRequest | null | undefined, {} | null | undefined>): void;
getGroup(request: protos.animeshon.identity.v1alpha1.IGetGroupRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IGroup, protos.animeshon.identity.v1alpha1.IGetGroupRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {animeshon.identity.v1alpha1.Group} request.group
* The group to create.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Group]{@link animeshon.identity.v1alpha1.Group}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.create_group.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_CreateGroup_async
*/
createGroup(request?: protos.animeshon.identity.v1alpha1.ICreateGroupRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IGroup,
protos.animeshon.identity.v1alpha1.ICreateGroupRequest | undefined,
{} | undefined
]>;
createGroup(request: protos.animeshon.identity.v1alpha1.ICreateGroupRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IGroup, protos.animeshon.identity.v1alpha1.ICreateGroupRequest | null | undefined, {} | null | undefined>): void;
createGroup(request: protos.animeshon.identity.v1alpha1.ICreateGroupRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IGroup, protos.animeshon.identity.v1alpha1.ICreateGroupRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {animeshon.identity.v1alpha1.Group} request.group
* The group to update.
* @param {google.protobuf.FieldMask} request.updateMask
* The field mask to determine which fields are to be updated. If empty, the
* server will assume all fields are to be updated.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Group]{@link animeshon.identity.v1alpha1.Group}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.update_group.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_UpdateGroup_async
*/
updateGroup(request?: protos.animeshon.identity.v1alpha1.IUpdateGroupRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IGroup,
protos.animeshon.identity.v1alpha1.IUpdateGroupRequest | undefined,
{} | undefined
]>;
updateGroup(request: protos.animeshon.identity.v1alpha1.IUpdateGroupRequest, options: CallOptions, callback: Callback<protos.animeshon.identity.v1alpha1.IGroup, protos.animeshon.identity.v1alpha1.IUpdateGroupRequest | null | undefined, {} | null | undefined>): void;
updateGroup(request: protos.animeshon.identity.v1alpha1.IUpdateGroupRequest, callback: Callback<protos.animeshon.identity.v1alpha1.IGroup, protos.animeshon.identity.v1alpha1.IUpdateGroupRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The name of the group to delete.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.delete_group.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_DeleteGroup_async
*/
deleteGroup(request?: protos.animeshon.identity.v1alpha1.IDeleteGroupRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.animeshon.identity.v1alpha1.IDeleteGroupRequest | undefined,
{} | undefined
]>;
deleteGroup(request: protos.animeshon.identity.v1alpha1.IDeleteGroupRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.animeshon.identity.v1alpha1.IDeleteGroupRequest | null | undefined, {} | null | undefined>): void;
deleteGroup(request: protos.animeshon.identity.v1alpha1.IDeleteGroupRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.animeshon.identity.v1alpha1.IDeleteGroupRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {number} request.pageSize
* If unspecified, server will pick an appropriate default.
* @param {string} request.pageToken
* The value returned from the previous call.
* @param {string} request.filter
* A filter to be applied to results.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [User]{@link animeshon.identity.v1alpha1.User}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
* We recommend using `listUsersAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
*/
listUsers(request?: protos.animeshon.identity.v1alpha1.IListUsersRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IUser[],
protos.animeshon.identity.v1alpha1.IListUsersRequest | null,
protos.animeshon.identity.v1alpha1.IListUsersResponse
]>;
listUsers(request: protos.animeshon.identity.v1alpha1.IListUsersRequest, options: CallOptions, callback: PaginationCallback<protos.animeshon.identity.v1alpha1.IListUsersRequest, protos.animeshon.identity.v1alpha1.IListUsersResponse | null | undefined, protos.animeshon.identity.v1alpha1.IUser>): void;
listUsers(request: protos.animeshon.identity.v1alpha1.IListUsersRequest, callback: PaginationCallback<protos.animeshon.identity.v1alpha1.IListUsersRequest, protos.animeshon.identity.v1alpha1.IListUsersResponse | null | undefined, protos.animeshon.identity.v1alpha1.IUser>): void;
/**
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {number} request.pageSize
* If unspecified, server will pick an appropriate default.
* @param {string} request.pageToken
* The value returned from the previous call.
* @param {string} request.filter
* A filter to be applied to results.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [User]{@link animeshon.identity.v1alpha1.User} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listUsersAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
*/
listUsersStream(request?: protos.animeshon.identity.v1alpha1.IListUsersRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listUsers`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {number} request.pageSize
* If unspecified, server will pick an appropriate default.
* @param {string} request.pageToken
* The value returned from the previous call.
* @param {string} request.filter
* A filter to be applied to results.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [User]{@link animeshon.identity.v1alpha1.User}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.list_users.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_ListUsers_async
*/
listUsersAsync(request?: protos.animeshon.identity.v1alpha1.IListUsersRequest, options?: CallOptions): AsyncIterable<protos.animeshon.identity.v1alpha1.IUser>;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {number} request.pageSize
* If unspecified, server will pick an appropriate default.
* @param {string} request.pageToken
* The value returned from the previous call.
* @param {string} request.filter
* A filter to be applied to results.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [Group]{@link animeshon.identity.v1alpha1.Group}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
* We recommend using `listGroupsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
*/
listGroups(request?: protos.animeshon.identity.v1alpha1.IListGroupsRequest, options?: CallOptions): Promise<[
protos.animeshon.identity.v1alpha1.IGroup[],
protos.animeshon.identity.v1alpha1.IListGroupsRequest | null,
protos.animeshon.identity.v1alpha1.IListGroupsResponse
]>;
listGroups(request: protos.animeshon.identity.v1alpha1.IListGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.animeshon.identity.v1alpha1.IListGroupsRequest, protos.animeshon.identity.v1alpha1.IListGroupsResponse | null | undefined, protos.animeshon.identity.v1alpha1.IGroup>): void;
listGroups(request: protos.animeshon.identity.v1alpha1.IListGroupsRequest, callback: PaginationCallback<protos.animeshon.identity.v1alpha1.IListGroupsRequest, protos.animeshon.identity.v1alpha1.IListGroupsResponse | null | undefined, protos.animeshon.identity.v1alpha1.IGroup>): void;
/**
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {number} request.pageSize
* If unspecified, server will pick an appropriate default.
* @param {string} request.pageToken
* The value returned from the previous call.
* @param {string} request.filter
* A filter to be applied to results.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [Group]{@link animeshon.identity.v1alpha1.Group} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listGroupsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
*/
listGroupsStream(request?: protos.animeshon.identity.v1alpha1.IListGroupsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listGroups`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {number} request.pageSize
* If unspecified, server will pick an appropriate default.
* @param {string} request.pageToken
* The value returned from the previous call.
* @param {string} request.filter
* A filter to be applied to results.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [Group]{@link animeshon.identity.v1alpha1.Group}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/identity.list_groups.js</caption>
* region_tag:identity_v1alpha1_generated_Identity_ListGroups_async
*/
listGroupsAsync(request?: protos.animeshon.identity.v1alpha1.IListGroupsRequest, options?: CallOptions): AsyncIterable<protos.animeshon.identity.v1alpha1.IGroup>;
/**
* Terminate the gRPC channel and close the client.
*
* The client will no longer be usable and all future behavior is undefined.
* @returns {Promise} A promise that resolves when the client is closed.
*/
close(): Promise<void>;
}