googleapis
Version:
Google APIs Client Library for Node.js
1,266 lines • 85.5 kB
TypeScript
/**
* 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 { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace blogger_v3 {
interface Options extends GlobalOptions {
version: 'v3';
}
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;
}
/**
* Blogger API
*
* API for access to the data within Blogger.
*
* @example
* const {google} = require('googleapis');
* const blogger = google.blogger('v3');
*
* @namespace blogger
* @type {Function}
* @version v3
* @variation v3
* @param {object=} options Options for Blogger
*/
class Blogger {
context: APIRequestContext;
blogs: Resource$Blogs;
blogUserInfos: Resource$Bloguserinfos;
comments: Resource$Comments;
pages: Resource$Pages;
pageViews: Resource$Pageviews;
posts: Resource$Posts;
postUserInfos: Resource$Postuserinfos;
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
interface Schema$Blog {
/**
* The JSON custom meta-data for the Blog
*/
customMetaData?: string;
/**
* The description of this blog. This is displayed underneath the title.
*/
description?: string;
/**
* The identifier for this resource.
*/
id?: string;
/**
* The kind of this entry. Always blogger#blog
*/
kind?: string;
/**
* The locale this Blog is set to.
*/
locale?: {
country?: string;
language?: string;
variant?: string;
};
/**
* The name of this blog. This is displayed as the title.
*/
name?: string;
/**
* The container of pages in this blog.
*/
pages?: {
selfLink?: string;
totalItems?: number;
};
/**
* The container of posts in this blog.
*/
posts?: {
items?: Schema$Post[];
selfLink?: string;
totalItems?: number;
};
/**
* RFC 3339 date-time when this blog was published.
*/
published?: string;
/**
* The API REST URL to fetch this resource from.
*/
selfLink?: string;
/**
* The status of the blog.
*/
status?: string;
/**
* RFC 3339 date-time when this blog was last updated.
*/
updated?: string;
/**
* The URL where this blog is published.
*/
url?: string;
}
interface Schema$BlogList {
/**
* Admin level list of blog per-user information
*/
blogUserInfos?: Schema$BlogUserInfo[];
/**
* The list of Blogs this user has Authorship or Admin rights over.
*/
items?: Schema$Blog[];
/**
* The kind of this entity. Always blogger#blogList
*/
kind?: string;
}
interface Schema$BlogPerUserInfo {
/**
* ID of the Blog resource
*/
blogId?: string;
/**
* True if the user has Admin level access to the blog.
*/
hasAdminAccess?: boolean;
/**
* The kind of this entity. Always blogger#blogPerUserInfo
*/
kind?: string;
/**
* The Photo Album Key for the user when adding photos to the blog
*/
photosAlbumKey?: string;
/**
* Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
*/
role?: string;
/**
* ID of the User
*/
userId?: string;
}
interface Schema$BlogUserInfo {
/**
* The Blog resource.
*/
blog?: Schema$Blog;
/**
* Information about a User for the Blog.
*/
blog_user_info?: Schema$BlogPerUserInfo;
/**
* The kind of this entity. Always blogger#blogUserInfo
*/
kind?: string;
}
interface Schema$Comment {
/**
* The author of this Comment.
*/
author?: {
displayName?: string;
id?: string;
image?: {
url?: string;
};
url?: string;
};
/**
* Data about the blog containing this comment.
*/
blog?: {
id?: string;
};
/**
* The actual content of the comment. May include HTML markup.
*/
content?: string;
/**
* The identifier for this resource.
*/
id?: string;
/**
* Data about the comment this is in reply to.
*/
inReplyTo?: {
id?: string;
};
/**
* The kind of this entry. Always blogger#comment
*/
kind?: string;
/**
* Data about the post containing this comment.
*/
post?: {
id?: string;
};
/**
* RFC 3339 date-time when this comment was published.
*/
published?: string;
/**
* The API REST URL to fetch this resource from.
*/
selfLink?: string;
/**
* The status of the comment (only populated for admin users)
*/
status?: string;
/**
* RFC 3339 date-time when this comment was last updated.
*/
updated?: string;
}
interface Schema$CommentList {
/**
* Etag of the response.
*/
etag?: string;
/**
* The List of Comments for a Post.
*/
items?: Schema$Comment[];
/**
* The kind of this entry. Always blogger#commentList
*/
kind?: string;
/**
* Pagination token to fetch the next page, if one exists.
*/
nextPageToken?: string;
/**
* Pagination token to fetch the previous page, if one exists.
*/
prevPageToken?: string;
}
interface Schema$Page {
/**
* The author of this Page.
*/
author?: {
displayName?: string;
id?: string;
image?: {
url?: string;
};
url?: string;
};
/**
* Data about the blog containing this Page.
*/
blog?: {
id?: string;
};
/**
* The body content of this Page, in HTML.
*/
content?: string;
/**
* Etag of the resource.
*/
etag?: string;
/**
* The identifier for this resource.
*/
id?: string;
/**
* The kind of this entity. Always blogger#page
*/
kind?: string;
/**
* RFC 3339 date-time when this Page was published.
*/
published?: string;
/**
* The API REST URL to fetch this resource from.
*/
selfLink?: string;
/**
* The status of the page for admin resources (either LIVE or DRAFT).
*/
status?: string;
/**
* The title of this entity. This is the name displayed in the Admin user interface.
*/
title?: string;
/**
* RFC 3339 date-time when this Page was last updated.
*/
updated?: string;
/**
* The URL that this Page is displayed at.
*/
url?: string;
}
interface Schema$PageList {
/**
* Etag of the response.
*/
etag?: string;
/**
* The list of Pages for a Blog.
*/
items?: Schema$Page[];
/**
* The kind of this entity. Always blogger#pageList
*/
kind?: string;
/**
* Pagination token to fetch the next page, if one exists.
*/
nextPageToken?: string;
}
interface Schema$Pageviews {
/**
* Blog Id
*/
blogId?: string;
/**
* The container of posts in this blog.
*/
counts?: Array<{
count?: string;
timeRange?: string;
}>;
/**
* The kind of this entry. Always blogger#page_views
*/
kind?: string;
}
interface Schema$Post {
/**
* The author of this Post.
*/
author?: {
displayName?: string;
id?: string;
image?: {
url?: string;
};
url?: string;
};
/**
* Data about the blog containing this Post.
*/
blog?: {
id?: string;
};
/**
* The content of the Post. May contain HTML markup.
*/
content?: string;
/**
* The JSON meta-data for the Post.
*/
customMetaData?: string;
/**
* Etag of the resource.
*/
etag?: string;
/**
* The identifier of this Post.
*/
id?: string;
/**
* Display image for the Post.
*/
images?: Array<{
url?: string;
}>;
/**
* The kind of this entity. Always blogger#post
*/
kind?: string;
/**
* The list of labels this Post was tagged with.
*/
labels?: string[];
/**
* The location for geotagged posts.
*/
location?: {
lat?: number;
lng?: number;
name?: string;
span?: string;
};
/**
* RFC 3339 date-time when this Post was published.
*/
published?: string;
/**
* Comment control and display setting for readers of this post.
*/
readerComments?: string;
/**
* The container of comments on this Post.
*/
replies?: {
items?: Schema$Comment[];
selfLink?: string;
totalItems?: string;
};
/**
* The API REST URL to fetch this resource from.
*/
selfLink?: string;
/**
* Status of the post. Only set for admin-level requests
*/
status?: string;
/**
* The title of the Post.
*/
title?: string;
/**
* The title link URL, similar to atom's related link.
*/
titleLink?: string;
/**
* RFC 3339 date-time when this Post was last updated.
*/
updated?: string;
/**
* The URL where this Post is displayed.
*/
url?: string;
}
interface Schema$PostList {
/**
* Etag of the response.
*/
etag?: string;
/**
* The list of Posts for this Blog.
*/
items?: Schema$Post[];
/**
* The kind of this entity. Always blogger#postList
*/
kind?: string;
/**
* Pagination token to fetch the next page, if one exists.
*/
nextPageToken?: string;
}
interface Schema$PostPerUserInfo {
/**
* ID of the Blog that the post resource belongs to.
*/
blogId?: string;
/**
* True if the user has Author level access to the post.
*/
hasEditAccess?: boolean;
/**
* The kind of this entity. Always blogger#postPerUserInfo
*/
kind?: string;
/**
* ID of the Post resource.
*/
postId?: string;
/**
* ID of the User.
*/
userId?: string;
}
interface Schema$PostUserInfo {
/**
* The kind of this entity. Always blogger#postUserInfo
*/
kind?: string;
/**
* The Post resource.
*/
post?: Schema$Post;
/**
* Information about a User for the Post.
*/
post_user_info?: Schema$PostPerUserInfo;
}
interface Schema$PostUserInfosList {
/**
* The list of Posts with User information for the post, for this Blog.
*/
items?: Schema$PostUserInfo[];
/**
* The kind of this entity. Always blogger#postList
*/
kind?: string;
/**
* Pagination token to fetch the next page, if one exists.
*/
nextPageToken?: string;
}
interface Schema$User {
/**
* Profile summary information.
*/
about?: string;
/**
* The container of blogs for this user.
*/
blogs?: {
selfLink?: string;
};
/**
* The timestamp of when this profile was created, in seconds since epoch.
*/
created?: string;
/**
* The display name.
*/
displayName?: string;
/**
* The identifier for this User.
*/
id?: string;
/**
* The kind of this entity. Always blogger#user
*/
kind?: string;
/**
* This user's locale
*/
locale?: {
country?: string;
language?: string;
variant?: string;
};
/**
* The API REST URL to fetch this resource from.
*/
selfLink?: string;
/**
* The user's profile page.
*/
url?: string;
}
class Resource$Blogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* blogger.blogs.get
* @desc Gets one blog by ID.
* @alias blogger.blogs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the blog to get.
* @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog.
* @param {string=} params.view Access level with which to view the blog. Note that some fields require elevated access.
* @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$Blogs$Get, options?: MethodOptions): GaxiosPromise<Schema$Blog>;
get(params: Params$Resource$Blogs$Get, options: MethodOptions | BodyResponseCallback<Schema$Blog>, callback: BodyResponseCallback<Schema$Blog>): void;
get(params: Params$Resource$Blogs$Get, callback: BodyResponseCallback<Schema$Blog>): void;
get(callback: BodyResponseCallback<Schema$Blog>): void;
/**
* blogger.blogs.getByUrl
* @desc Retrieve a Blog by URL.
* @alias blogger.blogs.getByUrl
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.url The URL of the blog to retrieve.
* @param {string=} params.view Access level with which to view the blog. Note that some fields require elevated access.
* @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
*/
getByUrl(params?: Params$Resource$Blogs$Getbyurl, options?: MethodOptions): GaxiosPromise<Schema$Blog>;
getByUrl(params: Params$Resource$Blogs$Getbyurl, options: MethodOptions | BodyResponseCallback<Schema$Blog>, callback: BodyResponseCallback<Schema$Blog>): void;
getByUrl(params: Params$Resource$Blogs$Getbyurl, callback: BodyResponseCallback<Schema$Blog>): void;
getByUrl(callback: BodyResponseCallback<Schema$Blog>): void;
/**
* blogger.blogs.listByUser
* @desc Retrieves a list of blogs, possibly filtered.
* @alias blogger.blogs.listByUser
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.fetchUserInfo Whether the response is a list of blogs with per-user information instead of just blogs.
* @param {string=} params.role User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.
* @param {string=} params.status Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.
* @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
* @param {string=} params.view Access level with which to view the blogs. Note that some fields require elevated access.
* @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
*/
listByUser(params?: Params$Resource$Blogs$Listbyuser, options?: MethodOptions): GaxiosPromise<Schema$BlogList>;
listByUser(params: Params$Resource$Blogs$Listbyuser, options: MethodOptions | BodyResponseCallback<Schema$BlogList>, callback: BodyResponseCallback<Schema$BlogList>): void;
listByUser(params: Params$Resource$Blogs$Listbyuser, callback: BodyResponseCallback<Schema$BlogList>): void;
listByUser(callback: BodyResponseCallback<Schema$BlogList>): void;
}
interface Params$Resource$Blogs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the blog to get.
*/
blogId?: string;
/**
* Maximum number of posts to pull back with the blog.
*/
maxPosts?: number;
/**
* Access level with which to view the blog. Note that some fields require elevated access.
*/
view?: string;
}
interface Params$Resource$Blogs$Getbyurl extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The URL of the blog to retrieve.
*/
url?: string;
/**
* Access level with which to view the blog. Note that some fields require elevated access.
*/
view?: string;
}
interface Params$Resource$Blogs$Listbyuser extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether the response is a list of blogs with per-user information instead of just blogs.
*/
fetchUserInfo?: boolean;
/**
* User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.
*/
role?: string[];
/**
* Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.
*/
status?: string[];
/**
* ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
/**
* Access level with which to view the blogs. Note that some fields require elevated access.
*/
view?: string;
}
class Resource$Bloguserinfos {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* blogger.blogUserInfos.get
* @desc Gets one blog and user info pair by blogId and userId.
* @alias blogger.blogUserInfos.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the blog to get.
* @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog.
* @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
* @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$Bloguserinfos$Get, options?: MethodOptions): GaxiosPromise<Schema$BlogUserInfo>;
get(params: Params$Resource$Bloguserinfos$Get, options: MethodOptions | BodyResponseCallback<Schema$BlogUserInfo>, callback: BodyResponseCallback<Schema$BlogUserInfo>): void;
get(params: Params$Resource$Bloguserinfos$Get, callback: BodyResponseCallback<Schema$BlogUserInfo>): void;
get(callback: BodyResponseCallback<Schema$BlogUserInfo>): void;
}
interface Params$Resource$Bloguserinfos$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the blog to get.
*/
blogId?: string;
/**
* Maximum number of posts to pull back with the blog.
*/
maxPosts?: number;
/**
* ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
}
class Resource$Comments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* blogger.comments.approve
* @desc Marks a comment as not spam.
* @alias blogger.comments.approve
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.commentId The ID of the comment to mark as not spam.
* @param {string} params.postId The ID of the Post.
* @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
*/
approve(params?: Params$Resource$Comments$Approve, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
approve(params: Params$Resource$Comments$Approve, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
approve(params: Params$Resource$Comments$Approve, callback: BodyResponseCallback<Schema$Comment>): void;
approve(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* blogger.comments.delete
* @desc Delete a comment by ID.
* @alias blogger.comments.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.commentId The ID of the comment to delete.
* @param {string} params.postId The ID of the Post.
* @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$Comments$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Comments$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Comments$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* blogger.comments.get
* @desc Gets one comment by ID.
* @alias blogger.comments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId ID of the blog to containing the comment.
* @param {string} params.commentId The ID of the comment to get.
* @param {string} params.postId ID of the post to fetch posts from.
* @param {string=} params.view Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.
* @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$Comments$Get, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
get(params: Params$Resource$Comments$Get, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
get(params: Params$Resource$Comments$Get, callback: BodyResponseCallback<Schema$Comment>): void;
get(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* blogger.comments.list
* @desc Retrieves the comments for a post, possibly filtered.
* @alias blogger.comments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId ID of the blog to fetch comments from.
* @param {string=} params.endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting.
* @param {boolean=} params.fetchBodies Whether the body content of the comments is included.
* @param {integer=} params.maxResults Maximum number of comments to include in the result.
* @param {string=} params.pageToken Continuation token if request is paged.
* @param {string} params.postId ID of the post to fetch posts from.
* @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
* @param {string=} params.status
* @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access.
* @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$Comments$List, options?: MethodOptions): GaxiosPromise<Schema$CommentList>;
list(params: Params$Resource$Comments$List, options: MethodOptions | BodyResponseCallback<Schema$CommentList>, callback: BodyResponseCallback<Schema$CommentList>): void;
list(params: Params$Resource$Comments$List, callback: BodyResponseCallback<Schema$CommentList>): void;
list(callback: BodyResponseCallback<Schema$CommentList>): void;
/**
* blogger.comments.listByBlog
* @desc Retrieves the comments for a blog, across all posts, possibly filtered.
* @alias blogger.comments.listByBlog
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId ID of the blog to fetch comments from.
* @param {string=} params.endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting.
* @param {boolean=} params.fetchBodies Whether the body content of the comments is included.
* @param {integer=} params.maxResults Maximum number of comments to include in the result.
* @param {string=} params.pageToken Continuation token if request is paged.
* @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
* @param {string=} params.status
* @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
*/
listByBlog(params?: Params$Resource$Comments$Listbyblog, options?: MethodOptions): GaxiosPromise<Schema$CommentList>;
listByBlog(params: Params$Resource$Comments$Listbyblog, options: MethodOptions | BodyResponseCallback<Schema$CommentList>, callback: BodyResponseCallback<Schema$CommentList>): void;
listByBlog(params: Params$Resource$Comments$Listbyblog, callback: BodyResponseCallback<Schema$CommentList>): void;
listByBlog(callback: BodyResponseCallback<Schema$CommentList>): void;
/**
* blogger.comments.markAsSpam
* @desc Marks a comment as spam.
* @alias blogger.comments.markAsSpam
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.commentId The ID of the comment to mark as spam.
* @param {string} params.postId The ID of the Post.
* @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
*/
markAsSpam(params?: Params$Resource$Comments$Markasspam, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
markAsSpam(params: Params$Resource$Comments$Markasspam, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
markAsSpam(params: Params$Resource$Comments$Markasspam, callback: BodyResponseCallback<Schema$Comment>): void;
markAsSpam(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* blogger.comments.removeContent
* @desc Removes the content of a comment.
* @alias blogger.comments.removeContent
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.commentId The ID of the comment to delete content from.
* @param {string} params.postId The ID of the Post.
* @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
*/
removeContent(params?: Params$Resource$Comments$Removecontent, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
removeContent(params: Params$Resource$Comments$Removecontent, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
removeContent(params: Params$Resource$Comments$Removecontent, callback: BodyResponseCallback<Schema$Comment>): void;
removeContent(callback: BodyResponseCallback<Schema$Comment>): void;
}
interface Params$Resource$Comments$Approve extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Blog.
*/
blogId?: string;
/**
* The ID of the comment to mark as not spam.
*/
commentId?: string;
/**
* The ID of the Post.
*/
postId?: string;
}
interface Params$Resource$Comments$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Blog.
*/
blogId?: string;
/**
* The ID of the comment to delete.
*/
commentId?: string;
/**
* The ID of the Post.
*/
postId?: string;
}
interface Params$Resource$Comments$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the blog to containing the comment.
*/
blogId?: string;
/**
* The ID of the comment to get.
*/
commentId?: string;
/**
* ID of the post to fetch posts from.
*/
postId?: string;
/**
* Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.
*/
view?: string;
}
interface Params$Resource$Comments$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the blog to fetch comments from.
*/
blogId?: string;
/**
* Latest date of comment to fetch, a date-time with RFC 3339 formatting.
*/
endDate?: string;
/**
* Whether the body content of the comments is included.
*/
fetchBodies?: boolean;
/**
* Maximum number of comments to include in the result.
*/
maxResults?: number;
/**
* Continuation token if request is paged.
*/
pageToken?: string;
/**
* ID of the post to fetch posts from.
*/
postId?: string;
/**
* Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
*/
startDate?: string;
/**
*
*/
status?: string[];
/**
* Access level with which to view the returned result. Note that some fields require elevated access.
*/
view?: string;
}
interface Params$Resource$Comments$Listbyblog extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the blog to fetch comments from.
*/
blogId?: string;
/**
* Latest date of comment to fetch, a date-time with RFC 3339 formatting.
*/
endDate?: string;
/**
* Whether the body content of the comments is included.
*/
fetchBodies?: boolean;
/**
* Maximum number of comments to include in the result.
*/
maxResults?: number;
/**
* Continuation token if request is paged.
*/
pageToken?: string;
/**
* Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
*/
startDate?: string;
/**
*
*/
status?: string[];
}
interface Params$Resource$Comments$Markasspam extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Blog.
*/
blogId?: string;
/**
* The ID of the comment to mark as spam.
*/
commentId?: string;
/**
* The ID of the Post.
*/
postId?: string;
}
interface Params$Resource$Comments$Removecontent extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Blog.
*/
blogId?: string;
/**
* The ID of the comment to delete content from.
*/
commentId?: string;
/**
* The ID of the Post.
*/
postId?: string;
}
class Resource$Pages {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* blogger.pages.delete
* @desc Delete a page by ID.
* @alias blogger.pages.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.pageId The ID of the Page.
* @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$Pages$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Pages$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Pages$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* blogger.pages.get
* @desc Gets one blog page by ID.
* @alias blogger.pages.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId ID of the blog containing the page.
* @param {string} params.pageId The ID of the page to get.
* @param {string=} params.view
* @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$Pages$Get, options?: MethodOptions): GaxiosPromise<Schema$Page>;
get(params: Params$Resource$Pages$Get, options: MethodOptions | BodyResponseCallback<Schema$Page>, callback: BodyResponseCallback<Schema$Page>): void;
get(params: Params$Resource$Pages$Get, callback: BodyResponseCallback<Schema$Page>): void;
get(callback: BodyResponseCallback<Schema$Page>): void;
/**
* blogger.pages.insert
* @desc Add a page.
* @alias blogger.pages.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId ID of the blog to add the page to.
* @param {boolean=} params.isDraft Whether to create the page as a draft (default: false).
* @param {().Page} 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$Pages$Insert, options?: MethodOptions): GaxiosPromise<Schema$Page>;
insert(params: Params$Resource$Pages$Insert, options: MethodOptions | BodyResponseCallback<Schema$Page>, callback: BodyResponseCallback<Schema$Page>): void;
insert(params: Params$Resource$Pages$Insert, callback: BodyResponseCallback<Schema$Page>): void;
insert(callback: BodyResponseCallback<Schema$Page>): void;
/**
* blogger.pages.list
* @desc Retrieves the pages for a blog, optionally including non-LIVE statuses.
* @alias blogger.pages.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId ID of the blog to fetch Pages from.
* @param {boolean=} params.fetchBodies Whether to retrieve the Page bodies.
* @param {integer=} params.maxResults Maximum number of Pages to fetch.
* @param {string=} params.pageToken Continuation token if the request is paged.
* @param {string=} params.status
* @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access.
* @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$Pages$List, options?: MethodOptions): GaxiosPromise<Schema$PageList>;
list(params: Params$Resource$Pages$List, options: MethodOptions | BodyResponseCallback<Schema$PageList>, callback: BodyResponseCallback<Schema$PageList>): void;
list(params: Params$Resource$Pages$List, callback: BodyResponseCallback<Schema$PageList>): void;
list(callback: BodyResponseCallback<Schema$PageList>): void;
/**
* blogger.pages.patch
* @desc Update a page. This method supports patch semantics.
* @alias blogger.pages.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.pageId The ID of the Page.
* @param {boolean=} params.publish Whether a publish action should be performed when the page is updated (default: false).
* @param {boolean=} params.revert Whether a revert action should be performed when the page is updated (default: false).
* @param {().Page} 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$Pages$Patch, options?: MethodOptions): GaxiosPromise<Schema$Page>;
patch(params: Params$Resource$Pages$Patch, options: MethodOptions | BodyResponseCallback<Schema$Page>, callback: BodyResponseCallback<Schema$Page>): void;
patch(params: Params$Resource$Pages$Patch, callback: BodyResponseCallback<Schema$Page>): void;
patch(callback: BodyResponseCallback<Schema$Page>): void;
/**
* blogger.pages.publish
* @desc Publishes a draft page.
* @alias blogger.pages.publish
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the blog.
* @param {string} params.pageId The ID of the page.
* @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
*/
publish(params?: Params$Resource$Pages$Publish, options?: MethodOptions): GaxiosPromise<Schema$Page>;
publish(params: Params$Resource$Pages$Publish, options: MethodOptions | BodyResponseCallback<Schema$Page>, callback: BodyResponseCallback<Schema$Page>): void;
publish(params: Params$Resource$Pages$Publish, callback: BodyResponseCallback<Schema$Page>): void;
publish(callback: BodyResponseCallback<Schema$Page>): void;
/**
* blogger.pages.revert
* @desc Revert a published or scheduled page to draft state.
* @alias blogger.pages.revert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the blog.
* @param {string} params.pageId The ID of the page.
* @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
*/
revert(params?: Params$Resource$Pages$Revert, options?: MethodOptions): GaxiosPromise<Schema$Page>;
revert(params: Params$Resource$Pages$Revert, options: MethodOptions | BodyResponseCallback<Schema$Page>, callback: BodyResponseCallback<Schema$Page>): void;
revert(params: Params$Resource$Pages$Revert, callback: BodyResponseCallback<Schema$Page>): void;
revert(callback: BodyResponseCallback<Schema$Page>): void;
/**
* blogger.pages.update
* @desc Update a page.
* @alias blogger.pages.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.blogId The ID of the Blog.
* @param {string} params.pageId The ID of the Page.
* @param {boolean=} params.publish Whether a publish action should be performed when the page is updated (default: false).
* @param {boolean=} params.revert Whether a revert action should be performed when the page is updated (default: false).
* @param {().Page} 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$Pages$Update, options?: MethodOptions): GaxiosPromise<Schema$Page>;
update(params: Params$Resource$Pages$Update, options: MethodOptions | BodyResponseCallback<Schema$Page>, callback: BodyResponseCallback<Schema$Page>): void;
update(params: Params$Resource$Pages$Update, callback: BodyResponseCallback<Schema$Page>): void;
update(callback: BodyResponseCallback<Schema$Page>): void;
}
interface Params$Resource$Pages$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Blog.
*/
blogId?: string;
/**
* The ID of the Page.
*/
pageId?: string;
}
interface Params$Resource$Pages$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the blog containing the page.
*/
blogId?: string;
/**
* The ID of the page to get.
*/
pageId?: string;
/**
*
*/
view?: string;
}
interface Params$Resource$Pages$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the blog to add the page to.
*/
blogId?: string;
/**
* Whether to create the page as a draft (default: false).
*/
isDraft?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Page;
}
interface Params$Resource$Pages$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the blog to fetch Pages from.
*/
blogId?: string;
/**
* Whether to retrieve the Page bodies.
*/
fetchBodie