@googleapis/admin
Advanced tools
Comparing version 12.0.0 to 12.1.0
@@ -214,52 +214,3 @@ /// <reference types="node" /> | ||
* Retrieves information about an application for the given application ID. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.applications.get({ | ||
* // ID of the application resource to be retrieved. | ||
* applicationId: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "name": "my_name", | ||
* // "transferParams": [] | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -278,55 +229,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Lists the applications available for data transfer for a customer. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.applications.list({ | ||
* // Immutable ID of the Google Workspace account. | ||
* customerId: 'placeholder-value', | ||
* // Maximum number of results to return. Default is 100. | ||
* maxResults: 'placeholder-value', | ||
* // Token to specify next page in the list. | ||
* pageToken: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "applications": [], | ||
* // "etag": "my_etag", | ||
* // "kind": "my_kind", | ||
* // "nextPageToken": "my_nextPageToken" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -369,55 +268,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Retrieves a data transfer request by its resource ID. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.transfers.get({ | ||
* // ID of the resource to be retrieved. This is returned in the response from the insert method. | ||
* dataTransferId: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "applicationDataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "newOwnerUserId": "my_newOwnerUserId", | ||
* // "oldOwnerUserId": "my_oldOwnerUserId", | ||
* // "overallTransferStatusCode": "my_overallTransferStatusCode", | ||
* // "requestTime": "my_requestTime" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -436,64 +283,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: ['https://www.googleapis.com/auth/admin.datatransfer'], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.transfers.insert({ | ||
* // Request body metadata | ||
* requestBody: { | ||
* // request body parameters | ||
* // { | ||
* // "applicationDataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "newOwnerUserId": "my_newOwnerUserId", | ||
* // "oldOwnerUserId": "my_oldOwnerUserId", | ||
* // "overallTransferStatusCode": "my_overallTransferStatusCode", | ||
* // "requestTime": "my_requestTime" | ||
* // } | ||
* }, | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "applicationDataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "newOwnerUserId": "my_newOwnerUserId", | ||
* // "oldOwnerUserId": "my_oldOwnerUserId", | ||
* // "overallTransferStatusCode": "my_overallTransferStatusCode", | ||
* // "requestTime": "my_requestTime" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -512,61 +298,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Lists the transfers for a customer by source user, destination user, or status. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.transfers.list({ | ||
* // Immutable ID of the Google Workspace account. | ||
* customerId: 'placeholder-value', | ||
* // Maximum number of results to return. Default is 100. | ||
* maxResults: 'placeholder-value', | ||
* // Destination user's profile ID. | ||
* newOwnerUserId: 'placeholder-value', | ||
* // Source user's profile ID. | ||
* oldOwnerUserId: 'placeholder-value', | ||
* // Token to specify the next page in the list. | ||
* pageToken: 'placeholder-value', | ||
* // Status of the transfer. | ||
* status: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "dataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "kind": "my_kind", | ||
* // "nextPageToken": "my_nextPageToken" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -573,0 +301,0 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. |
# Changelog | ||
## [12.1.0](https://github.com/googleapis/google-api-nodejs-client/compare/admin-v12.0.0...admin-v12.1.0) (2023-08-09) | ||
### Features | ||
* **admin:** update the API ([1bc7f53](https://github.com/googleapis/google-api-nodejs-client/commit/1bc7f538577d1c6671c53e9ed4cfad24e2a1cf8f)) | ||
## [12.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/admin-v11.0.0...admin-v12.0.0) (2023-07-10) | ||
@@ -4,0 +11,0 @@ |
@@ -272,52 +272,3 @@ // Copyright 2020 Google LLC | ||
* Retrieves information about an application for the given application ID. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.applications.get({ | ||
* // ID of the application resource to be retrieved. | ||
* applicationId: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "name": "my_name", | ||
* // "transferParams": [] | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -407,55 +358,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Lists the applications available for data transfer for a customer. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.applications.list({ | ||
* // Immutable ID of the Google Workspace account. | ||
* customerId: 'placeholder-value', | ||
* // Maximum number of results to return. Default is 100. | ||
* maxResults: 'placeholder-value', | ||
* // Token to specify next page in the list. | ||
* pageToken: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "applications": [], | ||
* // "etag": "my_etag", | ||
* // "kind": "my_kind", | ||
* // "nextPageToken": "my_nextPageToken" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -581,55 +480,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Retrieves a data transfer request by its resource ID. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.transfers.get({ | ||
* // ID of the resource to be retrieved. This is returned in the response from the insert method. | ||
* dataTransferId: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "applicationDataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "newOwnerUserId": "my_newOwnerUserId", | ||
* // "oldOwnerUserId": "my_oldOwnerUserId", | ||
* // "overallTransferStatusCode": "my_overallTransferStatusCode", | ||
* // "requestTime": "my_requestTime" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -719,64 +566,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: ['https://www.googleapis.com/auth/admin.datatransfer'], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.transfers.insert({ | ||
* // Request body metadata | ||
* requestBody: { | ||
* // request body parameters | ||
* // { | ||
* // "applicationDataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "newOwnerUserId": "my_newOwnerUserId", | ||
* // "oldOwnerUserId": "my_oldOwnerUserId", | ||
* // "overallTransferStatusCode": "my_overallTransferStatusCode", | ||
* // "requestTime": "my_requestTime" | ||
* // } | ||
* }, | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "applicationDataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "id": "my_id", | ||
* // "kind": "my_kind", | ||
* // "newOwnerUserId": "my_newOwnerUserId", | ||
* // "oldOwnerUserId": "my_oldOwnerUserId", | ||
* // "overallTransferStatusCode": "my_overallTransferStatusCode", | ||
* // "requestTime": "my_requestTime" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -867,61 +653,3 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. | ||
* Lists the transfers for a customer by source user, destination user, or status. | ||
* @example | ||
* ```js | ||
* // Before running the sample: | ||
* // - Enable the API at: | ||
* // https://console.developers.google.com/apis/api/admin.googleapis.com | ||
* // - Login into gcloud by running: | ||
* // `$ gcloud auth application-default login` | ||
* // - Install the npm module by running: | ||
* // `$ npm install googleapis` | ||
* | ||
* const {google} = require('googleapis'); | ||
* const admin = google.admin('datatransfer_v1'); | ||
* | ||
* async function main() { | ||
* const auth = new google.auth.GoogleAuth({ | ||
* // Scopes can be specified either as an array or as a single, space-delimited string. | ||
* scopes: [ | ||
* 'https://www.googleapis.com/auth/admin.datatransfer', | ||
* 'https://www.googleapis.com/auth/admin.datatransfer.readonly', | ||
* ], | ||
* }); | ||
* | ||
* // Acquire an auth client, and bind it to all future calls | ||
* const authClient = await auth.getClient(); | ||
* google.options({auth: authClient}); | ||
* | ||
* // Do the magic | ||
* const res = await datatransfer.transfers.list({ | ||
* // Immutable ID of the Google Workspace account. | ||
* customerId: 'placeholder-value', | ||
* // Maximum number of results to return. Default is 100. | ||
* maxResults: 'placeholder-value', | ||
* // Destination user's profile ID. | ||
* newOwnerUserId: 'placeholder-value', | ||
* // Source user's profile ID. | ||
* oldOwnerUserId: 'placeholder-value', | ||
* // Token to specify the next page in the list. | ||
* pageToken: 'placeholder-value', | ||
* // Status of the transfer. | ||
* status: 'placeholder-value', | ||
* }); | ||
* console.log(res.data); | ||
* | ||
* // Example response | ||
* // { | ||
* // "dataTransfers": [], | ||
* // "etag": "my_etag", | ||
* // "kind": "my_kind", | ||
* // "nextPageToken": "my_nextPageToken" | ||
* // } | ||
* } | ||
* | ||
* main().catch(e => { | ||
* console.error(e); | ||
* throw e; | ||
* }); | ||
* | ||
* ``` | ||
* | ||
* @param params - Parameters for request | ||
@@ -928,0 +656,0 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. |
@@ -43,3 +43,3 @@ // Copyright 2020 Google LLC | ||
| admin_directory_v1.Admin | ||
| admin_reports_v1.Admin | ||
| admin_reports_v1.Admin, | ||
>( | ||
@@ -46,0 +46,0 @@ this: GoogleConfigurable, |
{ | ||
"name": "@googleapis/admin", | ||
"version": "12.0.0", | ||
"version": "12.1.0", | ||
"description": "admin", | ||
@@ -5,0 +5,0 @@ "main": "build/index.js", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1344380
28888