google_api_blogger

v0.7.0

google_api_blogger v0.7.0 GoogleApi.Blogger.V3.Api.Pages View Source

API calls for all endpoints tagged Pages.

Link to this section Summary

Functions

blogger_pages_delete(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

Delete a page by ID.

blogger_pages_get(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

Gets one blog page by ID.

blogger_pages_insert(connection, blog_id, optional_params \\ [], opts \\ [])

Add a page.

blogger_pages_list(connection, blog_id, optional_params \\ [], opts \\ [])

Retrieves the pages for a blog, optionally including non-LIVE statuses.

blogger_pages_patch(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

Update a page. This method supports patch semantics.

blogger_pages_publish(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

Publishes a draft page.

blogger_pages_revert(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

Revert a published or scheduled page to draft state.

blogger_pages_update(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

Update a page.

Link to this section Functions

Link to this function

blogger_pages_delete(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete a page by ID.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - The ID of the Blog.
  • page_id (type: String.t) - The ID of the Page.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_get(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:error, Tesla.Env.t()}

Gets one blog page by ID.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - ID of the blog containing the page.
  • page_id (type: String.t) - The ID of the page to get.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :view (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_insert(connection, blog_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:error, Tesla.Env.t()}

Add a page.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - ID of the blog to add the page to.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :isDraft (type: boolean()) - Whether to create the page as a draft (default: false).
    • :body (type: GoogleApi.Blogger.V3.Model.Page.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_list(connection, blog_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Blogger.V3.Model.PageList.t()} | {:error, Tesla.Env.t()}

Retrieves the pages for a blog, optionally including non-LIVE statuses.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - ID of the blog to fetch Pages from.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :fetchBodies (type: boolean()) - Whether to retrieve the Page bodies.
    • :maxResults (type: integer()) - Maximum number of Pages to fetch.
    • :pageToken (type: String.t) - Continuation token if the request is paged.
    • :status (type: list(String.t)) -
    • :view (type: String.t) - Access level with which to view the returned result. Note that some fields require elevated access.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.PageList{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_patch(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:error, Tesla.Env.t()}

Update a page. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - The ID of the Blog.
  • page_id (type: String.t) - The ID of the Page.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :publish (type: boolean()) - Whether a publish action should be performed when the page is updated (default: false).
    • :revert (type: boolean()) - Whether a revert action should be performed when the page is updated (default: false).
    • :body (type: GoogleApi.Blogger.V3.Model.Page.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_publish(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_publish(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:error, Tesla.Env.t()}

Publishes a draft page.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - The ID of the blog.
  • page_id (type: String.t) - The ID of the page.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_revert(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_revert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:error, Tesla.Env.t()}

Revert a published or scheduled page to draft state.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - The ID of the blog.
  • page_id (type: String.t) - The ID of the page.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success
  • {:error, info} on failure
Link to this function

blogger_pages_update(connection, blog_id, page_id, optional_params \\ [], opts \\ [])

View Source 
blogger_pages_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:error, Tesla.Env.t()}

Update a page.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) - The ID of the Blog.
  • page_id (type: String.t) - The ID of the Page.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :publish (type: boolean()) - Whether a publish action should be performed when the page is updated (default: false).
    • :revert (type: boolean()) - Whether a revert action should be performed when the page is updated (default: false).
    • :body (type: GoogleApi.Blogger.V3.Model.Page.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success
  • {:error, info} on failure