NAME

WWW::TypePad::ExternalFeedSubscriptions - ExternalFeedSubscriptions API methods

METHODS

delete

  my $res = $tp->external_feed_subscriptions->delete($id);

Remove the selected subscription.

Returns ExternalFeedSubscription which contains following properties.

urlId

(string) The canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.

callbackUrl

(string) The URL to which to send notifications of new items in this subscription's feeds.

callbackStatus

(string) The HTTP status code that was returned by the last call to the subscription's callback URL.

filterRules

(array<string>) A list of rules for filtering notifications to this subscription. Each rule is a full-text search query string, like those used with the N</assets> endpoint. An item will be delivered to the M<callbackUrl> if it matches any one of these query strings.

postAsUserId

(array<string>) For a Group-owned subscription, the urlId of the User who will own the items posted into the group by the subscription.

get

  my $res = $tp->external_feed_subscriptions->get($id);

Get basic information about the selected subscription.

Returns ExternalFeedSubscription which contains following properties.

urlId

(string) The canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.

callbackUrl

(string) The URL to which to send notifications of new items in this subscription's feeds.

callbackStatus

(string) The HTTP status code that was returned by the last call to the subscription's callback URL.

filterRules

(array<string>) A list of rules for filtering notifications to this subscription. Each rule is a full-text search query string, like those used with the N</assets> endpoint. An item will be delivered to the M<callbackUrl> if it matches any one of these query strings.

postAsUserId

(array<string>) For a Group-owned subscription, the urlId of the User who will own the items posted into the group by the subscription.

add_feeds

  my $res = $tp->external_feed_subscriptions->add_feeds($id);

Add one or more feed identifiers to the subscription.

Returns hash reference which contains following properties.

get_feeds

  my $res = $tp->external_feed_subscriptions->get_feeds($id);

Get a list of strings containing the identifiers of the feeds to which this subscription is subscribed.

Returns List<string> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<string>) The items within the selected slice of the list.

remove_feeds

  my $res = $tp->external_feed_subscriptions->remove_feeds($id);

Remove one or more feed identifiers from the subscription.

Returns hash reference which contains following properties.

update_filters

  my $res = $tp->external_feed_subscriptions->update_filters($id);

Change the filtering rules for the subscription.

Returns hash reference which contains following properties.

update_notification_settings

  my $res = $tp->external_feed_subscriptions->update_notification_settings($id);

Change the callback URL and/or secret for the subscription.

Returns hash reference which contains following properties.

update_user

  my $res = $tp->external_feed_subscriptions->update_user($id);

Change the "post as" user for a subscription owned by a group.

Returns hash reference which contains following properties.