Skip to content

WordpressClient

Attributes

SiteModel module-attribute

SiteModel = List[Dict[str, Any]]

SiteStatsChartModel module-attribute

SiteStatsChartModel = List[Dict[str, Any]]

TopPostModel module-attribute

TopPostModel = List[Dict[str, Any]]

PostsModel module-attribute

PostsModel = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnTriggerNewPost': {'operation_id': 'OnTriggerNewPost', 'path': '/{connectionId}/trigger/me/posts', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListPostsResponse'}}

Classes

ListPostsResponse dataclass

ListPostsResponse(posts: Optional[List[PostResponse]] = None)

Response for When a post is created

Attributes

posts class-attribute instance-attribute
posts: Optional[List[PostResponse]] = None

Posts

SiteStatsModel dataclass

SiteStatsModel(visitors_today: Optional[int] = None, visitors_yesterday: Optional[int] = None, visitors: Optional[int] = None, views_today: Optional[int] = None, views_yesterday: Optional[int] = None, views_best_day: Optional[str] = None, views_best_day_total: Optional[int] = None, views: Optional[int] = None, comments: Optional[int] = None, posts: Optional[int] = None, followers_blog: Optional[int] = None, followers_comments: Optional[int] = None, comments_per_month: Optional[int] = None, comments_most_active_recent_day: Optional[str] = None, comments_most_active_time: Optional[str] = None, comments_spam: Optional[int] = None, categories: Optional[int] = None, tags: Optional[int] = None, shares: Optional[int] = None, shares_twitter: Optional[int] = None, shares_facebook: Optional[int] = None, shares_press_this: Optional[int] = None)

Response for Get site statistics

PostModel dataclass

PostModel(id: Optional[int] = None, site_id: Optional[int] = None, date: Optional[str] = None, modified: Optional[str] = None, title: Optional[str] = None, u_r_l: Optional[str] = None, short_u_r_l: Optional[str] = None, content: Optional[str] = None, excerpt: Optional[str] = None, slug: Optional[str] = None, guid: Optional[str] = None, status: Optional[str] = None, sticky: Optional[bool] = None, password: Optional[str] = None, parent: Optional[Any] = None, type_: Optional[str] = None, likes_enabled: Optional[bool] = None, sharing_enabled: Optional[bool] = None, like_count: Optional[int] = None, i_like: Optional[bool] = None, is_reblogged: Optional[bool] = None, is_following: Optional[bool] = None, global_id: Optional[str] = None, featured_image: Optional[str] = None, post_thumbnail: Optional[Dict[str, Any]] = None, format: Optional[str] = None, geo: Optional[bool] = None)

Response for Get post

SiteList dataclass

SiteList(sites: Optional[List[Site]] = None)

Response for List sites

Attributes

sites class-attribute instance-attribute
sites: Optional[List[Site]] = None

List of sites

Site dataclass

Site(id: Optional[int] = None, name: Optional[str] = None, description: Optional[str] = None, u_r_l: Optional[str] = None, is_multisite: Optional[bool] = None, post_count: Optional[int] = None, subscribers_count: Optional[int] = None, lang: Optional[str] = None, visible: Optional[bool] = None, is_private: Optional[bool] = None, single_user_site: Optional[bool] = None, is_vip: Optional[bool] = None, is_following: Optional[bool] = None)

Definition: Site

Attributes

id class-attribute instance-attribute
id: Optional[int] = field(default=None, metadata={'wire_name': 'ID'})

Site ID

name class-attribute instance-attribute
name: Optional[str] = None

Site Name

description class-attribute instance-attribute
description: Optional[str] = None

Site Description

u_r_l class-attribute instance-attribute
u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'URL'})

Site URL

is_multisite class-attribute instance-attribute
is_multisite: Optional[bool] = None

Whether the site is a Multisite site or not. Always true for WP.com sites.

post_count class-attribute instance-attribute
post_count: Optional[int] = None

The number of posts the site has

subscribers_count class-attribute instance-attribute
subscribers_count: Optional[int] = None

The number of subscribers the site has

lang class-attribute instance-attribute
lang: Optional[str] = None

Language

visible class-attribute instance-attribute
visible: Optional[bool] = None

Site visibility

is_private class-attribute instance-attribute
is_private: Optional[bool] = None

Is site private

single_user_site class-attribute instance-attribute
single_user_site: Optional[bool] = None

Is single user site

is_vip class-attribute instance-attribute
is_vip: Optional[bool] = None

Is VIP

is_following class-attribute instance-attribute
is_following: Optional[bool] = None

Is Following

SiteInsightsModel dataclass

SiteInsightsModel(highest_hour: Optional[int] = None, highest_hour_percent: Optional[float] = None, highest_day_of_week: Optional[int] = None, highest_day_percent: Optional[float] = None)

Definition: SiteInsightsModel

PostResponse dataclass

PostResponse(id: Optional[int] = None, comment_count: Optional[int] = None, site_id: Optional[int] = None, date: Optional[str] = None, modified: Optional[str] = None, title: Optional[str] = None, u_r_l: Optional[str] = None, slug: Optional[str] = None, guid: Optional[str] = None, type_: Optional[str] = None, like_count: Optional[int] = None)

Definition: PostResponse

CreatePostModel dataclass

CreatePostModel(title: Optional[str] = None, content: Optional[str] = None, status: Optional[str] = None, tags: Optional[str] = None)

Definition: CreatePostModel

Attributes

title class-attribute instance-attribute
title: Optional[str] = None

The title of the post

content class-attribute instance-attribute
content: Optional[str] = None

The content of the post

status class-attribute instance-attribute
status: Optional[str] = None

The status of the post

tags class-attribute instance-attribute
tags: Optional[str] = None

The tags for post

Error dataclass

Error(code: Optional[int] = None, message: Optional[str] = None, fields: Optional[str] = None)

Definition: Error

WordpressClient

WordpressClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for wordpress connector.

Initialize a WordpressClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

None
options Optional[ConnectorClientOptions]

Optional connector client options.

None

Methods:

site_stats_async async
site_stats_async(site_id: str) -> dict[str, Any] | None

Get site statistics

Get statistics for a specified site

get_async async
get_async(site_id: str, post_id: str) -> dict[str, Any] | None

Get post

Get post

create_async async
create_async(input: CreatePostModel, site_id: str) -> dict[str, Any] | None

Create post

Create post

list_sites_async async
list_sites_async() -> dict[str, Any] | None

List sites

List sites