UserVoice

class uservoice.UserVoice(subdomain, api_key, api_secret=None, access_token=None, access_token_secret=None)

Create a UserVoice service.

Variables:
  • subdomain (str) – The account-specific part of the UserVoice domain, for instance use mycompany if your UserVoice domain is mycompany.uservoice.com.
  • api_key (str) – The API key.
  • api_secret (str or None) – Optional API secret. If you leave this as None, all requests will be made as unauthenticated requests.
  • access_token (str or None) – Optional OAuth 1.0a access token. If you leave this as None, all requests be made as unauthenticated requests.
  • access_token_secret (str or None) – Optional OAuth 1.0a access token secret. If you leave this as None, all requests be made as unauthenticated requests.

Article

UserVoice.article(article_id)

Return the resource corresponding to a single article.

Article.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Article.delete()

Delete this resource.

Article.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Article.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Article.useful()

Mark the article as useful.

Articles

UserVoice.articles()

Return the resource corresponding to all the articles.

Articles.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Articles.delete()

Delete this resource.

Articles.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Articles.search(page=None, per_page=None, query=None)

Search for articles.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • query (str) – Search string.
Articles.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Comments

UserVoice.comments()

Return the resource corresponding to all the comments.

Comments.delete()

Delete this resource.

Comments.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Comments.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

CustomFields

UserVoice.custom_fields()

Return the resource corresponding to custom fields.

CustomFields.delete()

Delete this resource.

CustomFields.get(page=None, per_page=None, filter=None, sort=None)

Fetch all custom fields.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • filter (str) – The kind of fields to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
CustomFields.public(page=None, per_page=None, sort=None)

Fetch public custom fields.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • filter (str) – The kind of fields to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
CustomFields.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Faq

UserVoice.faq(faq_id)

Return the resource corresponding to a single FAQ.

FaqFlags

Faq.flags()

Return the resource corresponding to all the flags of this FAQ.

FaqFlags.create(flag)

Create a new flag.

Variables:flag (str) – The flag name. Refer to the upstream documentation for details.
FaqFlags.delete()

Delete this resource.

FaqFlags.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Faq.delete()

Delete this resource.

Faq.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Forum

UserVoice.forum(forum_id)

Return the resource corresponding to a single forum.

ForumCategories

Forum.categories()

Return a resource corresponding to all the categories on this forum.

ForumCategories.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
ForumCategories.delete()

Delete this resource.

ForumCategories.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumCategories.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

ForumCategory

Forum.category(category_id)

Return a resource corresponding to a single category on this forum.

ForumCategory.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
ForumCategory.delete()

Delete this resource.

ForumCategory.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumCategory.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Stream

Forum.stream()

Return a resource corresponding to the stream of events for this forum.

Stream.private(date=None, filter=None, since=None)

Fetch all private events.

Variables:
  • date (str) – Fetch only events from that day (EST). See upstream documentation for details.
  • filter – Specify which event types you want. See upstream documentation for allowed values.
  • filter – str
  • since (str) – Fetch events from that moment onward. If set, the date parameter is ignored See upstream documentation for details.
Stream.public(date=None, filter=None, since=None)

Fetch all public events.

Variables:
  • date (str) – Fetch only events from that day (EST). See upstream documentation for details.
  • filter – Specify which event types you want. See upstream documentation for allowed values.
  • filter – str
  • since (str) – Fetch events from that moment onward. If set, the date parameter is ignored See upstream documentation for details.

ForumSuggestion

Forum.suggestion(suggestion_id)

Return a resource corresponding to a single suggestion on a forum.

ForumSuggestionComment

ForumSuggestion.comment(comment_id)

Return the resource corresponding to a single comment on this suggestion.

SuggestionCommentFlags

ForumSuggestionComment.flags()

Return the resource corresponding to all the flags of this comment.

SuggestionCommentFlags.create(flag)

Create a new flag.

Variables:flag (str) – The flag name. Refer to the upstream documentation for details.
SuggestionCommentFlags.delete()

Delete this resource.

SuggestionCommentFlags.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestionComment.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
ForumSuggestionComment.delete()

Delete this resource.

ForumSuggestionComment.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestionComment.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

ForumSuggestionComments

ForumSuggestion.comments()

Return the resource corresponding to all the comments on this suggestion.

ForumSuggestionComments.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
ForumSuggestionComments.delete()

Delete this resource.

ForumSuggestionComments.get(page=None, per_page=None, filter=None, sort=None)

Fetch comments on this suggestion.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • filter (str) – The kind of comments to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestionComments.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

SuggestionFlags

ForumSuggestion.flags()

Return the resource corresponding to all the flags of this suggestion.

SuggestionFlags.create(flag)

Create a new flag.

Variables:flag (str) – The flag name. Refer to the upstream documentation for details.
SuggestionFlags.delete()

Delete this resource.

SuggestionFlags.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.

ForumSuggestionNote

ForumSuggestion.note(note_id)

Return the resource corresponding to a single note on this suggestion.

ForumSuggestionNote.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
ForumSuggestionNote.delete()

Delete this resource.

ForumSuggestionNote.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestionNote.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

ForumSuggestionNotes

ForumSuggestion.notes()

Return the resource corresponding to all the notes on this suggestion.

ForumSuggestionNotes.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
ForumSuggestionNotes.delete()

Delete this resource.

ForumSuggestionNotes.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestionNotes.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.
ForumSuggestion.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
ForumSuggestion.delete()

Delete this resource.

ForumSuggestion.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestion.respond(obj)

Respond to a suggestion.

Variables:obj – a Python object representing the response. Refer to the upstream documentation for details.
ForumSuggestion.supporters(page=None, per_page=None, sort=None)

Fetch the supporters for this suggestion.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
ForumSuggestion.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
ForumSuggestion.vote()

Vote for this suggestion.

ForumSuggestions

Forum.suggestions()

Return a resource corresponding to all the suggestion on a forum.

ForumSuggestions.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
ForumSuggestions.delete()

Delete this resource.

ForumSuggestions.get(page=None, per_page=None, category=None, filter=None, sort=None, updated_after_date=None)

Fetch suggestions from this forum.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • category (str) – Either a category ID, all or uncategorized. See upstream documentation for details.
  • filter (str) – The kind of suggestions to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
  • updated_after_date – If filter is assigned_after, a date string formatted yyyy-mm-dd HH:MM:SS -0000.
  • updated_after_date – str
ForumSuggestions.search(page=None, per_page=None, category_id=None, query=None)

Search for suggestions on this forum.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • category_id (int) – A category ID.
  • query (str) – Search string.
ForumSuggestions.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

ForumUserSuggestions

Forum.user_suggestions(user_id)

Return a resource corresponding to all the suggestions of a single user on this forum.

ForumUserSuggestions.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
ForumUserSuggestions.get(page=None, per_page=None, category=None, filter=None, sort=None)

Fetch suggestions from this user on this forum.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • category (str) – Either a category ID, all or uncategorized. See upstream documentation for details.
  • filter (str) – The kind of suggestions to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
Forum.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Forum.delete()

Delete this resource.

Forum.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Forum.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Forums

UserVoice.forums()

Return the resource corresponding to all the forums.

Forums.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Forums.delete()

Delete this resource.

Forums.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Forums.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Gadget

UserVoice.gadget(gadget_id)

Return the resource corresponding to a single gadget.

Gadget.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Gadget.delete()

Delete this resource.

Gadget.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Gadget.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Gadgets

UserVoice.gadgets()

Return the resource corresponding to all the gadgets.

Gadgets.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Gadgets.delete()

Delete this resource.

Gadgets.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Gadgets.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Notes

UserVoice.notes()

Return the resource corresponding to all the notes.

Notes.delete()

Delete this resource.

Notes.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Notes.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Stream

UserVoice.stream()

Return the resource corresponding to a stream.

Stream.private(date=None, filter=None, since=None)

Fetch all private events.

Variables:
  • date (str) – Fetch only events from that day (EST). See upstream documentation for details.
  • filter – Specify which event types you want. See upstream documentation for allowed values.
  • filter – str
  • since (str) – Fetch events from that moment onward. If set, the date parameter is ignored See upstream documentation for details.
Stream.public(date=None, filter=None, since=None)

Fetch all public events.

Variables:
  • date (str) – Fetch only events from that day (EST). See upstream documentation for details.
  • filter – Specify which event types you want. See upstream documentation for allowed values.
  • filter – str
  • since (str) – Fetch events from that moment onward. If set, the date parameter is ignored See upstream documentation for details.

Subdomain

UserVoice.subdomain(subdomain)

Return the resource corresponding to a UserVoice subdomain.

Subdomain.get()

Fetch information about the subdomain.

Suggestion

UserVoice.suggestion(suggestion_id)

Return the resource corresponding to a single suggestion.

Suggestion.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Suggestion.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.

Suggestions

UserVoice.suggestions()

Return the resource corresponding to all the suggestions.

Suggestions.delete()

Delete this resource.

Suggestions.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Suggestions.search(page=None, per_page=None, query=None)

Search for suggestions.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • query (str) – Search string.
Suggestions.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

SupportQueue

UserVoice.support_queue(queue_id)

Return the resource corresponding to a single support queue.

SupportQueue.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
SupportQueue.delete()

Delete this resource.

SupportQueue.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
SupportQueue.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

SupportQueues

UserVoice.support_queues()

Return the resource corresponding to all the support queues.

SupportQueues.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
SupportQueues.delete()

Delete this resource.

SupportQueues.get(page=None, per_page=None)

Fetch all the support queues.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
SupportQueues.sort(order)

Change the order of support queues.

Variables:order (list) – A list of support queue IDs in the desired new ordering.
SupportQueues.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Ticket

UserVoice.ticket(ticket_id)

Return the resource corresponding to a single ticket.

TicketMessages

Ticket.messages()

Return the resource corresponding to all the ticket messages.

TicketMessages.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
TicketMessages.delete()

Delete this resource.

TicketMessages.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
TicketMessages.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

TicketNote

Ticket.note(note_id)

Return the resource corresponding to a single ticket note.

TicketNote.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
TicketNote.delete()

Delete this resource.

TicketNote.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
TicketNote.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

TicketNotes

Ticket.notes()

Return the resource corresponding to all the ticket notes.

TicketNotes.create(text)

Create a new resource.

Variables:text (str) – the text of the resource to be created.
TicketNotes.delete()

Delete this resource.

TicketNotes.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
TicketNotes.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.
Ticket.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Ticket.delete()

Delete this resource.

Ticket.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Ticket.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Tickets

UserVoice.tickets()

Return the resource corresponding to all the tickets.

Tickets.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Tickets.delete()

Delete this resource.

Tickets.get(page=None, per_page=None, assigne_id=None, support_queue_id=None, support_queue=None, filter=None, sort=None, state=None, updated_after_date=None)

Fetch all of the tickets.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • assignee_id (int) – The ID of the user assigned to the ticket.
  • support_queue_id (int) – The ID of the support queue the ticket is in.
  • support_queue (str) – The name of the support queue the ticket is in.
  • filter (str) – Either all or assigned_after.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
  • state (str) – Ticket state. Refer to upstream documentation for possible values.
  • updated_after_date – If filter is assigned_after, a date string formatted yyyy-mm-dd HH:MM:SS -0000.
  • updated_after_date – str
Tickets.search(page=None, per_page=None, query=None)

Search for tickets.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • query (str) – Search string.
Tickets.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Tickets.upsert(obj)

Create or update a ticket

Variables:obj – a Python object representing the ticket. Refer to the upstream documentation for details.

Topic

UserVoice.topic(topic_id)

Return the resource corresponding a single topic.

Topic.articles(page=None, per_page=None, sort=None)

Fetch the articles on a given topic.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
Topic.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Topic.delete()

Delete this resource.

Topic.search(page=None, per_page=None, query=None)

Search for articles on a given topic.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • query (str) – Search string.

Topics

UserVoice.topics()

Return the resource corresponding all the topics.

Topics.delete()

Delete this resource.

Topics.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Topics.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

User

UserVoice.user(user_id=None)

Return the resource corresponding to a single user. If user_id is None, the returned resource is the currently authenticated user, otherwise it is the user with the given ID number.

UserComments

User.comments()

Return the resource corresponding to all of this user’s comments.

UserComments.delete()

Delete this resource.

UserComments.get(page=None, per_page=None, filter=None, sort=None)

Fetch comments from this user.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • filter (str) – The kind of comments to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
UserComments.update(text)

Update this resource.

Variables:text (str) – the new text of the resource.

UserNotes

User.notes()

Return the resource corresponding to all of this user’s notes.

UserNotes.delete()

Delete this resource.

UserNotes.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
UserNotes.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

UserSuggestions

User.suggestions()

Return a resource corresponding to all of this user’s suggestions.

UserSuggestions.delete()

Delete this resource.

UserSuggestions.get(page=None, per_page=None, category=None, filter=None, sort=None)

Fetch suggestions from this user on this forum.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • category (str) – Either a category ID, all or uncategorized. See upstream documentation for details.
  • filter (str) – The kind of suggestions to return, see upstream documentation for possible values.
  • sort (str) – How should the returned collection be sorted. Refer to upstream documentation for possible values.
UserSuggestions.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
User.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
User.delete()

Delete this resource.

User.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
User.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Users

UserVoice.users()

Return the resource corresponding to all the users.

Users.create(obj)

Create a new resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.
Users.delete()

Delete this resource.

Users.get(page=None, per_page=None, sort=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • page (int) – For collections, where should paging start. If left as None, the first page is returned.
  • per_page (int) – For collections, how many objects sould be returned. If left as None, 10 objects are returned.
  • sort (str) – For collections, how should the returned collection be sorted. Refer to upstream documentation for possible values.
Users.search(page=None, per_page=None, guid=None, query=None)

Search for users. One of guid or query mest be present.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • guid (str) – Search by SSO GUID
  • query (str) – Search by username substring.
Users.update(obj)

Update this resource.

Variables:obj –

a Python dictionary representing the resource to be created, in the same as returned from get, but one level less nested. For instance, if get returns {‘forum’: {‘name’: ‘Forum Name’}}, then obj should be {‘name’: ‘New Forum’}.

Refer to the upstream documentation for details.

Service methods

Search for instant answers.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • query (str) – Search string.
UserVoice.oembed(url)

Fetch the HTML used to embed a suggestion.

Variables:url (str) – URL to the Suggestion you want to embed (ex: forums/1/suggestions/1)
UserVoice.search(page=None, per_page=None, query=None)

Generic search for all objects.

Variables:
  • page (int) – Where should paging start. If left as None, the first page is returned.
  • per_page (int) – How many objects sould be returned. If left as None, 10 objects are returned.
  • query (str) – Search string.