/** * Copyright 2019 Google LLC * * 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 { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace siteVerification_v1 { interface Options extends GlobalOptions { version: 'v1'; } interface StandardParameters { /** * Data format for the response. */ alt?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API * access, quota, and reports. Required unless you provide an OAuth 2.0 * token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * An opaque string that represents a user for quota purposes. Must not * exceed 40 characters. */ quotaUser?: string; /** * Deprecated. Please use quotaUser instead. */ userIp?: string; } /** * Google Site Verification API * * Verifies ownership of websites or domains with Google. * * @example * const {google} = require('googleapis'); * const siteVerification = google.siteVerification('v1'); * * @namespace siteVerification * @type {Function} * @version v1 * @variation v1 * @param {object=} options Options for Siteverification */ class Siteverification { webResource: Resource$Webresource; constructor(options: GlobalOptions, google?: GoogleConfigurable); } interface Schema$SiteVerificationWebResourceGettokenRequest { /** * The site for which a verification token will be generated. */ site?: { identifier?: string; type?: string; }; /** * The verification method that will be used to verify this site. For sites, * 'FILE' or 'META' methods may be used. For domains, only * 'DNS' may be used. */ verificationMethod?: string; } interface Schema$SiteVerificationWebResourceGettokenResponse { /** * The verification method to use in conjunction with this token. For FILE, * the token should be placed in the top-level directory of the site, stored * inside a file of the same name. For META, the token should be placed in * the HEAD tag of the default page that is loaded for the site. For DNS, * the token should be placed in a TXT record of the domain. */ method?: string; /** * The verification token. The token must be placed appropriately in order * for verification to succeed. */ token?: string; } interface Schema$SiteVerificationWebResourceListResponse { /** * The list of sites that are owned by the authenticated user. */ items?: Schema$SiteVerificationWebResourceResource[]; } interface Schema$SiteVerificationWebResourceResource { /** * The string used to identify this site. This value should be used in the * "id" portion of the REST URL for the Get, Update, and Delete * operations. */ id?: string; /** * The email addresses of all verified owners. */ owners?: string[]; /** * The address and type of a site that is verified or will be verified. */ site?: { identifier?: string; type?: string; }; } class Resource$Webresource { constructor(); /** * siteVerification.webResource.delete * @desc Relinquish ownership of a website or domain. * @alias siteVerification.webResource.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id The id of a verified site or domain. * @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?: Params$Resource$Webresource$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Webresource$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Webresource$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * siteVerification.webResource.get * @desc Get the most current data for a website or domain. * @alias siteVerification.webResource.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id The id of a verified site or domain. * @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?: Params$Resource$Webresource$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Webresource$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Webresource$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * siteVerification.webResource.getToken * @desc Get a verification token for placing on a website or domain. * @alias siteVerification.webResource.getToken * @memberOf! () * * @param {object} params Parameters for request * @param {().SiteVerificationWebResourceGettokenRequest} 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 */ getToken(params?: Params$Resource$Webresource$Gettoken, options?: MethodOptions): GaxiosPromise; getToken(params: Params$Resource$Webresource$Gettoken, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getToken(params: Params$Resource$Webresource$Gettoken, callback: BodyResponseCallback): void; getToken(callback: BodyResponseCallback): void; /** * siteVerification.webResource.insert * @desc Attempt verification of a website or domain. * @alias siteVerification.webResource.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.verificationMethod The method to use for verifying a site or domain. * @param {().SiteVerificationWebResourceResource} 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?: Params$Resource$Webresource$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Webresource$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Webresource$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * siteVerification.webResource.list * @desc Get the list of your verified websites and domains. * @alias siteVerification.webResource.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?: Params$Resource$Webresource$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Webresource$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Webresource$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * siteVerification.webResource.patch * @desc Modify the list of owners for your website or domain. This method * supports patch semantics. * @alias siteVerification.webResource.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id The id of a verified site or domain. * @param {().SiteVerificationWebResourceResource} 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?: Params$Resource$Webresource$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Webresource$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Webresource$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * siteVerification.webResource.update * @desc Modify the list of owners for your website or domain. * @alias siteVerification.webResource.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id The id of a verified site or domain. * @param {().SiteVerificationWebResourceResource} 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?: Params$Resource$Webresource$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Webresource$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Webresource$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Webresource$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The id of a verified site or domain. */ id?: string; } interface Params$Resource$Webresource$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The id of a verified site or domain. */ id?: string; } interface Params$Resource$Webresource$Gettoken extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$SiteVerificationWebResourceGettokenRequest; } interface Params$Resource$Webresource$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The method to use for verifying a site or domain. */ verificationMethod?: string; /** * Request body metadata */ requestBody?: Schema$SiteVerificationWebResourceResource; } interface Params$Resource$Webresource$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; } interface Params$Resource$Webresource$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The id of a verified site or domain. */ id?: string; /** * Request body metadata */ requestBody?: Schema$SiteVerificationWebResourceResource; } interface Params$Resource$Webresource$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The id of a verified site or domain. */ id?: string; /** * Request body metadata */ requestBody?: Schema$SiteVerificationWebResourceResource; } }